SessionHostResource.GetUserSessionAsync(String, CancellationToken) Method

Definition

Get a userSession.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions/{userSessionId}
  • Operation Id: UserSessions_Get
  • Default Api Version: 2024-04-03
  • Resource: UserSessionResource
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.DesktopVirtualization.UserSessionResource>> GetUserSessionAsync (string userSessionId, System.Threading.CancellationToken cancellationToken = default);
abstract member GetUserSessionAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.DesktopVirtualization.UserSessionResource>>
override this.GetUserSessionAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.DesktopVirtualization.UserSessionResource>>
Public Overridable Function GetUserSessionAsync (userSessionId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of UserSessionResource))

Parameters

userSessionId
String

The name of the user session within the specified session host.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

userSessionId is null.

userSessionId is an empty string, and was expected to be non-empty.

Applies to