Get-RdsRemoteDesktop

Reference

Module:: WindowsVirtualDesktopPowershell

Gets the properties of a published desktop.

Syntax

Get-RdsRemoteDesktop
   [-TenantName] <String>
   [-HostPoolName] <String>
   [-AppGroupName] <String>
   [<CommonParameters>]

Description

The Get-RdsRemoteDesktop cmdlet gets the properties of the specified published desktop. This cmdlet will fail if you specify a RemoteApp app group.

Examples

Example 1: Get the properties of a published desktop

PS C:\> Get-RdsRemoteDesktop -TenantName "contoso" -HostPoolName "contosoHostPool" -AppGroupName "Desktop Application Group"

TenantGroupName   : Default Tenant Group
TenantName        : contoso
HostPoolName      : contosoHostPool
AppGroupName      : Desktop Application Group
RemoteDesktopName : Remote Desktop
FriendlyName      : Engineering - Desktop
Description       : The default Session Desktop
ShowInWebFeed     :

This command gets the properties of the specified published desktop. The desktop app group and its properties are displayed only if the desktop app group exists in the host pool and the current user is properly authorized.

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

-HostPoolName

The name of the host pool.

Type:	String
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	True
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