Compartilhar via


Get-RDVirtualDesktopCollection

Get-RDVirtualDesktopCollection

Gets a list of virtual desktop collections in a remote desktop deployment.

Syntax

Parameter Set: Default
Get-RDVirtualDesktopCollection [[-CollectionName] <String> ] [-ConnectionBroker <String> ] [ <CommonParameters>]

Detailed Description

The Get-RDVirtualDesktopCollection cmdlet gets a list of existing virtual desktop collections in a remote desktop deployment.

Parameters

-CollectionName<String>

Specifies the name of the virtual desktop collection.

Aliases

none

Required?

false

Position?

1

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ConnectionBroker<String>

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.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

  • System.Object

    The output type is Microsoft.RemoteDesktopServices.Management.RDVirtualDesktopCollection.

Examples

Example 1: Get the list of the virtual desktop collections in a remote desktop deployment

This command lists the virtual desktop collections associated with the RD Connection Broker named "rdcb.contoso.com".

PS C:\> Get-RDVirtualDesktopCollection -ConnectionBroker "rdcb.contoso.com"

New-RDVirtualDesktopCollection

Remove-RDVirtualDesktopCollection

Update-RDVirtualDesktopCollection