HostPoolResource.GetSessionHostAsync(String, CancellationToken) Method

Definition

Get a session host.

  • 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.Response<Azure.ResourceManager.DesktopVirtualization.SessionHostResource>> GetSessionHostAsync (string sessionHostName, System.Threading.CancellationToken cancellationToken = default);
abstract member GetSessionHostAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.DesktopVirtualization.SessionHostResource>>
override this.GetSessionHostAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.DesktopVirtualization.SessionHostResource>>
Public Overridable Function GetSessionHostAsync (sessionHostName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of SessionHostResource))

Parameters

sessionHostName
String

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

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

sessionHostName is null.

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

Applies to