Edit

Share via

Set-RDPersonalVirtualDesktopAssignment

  • Reference
Module:
RemoteDesktop

Creates an association between a personal virtual desktop and a user account.

Syntax

Set-RDPersonalVirtualDesktopAssignment
   [-CollectionName] <String>
   -User <String>
   -VirtualDesktopName <String>
   [-ConnectionBroker <String>]
   [<CommonParameters>]

Description

The Set-RDPersonalVirtualDesktopAssignment cmdlet creates an association between a personal virtual desktop and a user account.

Examples

Example 1: Create an association between a user and a personal virtual desktop

PS C:\>Set-RDPersonalVirtualDesktopAssignment -CollectionName "Virtual Desktop Collection" -User "CONTOSO\sarahjones" -PersonalVirtualDesktop "PVD-21"

This command associates a user with a personal virtual desktop.

Parameters

-CollectionName

Specifies the name of a personal virtual desktop collection.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters: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.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-User

Specifies the user account to associate with the personal virtual desktop, in DOMAIN\User format.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters: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.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

Outputs

Null