az capacity reservation
Manage capacity reservation.
Commands
Name | Description | Type | Status |
---|---|---|---|
az capacity reservation create |
Create capacity reservation. |
Core | GA |
az capacity reservation delete |
Delete 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. |
Core | GA |
az capacity reservation group |
Manage capacity reservation group. |
Core | GA |
az capacity reservation group create |
Create capacity reservation group. |
Core | GA |
az capacity reservation group delete |
Delete 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. |
Core | GA |
az capacity reservation group list |
List the capacity reservation groups. |
Core | GA |
az capacity reservation group show |
Show capacity reservation group. |
Core | GA |
az capacity reservation group update |
Update capacity reservation group. |
Core | GA |
az capacity reservation list |
List 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. |
Core | GA |
az capacity reservation show |
Show capacity reservation. |
Core | GA |
az capacity reservation update |
Update capacity reservation. |
Core | GA |
az capacity reservation create
Create capacity reservation.
az capacity reservation create --capacity-reservation-group
--capacity-reservation-name
--resource-group
--sku
[--capacity]
[--location]
[--no-wait]
[--tags]
[--zone]
Examples
Create a capacity reservation.
az capacity reservation create -c ReservationGroupName -n ReservationName \
-g MyResourceGroup --sku Standard_A0
Create a capacity reservation with specific capacity and zones.
az capacity reservation create -c ReservationGroupName -n ReservationName -l centraluseuap \
-g MyResourceGroup --sku Standard_A1_v2 --capacity 5 \
--zone 1 --tags key=val
Required Parameters
The name of the capacity reservation group.
The name of the capacity reservation.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The SKU of the resource for which capacity needs be reserved. Currently VM Skus with the capability called "CapacityReservationSupported" set to true are supported. Refer to List Microsoft.Compute SKUs in a region (https://docs.microsoft.com/rest/api/compute/resourceskus/list) for supported values.
Optional Parameters
Specify the number of virtual machines in the scale set.
Location. Values from: az account list-locations
. You can configure the default location using az configure --defaults location=<location>
.
Do not wait for the long-running operation to finish.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
Availability Zone to use for this capacity reservation. The zone has to be single value and also should be part for the list of zones specified during the capacity reservation group creation. If not provided, the reservation supports only non-zonal deployments. If provided, enforces VM/VMSS using this capacity reservation to be in same zone.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az capacity reservation delete
Delete 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.
az capacity reservation delete [--capacity-reservation-group]
[--capacity-reservation-name]
[--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
[--yes]
Examples
Delete a capacity reservation.
az capacity reservation delete -c ReservationGroupName -n ReservationName -g MyResourceGroup --yes
Optional Parameters
The name of the capacity reservation group.
The name of the capacity reservation.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Do not prompt for confirmation.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az capacity reservation list
List 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.
az capacity reservation list --capacity-reservation-group
--resource-group
Examples
List capacity reservation.
az capacity reservation list -c ReservationGroupName -g MyResourceGroup
Required Parameters
The name of the capacity reservation group.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az capacity reservation show
Show capacity reservation.
az capacity reservation show --capacity-reservation-group
--capacity-reservation-name
--resource-group
[--instance-view]
Examples
Get a capacity reservation.
az capacity reservation show -c ReservationGroupName -n ReservationName -g MyResourceGroup
Get a capacity reservation containing the instance views.
az capacity reservation show -c ReservationGroupName -n ReservationName \
-g MyResourceGroup --instance-view
Required Parameters
The name of the capacity reservation group.
The name of the capacity reservation.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
Retrieve a snapshot of the runtime properties of the capacity reservation that is managed by the platform and can change outside of control plane operations.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az capacity reservation update
Update capacity reservation.
az capacity reservation update --capacity-reservation-group
--capacity-reservation-name
--resource-group
[--capacity]
[--no-wait]
[--tags]
Examples
Update a capacity reservation.
az capacity reservation update -c ReservationGroupName -n ReservationName \
-g MyResourceGroup --capacity 5 --tags key=val
Required Parameters
The name of the capacity reservation group.
The name of the capacity reservation.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
Specify the number of virtual machines in the scale set.
Do not wait for the long-running operation to finish.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Azure CLI