< Back
Remove-RDVirtualDesktopFromCollection
Post
NAME Remove-RDVirtualDesktopFromCollection
SYNOPSIS
Removes virtual desktops from a virtual desktop collection.
SYNTAX
Remove-RDVirtualDesktopFromCollection [-CollectionName] <String> [-ConnectionBroker <String>] [-Force] -VirtualDesktopName <String[]> [-Confirm]
[-WhatIf] [<CommonParameters>]
DESCRIPTION
The Remove-RDVirtualDesktopFromCollection cmdlet removes one or more virtual desktops from a virtual desktop collection.
PARAMETERS
-CollectionName <String>
Specifies the name of a 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 (RD Connection Broker) server for a remote desktop deployment. If you do not specify 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
-VirtualDesktopName <String[]>
Specifies an array of names of virtual desktops.
Required? true
Position? named
Default value none
Accept pipeline input? false
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
Example 1: Remove a virtual desktop from a virtual desktop collection
PS C:\\> Remove-RDVirtualDesktopFromCollection -CollectionName "Virtual Desktop Pool" -VirtualDesktopName @("RDS-WKS-A27") -ConnectionBroker
"rdcb.contoso.com"
This command removes the virtual desktop named "RDS-WKS-A27" from the virtual desktop collection named "Virtual Desktop Pool".
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=294251
Get-RDVirtualDesktopCollection
Get-RDVirtualDesktop
SYNOPSIS
Removes virtual desktops from a virtual desktop collection.
SYNTAX
Remove-RDVirtualDesktopFromCollection [-CollectionName] <String> [-ConnectionBroker <String>] [-Force] -VirtualDesktopName <String[]> [-Confirm]
[-WhatIf] [<CommonParameters>]
DESCRIPTION
The Remove-RDVirtualDesktopFromCollection cmdlet removes one or more virtual desktops from a virtual desktop collection.
PARAMETERS
-CollectionName <String>
Specifies the name of a 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 (RD Connection Broker) server for a remote desktop deployment. If you do not specify 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
-VirtualDesktopName <String[]>
Specifies an array of names of virtual desktops.
Required? true
Position? named
Default value none
Accept pipeline input? false
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
Example 1: Remove a virtual desktop from a virtual desktop collection
PS C:\\> Remove-RDVirtualDesktopFromCollection -CollectionName "Virtual Desktop Pool" -VirtualDesktopName @("RDS-WKS-A27") -ConnectionBroker
"rdcb.contoso.com"
This command removes the virtual desktop named "RDS-WKS-A27" from the virtual desktop collection named "Virtual Desktop Pool".
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=294251
Get-RDVirtualDesktopCollection
Get-RDVirtualDesktop