Remove-Acctidentitypoolscope¶
Remove the specified identity pool(s) from the given scope(s).
Syntax¶
Remove-AcctIdentityPoolScope [-Scope] <String[]> -InputObject <IdentityPool[]> [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]<br><br>Remove-AcctIdentityPoolScope [-Scope] <String[]> -IdentityPoolUid <Guid[]> [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]<br><br>Remove-AcctIdentityPoolScope [-Scope] <String[]> -IdentityPoolName <String[]> [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]
Detailed Description¶
The Remove-AcctIdentityPoolScope command is used to remove one or more identity pool objects from the given scope(s).
To remove a identity pool from a scope you need permission to change the scopes of the identity pool.
If the identity pool is not in a specified scope, that scope will be silently ignored.
The identity pools may be specified using the unique identifier, name, or as a powershell object.
Related Commands¶
Parameters¶
| Name | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|
| Scope | Specifies the scopes to remove the objects from. | true | false | |
| InputObject | The identity pool objects to be removed. | true | true (ByValue, ByPropertyName) | |
| IdentityPoolUid | The unique identifier for the identity pools to be removed. | true | true (ByValue, ByPropertyName) | |
| IdentityPoolName | The name of the identity pools to be removed. | true | true (ByValue, ByPropertyName) | |
| 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. | 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 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¶
None¶
Notes¶
If the command fails, the following errors can be returned.
Error Codes
-----------
UnknownObject
One of the specified objects was not found.
ScopeNotFound
One of the specified scopes was not found.
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.
DataStoreException
An error occurred in the service while attempting a database operation - communication with the database failed for various reasons.
PermissionDenied
You do not have permission to execute this command with the specified objects or scopes.
AuthorizationError
There was a problem communicating with the Citrix Delegated Administration Service.
ConfigurationLoggingError
The operation could not be performed because of a configuration logging error.
CommunicationError
There was a problem communicating with the remote service.
ExceptionThrown
An unexpected error occurred. For more details, see the Windows event logs on the controller or the Citrix Virtual Apps and Desktops logs.
Examples¶
Example 1¶
c:\PS>Remove-AcctIdentityPoolScope Finance -IdentityPoolUid 6702C5D0-C073-4080-A0EE-EC74CB537C52
Description¶
Removes a single identity pool from the 'Finance' scope.
Example 2¶
c:\PS>Remove-AcctIdentityPoolScope Finance,Marketing -IdentityPoolUid 6702C5D0-C073-4080-A0EE-EC74CB537C52
Description¶
Removes a single identity pool from multiple scopes.
Example 3¶
c:\PS>Get-AcctIdentityPool | Remove-AcctIdentityPoolScope Finance
Description¶
Removes all visible identity pool objects from the 'Finance' scope.
Example 4¶
c:\PS>Remove-AcctIdentityPoolScope Finance -IdentityPoolName A\*
Description¶
Removes identity pool objects with a name starting with an 'A' from the 'Finance' scope.