Edit

Share via

Get-AzWvdUserSession

Module:
Az.DesktopVirtualization Module

Get a userSession.

Syntax

List (Default) 

Get-AzWvdUserSession
    -HostPoolName <String>
    -ResourceGroupName <String>
    [-SubscriptionId <String[]>]
    [-Filter <String>]
    [-InitialSkip <Int32>]
    [-IsDescending]
    [-PageSize <Int32>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

List1 

Get-AzWvdUserSession
    -HostPoolName <String>
    -ResourceGroupName <String>
    -SessionHostName <String>
    [-SubscriptionId <String[]>]
    [-InitialSkip <Int32>]
    [-IsDescending]
    [-PageSize <Int32>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Get 

Get-AzWvdUserSession
    -HostPoolName <String>
    -Id <String>
    -ResourceGroupName <String>
    -SessionHostName <String>
    [-SubscriptionId <String[]>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

GetViaIdentitySessionHost 

Get-AzWvdUserSession
    -Id <String>
    -SessionHostInputObject <IDesktopVirtualizationIdentity>
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

GetViaIdentityHostPool 

Get-AzWvdUserSession
    -Id <String>
    -SessionHostName <String>
    -HostPoolInputObject <IDesktopVirtualizationIdentity>
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

GetViaIdentity 

Get-AzWvdUserSession
    -InputObject <IDesktopVirtualizationIdentity>
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Description

Get a userSession.

Examples

Example 1: Get a Windows Virtual Desktop UserSession by name

Get-AzWvdUserSession -ResourceGroupName ResourceGroupName -HostPoolName HostPoolName -SessionHostName SessionHostName -Id 2

Name                           Type
----                           ----
HostPoolName/SessionHostName/2 Microsoft.DesktopVirtualization/hostpools/sessionhosts/usersessions

This command gets a Windows Virtual Desktop UserSession in a Session Host.

Example 2: List Windows Virtual Desktop UserSessions

Get-AzWvdUserSession -ResourceGroupName ResourceGroupName -HostPoolName HostPoolName -SessionHostName SessionHostName

Name                           Type
----                           ----
HostPoolName/SessionHostName/2 Microsoft.DesktopVirtualization/hostpools/sessionhosts/usersessions
HostPoolName/SessionHostName/3 Microsoft.DesktopVirtualization/hostpools/sessionhosts/usersessions

This command lists a Windows Virtual Desktop UserSessions in a Session Host.

Example 3: List Windows Virtual Desktop UserSessions in host pool

Get-AzWvdUserSession -ResourceGroupName ResourceGroupName -HostPoolName HostPoolName

Name                           Type
----                           ----
HostPoolName/SessionHostName/2 Microsoft.DesktopVirtualization/hostpools/sessionhosts/usersessions
HostPoolName/SessionHostName/3 Microsoft.DesktopVirtualization/hostpools/sessionhosts/usersessions

This command lists a Windows Virtual Desktop UserSessions in a Session Host in a host pool.

Parameters

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Parameter properties

Type:PSObject
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzureRMContext, AzureCredential

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Filter

OData filter expression. Valid properties for filtering are userprincipalname and sessionstate.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

List
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-HostPoolInputObject

Identity Parameter

Parameter properties

Type:IDesktopVirtualizationIdentity
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

GetViaIdentityHostPool
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-HostPoolName

The name of the host pool within the specified resource group

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

List
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
List1
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Get
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Id

The name of the user session within the specified session host

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:UserSessionId

Parameter sets

Get
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
GetViaIdentitySessionHost
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
GetViaIdentityHostPool
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InitialSkip

Initial number of items to skip.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

List
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
List1
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InputObject

Identity Parameter

Parameter properties

Type:IDesktopVirtualizationIdentity
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

GetViaIdentity
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-IsDescending

Indicates whether the collection is descending.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

List
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
List1
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PageSize

Number of items per page.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

List
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
List1
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ResourceGroupName

The name of the resource group. The name is case insensitive.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

List
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
List1
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Get
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SessionHostInputObject

Identity Parameter

Parameter properties

Type:IDesktopVirtualizationIdentity
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

GetViaIdentitySessionHost
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-SessionHostName

The name of the session host within the specified host pool

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

List1
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Get
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
GetViaIdentityHostPool
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SubscriptionId

The ID of the target subscription. The value must be an UUID.

Parameter properties

Type:

String[]

Default value:(Get-AzContext).Subscription.Id
Supports wildcards:False
DontShow:False

Parameter sets

List
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
List1
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Get
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

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

Inputs

IDesktopVirtualizationIdentity

Outputs

IUserSession