ProximityPlacementGroupCollection.GetIfExistsAsync Method

Reference

Definition

Namespace:: Azure.ResourceManager.Compute

Assembly:: Azure.ResourceManager.Compute.dll

Package:: Azure.ResourceManager.Compute v1.6.0

Package:: Azure.ResourceManager.Compute v1.7.0-beta.1

Source:: ProximityPlacementGroupCollection.cs

Source:: ProximityPlacementGroupCollection.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

Task<NullableResponse<ProximityPlacementGroupResource>>

Exceptions

ArgumentException

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

ArgumentNullException

proximityPlacementGroupName is null.

Applies to

Share via