DedicatedHostGroupCollection.GetIfExistsAsync 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.
Tries to get details for this resource from the service.
- Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}
- Operation Id: DedicatedHostGroups_Get
- Default Api Version: 2024-07-01
- Resource: DedicatedHostGroupResource
public virtual System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.Compute.DedicatedHostGroupResource>> GetIfExistsAsync (string hostGroupName, 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.DedicatedHostGroupResource>>
override this.GetIfExistsAsync : string * Nullable<Azure.ResourceManager.Compute.Models.InstanceViewType> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.Compute.DedicatedHostGroupResource>>
Public Overridable Function GetIfExistsAsync (hostGroupName As String, Optional expand As Nullable(Of InstanceViewType) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of NullableResponse(Of DedicatedHostGroupResource))
Parameters
- 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
hostGroupName
is an empty string, and was expected to be non-empty.
hostGroupName
is null.