CapacityReservationGroups interface
Interface representing a CapacityReservationGroups.
Methods
| create |
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. |
| delete(string, string, Capacity |
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. |
| get(string, string, Capacity |
The operation that retrieves information about a capacity reservation group. |
| list |
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. |
| list |
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. |
| update(string, string, Capacity |
The operation to update a capacity reservation group. When updating a capacity reservation group, only tags and sharing profile may be modified. |
Method Details
createOrUpdate(string, string, CapacityReservationGroup, CapacityReservationGroupsCreateOrUpdateOptionalParams)
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.
function createOrUpdate(resourceGroupName: string, capacityReservationGroupName: string, parameters: CapacityReservationGroup, options?: CapacityReservationGroupsCreateOrUpdateOptionalParams): Promise<CapacityReservationGroup>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.
The options parameters.
Returns
Promise<CapacityReservationGroup>
delete(string, string, CapacityReservationGroupsDeleteOptionalParams)
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.
function delete(resourceGroupName: string, capacityReservationGroupName: string, options?: CapacityReservationGroupsDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group.
- capacityReservationGroupName
-
string
The name of the capacity reservation group.
The options parameters.
Returns
Promise<void>
get(string, string, CapacityReservationGroupsGetOptionalParams)
The operation that retrieves information about a capacity reservation group.
function get(resourceGroupName: string, capacityReservationGroupName: string, options?: CapacityReservationGroupsGetOptionalParams): Promise<CapacityReservationGroup>Parameters
- resourceGroupName
-
string
The name of the resource group.
- capacityReservationGroupName
-
string
The name of the capacity reservation group.
The options parameters.
Returns
Promise<CapacityReservationGroup>
listByResourceGroup(string, CapacityReservationGroupsListByResourceGroupOptionalParams)
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.
function listByResourceGroup(resourceGroupName: string, options?: CapacityReservationGroupsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<CapacityReservationGroup, CapacityReservationGroup[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group.
The options parameters.
Returns
listBySubscription(CapacityReservationGroupsListBySubscriptionOptionalParams)
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.
function listBySubscription(options?: CapacityReservationGroupsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<CapacityReservationGroup, CapacityReservationGroup[], PageSettings>Parameters
The options parameters.
Returns
update(string, string, CapacityReservationGroupUpdate, CapacityReservationGroupsUpdateOptionalParams)
The operation to update a capacity reservation group. When updating a capacity reservation group, only tags and sharing profile may be modified.
function update(resourceGroupName: string, capacityReservationGroupName: string, parameters: CapacityReservationGroupUpdate, options?: CapacityReservationGroupsUpdateOptionalParams): Promise<CapacityReservationGroup>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.
The options parameters.
Returns
Promise<CapacityReservationGroup>