Test-AcctIdentityPoolNameAvailable
Checks to ensure that the proposed name for an identity pool is unused.
Syntax
Test-AcctIdentityPoolNameAvailable
[-IdentityPoolName] <String[]>
[<CitrixCommonParameters>]
[<CommonParameters>]
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.
Examples
EXAMPLE 1
Tests whether the identity pool names "MyPool", "NewPool", and "UnusedPool" are available. The output indicates that only "UnusedPool" is available.
Test-AcctIdentityPoolNameAvailable -IdentityPoolName MyPool, NewPool, UnusedPool
Name Available
---- ---------
MyPool False
NewPool False
UnusedPool True
Parameters
-IdentityPoolName
The name or names of the identity pool(s) to be tested.
| Type: | String[] |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName, ByValue) |
| 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
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.
Error Codes
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.