az capacity reservation

  • Preview
  • Reference

This command group is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage capacity reservation.

Commands

Name Description Type Status
az capacity reservation create

Create capacity reservation.

 Core Preview
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 Preview
az capacity reservation group

Manage capacity reservation group.

 Core Preview
az capacity reservation group create

Create capacity reservation group.

 Core Preview
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 Preview
az capacity reservation group list

List the capacity reservation groups.

 Core Preview
az capacity reservation group show

Show capacity reservation group.

 Core Preview
az capacity reservation group update

Update capacity reservation group.

 Core Preview
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 Preview
az capacity reservation show

Show capacity reservation.

 Core Preview
az capacity reservation update

Update capacity reservation.

 Core Preview

az capacity reservation create

Preview

Command group 'capacity reservation' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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

--capacity-reservation-group -c

The name of the capacity reservation group.

--capacity-reservation-name -n

The name of the capacity reservation.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--sku -s

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

--capacity

Specify the number of virtual machines in the scale set.

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--no-wait

Do not wait for the long-running operation to finish.

default value: False
--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

--zone -z

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
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az capacity reservation delete

Preview

Command group 'capacity reservation' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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

--capacity-reservation-group --capacity-reservation-group-name -c

The name of the capacity reservation group.

--capacity-reservation-name --name -n

The name of the capacity reservation.

--ids

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.

--no-wait

Do not wait for the long-running operation to finish.

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--yes -y

Do not prompt for confirmation.

default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az capacity reservation list

Preview

Command group 'capacity reservation' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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

--capacity-reservation-group --capacity-reservation-group-name -c

The name of the capacity reservation group.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az capacity reservation show

Preview

Command group 'capacity reservation' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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

--capacity-reservation-group -c

The name of the capacity reservation group.

--capacity-reservation-name -n

The name of the capacity reservation.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--instance-view -i

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
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az capacity reservation update

Preview

Command group 'capacity reservation' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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

--capacity-reservation-group -c

The name of the capacity reservation group.

--capacity-reservation-name -n

The name of the capacity reservation.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--capacity

Specify the number of virtual machines in the scale set.

--no-wait

Do not wait for the long-running operation to finish.

default value: False
--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.