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
 

Remove-RDPersonalVirtualDesktopAssignment

Remove-RDPersonalVirtualDesktopAssignment

remotedesktop.psm1

Synopsis

Removes the association between a personal virtual desktop and a user.

Syntax

Remove-RDPersonalVirtualDesktopAssignment [-CollectionName] [-User] [-ConnectionBroker] [-Force] [-Confirm] [-WhatIf] [<CommonParameters>]

Remove-RDPersonalVirtualDesktopAssignment [-CollectionName] [-VirtualDesktopName] [-ConnectionBroker] [-Force] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

The Remove-RDPersonalVirtualDesktopAssignment cmdlet removes an existing association between a personal virtual desktop and a user. This removal makes the virtual desktop available for another user.

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

-Force <SwitchParameter>

Performs the action without displaying a confirmation message.

Aliases

None

Required?

false

Position

named

Default value

Accept pipeline input?

false

Accept wildcard characters?

false

-User <String>

Specifies the user account to remove, in DOMAIN\User format.

Aliases

None

Required?

true

Position

2

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

2

Default value

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-Confirm <SwitchParameter>

Prompts you for confirmation before running the cmdlet.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

-WhatIf <SwitchParameter>

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type


Return Type

System.Object

Notes

None

Examples

Remove a personal virtual desktop assignment

This command removes a personal virtual desktop assignment.

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

Online Version
Export-RDPersonalVirtualDesktopAssignment
Get-RDPersonalVirtualDesktopAssignment
Import-RDPersonalVirtualDesktopAssignment
Set-RDPersonalVirtualDesktopAssignment