MockableComputeResourceGroupResource.GetProximityPlacementGroupAsync Method

  • Reference

Definition

Namespace:
Azure.ResourceManager.Compute.Mocking
Assembly:
Azure.ResourceManager.Compute.dll
Package:
Azure.ResourceManager.Compute v1.6.0
Package:
Azure.ResourceManager.Compute v1.7.0-beta.1
Source:
MockableComputeResourceGroupResource.cs
Source:
MockableComputeResourceGroupResource.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>> GetProximityPlacementGroupAsync (string proximityPlacementGroupName, string includeColocationStatus = default, System.Threading.CancellationToken cancellationToken = default);
abstract member GetProximityPlacementGroupAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Compute.ProximityPlacementGroupResource>>
override this.GetProximityPlacementGroupAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Compute.ProximityPlacementGroupResource>>
Public Overridable Function GetProximityPlacementGroupAsync (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

ArgumentNullException

proximityPlacementGroupName is null.

ArgumentException

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

Applies to