Share via


ComputeExtensions.GetCapacityReservationGroupsAsync Method

Definition

Lists all of the capacity reservation groups in the subscription. Use the nextLink property in the response to get the next page of capacity reservation groups.

  • Request Path: /subscriptions/{subscriptionId}/providers/Microsoft.Compute/capacityReservationGroups
  • Operation Id: CapacityReservationGroups_ListBySubscription
  • Default Api Version: 2024-07-01
  • Resource: CapacityReservationGroupResource
public static Azure.AsyncPageable<Azure.ResourceManager.Compute.CapacityReservationGroupResource> GetCapacityReservationGroupsAsync (this Azure.ResourceManager.Resources.SubscriptionResource subscriptionResource, Azure.ResourceManager.Compute.Models.CapacityReservationGroupGetExpand? expand = default, Azure.ResourceManager.Compute.Models.ResourceIdOptionsForGetCapacityReservationGroup? resourceIdsOnly = default, System.Threading.CancellationToken cancellationToken = default);
static member GetCapacityReservationGroupsAsync : Azure.ResourceManager.Resources.SubscriptionResource * Nullable<Azure.ResourceManager.Compute.Models.CapacityReservationGroupGetExpand> * Nullable<Azure.ResourceManager.Compute.Models.ResourceIdOptionsForGetCapacityReservationGroup> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.Compute.CapacityReservationGroupResource>
<Extension()>
Public Function GetCapacityReservationGroupsAsync (subscriptionResource As SubscriptionResource, Optional expand As Nullable(Of CapacityReservationGroupGetExpand) = Nothing, Optional resourceIdsOnly As Nullable(Of ResourceIdOptionsForGetCapacityReservationGroup) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of CapacityReservationGroupResource)

Parameters

subscriptionResource
SubscriptionResource

The SubscriptionResource instance the method will execute against.

expand
Nullable<CapacityReservationGroupGetExpand>

The expand expression to apply on the operation. Based on the expand param(s) specified we return Virtual Machine or ScaleSet VM Instance or both resource Ids which are associated to capacity reservation group in the response.

resourceIdsOnly
Nullable<ResourceIdOptionsForGetCapacityReservationGroup>

The query option to fetch Capacity Reservation Group Resource Ids. <br> 'CreatedInSubscription' enables fetching Resource Ids for all capacity reservation group resources created in the subscription. <br> 'SharedWithSubscription' enables fetching Resource Ids for all capacity reservation group resources shared with the subscription. <br> 'All' enables fetching Resource Ids for all capacity reservation group resources shared with the subscription and created in the subscription.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

An async collection of CapacityReservationGroupResource that may take multiple service requests to iterate over.

Exceptions

subscriptionResource is null.

Applies to