Citrix Virtual Apps and Desktops SDK

Rename-Brokerapplicationgroup

August 3, 2023

Contributed by:

Renames an application group.

Syntax

Rename-BrokerApplicationGroup [-InputObject] <ApplicationGroup[]> [-NewName] <String> [-PassThru] [-LoggingId <Guid>] [-AdminAddress <String>] [-BearerToken <String>] [<CommonParameters>]

Rename-BrokerApplicationGroup [-Name] <String> [-NewName] <String> [-PassThru] [-LoggingId <Guid>] [-AdminAddress <String>] [-BearerToken <String>] [<CommonParameters>]
<!--NeedCopy-->

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

Parameters

Name	Description	Required?	Pipeline Input	Default Value
InputObject	Specifies the application group to rename.	true	true (ByValue)	nul
Name	Specifies the name of the application group to rename.	true	true (ByPropertyName)	null
NewName	Specifies the new name of the application group.	true	false
PassThru	This cmdlet does not generate any output, unless you use the PassThru parameter, in which case it returns the affected record.	false	false	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.	false	false
AdminAddress	Specifies the address of a XenDesktop controller that the PowerShell snapin will connect to. This can be provided as a host name or an IP address.	false	false	Localhost. Once a value is provided by any cmdlet, this value will become the default.
BearerToken	Specifies the bearer token assigned to the calling user	false	false

Input Type

Citrix.Broker.Admin.Sdk.Applicationgroup

You can pipe application groups to Rename-BrokerApplicationGroup.

Return Values

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.

Examples

Example 1

C:\PS> Rename-BrokerApplicationGroup -Name "Ofice" -NewName "Office"
<!--NeedCopy-->

Description

Renames the application group with name “Ofice” to “Office”.

Example 2

C:\PS> Get-BrokerApplicationGroup -Uid 1 | Rename-BrokerApplicationGroup -NewName "New Name" -PassThru
<!--NeedCopy-->

Description

Renames application group with the Uid 1 to “New Name”, showing the result.

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Rename-Brokerapplicationgroup

August 3, 2023

Contributed by:

August 3, 2023

Contributed by:

Rename-Brokerapplicationgroup

Syntax

Detailed Description

Related Commands

Parameters

Input Type

Citrix.Broker.Admin.Sdk.Applicationgroup

Return Values

None Or Citrix.Broker.Admin.Sdk.Applicationgroup

Examples

Example 1

Description

Example 2

Description

In this article