ProximityPlacementGroupCollection.GetAsync Method

Definition

Namespace:

Azure.ResourceManager.Compute

Assembly:

Azure.ResourceManager.Compute.dll

Package:

Azure.ResourceManager.Compute v1.6.0

Source:

ProximityPlacementGroupCollection.cs

Retrieves information about a proximity placement group .

• Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/proximityPlacementGroups/{proximityPlacementGroupName}
• Operation Id: ProximityPlacementGroups_Get
• Default Api Version: 2024-07-01
• Resource: ProximityPlacementGroupResource

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Compute.ProximityPlacementGroupResource>> GetAsync (string proximityPlacementGroupName, string includeColocationStatus = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Compute.ProximityPlacementGroupResource>>
override this.GetAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Compute.ProximityPlacementGroupResource>>

Public Overridable Function GetAsync (proximityPlacementGroupName As String, Optional includeColocationStatus As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of ProximityPlacementGroupResource))

Parameters

proximityPlacementGroupName

String

The name of the proximity placement group.

includeColocationStatus

String

includeColocationStatus=true enables fetching the colocation status of all the resources in the proximity placement group.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<Response<ProximityPlacementGroupResource>>

Exceptions

ArgumentException

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

ArgumentNullException

proximityPlacementGroupName is null.