< Back
Remove-RDPersonalVirtualDesktopAssignment
Post
NAME Remove-RDPersonalVirtualDesktopAssignment
SYNOPSIS
Removes the association between a personal virtual desktop and a user.
SYNTAX
Remove-RDPersonalVirtualDesktopAssignment [-CollectionName] <String> [-User] <String> [-ConnectionBroker <String>] [-Force] [-Confirm] [-WhatIf]
[<CommonParameters>]
Remove-RDPersonalVirtualDesktopAssignment [-CollectionName] <String> [-VirtualDesktopName] <String> [-ConnectionBroker <String>] [-Force]
[-Confirm] [-WhatIf] [<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.
PARAMETERS
-CollectionName <String>
Specifies the name of a personal virtual desktop collection.
Required? true
Position? 1
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ConnectionBroker [<String>]
Specifies the Remote Desktop Connection Broker (RDConnection 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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Force [<SwitchParameter>]
Forces the command to run without asking for user confirmation.
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.
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.
Required? true
Position? 2
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.
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.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, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
System.Object
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.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=294244
Export-RDPersonalVirtualDesktopAssignment
Get-RDPersonalVirtualDesktopAssignment
Import-RDPersonalVirtualDesktopAssignment
Set-RDPersonalVirtualDesktopAssignment
SYNOPSIS
Removes the association between a personal virtual desktop and a user.
SYNTAX
Remove-RDPersonalVirtualDesktopAssignment [-CollectionName] <String> [-User] <String> [-ConnectionBroker <String>] [-Force] [-Confirm] [-WhatIf]
[<CommonParameters>]
Remove-RDPersonalVirtualDesktopAssignment [-CollectionName] <String> [-VirtualDesktopName] <String> [-ConnectionBroker <String>] [-Force]
[-Confirm] [-WhatIf] [<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.
PARAMETERS
-CollectionName <String>
Specifies the name of a personal virtual desktop collection.
Required? true
Position? 1
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ConnectionBroker [<String>]
Specifies the Remote Desktop Connection Broker (RDConnection 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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Force [<SwitchParameter>]
Forces the command to run without asking for user confirmation.
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.
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.
Required? true
Position? 2
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.
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.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, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
System.Object
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.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=294244
Export-RDPersonalVirtualDesktopAssignment
Get-RDPersonalVirtualDesktopAssignment
Import-RDPersonalVirtualDesktopAssignment
Set-RDPersonalVirtualDesktopAssignment