Rename-BrokerApplicationGroup

Last published : Oct 31, 2026
Renames an application group.
Related information
about_Broker_AccessPolicy

Syntax

Rename-BrokerApplicationGroup
      [-InputObject] <ApplicationGroup[]>
      [-PassThru]
      [-NewName] <String>
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
Rename-BrokerApplicationGroup
      [-Name] <String>
      [-PassThru]
      [-NewName] <String>
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]

Description

The Rename-BrokerApplicationGroup cmdlet changes the name of an application group. An application group cannot have the same name as another application group.
Application group names are not visible to end users.

Examples

EXAMPLE 1

Renames the application group with name "Ofice" to "Office".
Rename-BrokerApplicationGroup -Name "Ofice" -NewName "Office"

EXAMPLE 2

Renames application group with the Uid 1 to "New Name", showing the result.
Get-BrokerApplicationGroup -Uid 1 | Rename-BrokerApplicationGroup -NewName "New Name" -PassThru

Parameters

-InputObject

Specifies the application group to rename.
Type: ApplicationGroup[]
Position: 2
Default value: Nul
Required: True
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Name

Specifies the name of the application group to rename.
Type: String
Position: 2
Default value: Null
Required: True
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: True

-NewName

Specifies the new name of the application group.
Type: String
Position: 3
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: False

-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.ApplicationGroup

You can pipe application groups to Rename-BrokerApplicationGroup.

Outputs

None or Citrix.Broker.Admin.SDK.ApplicationGroup

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