Package version:

Interface CapacityReservations

Interface representing a CapacityReservations.

interface CapacityReservations {
    beginCreateOrUpdate(resourceGroupName: string, capacityReservationGroupName: string, capacityReservationName: string, parameters: CapacityReservation, options?: CapacityReservationsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<CapacityReservation>, CapacityReservation>>;
    beginCreateOrUpdateAndWait(resourceGroupName: string, capacityReservationGroupName: string, capacityReservationName: string, parameters: CapacityReservation, options?: CapacityReservationsCreateOrUpdateOptionalParams): Promise<CapacityReservation>;
    beginDelete(resourceGroupName: string, capacityReservationGroupName: string, capacityReservationName: string, options?: CapacityReservationsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginDeleteAndWait(resourceGroupName: string, capacityReservationGroupName: string, capacityReservationName: string, options?: CapacityReservationsDeleteOptionalParams): Promise<void>;
    beginUpdate(resourceGroupName: string, capacityReservationGroupName: string, capacityReservationName: string, parameters: CapacityReservationUpdate, options?: CapacityReservationsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<CapacityReservation>, CapacityReservation>>;
    beginUpdateAndWait(resourceGroupName: string, capacityReservationGroupName: string, capacityReservationName: string, parameters: CapacityReservationUpdate, options?: CapacityReservationsUpdateOptionalParams): Promise<CapacityReservation>;
    get(resourceGroupName: string, capacityReservationGroupName: string, capacityReservationName: string, options?: CapacityReservationsGetOptionalParams): Promise<CapacityReservation>;
    listByCapacityReservationGroup(resourceGroupName: string, capacityReservationGroupName: string, options?: CapacityReservationsListByCapacityReservationGroupOptionalParams): PagedAsyncIterableIterator<CapacityReservation>;
}

Index

Methods

beginCreateOrUpdate beginCreateOrUpdateAndWait beginDelete beginDeleteAndWait beginUpdate beginUpdateAndWait get listByCapacityReservationGroup

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName, capacityReservationGroupName, capacityReservationName, parameters, options?): Promise<SimplePollerLike<OperationState<CapacityReservation>, CapacityReservation>>
The operation to create or update a capacity reservation. Please note some properties can be set only during capacity reservation creation. 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.
- capacityReservationName: string
  The name of the capacity reservation.
- parameters: CapacityReservation
  Parameters supplied to the Create capacity reservation.
- Optionaloptions: CapacityReservationsCreateOrUpdateOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<CapacityReservation>, CapacityReservation>>
- Defined in operationsInterfaces/capacityReservations.ts:49

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName, capacityReservationGroupName, capacityReservationName, parameters, options?): Promise<CapacityReservation>
The operation to create or update a capacity reservation. Please note some properties can be set only during capacity reservation creation. 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.
- capacityReservationName: string
  The name of the capacity reservation.
- parameters: CapacityReservation
  Parameters supplied to the Create capacity reservation.
- Optionaloptions: CapacityReservationsCreateOrUpdateOptionalParams
  The options parameters.
Returns Promise<CapacityReservation>
- Defined in operationsInterfaces/capacityReservations.ts:71

beginDelete

beginDelete(resourceGroupName, capacityReservationGroupName, capacityReservationName, options?): Promise<SimplePollerLike<OperationState<void>, void>>
The operation to delete a capacity reservation. This operation is allowed only when all the associated resources are disassociated from the capacity reservation. 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.
- capacityReservationName: string
  The name of the capacity reservation.
- Optionaloptions: CapacityReservationsDeleteOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/capacityReservations.ts:122

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName, capacityReservationGroupName, capacityReservationName, options?): Promise<void>
The operation to delete a capacity reservation. This operation is allowed only when all the associated resources are disassociated from the capacity reservation. 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.
- capacityReservationName: string
  The name of the capacity reservation.
- Optionaloptions: CapacityReservationsDeleteOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/capacityReservations.ts:137

beginUpdate

beginUpdate(resourceGroupName, capacityReservationGroupName, capacityReservationName, parameters, options?): Promise<SimplePollerLike<OperationState<CapacityReservation>, CapacityReservation>>
The operation to update a capacity reservation.
Parameters
- resourceGroupName: string
  The name of the resource group.
- capacityReservationGroupName: string
  The name of the capacity reservation group.
- capacityReservationName: string
  The name of the capacity reservation.
- parameters: CapacityReservationUpdate
  Parameters supplied to the Update capacity reservation operation.
- Optionaloptions: CapacityReservationsUpdateOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<CapacityReservation>, CapacityReservation>>
- Defined in operationsInterfaces/capacityReservations.ts:86

beginUpdateAndWait

beginUpdateAndWait(resourceGroupName, capacityReservationGroupName, capacityReservationName, parameters, options?): Promise<CapacityReservation>
The operation to update a capacity reservation.
Parameters
- resourceGroupName: string
  The name of the resource group.
- capacityReservationGroupName: string
  The name of the capacity reservation group.
- capacityReservationName: string
  The name of the capacity reservation.
- parameters: CapacityReservationUpdate
  Parameters supplied to the Update capacity reservation operation.
- Optionaloptions: CapacityReservationsUpdateOptionalParams
  The options parameters.
Returns Promise<CapacityReservation>
- Defined in operationsInterfaces/capacityReservations.ts:106

get

get(resourceGroupName, capacityReservationGroupName, capacityReservationName, options?): Promise<CapacityReservation>
The operation that retrieves information about the capacity reservation.
Parameters
- resourceGroupName: string
  The name of the resource group.
- capacityReservationGroupName: string
  The name of the capacity reservation group.
- capacityReservationName: string
  The name of the capacity reservation.
- Optionaloptions: CapacityReservationsGetOptionalParams
  The options parameters.
Returns Promise<CapacityReservation>
- Defined in operationsInterfaces/capacityReservations.ts:150

listByCapacityReservationGroup

listByCapacityReservationGroup(resourceGroupName, capacityReservationGroupName, options?): PagedAsyncIterableIterator<CapacityReservation>
Lists all of the capacity reservations in the specified capacity reservation group. Use the nextLink property in the response to get the next page of capacity reservations.
Parameters
- resourceGroupName: string
  The name of the resource group.
- capacityReservationGroupName: string
  The name of the capacity reservation group.
- Optionaloptions: CapacityReservationsListByCapacityReservationGroupOptionalParams
  The options parameters.
Returns PagedAsyncIterableIterator<CapacityReservation>
- Defined in operationsInterfaces/capacityReservations.ts:34

Interface CapacityReservations

Index

Methods

Methods

beginCreateOrUpdate

Parameters

Returns Promise<SimplePollerLike<OperationState<CapacityReservation>, CapacityReservation>>

beginCreateOrUpdateAndWait

Parameters

Returns Promise<CapacityReservation>

beginDelete

Parameters

Returns Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Parameters

Returns Promise<void>

beginUpdate

Parameters

Returns Promise<SimplePollerLike<OperationState<CapacityReservation>, CapacityReservation>>

beginUpdateAndWait

Parameters

Returns Promise<CapacityReservation>

get

Parameters

Returns Promise<CapacityReservation>

listByCapacityReservationGroup

Parameters

Returns PagedAsyncIterableIterator<CapacityReservation>

Settings