Set-BrokerResourceAccessPolicyRule
Introduced in: Citrix Virtual Apps and Desktop 7 2511
Modifies an existing resource access policy rule.
Syntax
Set-BrokerResourceAccessPolicyRule
[-InputObject] <ResourceAccessPolicyRule[]>
[-PassThru]
[-AddExcludedSmartAccessTags <String[]>]
[-AddIncludedSmartAccessTags <String[]>]
[-Description <String>]
[-Enabled <Boolean>]
[-ExcludedSmartAccessFilterEnabled <Boolean>]
[-ExcludedSmartAccessTags <String[]>]
[-IncludedSmartAccessFilterEnabled <Boolean>]
[-IncludedSmartAccessFilterType <String>]
[-IncludedSmartAccessTags <String[]>]
[-RemoveExcludedSmartAccessTags <String[]>]
[-RemoveIncludedSmartAccessTags <String[]>]
[-ResourceType <ResourceAccessPolicyResourceType>]
[-TagUid <Int32>]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Set-BrokerResourceAccessPolicyRule
[-Name] <String>
[-PassThru]
[-AddExcludedSmartAccessTags <String[]>]
[-AddIncludedSmartAccessTags <String[]>]
[-Description <String>]
[-Enabled <Boolean>]
[-ExcludedSmartAccessFilterEnabled <Boolean>]
[-ExcludedSmartAccessTags <String[]>]
[-IncludedSmartAccessFilterEnabled <Boolean>]
[-IncludedSmartAccessFilterType <String>]
[-IncludedSmartAccessTags <String[]>]
[-RemoveExcludedSmartAccessTags <String[]>]
[-RemoveIncludedSmartAccessTags <String[]>]
[-ResourceType <ResourceAccessPolicyResourceType>]
[-TagUid <Int32>]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
Sets the properties of an existing resource access policy rule.
Examples
EXAMPLE 1
Disables the resource access policy rule named "MyResourceAccessPolicyRule".
Set-BrokerResourceAccessPolicyRule -Name "MyResourceAccessPolicyRule" -Enabled $false
EXAMPLE 2
Gets the resource access policy rule named "MyResourceAccessPolicyRule" and sets its description to "New Description".
Get-BrokerResourceAccessPolicyRule -Name "MyResourceAccessPolicyRule" | Set-BrokerResourceAccessPolicyRule -Description "New Description"
Parameters
-InputObject
Specifies the resource access policy rule object to modify.
| Type: | ResourceAccessPolicyRule[] |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByValue) |
| Accept wildcard characters: | False |
-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 |
-PassThru
This cmdlet does not generate any output, unless you use the PassThru parameter, in which case it returns the affected record.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-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: | False |
| Disallowed characters: | All ASCII control characters |
-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 |
-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 |
-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 |
-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 |
-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, -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
Citrix.Broker.Admin.SDK.ResourceAccessPolicyRule
You can pipe a Citrix.Broker.Admin.SDK.ResourceAccessPolicyRule object to this cmdlet.
Outputs
None or Citrix.Broker.Admin.SDK.ResourceAccessPolicyRule
This cmdlet does not generate any output, unless you use the PassThru parameter, in which case it generates a Citrix.Broker.Admin.SDK.ResourceAccessPolicyRule object.