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

Get-RDPersonalVirtualDesktopAssignment

Brian Lich|Last Updated: 4/3/2017

SYNOPSIS

Retrieves a list of personal virtual desktops and associated user accounts.

SYNTAX

GetByCollection (Default)

Get-RDPersonalVirtualDesktopAssignment [-CollectionName] <String> [-ConnectionBroker <String>]
 [<CommonParameters>]

GetByDesktop

Get-RDPersonalVirtualDesktopAssignment [-CollectionName] <String> -VirtualDesktopName <String>
 [-ConnectionBroker <String>] [<CommonParameters>]

GetByUser

Get-RDPersonalVirtualDesktopAssignment [-CollectionName] <String> -User <String> [-ConnectionBroker <String>]
 [<CommonParameters>]

DESCRIPTION

The Get-RDPersonalVirtualDesktopAssignment cmdlet retrieves a list of personal virtual desktops and associated user accounts. Specify one or more user accounts to retrieve the associated personal virtual desktops, or specify one or more personal virtual desktop names to retrieve the associated user accounts.

EXAMPLES

Example1: Retrieve a list of the current associations between personal virtual desktops and users

PS C:\>Get-RDPersonalVirtualDesktopAssignment -CollectionName "Virtual Desktop Collection"

This command lists current associations between personal virtual desktops and users from the virtual desktop collection named Virtual Desktop Collection.

PARAMETERS

-CollectionName

Specifies the name of a personal virtual desktop collection.

Type: String
Parameter Sets: (All)
Aliases: 

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
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
Parameter Sets: (All)
Aliases: 

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

-User

Specifies one or more user accounts, in DOMAIN\User format.

Type: String
Parameter Sets: GetByUser
Aliases: 

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

-VirtualDesktopName

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
Parameter Sets: GetByDesktop
Aliases: 

Required: True
Position: Named
Default value: None
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

System.Object

NOTES

Export-RDPersonalVirtualDesktopAssignment

Import-RDPersonalVirtualDesktopAssignment

Remove-RDPersonalVirtualDesktopAssignment

Set-RDPersonalVirtualDesktopAssignment

© 2017 Microsoft