Set-RDPersonalVirtualDesktopAssignment
Set-RDPersonalVirtualDesktopAssignment
Creates an association between a personal virtual desktop and a user account.
Syntax
Parameter Set: Default
Set-RDPersonalVirtualDesktopAssignment [-CollectionName] <String> -User <String> -VirtualDesktopName <String> [-ConnectionBroker <String> ] [ <CommonParameters>]
Detailed Description
The Set-RDPersonalVirtualDesktopAssignment cmdlet creates an association between a personal virtual desktop and a user account.
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 the user account to associate with the personal virtual desktop, in DOMAIN\User format.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
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? |
True (ByPropertyName) |
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.
Null
None
Examples
Example 1: Create an association between a user and a personal virtual desktop
This command associates a user with a personal virtual desktop.
PS C:\> Set-RDPersonalVirtualDesktopAssignment -CollectionName "Virtual Desktop Collection" -User "CONTOSO\sarahjones" -PersonalVirtualDesktop "PVD-21"
Related topics
Export-RDPersonalVirtualDesktopAssignment
Get-RDPersonalVirtualDesktopAssignment