-
Understanding the Citrix Virtual Apps and Desktops Administration Model
-
-
Rename-AcctIdentityPool
-
-
-
-
-
-
-
-
-
-
-
-
-
-
This content has been machine translated dynamically.
Dieser Inhalt ist eine maschinelle Übersetzung, die dynamisch erstellt wurde. (Haftungsausschluss)
Cet article a été traduit automatiquement de manière dynamique. (Clause de non responsabilité)
Este artículo lo ha traducido una máquina de forma dinámica. (Aviso legal)
此内容已经过机器动态翻译。 放弃
このコンテンツは動的に機械翻訳されています。免責事項
이 콘텐츠는 동적으로 기계 번역되었습니다. 책임 부인
Este texto foi traduzido automaticamente. (Aviso legal)
Questo contenuto è stato tradotto dinamicamente con traduzione automatica.(Esclusione di responsabilità))
This article has been machine translated.
Dieser Artikel wurde maschinell übersetzt. (Haftungsausschluss)
Ce article a été traduit automatiquement. (Clause de non responsabilité)
Este artículo ha sido traducido automáticamente. (Aviso legal)
この記事は機械翻訳されています.免責事項
이 기사는 기계 번역되었습니다.책임 부인
Este artigo foi traduzido automaticamente.(Aviso legal)
这篇文章已经过机器翻译.放弃
Questo articolo è stato tradotto automaticamente.(Esclusione di responsabilità))
Translation failed!
Rename-AcctIdentityPool
Renames an identity pool.
Syntax
Rename-AcctIdentityPool
-IdentityPoolUid <Guid>
[-NewIdentityPoolName] <String>
[-PassThru]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
<!--NeedCopy-->
Rename-AcctIdentityPool
[-IdentityPoolName] <String>
[-NewIdentityPoolName] <String>
[-PassThru]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
<!--NeedCopy-->
Description
Provides the ability to change the name of an existing identity pool.
Examples
EXAMPLE 1
Renames an existing identity pool called “oldName” to be called “newName”.
Rename-AcctIdentityPool -IdentityPoolName oldName -NewIdentityPoolName newName
<!--NeedCopy-->
Parameters
-IdentityPoolUid
The unique identifier for the identity pool to be renamed.
Type: | Guid |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-IdentityPoolName
The name of the identity pool to be renamed.
Type: | String |
Position: | 2 |
Default value: | None |
Required: | True |
Accept pipeline input: | True (ByPropertyName) |
Accept wildcard characters: | False |
Length range: | 1 to 64 |
-NewIdentityPoolName
The new name for the identity pool. This must be a name which is not used by an existing identity pool, and it must not contain any of the following characters \/;:#.*?=<>|[]()””’
Type: | String |
Position: | 3 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Length range: | 1 to 64 |
Disallowed characters: | \/;:#.*?=<>\|[]()"' |
Type: | String |
Position: | 3 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Length range: | 1 to 64 |
Disallowed characters: | \/;:#.*?=<>\|[]()"' |
-PassThru
Defines whether or not the command returns a result showing the new state of the updated provisioning scheme.
Type: | SwitchParameter |
Position: | Named |
Default value: | True |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Type: | SwitchParameter |
Position: | Named |
Default value: | True |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-LoggingId
Specifies the identifier of the high-level operation this cmdlet call forms a part of. Citrix Studio and Director typically create high-level operations. PowerShell scripts can also wrap a series of cmdlet calls in a high-level operation by way of the Start-LogHighLevelOperation and Stop-LogHighLevelOperation cmdlets.
Type: | Guid |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
CitrixCommonParameters
This cmdlet supports the common Citrix parameters: -AdminAddress, -AdminClientIP, -BearerToken, -TraceParent, -TraceState and -VirtualSiteId. For more information, see about_CitrixCommonParameters.
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
None
You can’t pipe objects to this cmdlet.
Outputs
Citrix.ADIdentity.Sdk.IdentityPool
This object provides details of the identity pool and contains the following information:
AvailableAccounts <int>
The number of existing accounts (AcctADAccount objects) in the ‘Available’ state (not in ‘InUse’, ‘Tainted’, or ‘Error’).
DeviceManagementType <string>
The device management type. Can be Intune, IntuneWithCitrixTags, IntuneWithSCCM, or None by default.
Domain <string>
The Active Directory domain (in FQDN format) that accounts in the pool belong to.
ErrorAccounts <int>
The number of existing AD accounts in the ‘Error’ state.
IdentityContent <string>
JSON formatted metadata containing Azure AD tenant and Azure AD security group information associated with this identity pool.
IdentityPoolName <string>
The name of the identity pool.
IdentityPoolUid <GUID>
The unique identifier for the identity pool.
IdentityType <string>
The identity type.
InUseAccounts <int>
The number of existing AD accounts in the ‘InUse’ state.
Lock <bool>
Indicates if the identity pool is locked.
MetadataMap <IDictionary[string, string];>
The metadata associated with this identity pool arranged in key value pairs.
NamingScheme <string>
The naming scheme for the identity pool.
NamingSchemeType <string>
The naming scheme type for the identity pool. This can be one of the following:
Numeric - naming scheme uses numeric indexes
Alphabetic - naming scheme uses alphabetic indexes
OU <string>
The Active Directory distinguished name for the OU in which accounts for this identity pool will be created.
ResourceLocationId <GUID>
The UID that corresponds to the resource location (DaaS only).
StartCount <int>
The next index to be used when creating an account in the identity pool.
TaintedAccounts <int>
The number of existing AD accounts in the ‘Tainted’ state.
WorkgroupMachine <bool>
If this is true, the identity pool can have an IdentityType of ‘AzureAD’ or ‘Workgroup’.
If this is false, the identity pool can have an IdentityType of ‘ActiveDirectory’ or ‘HybridAzureAD’.
ZoneUid <GUID>
The UID that corresponds to the Zone in which AD accounts are created.
Scopes <Citrix.ADIdentity.Sdk.ScopeReference[]>
The administration scopes associated with this identity pool.
TenantId <GUID>
Identity of the Citrix tenant associated with this identity pool.
Not applicable (always blank) in non-multitenant sites.
Notes
In the case of failure the following errors can result.
Error Codes
IdentityPoolObjectNotFound
The specified identity pool could not be located.
PermissionDenied
The user does not have administrative rights to perform this operation.
ConfigurationLoggingError
The operation could not be performed because of a configuration logging error
DatabaseError
An error occurred in the service while attempting a database operation.
DatabaseNotConfigured
The operation could not be completed because the database for the service is not configured.
ServiceStatusInvalidDb
An error occurred in the service while attempting a database operation - communication with the database failed for various reasons.
CommunicationError
An error occurred while communicating with the service.
ExceptionThrown
An unexpected error occurred. To locate more details, see the Windows event logs on the controller being used or examine the Citrix Virtual Apps and Desktops logs.
Related Links
Share
Share
In this article
This Preview product documentation is Citrix Confidential.
You agree to hold this documentation confidential pursuant to the terms of your Citrix Beta/Tech Preview Agreement.
The development, release and timing of any features or functionality described in the Preview documentation remains at our sole discretion and are subject to change without notice or consultation.
The documentation is for informational purposes only and is not a commitment, promise or legal obligation to deliver any material, code or functionality and should not be relied upon in making Citrix product purchase decisions.
If you do not agree, select I DO NOT AGREE to exit.