Citrix Virtual Apps and Desktops SDK

New-BrokerResourceAccessPolicyRule

Introduced in: Citrix Virtual Apps and Desktop 7 2511

Creates a new resource access policy rule.

Syntax

New-BrokerResourceAccessPolicyRule
   [-Description <String>]
   [-Enabled <Boolean>]
   [-ExcludedSmartAccessFilterEnabled <Boolean>]
   [-ExcludedSmartAccessTags <String[]>]
   [-IncludedSmartAccessFilterEnabled <Boolean>]
   [-IncludedSmartAccessFilterType <String>]
   [-IncludedSmartAccessTags <String[]>]
   [-Name] <String>
   [-ResourceType <ResourceAccessPolicyResourceType>]
   [-TagUid <Int32>]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

Creates a new resource access policy rule with the specified parameters. Resource access policy rules allow fine-grained control over resource access based on tags.

A resource access policy rule defines a set of access control rights relating to a tag/resource type. These allow fine-grained control of what access is granted to a resource based on details of, the SmartAccess Tags.

Multiple rules in the resource access policy can apply to the resourceType/Tag.

For a user to gain access to a resource via a rule their connection must match all its enabled include filters, and none of its enabled exclude filters.

Examples

EXAMPLE 1

Creates a new disabled resource access policy rule named “MyResourceAccessPolicyRule” for applications with tag UID 1234.

New-BrokerResourceAccessPolicyRule -Name "MyResourceAccessPolicyRule" -TagUid 1234 -ResourceType "Application"
<!--NeedCopy-->

EXAMPLE 2

Creates a new enabled resource access policy rule named “MyResourceAccessPolicyRule” for desktops with tag UID 5678.

New-BrokerResourceAccessPolicyRule -Name "MyResourceAccessPolicyRule" -TagUid 5678 -ResourceType "Desktop" -Enabled $true
<!--NeedCopy-->

Parameters

-Name

Specifies the name of the resource access policy rule.

Type: String
Position: 2
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: True
Length range: 1 to 64
Disallowed characters: /;:#.*?=<>\|[]()"'`\ and all ASCII control characters

-Description

Specifies a description of the resource access policy rule.

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

-Enabled

Specifies whether the resource access policy rule is enabled.

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

-ExcludedSmartAccessFilterEnabled

Specifies whether the excluded SmartAccess tag filter is enabled.

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

-ExcludedSmartAccessTags

Specifies the SmartAccess tags to exclude from the resource access policy rule.

Type: String[]
Position: Named
Default value: (empty list)
Required: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-IncludedSmartAccessFilterEnabled

Specifies whether the included SmartAccess tag filter is enabled.

Type: Boolean
Position: Named
Default value: False
Required: False
Accept pipeline input: True (ByPropertyName)
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: MatchAny
Required: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-IncludedSmartAccessTags

Specifies the SmartAccess tags to include in the resource access policy rule.

Type: String[]
Position: Named
Default value: (empty list)
Required: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ResourceType

Specifies the type of resource to which the policy applies (e.g., Application, Desktop, Content).

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

-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: True (ByPropertyName)
Accept wildcard characters: False

-LoggingId

Specifies the identifier of the high level operation that this cmdlet call forms a part of. Desktop Studio and Desktop 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.

Type: Guid
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

New-BrokerResourceAccessPolicyRule returns the newly created resource access policy rule object.

New-BrokerResourceAccessPolicyRule