Export (0) Print
Expand All
Expand Minimize

Remove-RDVirtualDesktopFromCollection

Windows Server 2012 R2 and Windows 8.1

Updated: October 17, 2013

Applies To: Windows 8.1, Windows PowerShell 4.0, Windows Server 2012 R2

Remove-RDVirtualDesktopFromCollection

Removes virtual desktops from a virtual desktop collection.

Syntax

Parameter Set: Default
Remove-RDVirtualDesktopFromCollection [-CollectionName] <String> -VirtualDesktopName <String[]> [-ConnectionBroker <String> ] [-Force] [-Confirm] [-WhatIf] [ <CommonParameters>]




Detailed 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.


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 a remote desktop deployment. If you do not specify a value, the cmdlet uses the fully qualified domain name (FQDN) of the local computer.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Force

Performs the action without a confirmation message.


Aliases

none

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.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

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.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

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

  • System.Object

Examples

Example 1: Remove a virtual desktop from a virtual desktop collection

This command removes the virtual desktop named "RDS-WKS-A27" from the virtual desktop collection named "Virtual Desktop Pool".


PS C:\> Remove-RDVirtualDesktopFromCollection -CollectionName "Virtual Desktop Pool" -VirtualDesktopName @("RDS-WKS-A27") -ConnectionBroker "rdcb.contoso.com"

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft