Get-RDPersonalVirtualDesktopAssignment
Retrieves a list of personal virtual desktops and associated user accounts.
Syntax
GetByCollection (Default)
Get-RDPersonalVirtualDesktopAssignment
[-CollectionName] <String>
[-ConnectionBroker <String>]
[<CommonParameters>]
GetByDesktop
Get-RDPersonalVirtualDesktopAssignment
[-CollectionName] <String>
-VirtualDesktopName <String>
[-ConnectionBroker <String>]
[<CommonParameters>]
GetByUser
Get-RDPersonalVirtualDesktopAssignment
[-CollectionName] <String>
-User <String>
[-ConnectionBroker <String>]
[<CommonParameters>]
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.
Examples
Example1: Retrieve a list of the current associations between personal virtual desktops and users
PS C:\>Get-RDPersonalVirtualDesktopAssignment -CollectionName "Virtual Desktop Collection"
This command lists current associations between personal virtual desktops and users from the virtual desktop collection named Virtual Desktop Collection.
Parameters
-CollectionName
Specifies the name of a personal virtual desktop collection.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-ConnectionBroker
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.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-User
Specifies one or more user accounts, in DOMAIN\User format.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
GetByUser
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-VirtualDesktopName
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.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
GetByDesktop
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| 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.