Set-RdsRemoteDesktop
Sets the properties for a published desktop.
Syntax
Set-RdsRemoteDesktop
[-TenantName] <String>
[-HostPoolName] <String>
[-AppGroupName] <String>
[-FriendlyName <String>]
[-Description <String>]
[-ShowInWebFeed <Boolean>]
[<CommonParameters>] Description
The Set-RdsRemoteDesktop cmdlet sets the properties for a published desktop. You can edit the friendly name, description, and if it appears in the web feed. By changing the friendly name, you can set the name that appears to end-users for the published desktop in their Windows Virtual Desktop feed.
Examples
Example 1: Set the friendly name that will appear in the feed
PS C:\> Set-RdsRemoteDesktop -TenantName "contoso" -HostPoolName "contosoHostPool" -AppGroupName "Desktop Application Group" -FriendlyName "Accounting - Desktop"
TenantGroupName : Default Tenant Group
TenantName : contoso
HostPoolName : ontosoHostPool
AppGroupName : Desktop Application Group
RemoteDesktopName : Remote Desktop
FriendlyName : Accounting - Desktop
Description :
ShowInWebFeed :This command sets the friendly name for the specified desktop app group. The provided friendly name will now be shown to end-users who have access to this app group.
Parameters
-AppGroupName
The name of the app group, which must be a desktop app group.
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Description
A 512 character string that describes the RemoteDesktop to help administrators. Any character is allowed.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FriendlyName
A 256 character string that is displayed to end users in the Windows Virtual Desktop feed. Any character is allowed.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-HostPoolName
The name of the host pool.
| Type: | String |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ShowInWebFeed
Note
This feature is not yet supported.
Specifies whether to show the published desktop in the Windows Virtual Desktop feed. This allows you to temporarily disable a desktop and then re-enable it without deleting and re-creating the custom desktop information.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-TenantName
The name of the tenant.
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
Inputs
System.String
Outputs
Microsoft.RDInfra.RDManagementData.RdMgmtPublishedDesktop