Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Remove-RDVirtualDesktopCollection

Remove-RDVirtualDesktopCollection

remotedesktop.psm1

Synopsis

Removes a virtual desktop collection.

Syntax

Remove-RDVirtualDesktopCollection [-CollectionName] [-ConnectionBroker] [-Force] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

The Remove-RDVirtualDesktopCollection cmdlet removes a virtual desktop collection from a remote desktop deployment.

Parameters

-CollectionName <String>

Specifies the name of a virtual desktop collection.

Aliases

None

Required?

true

Position

1

Default value

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

Accept pipeline input?

false

Accept wildcard characters?

false

-Force <SwitchParameter>

Performs the action without a confirmation message.

Aliases

None

Required?

false

Position

named

Default value

Accept pipeline input?

false

Accept wildcard characters?

false

-Confirm <SwitchParameter>

Prompts you for confirmation before running the cmdlet.

Aliases

None

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.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type


Return Type

System.Object

Notes

None

Examples

Example 1: Remove a virtual desktop collection

This command removes the virtual desktop collection named "Virtual Desktop Pool" that is associated with the RD Connection Broker server named "rdcb.contoso.com". The Force parameter removes the virtual desktop collection without prompting you for confirmation.

PS C:\> Remove-RDVirtualDesktopCollection -CollectionName "Virtual Desktop Pool" -ConnectionBroker "rdcb.contoso.com" -Force

Online Version
Get-RDVirtualDesktopCollection
New-RDVirtualDesktopCollection
Remove-RDVirtualDesktopCollection
Update-RDVirtualDesktopCollection