CapacityReservations interface
Interface representing a CapacityReservations.
Methods
| begin |
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. |
| begin |
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. |
| begin |
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. |
| begin |
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. |
| begin |
The operation to update a capacity reservation. |
| begin |
The operation to update a capacity reservation. |
| get(string, string, string, Capacity |
The operation that retrieves information about the capacity reservation. |
| list |
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. |
Method Details
beginCreateOrUpdate(string, string, string, CapacityReservation, CapacityReservationsCreateOrUpdateOptionalParams)
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.
function beginCreateOrUpdate(resourceGroupName: string, capacityReservationGroupName: string, capacityReservationName: string, parameters: CapacityReservation, options?: CapacityReservationsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<CapacityReservation>, CapacityReservation>>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.
The options parameters.
Returns
beginCreateOrUpdateAndWait(string, string, string, CapacityReservation, CapacityReservationsCreateOrUpdateOptionalParams)
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.
function beginCreateOrUpdateAndWait(resourceGroupName: string, capacityReservationGroupName: string, capacityReservationName: string, parameters: CapacityReservation, options?: CapacityReservationsCreateOrUpdateOptionalParams): Promise<CapacityReservation>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.
The options parameters.
Returns
Promise<CapacityReservation>
beginDelete(string, string, string, CapacityReservationsDeleteOptionalParams)
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.
function beginDelete(resourceGroupName: string, capacityReservationGroupName: string, capacityReservationName: string, options?: CapacityReservationsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>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.
The options parameters.
Returns
Promise<SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, string, CapacityReservationsDeleteOptionalParams)
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.
function beginDeleteAndWait(resourceGroupName: string, capacityReservationGroupName: string, capacityReservationName: string, options?: CapacityReservationsDeleteOptionalParams): Promise<void>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.
The options parameters.
Returns
Promise<void>
beginUpdate(string, string, string, CapacityReservationUpdate, CapacityReservationsUpdateOptionalParams)
The operation to update a capacity reservation.
function beginUpdate(resourceGroupName: string, capacityReservationGroupName: string, capacityReservationName: string, parameters: CapacityReservationUpdate, options?: CapacityReservationsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<CapacityReservation>, CapacityReservation>>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.
The options parameters.
Returns
beginUpdateAndWait(string, string, string, CapacityReservationUpdate, CapacityReservationsUpdateOptionalParams)
The operation to update a capacity reservation.
function beginUpdateAndWait(resourceGroupName: string, capacityReservationGroupName: string, capacityReservationName: string, parameters: CapacityReservationUpdate, options?: CapacityReservationsUpdateOptionalParams): Promise<CapacityReservation>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.
The options parameters.
Returns
Promise<CapacityReservation>
get(string, string, string, CapacityReservationsGetOptionalParams)
The operation that retrieves information about the capacity reservation.
function get(resourceGroupName: string, capacityReservationGroupName: string, capacityReservationName: string, options?: CapacityReservationsGetOptionalParams): Promise<CapacityReservation>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.
The options parameters.
Returns
Promise<CapacityReservation>
listByCapacityReservationGroup(string, string, CapacityReservationsListByCapacityReservationGroupOptionalParams)
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.
function listByCapacityReservationGroup(resourceGroupName: string, capacityReservationGroupName: string, options?: CapacityReservationsListByCapacityReservationGroupOptionalParams): PagedAsyncIterableIterator<CapacityReservation, CapacityReservation[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group.
- capacityReservationGroupName
-
string
The name of the capacity reservation group.
The options parameters.