Share via


ProximityPlacementGroupCollection.GetIfExistsAsync Method

Definition

Tries to get details for this resource from the service.

  • 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.NullableResponse<Azure.ResourceManager.Compute.ProximityPlacementGroupResource>> GetIfExistsAsync (string proximityPlacementGroupName, string includeColocationStatus = default, System.Threading.CancellationToken cancellationToken = default);
abstract member GetIfExistsAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.Compute.ProximityPlacementGroupResource>>
override this.GetIfExistsAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.Compute.ProximityPlacementGroupResource>>
Public Overridable Function GetIfExistsAsync (proximityPlacementGroupName As String, Optional includeColocationStatus As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of NullableResponse(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 an empty string, and was expected to be non-empty.

proximityPlacementGroupName is null.

Applies to