Get-RdsRemoteDesktop
Gets the properties of a published desktop.
Syntax
Default (Default)
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.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 2 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-HostPoolName
The name of the host pool.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 1 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-TenantName
The name of the tenant.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.