CapacityReservations | @azure/arm-compute

Interface representing a CapacityReservations.

Hierarchy

CapacityReservations

Implemented by

CapacityReservationsImpl

Index

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, capacityReservationGroupName: string, capacityReservationName: string, parameters: CapacityReservation, options?: CapacityReservationsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<CapacityReservationsCreateOrUpdateResponse>, CapacityReservationsCreateOrUpdateResponse>>

- Defined in operationsInterfaces/capacityReservations.ts:50
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.
- Optional options: CapacityReservationsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<CapacityReservationsCreateOrUpdateResponse>, CapacityReservationsCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName: string, capacityReservationGroupName: string, capacityReservationName: string, parameters: CapacityReservation, options?: CapacityReservationsCreateOrUpdateOptionalParams): Promise<CapacityReservationsCreateOrUpdateResponse>

- Defined in operationsInterfaces/capacityReservations.ts:72
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.
- Optional options: CapacityReservationsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<CapacityReservationsCreateOrUpdateResponse>

beginDelete

beginDelete(resourceGroupName: string, capacityReservationGroupName: string, capacityReservationName: string, options?: CapacityReservationsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

- Defined in operationsInterfaces/capacityReservations.ts:123
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.
- Optional options: CapacityReservationsDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName: string, capacityReservationGroupName: string, capacityReservationName: string, options?: CapacityReservationsDeleteOptionalParams): Promise<void>

- Defined in operationsInterfaces/capacityReservations.ts:138
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.
- Optional options: CapacityReservationsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

beginUpdate

beginUpdate(resourceGroupName: string, capacityReservationGroupName: string, capacityReservationName: string, parameters: CapacityReservationUpdate, options?: CapacityReservationsUpdateOptionalParams): Promise<PollerLike<PollOperationState<CapacityReservationsUpdateResponse>, CapacityReservationsUpdateResponse>>

- Defined in operationsInterfaces/capacityReservations.ts:87
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.
- Optional options: CapacityReservationsUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<CapacityReservationsUpdateResponse>, CapacityReservationsUpdateResponse>>

beginUpdateAndWait

beginUpdateAndWait(resourceGroupName: string, capacityReservationGroupName: string, capacityReservationName: string, parameters: CapacityReservationUpdate, options?: CapacityReservationsUpdateOptionalParams): Promise<CapacityReservationsUpdateResponse>

- Defined in operationsInterfaces/capacityReservations.ts:107
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.
- Optional options: CapacityReservationsUpdateOptionalParams
  
  The options parameters.
Returns Promise<CapacityReservationsUpdateResponse>

get

get(resourceGroupName: string, capacityReservationGroupName: string, capacityReservationName: string, options?: CapacityReservationsGetOptionalParams): Promise<CapacityReservationsGetResponse>

- Defined in operationsInterfaces/capacityReservations.ts:151
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.
- Optional options: CapacityReservationsGetOptionalParams
  
  The options parameters.
Returns Promise<CapacityReservationsGetResponse>

listByCapacityReservationGroup

listByCapacityReservationGroup(resourceGroupName: string, capacityReservationGroupName: string, options?: CapacityReservationsListByCapacityReservationGroupOptionalParams): PagedAsyncIterableIterator<CapacityReservation>

- Defined in operationsInterfaces/capacityReservations.ts:35
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.
- Optional options: CapacityReservationsListByCapacityReservationGroupOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<CapacityReservation>

Hierarchy

Implemented by

Index

Methods

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

capacityReservationGroupName: string

capacityReservationName: string

parameters: CapacityReservation

Optional options: CapacityReservationsCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<CapacityReservationsCreateOrUpdateResponse>, CapacityReservationsCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

capacityReservationGroupName: string

capacityReservationName: string

parameters: CapacityReservation

Optional options: CapacityReservationsCreateOrUpdateOptionalParams

Returns Promise<CapacityReservationsCreateOrUpdateResponse>

beginDelete

Parameters

resourceGroupName: string

capacityReservationGroupName: string

capacityReservationName: string

Optional options: CapacityReservationsDeleteOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

Parameters

resourceGroupName: string

capacityReservationGroupName: string

capacityReservationName: string

Optional options: CapacityReservationsDeleteOptionalParams

Returns Promise<void>

beginUpdate

Parameters

resourceGroupName: string

capacityReservationGroupName: string

capacityReservationName: string

parameters: CapacityReservationUpdate

Optional options: CapacityReservationsUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<CapacityReservationsUpdateResponse>, CapacityReservationsUpdateResponse>>

beginUpdateAndWait

Parameters

resourceGroupName: string

capacityReservationGroupName: string

capacityReservationName: string

parameters: CapacityReservationUpdate

Optional options: CapacityReservationsUpdateOptionalParams

Returns Promise<CapacityReservationsUpdateResponse>

get

Parameters

resourceGroupName: string

capacityReservationGroupName: string

capacityReservationName: string

Optional options: CapacityReservationsGetOptionalParams

Returns Promise<CapacityReservationsGetResponse>

listByCapacityReservationGroup

Parameters

resourceGroupName: string

capacityReservationGroupName: string

Optional options: CapacityReservationsListByCapacityReservationGroupOptionalParams

Returns PagedAsyncIterableIterator<CapacityReservation>