Get-RDVirtualDesktopCollectionConfiguration
Get-RDVirtualDesktopCollectionConfiguration
Gets configuration settings of a virtual desktop collection.
Syntax
Parameter Set: General
Get-RDVirtualDesktopCollectionConfiguration [-CollectionName] <String> [-ConnectionBroker <String> ] [ <CommonParameters>]
Parameter Set: Client
Get-RDVirtualDesktopCollectionConfiguration [-CollectionName] <String> -Client [-ConnectionBroker <String> ] [ <CommonParameters>]
Parameter Set: UserGroups
Get-RDVirtualDesktopCollectionConfiguration [-CollectionName] <String> -UserGroups [-ConnectionBroker <String> ] [ <CommonParameters>]
Parameter Set: UserProfileDisks
Get-RDVirtualDesktopCollectionConfiguration [-CollectionName] <String> -UserProfileDisks [-ConnectionBroker <String> ] [ <CommonParameters>]
Parameter Set: VirtualDesktopConfiguration
Get-RDVirtualDesktopCollectionConfiguration [-CollectionName] <String> -VirtualDesktopConfiguration [-ConnectionBroker <String> ] [ <CommonParameters>]
Detailed Description
The Get-RDVirtualDesktopCollectionConfiguration gets configuration settings of a virtual desktop collection.
Parameters
-Client
Indicates that cmdlet gets Remote Desktop Protocol (RDP) settings for virtual desktops in the collection.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-CollectionName<String>
Specifies the name of a virtual desktop collection.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
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 |
-UserGroups
Indicates that the cmdlet gets a list of domain groups and users that are authorized to connect to the collection.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-UserProfileDisks
Indicates that the cmdlet gets a list of user profile disk settings for the collection.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-VirtualDesktopConfiguration
Indicates that the cmdlet gets configuration settings for virtual desktops in the collection.
Aliases |
none |
Required? |
true |
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
Examples
Example 1: Get configuration settings for virtual desktops in a collection
This command gets the configuration settings for the virtual desktops in the collection named "Virtual Desktop Pool" that is associated with the RD Connection Broker server named "rdcb.contoso.com".
PS C:\> Get-RDVirtualDesktopCollectionConfiguration -ConnectionBroker "rdcb.contoso.com" -CollectionName "Virtual Desktop Pool" -VirtualDesktopConfiguration
Example 2: Get user profile disk settings for a virtual desktop collection
This command gets the user profile disk settings for the virtual desktop collection named "Virtual Desktop Pool" that is associated with the RD Connection Broker server named "rdcb.contoso.com".
PS C:\> Get-RDVirtualDesktopCollectionConfiguration -ConnectionBroker "rdcb.contoso.com" -CollectionName "Virtual Desktop Pool" -UserProfileDisks
Related topics
Set-RDVirtualDesktopCollectionConfiguration