ComputeExtensions.GetDedicatedHostGroupAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
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: 2024-07-01
- Resource: DedicatedHostGroupResource
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 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
Exceptions
resourceGroupResource
or hostGroupName
is null.
hostGroupName
is an empty string, and was expected to be non-empty.