Export-AcctIdentityPool¶
Exports a Identity Pool
Syntax¶
Export-AcctIdentityPool [-IdentityPoolName] <String> [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]
Export-AcctIdentityPool -IdentityPoolUid <Guid> [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]
Detailed Description¶
Export an Identity pool and it ADAccounts to JSON encoded string, note that any account that has been created by has not yet been used by MCS will not be exported
Related Commands¶
Parameters¶
Name | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|
IdentityPoolName | The name of the identity pool. | true | true (ByPropertyName) | |
IdentityPoolUid | The unique identifier for the identity pool. | true | 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 | Specifies the address of a XenDesktop 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¶
System.String¶
A JSON encoded version of the identity pool and the ADAccounts that are part of the identity pool
Notes¶
In the case of failure, the following errors can result.
-
PartialData: Only a subset of the available data was returned.
-
CouldNotQueryDatabase: The query required to get the database was not defined.
-
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
-
CommunicationError: An error occurred while communicating with the service.
-
DatabaseNotConfigured: The operation could not be completed because the database for the service is not configured.
-
InvalidFilter: A filtering expression was supplied that could not be interpreted for this cmdlet.
-
ExceptionThrown: An unexpected error occurred. To locate more details, see the Windows event logs on the controller being used or examine the XenDesktop logs.
Examples¶
Example 1¶
Export-AcctIdentityPool -IdentityPoolName MyIdentityPool
Description¶
Exports the Identity pool MyIdentityPool