Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Set-RDPersonalVirtualDesktopAssignment

Set-RDPersonalVirtualDesktopAssignment

remotedesktop.psm1

Synopsis

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

Syntax

Set-RDPersonalVirtualDesktopAssignment [-CollectionName] [-ConnectionBroker] [-User] [-VirtualDesktopName] [<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

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

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

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

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

Input Type


Return Type

Null

Notes

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"

Online Version
Export-RDPersonalVirtualDesktopAssignment
Get-RDPersonalVirtualDesktopAssignment
Import-RDPersonalVirtualDesktopAssignment
Remove-RDPersonalVirtualDesktopAssignment