ComputeExtensions.GetDedicatedHostGroupAsync Method

Definition

Namespace:

Azure.ResourceManager.Compute

Assembly:

Azure.ResourceManager.Compute.dll

Package:

Azure.ResourceManager.Compute v1.15.0

Source:

ComputeExtensions.cs

Retrieves information about a dedicated host group. <item> Mocking. To mock this method, please mock GetDedicatedHostGroupAsync(String, Nullable<InstanceViewType>, CancellationToken) instead. </item>

public static System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Compute.DedicatedHostGroupResource>> GetDedicatedHostGroupAsync(this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource, string hostGroupName, Azure.ResourceManager.Compute.Models.InstanceViewType? expand = default, System.Threading.CancellationToken cancellationToken = default);

static member GetDedicatedHostGroupAsync : Azure.ResourceManager.Resources.ResourceGroupResource * string * Nullable<Azure.ResourceManager.Compute.Models.InstanceViewType> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Compute.DedicatedHostGroupResource>>

<Extension()>
Public Function GetDedicatedHostGroupAsync (resourceGroupResource As ResourceGroupResource, hostGroupName As String, Optional expand As Nullable(Of InstanceViewType) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of DedicatedHostGroupResource))

Parameters

resourceGroupResource

ResourceGroupResource

The ResourceGroupResource the method will execute against.

hostGroupName

String

The name of the dedicated host group.

expand

Nullable<InstanceViewType>

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

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<Response<DedicatedHostGroupResource>>

Exceptions

ArgumentException

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

ArgumentNullException

resourceGroupResource is null.