Citrix Virtual Apps and Desktops SDK

Test-Adminaccess

July 4, 2023

Contributed by:

Retrieves the scopes where the specified operation is permitted.

Syntax

Test-AdminAccess [-Operation] <String[]> [-Annotate] [-RejectedScopes] [-BearerToken <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]
<!--NeedCopy-->

Detailed Description

This cmdlet evaluates what rights the current user has, and from these determines the scopes where the specified operation is permitted.

Operations are the indivisible unit of functionality that each XenDesktop service can perform, and usually correspond to individual cmdlets.

If you specify the -Annotate option or specify multiple operations to check, the resulting object is annotated with the operation the result relates to.

Parameters

Name	Description	Required?	Pipeline Input	Default Value
Operation	The operation to query.	true	true (ByValue)
Annotate	Annotates each result with the operation it relates to.	false	false
RejectedScopes	Gets the scopes where operations are not allowed as well as the scopes where an operation is allowed	false	false
BearerToken	Specifies the bearer token assigned to the calling user	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

Citrix.Delegatedadmin.Sdk.Scopereference

The list of permissible scopes for the specified single operation.

Psobject

The list of permissible scopes for each operation. This type of object is returned when the -Annotate option or multiple operations are specified.

Notes

If the specified operation has unrestricted access a single object is returned representing the ‘All’ scope with a ScopeId of Guid.Empty (00000000-0000-0000-0000-000000000000).

Examples

Example 1

C:\PS> Test-AdminAccess -Operation 'Broker:GetCatalog'
<!--NeedCopy-->

Description

Queries the scopes where ‘Broker:GetCatalog’ is permitted.

Example 2

C:\PS> Test-AdminAccess -Operation 'Broker:GetCatalog','Broker:GetMachine'
<!--NeedCopy-->

Description

Queries the scopes where ‘Broker:GetCatalog’ or ‘Broker:GetMachine’ are permitted.

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

Test-Adminaccess

July 4, 2023

Contributed by:

July 4, 2023

Contributed by:

Test-Adminaccess

Syntax

Detailed Description

Related Commands

Parameters

Input Type

Return Values

Citrix.Delegatedadmin.Sdk.Scopereference

Psobject

Notes

Examples

Example 1

Description

Example 2

Description

In this article