DedicatedHostCollection.GetIfExistsAsync Method

Definition

Namespace:

Azure.ResourceManager.Compute

Assembly:

Azure.ResourceManager.Compute.dll

Package:

Azure.ResourceManager.Compute v1.5.0

Source:

DedicatedHostCollection.cs

Tries to get details for this resource from the service.

• Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}/hosts/{hostName}
• Operation Id: DedicatedHosts_Get
• Default Api Version: 2024-03-01
• Resource: DedicatedHostResource

public virtual System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.Compute.DedicatedHostResource>> GetIfExistsAsync (string hostName, Azure.ResourceManager.Compute.Models.InstanceViewType? expand = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetIfExistsAsync : string * Nullable<Azure.ResourceManager.Compute.Models.InstanceViewType> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.Compute.DedicatedHostResource>>
override this.GetIfExistsAsync : string * Nullable<Azure.ResourceManager.Compute.Models.InstanceViewType> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.Compute.DedicatedHostResource>>

Public Overridable Function GetIfExistsAsync (hostName As String, Optional expand As Nullable(Of InstanceViewType) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of NullableResponse(Of DedicatedHostResource))

Parameters

hostName

String

The name of the dedicated host.

expand

Nullable<InstanceViewType>

The expand expression to apply on the operation. 'InstanceView' will retrieve the list of instance views of the dedicated host. 'UserData' is not supported for dedicated host.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<NullableResponse<DedicatedHostResource>>

Exceptions

ArgumentException

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

ArgumentNullException

hostName is null.