ComputeExtensions.GetProximityPlacementGroup Method

Reference

Definition

Namespace:: Azure.ResourceManager.Compute

Assembly:: Azure.ResourceManager.Compute.dll

Package:: Azure.ResourceManager.Compute v1.4.0

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

Source:: ComputeExtensions.cs

Source:: ComputeExtensions.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.

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: 2023-09-01
Resource: ProximityPlacementGroupResource

public static Azure.Response<Azure.ResourceManager.Compute.ProximityPlacementGroupResource> GetProximityPlacementGroup (this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource, string proximityPlacementGroupName, string includeColocationStatus = default, System.Threading.CancellationToken cancellationToken = default);

static member GetProximityPlacementGroup : Azure.ResourceManager.Resources.ResourceGroupResource * string * string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.Compute.ProximityPlacementGroupResource>

<Extension()>
Public Function GetProximityPlacementGroup (resourceGroupResource As ResourceGroupResource, proximityPlacementGroupName As String, Optional includeColocationStatus As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of ProximityPlacementGroupResource)

Parameters

resourceGroupResource: ResourceGroupResource

The ResourceGroupResource instance the method will execute against.

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

ArgumentNullException

resourceGroupResource or proximityPlacementGroupName is null.

ArgumentException

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

Applies to