Citrix Virtual Apps and Desktops SDK

Rename-BrokerAutoTagRule

Introduced in: Citrix Virtual Apps and Desktop 7 2109

Renames the AutoTagRule.

Syntax

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

Description

Renames the AutoTagRule.

Examples

EXAMPLE 1

Renames RandomAllocatedCatalogs to StaticAllocatedCatalogs.

Rename-BrokerAutoTagRule -Name RandomAllocatedCatalogs -NewName StaticAllocatedCatalogs
<!--NeedCopy-->

Parameters

-InputObject

Specifies the AutoTagRule object to rename.

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

-Name

Specifies the AutoTagRule be renamed.

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

-NewName

Specifies the new name for the AutoTagRule.

Type: String
Position: 3
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: False
Length range: 1 to 255
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.AutoTagRule

AutoTagRule may be specified through pipeline input.

Outputs

None

By default, this cmdlet returns no output.

Rename-BrokerAutoTagRule