ComputeExtensions.GetProximityPlacementGroupAsync Method

Definition

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 static System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Compute.ProximityPlacementGroupResource>> GetProximityPlacementGroupAsync (this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource, string proximityPlacementGroupName, string includeColocationStatus = default, System.Threading.CancellationToken cancellationToken = default);
static member GetProximityPlacementGroupAsync : Azure.ResourceManager.Resources.ResourceGroupResource * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Compute.ProximityPlacementGroupResource>>
<Extension()>
Public Function GetProximityPlacementGroupAsync (resourceGroupResource As ResourceGroupResource, proximityPlacementGroupName As String, Optional includeColocationStatus As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of ProximityPlacementGroupResource))

Parameters

resourceGroupResource
ResourceGroupResource

The ResourceGroupResource instance the method will execute against.

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

Exceptions

resourceGroupResource or proximityPlacementGroupName is null.

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

Applies to