UserSessionCollection.GetIfExistsAsync(String, CancellationToken) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
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 System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.DesktopVirtualization.UserSessionResource>> GetIfExistsAsync (string userSessionId, System.Threading.CancellationToken cancellationToken = default);abstract member GetIfExistsAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.DesktopVirtualization.UserSessionResource>>
override this.GetIfExistsAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.DesktopVirtualization.UserSessionResource>>Public Overridable Function GetIfExistsAsync (userSessionId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of 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.
