SessionHostCollection.GetIfExistsAsync(String, CancellationToken) Method

Reference

Definition

Namespace:: Azure.ResourceManager.DesktopVirtualization

Assembly:: Azure.ResourceManager.DesktopVirtualization.dll

Package:: Azure.ResourceManager.DesktopVirtualization v1.3.0

Source:: SessionHostCollection.cs

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}
Operation Id: SessionHosts_Get
Default Api Version: 2024-04-03
Resource: SessionHostResource

public virtual System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.DesktopVirtualization.SessionHostResource>> GetIfExistsAsync (string sessionHostName, System.Threading.CancellationToken cancellationToken = default);

abstract member GetIfExistsAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.DesktopVirtualization.SessionHostResource>>
override this.GetIfExistsAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.DesktopVirtualization.SessionHostResource>>

Public Overridable Function GetIfExistsAsync (sessionHostName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of NullableResponse(Of SessionHostResource))

Parameters

sessionHostName: String

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

cancellationToken: CancellationToken

The cancellation token to use.

Returns

Task<NullableResponse<SessionHostResource>>

Exceptions

ArgumentException

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

ArgumentNullException

sessionHostName is null.

Applies to

Share via