Developer Documentation
Citrix Virtual Apps and Desktops SDK
2511 CR 2507 LTSR 2503 CR 2411 CR 2407 CR 2402 LTSR 2311 CR 2305 CR 2303 CR 2212 CR 2209 CR 2206 CR 2203 LTSR 2112 CR 2109 CR 2103 CR 1912 LTSR
View PDF

Rename-BrokerResourceAccessPolicyRule

January 13, 2026
Contributed by: 
C

Introduced in: Citrix Virtual Apps and Desktop 7 2511

Renames a resource access policy rule.

Syntax

Rename-BrokerResourceAccessPolicyRule
      [-InputObject] <ResourceAccessPolicyRule[]>
      [-PassThru]
      [-NewName] <String>
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->

Rename-BrokerResourceAccessPolicyRule
      [-Name] <String>
      [-PassThru]
      [-NewName] <String>
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->

Description

Renames an existing resource access policy rule.

Examples

EXAMPLE 1

Renames the resource access policy rule named “OldName” to “NewName”.

Rename-BrokerResourceAccessPolicyRule -Name "OldName" -NewName "NewName"
<!--NeedCopy-->

Parameters

-InputObject

Specifies the resource access policy rule object to rename.

Type: ResourceAccessPolicyRule[]
Position: 2
Default value: None
Required: True
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Name

The existing name of the resource access policy rule to rename.

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

-NewName

The new name for the resource access policy rule.

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

-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

-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

Citrix.Broker.Admin.SDK.ResourceAccessPolicyRule

The resource access policy rule object to rename.

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.

Rename-BrokerResourceAccessPolicyRule
January 13, 2026
Contributed by: 
C
January 13, 2026
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.