Citrix Virtual Apps and Desktops SDK

Get-AdminPermission

August 9, 2024

Contributed by:

Gets permissions configured for the site.

Syntax

Get-AdminPermission
   [-Id <String>]
   [[-Name] <String>]
   [-Description <String>]
   [-GroupId <String>]
   [-GroupName <String>]
   [-IsHidden <Boolean>]
   [-Metadata <String>]
   [-Operation <String>]
   [-ReadOnly <Boolean>]
   [-Property <String[]>]
   [-ReturnTotalRecordCount]
   [-MaxRecordCount <Int32>]
   [-Skip <Int32>]
   [-SortBy <String>]
   [-Filter <String>]
   [-FilterScope <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

Retrieves permission matching the specified criteria. If no parameters are specified this cmdlet enumerates all permissions.

Permissions are configured using the Import-AdminRoleConfiguration command, and are used to represent collections of operations that are needed to perform a particular task. These permissions are presented in Citrix Studio when configuring roles.

Permissions can also have metadata associated with them.

See about_Admin_Filtering for information about advanced filtering options.

Examples

EXAMPLE 1

Finds all permissions with ‘Edit’ in their names.

Get-AdminPermission -Name *Edit*
<!--NeedCopy-->

EXAMPLE 2

Finds permissions that contain specific operations, with the -Filter form needed to match multiple values.

Get-AdminPermission -Operation "Broker:SetCatalog"
Get-AdminPermission -Filter { Operations -contains "Broker:SetCatalog" -or Operations -contains "Broker:NewCatalog" }
<!--NeedCopy-->

Parameters

-Id

Gets permissions with the specified identifier.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True (ByPropertyName)
Accept wildcard characters:	True

-Description

Gets permissions with the specified description.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	True

-GroupId

Gets permissions that are a member of the specified permission group (by group id).

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	True

-GroupName

Gets permissions that are a member of the specified permission group (by group name).

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	True

-IsHidden

Gets permissions with the specified value for the IsHidden flag.

Type:	Boolean
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Introduced in:	Citrix Virtual Apps and Desktop 7 2305

-Metadata

Gets records with matching metadata entries.

The value being compared with is a concatenation of the key name, a colon, and the value. For example: -Metadata “abc:x*” matches records with a metadata entry having a key name of “abc” and a value starting with the letter “x”.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Operation

Gets permissions that contain a specific operation.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	True

-ReadOnly

Gets permissions with the specified value for the ReadOnly flag.

Type:	Boolean
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Property

Specifies the properties to be returned. This is similar to piping the output of the command through Select-Object, but the properties are filtered more efficiently at the server.

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ReturnTotalRecordCount

When specified, the cmdlet outputs an error record containing the number of records available. This error record is additional information and does not affect the objects written to the output pipeline. See about_Admin_Filtering for details.

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-MaxRecordCount

Specifies the maximum number of records to return.

Type:	Int32
Position:	Named
Default value:	250
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Skip

Skips the specified number of records before returning results. Also reduces the count returned by -ReturnTotalRecordCount.

Type:	Int32
Position:	Named
Default value:	0
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SortBy

Sorts the results by the specified list of properties. The list is a set of property names separated by commas, semi-colons, or spaces. Optionally, prefix each name with a + or - to indicate ascending or descending order. Ascending order is assumed if no prefix is present.

Type:	String
Position:	Named
Default value:	The default sort order is by name or unique identifier.
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Filter

Gets records that match a PowerShell-style filter expression. See about_Admin_Filtering for details.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-FilterScope

Gets only results allowed by the specified scope id.

Type:	Guid
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Introduced in:	Citrix Virtual Apps and Desktop 7 2106

-Name

Gets permissions with the specified name (localized)

Type:	String
Position:	2
Default value:	None
Required:	False
Accept pipeline input:	True (ByPropertyName, ByValue)
Accept wildcard characters:	True

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 cannot pipe input into this cmdlet.

Outputs

Citrix.DelegatedAdmin.Sdk.Permission

Get-AdminPermission returns an object for each matching permission.

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

Get-AdminPermission

August 9, 2024

Contributed by:

August 9, 2024

Contributed by:

Get-AdminPermission

Syntax

Description

Examples

EXAMPLE 1

EXAMPLE 2

Parameters

-Id

-Description

-GroupId

-GroupName

-IsHidden

-Metadata

-Operation

-ReadOnly

-Property

-ReturnTotalRecordCount

-MaxRecordCount

-Skip

-SortBy

-Filter

-FilterScope

-Name

CitrixCommonParameters

CommonParameters

Inputs

None

Outputs

Citrix.DelegatedAdmin.Sdk.Permission

Related Links

In this article