Citrix Virtual Apps and Desktops SDK

Get-AcctIdentityPool

Gets a list of existing identity pools.

Syntax

Get-AcctIdentityPool
   [[-IdentityPoolName] <String>]
   [-IdentityPoolUid <Guid>]
   [-Lock <Boolean>]
   [-ScopeId <Guid>]
   [-ScopeName <String>]
   [-ReturnTotalRecordCount]
   [-MaxRecordCount <Int32>]
   [-Skip <Int32>]
   [-SortBy <String>]
   [-Filter <String>]
   [-FilterScope <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

Provides the ability to retrieve a list of existing identity pools.

Examples

EXAMPLE 1

Gets all the identity pools.

Get-AcctIdentityPool

AvailableAccounts    : 1
DeviceManagementType : None
Domain               : MyDomain.com
ErrorAccounts        : 0
IdentityContent      :
IdentityPoolName     : MyPool1
IdentityPoolUid      : 22072d9e-6a8f-494b-a5bc-2ef18ca4b915
IdentityType         : ActiveDirectory
InUseAccounts        : 2
Lock                 : False
MetadataMap          : {}
NamingScheme         : Acc####
NamingSchemeType     : Numeric
OU                   :
ResourceLocationId   : 59e9d28d-f46b-434a-97c2-995da9e120d7
StartCount           : 4
TaintedAccounts      : 0
WorkgroupMachine     : False
ZoneUid              :
Scopes               :
TenantId             :

AvailableAccounts    : 0
DeviceManagementType : None
Domain               : MyDomain.com
ErrorAccounts        : 0
IdentityContent      :
IdentityPoolName     : Pool2
IdentityPoolUid      : 03743136-e43b-4a87-af74-ab71686b3c16
IdentityType         : ActiveDirectory
InUseAccounts        : 0
Lock                 : False
MetadataMap          : {}
NamingScheme         : Test####
NamingSchemeType     : Alphabetic
OU                   :
ResourceLocationId   :
StartCount           : 1
TaintedAccounts      : 0
WorkgroupMachine     : False
ZoneUid              :
Scopes               :
TenantId             :
<!--NeedCopy-->

EXAMPLE 2

Gets all the identity pools beginning with the character ‘M’.

Get-AcctIdentityPool -IdentityPoolName M*

AvailableAccounts    : 0
DeviceManagementType : None
Domain               : MyDomain.com
ErrorAccounts        : 0
IdentityContent      :
IdentityPoolName     : MyPool1
IdentityPoolUid      : 22072d9e-6a8f-494b-a5bc-2ef18ca4b915
IdentityType         : ActiveDirectory
InUseAccounts        : 0
Lock                 : False
MetadataMap          : {}
NamingScheme         : Acc####
NamingSchemeType     : Numeric
OU                   :
ResourceLocationId   :
StartCount           : 1
TaintedAccounts      : 0
WorkgroupMachine     : False
ZoneUid              :
Scopes               :
TenantId             :
<!--NeedCopy-->

Parameters

-IdentityPoolName

The name of the identity pool.

Type: String
Position: 2
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: True

-IdentityPoolUid

The unique identifier for the identity pool.

Type: Guid
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: True

-Lock

Whether the identity pool is locked or not.

Type: Boolean
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-ScopeId

Gets only results with a scope matching the specified scope identifier.

Type: Guid
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-ScopeName

Gets only results with a scope matching the specified scope name.

Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-ReturnTotalRecordCount

See about_Acct_Filtering for details.

Type: SwitchParameter
Position: Named
Default value: False
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-MaxRecordCount

See about_Acct_Filtering for details.

Type: Int32
Position: Named
Default value: 250
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-Skip

See about_Acct_Filtering for details.

Type: Int32
Position: Named
Default value: 0
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-SortBy

See about_Acct_Filtering for details.

Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-Filter

See about_Acct_Filtering for details.

Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-FilterScope

Gets only results allowed by the specified scope id.

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

  • PartialData

    Only a subset of the available data was returned.

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

  • InvalidFilter

    A filtering expression was supplied that could not be interpreted for this cmdlet.

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

Get-AcctIdentityPool