DedicatedHostGroupResource.GetDedicatedHostAsync Method

  • Reference

Definition

Namespace:
Azure.ResourceManager.Compute
Assembly:
Azure.ResourceManager.Compute.dll
Package:
Azure.ResourceManager.Compute v1.4.0
Package:
Azure.ResourceManager.Compute v1.4.0-beta.1
Source:
DedicatedHostGroupResource.cs
Source:
DedicatedHostGroupResource.cs

Retrieves information about a dedicated host.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}/hosts/{hostName}
  • Operation Id: DedicatedHosts_Get
  • Default Api Version: 2023-09-01
  • Resource: DedicatedHostResource
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Compute.DedicatedHostResource>> GetDedicatedHostAsync (string hostName, Azure.ResourceManager.Compute.Models.InstanceViewType? expand = default, System.Threading.CancellationToken cancellationToken = default);
abstract member GetDedicatedHostAsync : string * Nullable<Azure.ResourceManager.Compute.Models.InstanceViewType> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Compute.DedicatedHostResource>>
override this.GetDedicatedHostAsync : string * Nullable<Azure.ResourceManager.Compute.Models.InstanceViewType> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Compute.DedicatedHostResource>>
Public Overridable Function GetDedicatedHostAsync (hostName As String, Optional expand As Nullable(Of InstanceViewType) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(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<Response<DedicatedHostResource>>

Exceptions

ArgumentNullException

hostName is null.

ArgumentException

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

Applies to