Citrix Virtual Apps and Desktops SDK

Rename-BrokerAccessPolicyRule

Renames a rule in the site’s access policy.

Syntax

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

Description

The Rename-BrokerAccessPolicyRule cmdlet renames a rule in the site’s access policy. The Name property of the rule is changed.

An access policy rule defines a set of connection filters and access control rights relating to a desktop group. These allow fine-grained control of what access is granted to a desktop group based on details of, for example, a user’s endpoint device, its address, and the user’s identity.

Examples

EXAMPLE 1

Renames the access policy rule called Sales to TeleSales. The new name of the rule must be unique in the access policy.

Rename-BrokerAccessPolicyRule 'Sales' -NewName 'TeleSales'
<!--NeedCopy-->

Parameters

-InputObject

The access policy rule to be renamed.

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

-Name

The existing name of the access policy rule to be renamed.

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

-NewName

The new name for the access policy rule being renamed. The new name must not match that of any other existing rules in the policy.

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, -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.AccessPolicyRule

The access policy rule to be renamed.

Outputs

None or Citrix.Broker.Admin.SDK.AccessPolicyRule

This cmdlet does not generate any output, unless you use the PassThru parameter, in which case it generates a Citrix.Broker.Admin.SDK.AccessPolicyRule object.

Rename-BrokerAccessPolicyRule