ProximityPlacementGroupCollection.GetAsync Method
Definition
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: 2024-07-01
- Resource: ProximityPlacementGroupResource
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Compute.ProximityPlacementGroupResource>> GetAsync (string proximityPlacementGroupName, string includeColocationStatus = default, System.Threading.CancellationToken cancellationToken = default);abstract member GetAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Compute.ProximityPlacementGroupResource>>
override this.GetAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Compute.ProximityPlacementGroupResource>>Public Overridable Function GetAsync (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
Exceptions
proximityPlacementGroupName is an empty string, and was expected to be non-empty.
proximityPlacementGroupName is null.
