ComputeExtensions.GetDedicatedHostGroup 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:
ComputeExtensions.cs
Source:
ComputeExtensions.cs

Retrieves information about a dedicated host group.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}
  • Operation Id: DedicatedHostGroups_Get
  • Default Api Version: 2023-09-01
  • Resource: DedicatedHostGroupResource
public static Azure.Response<Azure.ResourceManager.Compute.DedicatedHostGroupResource> GetDedicatedHostGroup (this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource, string hostGroupName, Azure.ResourceManager.Compute.Models.InstanceViewType? expand = default, System.Threading.CancellationToken cancellationToken = default);
static member GetDedicatedHostGroup : Azure.ResourceManager.Resources.ResourceGroupResource * string * Nullable<Azure.ResourceManager.Compute.Models.InstanceViewType> * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.Compute.DedicatedHostGroupResource>
<Extension()>
Public Function GetDedicatedHostGroup (resourceGroupResource As ResourceGroupResource, hostGroupName As String, Optional expand As Nullable(Of InstanceViewType) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of DedicatedHostGroupResource)

Parameters

resourceGroupResource
ResourceGroupResource

The ResourceGroupResource instance 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

Response<DedicatedHostGroupResource>

Exceptions

ArgumentNullException

resourceGroupResource or hostGroupName is null.

ArgumentException

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

Applies to