Table of contents
TLS
TOC
Collapse the table of content
Expand the table of content

Remove-RDPersonalSessionDesktopAssignment

Last Updated: 3/8/2017

SYNOPSIS

Removes the association between a personal session desktop assignment and a user.

SYNTAX

RemoveByUser (Default)

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

RemoveByDesktop

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

DESCRIPTION

The Remove-RDPersonalSessionDesktopAssignment cmdlet removes the association between a personal session desktop assignment and a user. This operation makes the personal session desktop that you remove available for use.

EXAMPLES

1:

PARAMETERS

-CollectionName

Specifies the name of a personal session desktop collection.

Type: String
Parameter Sets: (All)
Aliases: 

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
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
Parameter Sets: (All)
Aliases: 

Required: False
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
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Name

Specifies the name of the personal session desktop assignment to remove.

Type: String
Parameter Sets: RemoveByDesktop
Aliases: 

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-User

Specifies a user account in DOMAIN\user format.

Type: String
Parameter Sets: RemoveByUser
Aliases: 

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-WhatIf

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

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

Get-RDPersonalSessionDesktopAssignment

Export-RDPersonalSessionDesktopAssignment

Import-RDPersonalSessionDesktopAssignment

Set-RDPersonalSessionDesktopAssignment

© 2017 Microsoft