Remove-AcctIdentityPool
Removes identity pools.
Syntax
Remove-AcctIdentityPool
-IdentityPoolUid <Guid>
[-AzureADAccessToken <String>]
[-LoggingId <Guid>]
[-SkipCertificateValidation]
[<CitrixCommonParameters>]
[<CommonParameters>]
Remove-AcctIdentityPool
[-IdentityPoolName] <String>
[-AzureADAccessToken <String>]
[-LoggingId <Guid>]
[-SkipCertificateValidation]
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
Provides the ability to remove identity pools. The identity pool must be emptied of any AD accounts that it contains before it can be removed.
Examples
EXAMPLE 1
Removes the identity pool named "MyPool".
c:\Remove-AcctIdentityPool -IdentityPoolName MyPool
Parameters
-IdentityPoolUid
The unique identifier for the identity pool to be removed.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-IdentityPoolName
The name of the identity pool to be removed.
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
| Length range: | 1 to 64 |
-AzureADAccessToken
The access token of Microsoft Graph API. Must be specified if "SecurityGroup" is managed by Citrix.
Make sure grant consent to following permissions:
-
Group.ReadWrite.All
-
GroupMember.ReadWrite.All
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2206 |
-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.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SkipCertificateValidation
Forces the cmdlet to skip checking SSL certificates. By default, the cmdlet will check the certificate from the server. If the certificate is not valid, the cmdlet will not connect to the server.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2511 |
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
None
By default, this cmdlet returns no output.
Notes
In the case of failure the following errors can be produced.
Error Codes
IdentityPoolObjectNotFound
The specified identity pool could not be located.
UnableToRemoveDueToAssociatedAccounts
The identity pool is not empty.
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
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.
AzureADTenantIdInIdentityContentMismatchAzureADAccessToken
The TenantId extracted from AccessToken must be the same as specified TenantId in IdentityContent.
FailedToDeleteAzureADSecurityGroup
An error occured in the service while deleting Azure AD security group.
UnableToRemoveDueToAssociatedProvScheme
The IdentityPool cannot be removed as it is associated with one or more ProvSchemes
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.