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.

Type:

String

Position:

1

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 supply 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

Performs the action without displaying a confirmation message.

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

Related Links

The feedback system for this content will be changing soon. Old comments will not be carried over. If content within a comment thread is important to you, please save a copy. For more information on the upcoming change, we invite you to read our blog post.