Package version:

Interface CapacityReservationGroups

Interface representing a CapacityReservationGroups.

interface CapacityReservationGroups {
    createOrUpdate(resourceGroupName: string, capacityReservationGroupName: string, parameters: CapacityReservationGroup, options?: CapacityReservationGroupsCreateOrUpdateOptionalParams): Promise<CapacityReservationGroup>;
    delete(resourceGroupName: string, capacityReservationGroupName: string, options?: CapacityReservationGroupsDeleteOptionalParams): Promise<void>;
    get(resourceGroupName: string, capacityReservationGroupName: string, options?: CapacityReservationGroupsGetOptionalParams): Promise<CapacityReservationGroup>;
    listByResourceGroup(resourceGroupName: string, options?: CapacityReservationGroupsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<CapacityReservationGroup>;
    listBySubscription(options?: CapacityReservationGroupsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<CapacityReservationGroup>;
    update(resourceGroupName: string, capacityReservationGroupName: string, parameters: CapacityReservationGroupUpdate, options?: CapacityReservationGroupsUpdateOptionalParams): Promise<CapacityReservationGroup>;
}

Methods

createOrUpdate(resourceGroupName, capacityReservationGroupName, parameters, options?): Promise<CapacityReservationGroup>
The operation to create or update a capacity reservation group. When updating a capacity reservation group, only tags and sharing profile may be modified. Please refer to https://aka.ms/CapacityReservation for more details.
Parameters
- resourceGroupName: string
  The name of the resource group.
- capacityReservationGroupName: string
  The name of the capacity reservation group.
- parameters: CapacityReservationGroup
  Parameters supplied to the Create capacity reservation Group.
- Optionaloptions: CapacityReservationGroupsCreateOrUpdateOptionalParams
  The options parameters.
Returns Promise<CapacityReservationGroup>
- Defined in operationsInterfaces/capacityReservationGroups.ts:54

delete(resourceGroupName, capacityReservationGroupName, options?): Promise<void>
The operation to delete a capacity reservation group. This operation is allowed only if all the associated resources are disassociated from the reservation group and all capacity reservations under the reservation group have also been deleted. Please refer to https://aka.ms/CapacityReservation for more details.
Parameters
- resourceGroupName: string
  The name of the resource group.
- capacityReservationGroupName: string
  The name of the capacity reservation group.
- Optionaloptions: CapacityReservationGroupsDeleteOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/capacityReservationGroups.ts:83

get(resourceGroupName, capacityReservationGroupName, options?): Promise<CapacityReservationGroup>
The operation that retrieves information about a capacity reservation group.
Parameters
- resourceGroupName: string
  The name of the resource group.
- capacityReservationGroupName: string
  The name of the capacity reservation group.
- Optionaloptions: CapacityReservationGroupsGetOptionalParams
  The options parameters.
Returns Promise<CapacityReservationGroup>
- Defined in operationsInterfaces/capacityReservationGroups.ts:94

listByResourceGroup(resourceGroupName, options?): PagedAsyncIterableIterator<CapacityReservationGroup>
Lists all of the capacity reservation groups in the specified resource group. Use the nextLink property in the response to get the next page of capacity reservation groups.
Parameters
- resourceGroupName: string
  The name of the resource group.
- Optionaloptions: CapacityReservationGroupsListByResourceGroupOptionalParams
  The options parameters.
Returns PagedAsyncIterableIterator<CapacityReservationGroup>
- Defined in operationsInterfaces/capacityReservationGroups.ts:33

listBySubscription(options?): PagedAsyncIterableIterator<CapacityReservationGroup>
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.
Parameters
- Optionaloptions: CapacityReservationGroupsListBySubscriptionOptionalParams
  The options parameters.
Returns PagedAsyncIterableIterator<CapacityReservationGroup>
- Defined in operationsInterfaces/capacityReservationGroups.ts:42

update(resourceGroupName, capacityReservationGroupName, parameters, options?): Promise<CapacityReservationGroup>
The operation to update a capacity reservation group. When updating a capacity reservation group, only tags and sharing profile may be modified.
Parameters
- resourceGroupName: string
  The name of the resource group.
- capacityReservationGroupName: string
  The name of the capacity reservation group.
- parameters: CapacityReservationGroupUpdate
  Parameters supplied to the Update capacity reservation Group operation.
- Optionaloptions: CapacityReservationGroupsUpdateOptionalParams
  The options parameters.
Returns Promise<CapacityReservationGroup>
- Defined in operationsInterfaces/capacityReservationGroups.ts:68