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>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]
Detailed Description¶
Provides the ability to retrieve a list of existing identity pools.
Related Commands¶
Parameters¶
| Name | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|
| IdentityPoolName | The name of the identity pool. | false | false | |
| IdentityPoolUid | The unique identifier for the identity pool. | false | false | |
| Lock | Whether the identity pool is locked or not. | false | false | |
| ScopeId | Gets only results with a scope matching the specified scope identifier. | false | false | |
| ScopeName | Gets only results with a scope matching the specified scope name. | false | false | |
| ReturnTotalRecordCount | See about_Acct_Filtering for details. | false | false | false |
| MaxRecordCount | See about_Acct_Filtering for details. | false | false | 250 |
| Skip | See about_Acct_Filtering for details. | false | false | 0 |
| SortBy | See about_Acct_Filtering for details. | false | false | |
| Filter | See about_Acct_Filtering for details. | false | false | |
| FilterScope | Gets only results allowed by the specified scope id. | false | false | |
| BearerToken | Specifies the bearer token assigned to 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 that the PowerShell snap-in connects 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 will become 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.
Error Codes
-----------
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.
Examples¶
Example 1¶
c:\PS>Get-AcctIdentityPool<br><br> AvailableAccounts : 1<br><br> DeviceManagementType : None<br><br> Domain : MyDomain.com<br><br> ErrorAccounts : 0<br><br> IdentityContent :<br><br> IdentityPoolName : MyPool1<br><br> IdentityPoolUid : 22072d9e-6a8f-494b-a5bc-2ef18ca4b915<br><br> IdentityType : ActiveDirectory<br><br> InUseAccounts : 2<br><br> Lock : False<br><br> MetadataMap : {}<br><br> NamingScheme : Acc####<br><br> NamingSchemeType : Numeric<br><br> OU :<br><br> ResourceLocationId : 59e9d28d-f46b-434a-97c2-995da9e120d7<br><br> StartCount : 4<br><br> TaintedAccounts : 0<br><br> WorkgroupMachine : False<br><br> ZoneUid :<br><br> Scopes :<br><br> TenantId :<br><br> AvailableAccounts : 0<br><br> DeviceManagementType : None<br><br> Domain : MyDomain.com<br><br> ErrorAccounts : 0<br><br> IdentityContent :<br><br> IdentityPoolName : Pool2<br><br> IdentityPoolUid : 03743136-e43b-4a87-af74-ab71686b3c16<br><br> IdentityType : ActiveDirectory<br><br> InUseAccounts : 0<br><br> Lock : False<br><br> MetadataMap : {}<br><br> NamingScheme : Test####<br><br> NamingSchemeType : Alphabetic<br><br> OU :<br><br> ResourceLocationId :<br><br> StartCount : 1<br><br> TaintedAccounts : 0<br><br> WorkgroupMachine : False<br><br> ZoneUid :<br><br> Scopes :<br><br> TenantId :
Description¶
Gets all the identity pools.
Example 2¶
C:\PS>Get-AcctIdentityPool -IdentityPoolName M\*<br><br>AvailableAccounts : 0<br><br>DeviceManagementType : None<br><br>Domain : MyDomain.com<br><br>ErrorAccounts : 0<br><br>IdentityContent :<br><br>IdentityPoolName : MyPool1<br><br>IdentityPoolUid : 22072d9e-6a8f-494b-a5bc-2ef18ca4b915<br><br>IdentityType : ActiveDirectory<br><br>InUseAccounts : 0<br><br>Lock : False<br><br>MetadataMap : {}<br><br>NamingScheme : Acc####<br><br>NamingSchemeType : Numeric<br><br>OU :<br><br>ResourceLocationId :<br><br>StartCount : 1<br><br>TaintedAccounts : 0<br><br>WorkgroupMachine : False<br><br>ZoneUid :<br><br>Scopes :<br><br>TenantId :
Description¶
Gets all the identity pools beginning with the character 'M'.