Get-RDPersonalVirtualDesktopAssignment
Get-RDPersonalVirtualDesktopAssignment
Retrieves a list of personal virtual desktops and associated user accounts.
Syntax
Parameter Set: GetByCollection
Get-RDPersonalVirtualDesktopAssignment [-CollectionName] <String> [-ConnectionBroker <String> ] [ <CommonParameters>]
Parameter Set: GetByDesktop
Get-RDPersonalVirtualDesktopAssignment [-CollectionName] <String> -VirtualDesktopName <String> [-ConnectionBroker <String> ] [ <CommonParameters>]
Parameter Set: GetByUser
Get-RDPersonalVirtualDesktopAssignment [-CollectionName] <String> -User <String> [-ConnectionBroker <String> ] [ <CommonParameters>]
Detailed Description
The Get-RDPersonalVirtualDesktopAssignment cmdlet retrieves a list of personal virtual desktops and associated user accounts. Specify one or more user accounts to retrieve the associated personal virtual desktops, or specify one or more personal virtual desktop names to retrieve the associated user accounts.
Parameters
-CollectionName<String>
Specifies the name of a personal 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 supply 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 |
-User<String>
Specifies one or more user accounts, in DOMAIN\User format.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-VirtualDesktopName<String>
Specifies the name of the virtual desktop. This parameter is required. The virtual desktop identified here must be a member of the collection that the CollectionName parameter specifies.
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
Example1: Retrieve a list of the current associations between personal virtual desktops and users
This command lists current associations between personal virtual desktops and users from the virtual desktop collection named Virtual Desktop Collection.
PS C:\> Get-RDPersonalVirtualDesktopAssignment –CollectionName "Virtual Desktop Collection"
Related topics
Export-RDPersonalVirtualDesktopAssignment
Import-RDPersonalVirtualDesktopAssignment