Remove-RDPersonalVirtualDesktopAssignment
Removes the association between a personal virtual desktop and a user.
Syntax
Remove-RDPersonalVirtualDesktopAssignment
[-CollectionName] <String>
[-User] <String>
[-ConnectionBroker <String>]
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Remove-RDPersonalVirtualDesktopAssignment
[-CollectionName] <String>
[-VirtualDesktopName] <String>
[-ConnectionBroker <String>]
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>] 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.
Examples
Example 1: Remove a personal virtual desktop assignment by user
PS C:\>Remove-RDPersonalVirtualDesktopAssignment -CollectionName "Virtual Desktop Collection" -User "CONTOSO\sarahjones"This command removes a personal virtual desktop assignment by user.
Example 2: Remove a personal virtual desktop assignment virtual desktop name
PS C:\>Remove-RDPersonalVirtualDesktopAssignment -CollectionName "Virtual Desktop Collection" -VirtualDesktopName "PVD-12"This command removes a personal virtual desktop assignment by virtual desktop name.
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 |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| 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 |
-Force
Forces the command to run without asking for user confirmation.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-User
Specifies the user account to remove, in DOMAIN\User format.
| Type: | String |
| Position: | 1 |
| 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: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |