Renames an application.
Rename-BrokerApplication [-InputObject] <Application> [-NewName] <String> [-PassThru] [-LoggingId <Guid>] [-AdminAddress <String>] [-BearerToken <String>] [<CommonParameters>] Rename-BrokerApplication [-Name] <String> [-NewName] <String> [-PassThru] [-LoggingId <Guid>] [-AdminAddress <String>] [-BearerToken <String>] [<CommonParameters>]
The Rename-BrokerApplication cmdlet changes the administrative name of an application. An application cannot have the same name as another application.
Renaming an application does not alter its published name. To change the name with which this application appears to end-users, set a new value for the PublishedName property using the Set-BrokerApplication cmdlet.
Renaming an application does not alter its BrowserName. If the BrowserName property also needs to be changed, use the Set-BrokerApplication cmdlet to modify it.
|Name||Description||Required?||Pipeline Input||Default Value|
|InputObject||Specifies the application to rename.||true||true (ByValue)||null|
|Name||Specifies the name of the application to rename.||true||true (ByPropertyName)||null|
|NewName||Specifies the new name for the application.||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|
You can pipe applications to Rename-BrokerApplication.
This cmdlet does not generate any output, unless you use the PassThru parameter, in which case it generates a Citrix.Broker.Admin.SDK.Application object.
C:\PS> Rename-BrokerApplication -Name "Old Name" -NewName "New Name"
Renames the application with name "Old Name" to "New Name".
C:\PS> Get-BrokerApplication -Uid 1 | Rename-BrokerApplication -NewName "New Name" -PassThru
Renames application with the Uid 1 to "New Name", showing the result.