Remove-AcctIdentityPoolMetadata
Removes metadata from the given identity pool.
Syntax
Remove-AcctIdentityPoolMetadata
[-IdentityPoolUid] <Guid>
-Name <String>
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Remove-AcctIdentityPoolMetadata
[-IdentityPoolUid] <Guid>
-Map <PSObject>
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Remove-AcctIdentityPoolMetadata
[-InputObject] <IdentityPool[]>
-Name <String>
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Remove-AcctIdentityPoolMetadata
[-InputObject] <IdentityPool[]>
-Map <PSObject>
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Remove-AcctIdentityPoolMetadata
[-IdentityPoolName] <String>
-Name <String>
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Remove-AcctIdentityPoolMetadata
[-IdentityPoolName] <String>
-Map <PSObject>
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
Provides the ability to remove metadata from the given identity pool.
The identity pools may be specified using the unique identifier, name, or as a powershell object.
Examples
EXAMPLE 1
Remove the metadata property "metadataName" from the identity pool "MyPool".
Remove-AcctIdentityPoolMetadata -IdentityPoolName MyPool -Name metadataName
EXAMPLE 2
Removes the metadata properties "metadataName1" and "metadataName2" from the identity "MyPool". Note that the values of the properties DO NOT have to match "val1" and "val2".
Remove-AcctIdentityPoolMetadata -IdentityPoolName MyPool -Map (@{"metadataName1" = "val1"; "metadataname2" = "val2"})
EXAMPLE 3
Remove all metadata from all identity pool objects.
Get-AcctIdentityPool | % { Remove-AcctIdentityPoolMetadata -Map $_.MetadataMap }
Parameters
-Name
The metadata property to remove.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Length range: | 1 to 64 |
| Disallowed characters: | \/;:#.*?=<>\|[]()"' |
-Map
Specifies a dictionary of (name, value)-pairs for the properties. This can be either a hashtable (created with @{"name1" = "val1"; "name2" = "val2"}) or a string dictionary (created with new-object "System.Collections.Generic.Dictionary\[String,String\]"). The properties whose names match keys in the map will be removed.
| Type: | PSObject |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByValue) |
| Accept wildcard characters: | False |
-IdentityPoolUid
The unique identifier for the identity pool from which metadata is to be removed.
| Type: | Guid |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName, ByValue) |
| Accept wildcard characters: | False |
-IdentityPoolName
The name of the identity pool from which metadata is to be removed.
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName, ByValue) |
| Accept wildcard characters: | True |
-InputObject
Objects from which the metadata is to be removed.
| Type: | IdentityPool[] |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByValue) |
| Accept wildcard characters: | False |
-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 |
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
If the command fails, the following errors can be returned.
Error Codes
InvalidParameterCombination
The cmdlet parameters are inconsistent.
UnknownObject
One of the specified objects 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.
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.