你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Get-AzWvdUserSession

Get a userSession.

Syntax

Get-AzWvdUserSession
   -HostPoolName <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-Filter <String>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzWvdUserSession
   -HostPoolName <String>
   -Id <String>
   -ResourceGroupName <String>
   -SessionHostName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzWvdUserSession
   -InputObject <IDesktopVirtualizationIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzWvdUserSession
   -HostPoolName <String>
   -ResourceGroupName <String>
   -SessionHostName <String>
   [-SubscriptionId <String[]>]
   [-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 credentials, account, tenant, and subscription used for communication with Azure.

Type:PSObject
Aliases:AzureRMContext, AzureCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-Filter

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

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

-HostPoolName

The name of the host pool within the specified resource group

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

-Id

The name of the user session within the specified session host

Type:String
Aliases:UserSessionId
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

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

-ResourceGroupName

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

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

-SessionHostName

The name of the session host within the specified host pool

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

-SubscriptionId

The ID of the target subscription.

Type:String[]
Position:Named
Default value:(Get-AzContext).Subscription.Id
Accept pipeline input:False
Accept wildcard characters:False

Inputs

IDesktopVirtualizationIdentity

Outputs

IUserSession

Notes

ALIASES

COMPLEX PARAMETER PROPERTIES

To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

INPUTOBJECT <IDesktopVirtualizationIdentity>: Identity Parameter

  • [ApplicationGroupName <String>]: The name of the application group
  • [ApplicationName <String>]: The name of the application within the specified application group
  • [DesktopName <String>]: The name of the desktop within the specified desktop group
  • [HostPoolName <String>]: The name of the host pool within the specified resource group
  • [Id <String>]: Resource identity path
  • [MsixPackageFullName <String>]: The version specific package full name of the MSIX package within specified hostpool
  • [ResourceGroupName <String>]: The name of the resource group. The name is case insensitive.
  • [ScalingPlanName <String>]: The name of the scaling plan.
  • [SessionHostName <String>]: The name of the session host within the specified host pool
  • [SubscriptionId <String>]: The ID of the target subscription.
  • [UserSessionId <String>]: The name of the user session within the specified session host
  • [WorkspaceName <String>]: The name of the workspace