This topic has not yet been rated - Rate this topic

Remove-RDPersonalVirtualDesktopAssignment

Updated: September 14, 2012

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> [-Confirm] [-WhatIf] [ <CommonParameters>]

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

Parameter Set: RemoveByDesktop
Remove-RDPersonalVirtualDesktopAssignment [-CollectionName] <String> [-VirtualDesktopName] <String> [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Remove-RDPersonalVirtualDesktopAssignment cmdlet removes an existing association between a personal virtual desktop and a user, therefore making the virtual desktop available for another user.

Parameters

-CollectionName<String>

Specifies the name of the personal virtual desktop collection. This parameter is required.

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 this remote desktop deployment. If not supplied, defaults to the fully qualified domain name (FQDN) of the local host.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Force

Runs the operation without prompting for user confirmation.

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. This parameter is required. The account must be entered 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.

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.

Outputs

The output type is the type of the objects that the cmdlet emits.

System.Object

Examples

PS C:\>

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)