Citrix Virtual Apps and Desktops SDK

Import-AcctIdentityPool

March 11, 2024

Contributed by:

Imports an identity pool in the site

Syntax

Import-AcctIdentityPool -IdentityPoolData <String> [-Scope <String[]>] [-ZoneUid <Guid>] [-LoggingId <Guid>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

<!--NeedCopy-->

Detailed Description

Provides the ability to import an identity pool from another site that has been exported using Export-AcctIdentityPool. Any AD accounts in the exported identity pool will be imported as well.

Parameters

Name	Description	Required?	Pipeline Input	Default Value
IdentityPoolData	Specifies the identity pool to import in the form of a JSON encoded string.	true	true (ByPropertyName)
Scope	The administration scopes to be applied to the new identity pool.	false	false
ZoneUid	The UID that corresponds to the Zone in which these AD accounts will be created. This is only intended to be used for Citrix Cloud Delivery Controllers.	false	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.	false	false
BearerToken	Specifies the bearer token assigned to the calling user	false	false
AdminClientIP	Specifies the Client IP of the calling user	false	false
TraceParent	Specifies the trace parent assigned for internal diagnostic tracing use	false	false
TraceState	Specifies the trace state assigned for internal diagnostic tracing use	false	false
VirtualSiteId	Specifies the virtual site the PowerShell snap-in will connect to.	false	false
AdminAddress	The address of a Citrix Virtual Apps and Desktops controller the PowerShell snap-in will connect to. You can provide this as a host name or an IP address.	false	false	Localhost. Once a value is provided by any cmdlet, this value becomes the default.

Input Type

Return Values

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, 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.

CouldNotQueryDatabase: The query required to get the database was not defined.
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
CommunicationError: An error occurred while communicating with the service.
DatabaseNotConfigured: The operation could not be completed because the database for the service is not configured.
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.

Examples

Example 1

c:\PS>Import-AcctIdentityPool -IdentityPoolData $identityPoolData

        c:\PS> Get-AcctIdentityPool -IdentityPoolName MyPool

          AvailableAccounts    : 0

          DeviceManagementType : None

          Domain               : MyDomain.com

          ErrorAccounts        : 0

          IdentityContent      :

          IdentityPoolName     : MyPool

          IdentityPoolUid      : 5a2ac1c4-b183-4796-a984-163b645c6ca4

          IdentityType         : ActiveDirectory

          InUseAccounts        : 2

          Lock                 : False

          MetadataMap          : {}

          NamingScheme         : Acc

          NamingSchemeType     : Numeric

          OU                   :

          ResourceLocationId   :

          StartCount           : 3

          TaintedAccounts      : 0

          WorkgroupMachine     : False

          ZoneUid              :

          Scopes               :

          TenantId             :

<!--NeedCopy-->

Description

Import the identity pool defined in the variable $identityPoolData. This variable should be created using Export-AcctIdentityPool (potentially on a different site). The imported identity pool contains any accounts that were exported with the identity pool.

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Import-AcctIdentityPool

March 11, 2024

Contributed by:

March 11, 2024

Contributed by:

Import-AcctIdentityPool

Syntax

Detailed Description

Related Commands

Parameters

Input Type

Return Values

Citrix.Adidentity.Sdk.Identitypool

Notes

Examples

Example 1

Description

In this article