Share via


MockableComputeResourceGroupResource.GetProximityPlacementGroup 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 virtual Azure.Response<Azure.ResourceManager.Compute.ProximityPlacementGroupResource> GetProximityPlacementGroup (string proximityPlacementGroupName, string includeColocationStatus = default, System.Threading.CancellationToken cancellationToken = default);
abstract member GetProximityPlacementGroup : string * string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.Compute.ProximityPlacementGroupResource>
override this.GetProximityPlacementGroup : string * string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.Compute.ProximityPlacementGroupResource>
Public Overridable Function GetProximityPlacementGroup (proximityPlacementGroupName As String, Optional includeColocationStatus As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As 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

Exceptions

proximityPlacementGroupName is null.

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

Applies to