Citrix Virtual Apps and Desktops SDK

Add-Acctidentitypoolscope

August 3, 2023

Contributed by:

Add the specified IdentityPool(s) to the given scope(s).

Syntax

Add-AcctIdentityPoolScope [-Scope] <String[]> -InputObject <IdentityPool[]> [-LoggingId <Guid>] [-BearerToken <String>] [-AdminAddress <String>] [<CommonParameters>]

Add-AcctIdentityPoolScope [-Scope] <String[]> -IdentityPoolUid <Guid[]> [-LoggingId <Guid>] [-BearerToken <String>] [-AdminAddress <String>] [<CommonParameters>]

Add-AcctIdentityPoolScope [-Scope] <String[]> -IdentityPoolName <String[]> [-LoggingId <Guid>] [-BearerToken <String>] [-AdminAddress <String>] [<CommonParameters>]
<!--NeedCopy-->

Detailed Description

The Add-AcctIdentityPoolScope command is used to associate one or more IdentityPool objects with given scope(s).

There are multiple parameter sets for this cmdlet, allowing you to identify the IdentityPool objects in different ways: - IdentityPool objects can be piped in or specified by the InputObject parameter - The IdentityPoolUid parameter specifies objects by IdentityPoolUid - The IdentityPoolName parameter specifies objects by IdentityPoolName (supports wildcards)

To add a IdentityPool to a scope you need permission to change the scopes of the IdentityPool and permission to add objects to all of the scopes you have specified.

If the IdentityPool is already in a scope, that scope will be silently ignored.

Parameters

Name	Description	Required?	Pipeline Input	Default Value
Scope	Specifies the scopes to add the objects to.	true	false
InputObject	Specifies the IdentityPool objects to be added.	true	true (ByValue, ByPropertyName)
IdentityPoolUid	Specifies the IdentityPool objects to be added by IdentityPoolUid.	true	true (ByValue, ByPropertyName)
IdentityPoolName	Specifies the IdentityPool objects to be added by IdentityPoolName.	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
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

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 XenDesktop logs.

Examples

Example 1

c:\PS>Add-AcctIdentityPoolScope Finance -IdentityPoolUid 6702C5D0-C073-4080-A0EE-EC74CB537C52
<!--NeedCopy-->

Description

Adds a single IdentityPool to the ‘Finance’ scope.

Example 2

c:\PS>Add-AcctIdentityPoolScope Finance,Marketing -IdentityPoolUid 6702C5D0-C073-4080-A0EE-EC74CB537C52
<!--NeedCopy-->

Description

Adds a single IdentityPool to the multiple scopes.

Example 3

c:\PS>Get-AcctIdentityPool | Add-AcctIdentityPoolScope Finance
<!--NeedCopy-->

Description

Adds all visible IdentityPool objects to the ‘Finance’ scope.

Example 4

c:\PS>Add-AcctIdentityPoolScope Finance -IdentityPoolName A\*
<!--NeedCopy-->

Description

Adds IdentityPool objects with a name starting with an ‘A’ to the ‘Finance’ scope.

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Add-Acctidentitypoolscope

August 3, 2023

Contributed by:

August 3, 2023

Contributed by:

Add-Acctidentitypoolscope

Syntax

Detailed Description

Related Commands

Parameters

Input Type

Return Values

None

Notes

Examples

Example 1

Description

Example 2

Description

Example 3

Description

Example 4

Description

In this article