Share via


UserSessionCollection.GetIfExists(String, CancellationToken) Method

Definition

Tries to get details for this resource from the service.

  • 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 Azure.NullableResponse<Azure.ResourceManager.DesktopVirtualization.UserSessionResource> GetIfExists (string userSessionId, System.Threading.CancellationToken cancellationToken = default);
abstract member GetIfExists : string * System.Threading.CancellationToken -> Azure.NullableResponse<Azure.ResourceManager.DesktopVirtualization.UserSessionResource>
override this.GetIfExists : string * System.Threading.CancellationToken -> Azure.NullableResponse<Azure.ResourceManager.DesktopVirtualization.UserSessionResource>
Public Overridable Function GetIfExists (userSessionId As String, Optional cancellationToken As CancellationToken = Nothing) As NullableResponse(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 an empty string, and was expected to be non-empty.

userSessionId is null.

Applies to