ComputeExtensions.GetCapacityReservationGroup Method

Definition

The operation that retrieves information about a capacity reservation group.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}
  • Operation Id: CapacityReservationGroups_Get
  • Default Api Version: 2024-07-01
  • Resource: CapacityReservationGroupResource
public static Azure.Response<Azure.ResourceManager.Compute.CapacityReservationGroupResource> GetCapacityReservationGroup (this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource, string capacityReservationGroupName, Azure.ResourceManager.Compute.Models.CapacityReservationGroupInstanceViewType? expand = default, System.Threading.CancellationToken cancellationToken = default);
static member GetCapacityReservationGroup : Azure.ResourceManager.Resources.ResourceGroupResource * string * Nullable<Azure.ResourceManager.Compute.Models.CapacityReservationGroupInstanceViewType> * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.Compute.CapacityReservationGroupResource>
<Extension()>
Public Function GetCapacityReservationGroup (resourceGroupResource As ResourceGroupResource, capacityReservationGroupName As String, Optional expand As Nullable(Of CapacityReservationGroupInstanceViewType) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of CapacityReservationGroupResource)

Parameters

resourceGroupResource
ResourceGroupResource

The ResourceGroupResource instance the method will execute against.

capacityReservationGroupName
String

The name of the capacity reservation group.

expand
Nullable<CapacityReservationGroupInstanceViewType>

The expand expression to apply on the operation. 'InstanceView' will retrieve the list of instance views of the capacity reservations under the capacity reservation group which is a snapshot of the runtime properties of a capacity reservation that is managed by the platform and can change outside of control plane operations.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

resourceGroupResource or capacityReservationGroupName is null.

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

Applies to