Table of contents
TLS
TOC
Collapse the table of content
Expand the table of content

Remove-RDPersonalVirtualDesktopAssignment

Brian Lich|Last Updated: 4/3/2017

SYNOPSIS

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

SYNTAX

RemoveByUser (Default)

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

RemoveByDesktop

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

1: Remove a personal virtual desktop assignment

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

This command removes a personal virtual desktop assignment.

PARAMETERS

-CollectionName

Specifies the name of a personal virtual desktop collection.

Type: String
Parameter Sets: (All)
Aliases: 

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: 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
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Force

Forces the command to run without asking for user confirmation.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-User

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

Type: String
Parameter Sets: RemoveByUser
Aliases: 

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
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
Parameter Sets: RemoveByDesktop
Aliases: 

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-WhatIf

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

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

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

INPUTS

OUTPUTS

System.Object

NOTES

Export-RDPersonalVirtualDesktopAssignment

Get-RDPersonalVirtualDesktopAssignment

Import-RDPersonalVirtualDesktopAssignment

Set-RDPersonalVirtualDesktopAssignment

© 2017 Microsoft