SessionHostCollection.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}
  • Operation Id: SessionHosts_Get
  • Default Api Version: 2024-04-03
  • Resource: SessionHostResource
public virtual Azure.NullableResponse<Azure.ResourceManager.DesktopVirtualization.SessionHostResource> GetIfExists (string sessionHostName, System.Threading.CancellationToken cancellationToken = default);
abstract member GetIfExists : string * System.Threading.CancellationToken -> Azure.NullableResponse<Azure.ResourceManager.DesktopVirtualization.SessionHostResource>
override this.GetIfExists : string * System.Threading.CancellationToken -> Azure.NullableResponse<Azure.ResourceManager.DesktopVirtualization.SessionHostResource>
Public Overridable Function GetIfExists (sessionHostName As String, Optional cancellationToken As CancellationToken = Nothing) As 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

Exceptions

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

sessionHostName is null.

Applies to