Table of contents
TLS
TOC
Collapse the table of content
Expand the table of content

Get-RDVirtualDesktop

Last Updated: 4/3/2017

SYNOPSIS

Gets a list of virtual desktops in the remote desktop deployment.

SYNTAX

Get-RDVirtualDesktop [[-CollectionName] <String[]>] [-ConnectionBroker <String>] [<CommonParameters>]

DESCRIPTION

The Get-RDVirtualDesktop cmdlet gets a list of virtual desktops in the remote desktop deployment.

EXAMPLES

Example 1: Retrieve a list of Virtual Desktops

PS C:\> Get-RDVirtualDesktop -ConnectionBroker "rdcb.contoso.com" | sort-object VirtualDesktopName

This command lists virtual desktops in the collections associated with the connection broker server named rdcb.contoso.com. The command uses the pipeline operator to send the results to the Sort-Object cmdlet, which sorts the objects in order of the VirtualDesktopName property.

Example 2: Retrieve a list of Virtual Desktops in a Collection

PS C:\> Get-RDVirtualDesktop -ConnectionBroker "rdcb.contoso.com" -CollectionName @("Virtual Desktop pool")

This command lists virtual desktops in the collection named Virtual Desktop pool that is associated with the connection broker server named rdcb.contoso.com.

PARAMETERS

-CollectionName

Specifies an array of names of personal virtual desktop collections.

Type: String[]
Parameter Sets: (All)
Aliases: 

Required: False
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ConnectionBroker

Specifies the Remote Desktop Connection Broker (RD Connection Broker) server for a remote desktop deployment. If you do not specify a value, the cmdlet uses the fully qualified domain name (FQDN) of the local computer.

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

System.Object

NOTES

Move-RDVirtualDesktop

Get-RDVirtualDesktopCollection

© 2017 Microsoft