Remove-RDVirtual Desktop Collection

Module:
remotedesktop
Removes a virtual desktop collection.

Syntax 

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

Description

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

Examples

Example 1: Remove a virtual desktop collection 

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

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.

Required Parameters

-CollectionName

Specifies the name of a virtual desktop collection.

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

Optional Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Aliases: cf
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 specify a value, the cmdlet uses the fully qualified domain name (FQDN) of the local computer.

Type: String
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
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-WhatIf

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

Type: SwitchParameter
Aliases: wi
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

Outputs

System.Object