ProximityPlacementGroupCollection.Get Method

Definition

Namespace:

Azure.ResourceManager.Compute

Assembly:

Azure.ResourceManager.Compute.dll

Package:

Azure.ResourceManager.Compute v1.5.0

Source:

ProximityPlacementGroupCollection.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-03-01
• Resource: ProximityPlacementGroupResource

public virtual Azure.Response<Azure.ResourceManager.Compute.ProximityPlacementGroupResource> Get (string proximityPlacementGroupName, string includeColocationStatus = default, System.Threading.CancellationToken cancellationToken = default);

abstract member Get : string * string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.Compute.ProximityPlacementGroupResource>
override this.Get : string * string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.Compute.ProximityPlacementGroupResource>

Public Overridable Function Get (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

Response<ProximityPlacementGroupResource>

Exceptions

ArgumentException

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

ArgumentNullException

proximityPlacementGroupName is null.