Export (0) Print
Expand All
Expand Minimize

Remove-RDPersonalVirtualDesktopAssignment

Updated: August 12, 2013

Applies To: Windows Server 2012

Remove-RDPersonalVirtualDesktopAssignment

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

Syntax

Parameter Set: RemoveByUser
Remove-RDPersonalVirtualDesktopAssignment [-CollectionName] <String> [-User] <String> [-ConnectionBroker <String> ] [-Force] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: RemoveByDesktop
Remove-RDPersonalVirtualDesktopAssignment [-CollectionName] <String> [-VirtualDesktopName] <String> [-ConnectionBroker <String> ] [-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

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

-Force

Performs the action without displaying a confirmation message.


Aliases

none

Required?

false

Position?

named

Default Value

none

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

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?

2

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

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


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters.

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.

  • System.Object

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"

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft