Test-AcctIdentityPoolNameAvailable¶

Checks to ensure that the proposed name for an identity pool is unused.

Syntax¶

Test-AcctIdentityPoolNameAvailable [-IdentityPoolName] <String[]> [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

Detailed Description¶

Checks to ensure that the proposed name for an identity pool is unused. This check is done without regard for scoping of existing identity pools, so the names of identity pools under inaccessible administrative scopes are also checked.

Parameters¶

Name	Description	Required?	Pipeline Input	Default Value
IdentityPoolName	The name or names of the identity pool(s) to be tested.	true	true (ByValue, ByPropertyName)
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¶

Object[]¶

An array of PSObjects that pair the name and availability of the name

Notes¶

In the case of failure, the following errors can result.

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.
PermissionDenied: The user does not have administrative rights to perform this operation.
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>Test-AcctIdentityPoolNameAvailable -IdentityPoolName MyPool, NewPool, UnusedPool

Name       Available

----       ---------

MyPool         False

NewPool        False

UnusedPool      True

Description¶

Tests whether the identity pool names "MyPool", "NewPool", and "UnusedPool" are available. The output indicates that only "UnusedPool" is available.