-
Understanding the Citrix Virtual Apps and Desktops Administration Model
-
-
-
-
-
Get-BrokerResourceAccessPolicyRule
-
-
-
-
-
-
-
-
-
-
-
-
-
This content has been machine translated dynamically.
Dieser Inhalt ist eine maschinelle Übersetzung, die dynamisch erstellt wurde. (Haftungsausschluss)
Cet article a été traduit automatiquement de manière dynamique. (Clause de non responsabilité)
Este artículo lo ha traducido una máquina de forma dinámica. (Aviso legal)
此内容已经过机器动态翻译。 放弃
このコンテンツは動的に機械翻訳されています。免責事項
이 콘텐츠는 동적으로 기계 번역되었습니다. 책임 부인
Este texto foi traduzido automaticamente. (Aviso legal)
Questo contenuto è stato tradotto dinamicamente con traduzione automatica.(Esclusione di responsabilità))
This article has been machine translated.
Dieser Artikel wurde maschinell übersetzt. (Haftungsausschluss)
Ce article a été traduit automatiquement. (Clause de non responsabilité)
Este artículo ha sido traducido automáticamente. (Aviso legal)
この記事は機械翻訳されています.免責事項
이 기사는 기계 번역되었습니다.책임 부인
Este artigo foi traduzido automaticamente.(Aviso legal)
这篇文章已经过机器翻译.放弃
Questo articolo è stato tradotto automaticamente.(Esclusione di responsabilità))
Translation failed!
Get-BrokerResourceAccessPolicyRule
Introduced in: Citrix Virtual Apps and Desktop 7 2511
Gets resource access policy rules from the site.
Syntax
Get-BrokerResourceAccessPolicyRule
[[-Name] <String>]
[-Description <String>]
[-Enabled <Boolean>]
[-ExcludedSmartAccessFilterEnabled <Boolean>]
[-ExcludedSmartAccessTag <String>]
[-IncludedSmartAccessFilterEnabled <Boolean>]
[-IncludedSmartAccessFilterType <String>]
[-IncludedSmartAccessTag <String>]
[-Metadata <String>]
[-ResourceType <ResourceAccessPolicyResourceType>]
[-TagName <String>]
[-TagUid <Int32>]
[-Property <String[]>]
[-ReturnTotalRecordCount]
[-MaxRecordCount <Int32>]
[-Skip <Int32>]
[-SortBy <String>]
[-Filter <String>]
[-FilterScope <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
<!--NeedCopy-->
Get-BrokerResourceAccessPolicyRule
[-Uid] <Int32>
[-Property <String[]>]
[<CitrixCommonParameters>]
[<CommonParameters>]
<!--NeedCopy-->
Description
Returns resource access policy rules matching the specified search criteria from the site. If no search criteria are specified, all resource access policy rules are obtained.
A resource access policy rule defines a set of filters and access control rights relating to resources based on tags. These allow fine-grained control of what access is granted to resources based on details such as resource type and tags.
————————– BrokerResourceAccessPolicyRule Object
Represents a resource access policy rule in the Citrix Broker SDK.
-
Description (System.String)
The description of the resource access policy rule.
-
Enabled (System.Boolean)
Indicates whether the resource access policy rule is enabled.
-
ExcludedSmartAccessFilterEnabled (System.Boolean)
Indicates whether the excluded SmartAccess tag filter is enabled.
-
ExcludedSmartAccessTags (System.String[])
The list of SmartAccess tags excluded from the resource access policy rule.
-
IncludedSmartAccessFilterEnabled (System.Boolean)
Indicates whether the included SmartAccess tag filter is enabled.
-
IncludedSmartAccessFilterType (System.String)
The type of SmartAccess filter for included tags (e.g., MatchAny, MatchAll).
-
IncludedSmartAccessTags (System.String[])
The list of SmartAccess tags included in the resource access policy rule.
-
MetadataMap (System.Collections.Generic.Dictionary<string, string>)
A dictionary containing metadata associated with the resource access policy rule.
-
Name (System.String)
The name of the resource access policy rule.
-
ResourceType (Citrix.Broker.Admin.SDK.ResourceAccessPolicyResourceType?)
The type of resource to which the policy applies.
-
TagName (System.String)
The name of the tag associated with the resource access policy rule.
-
TagUid (System.Int32?)
The unique identifier of the tag associated with the resource access policy rule.
-
Uid (System.Int32)
The unique identifier of the resource access policy rule.
Examples
EXAMPLE 1
Gets the resource access policy rule named “MyResourceAccessPolicyRule”.
Get-BrokerResourceAccessPolicyRule -Name "MyResourceAccessPolicyRule"
<!--NeedCopy-->
EXAMPLE 2
Gets all resource access policy rules associated with the tag UID 21.
Get-BrokerResourceAccessPolicyRule -TagUid 21
<!--NeedCopy-->
Parameters
-Uid
Specifies the unique identifier of the resource access policy rule.
| Type: | Int32 |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
Specifies the name of the resource access policy rule.
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-Description
Specifies a description of the resource access policy rule.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-Enabled
Specifies whether the resource access policy rule is enabled.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ExcludedSmartAccessFilterEnabled
Specifies whether the excluded SmartAccess tag filter is enabled.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ExcludedSmartAccessTag
Specifies the SmartAccess tags to exclude from the resource access policy rule.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-IncludedSmartAccessFilterEnabled
Specifies whether the included SmartAccess tag filter is enabled.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-IncludedSmartAccessFilterType
Specifies the type of SmartAccess filter to use for included tags (e.g., MatchAny, MatchAll).
| Type: | String |
| Accepted values: | MatchAny, MatchAll |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-IncludedSmartAccessTag
Specifies the SmartAccess tags to include in the resource access policy rule.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-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 |
-ResourceType
Specifies the type of resource to which the policy applies (e.g., Application, Desktop).
| Type: | ResourceAccessPolicyResourceType |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-TagName
Specifies the name of the tag associated with the resource access policy rule.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-TagUid
Specifies the unique identifier of the tag associated with the resource access policy rule.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ReturnTotalRecordCount
When specified, this causes the cmdlet to output 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_Broker_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_Broker_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 |
-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 |
CitrixCommonParameters
This cmdlet supports the common Citrix parameters: -AdminAddress, -AdminClientIP, -BearerToken, -SkipCertificateValidation, -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.Broker.Admin.SDK.ResourceAccessPolicyRule
Get-BrokerResourceAccessPolicyRule returns all resource access policy rules that match the specified selection criteria.
Related Links
Share
Share
In this article
This Preview product documentation is Citrix Confidential.
You agree to hold this documentation confidential pursuant to the terms of your Citrix Beta/Tech Preview Agreement.
The development, release and timing of any features or functionality described in the Preview documentation remains at our sole discretion and are subject to change without notice or consultation.
The documentation is for informational purposes only and is not a commitment, promise or legal obligation to deliver any material, code or functionality and should not be relied upon in making Citrix product purchase decisions.
If you do not agree, select I DO NOT AGREE to exit.