az billing-benefits reservation-order-aliases
Note
This reference is part of the billing-benefits extension for the Azure CLI (version 2.43.0 or higher). The extension will automatically install the first time you run an az billing-benefits reservation-order-aliases command. Learn more about extensions.
Azure billing benefits reservation order aliases commands.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az billing-benefits reservation-order-aliases create |
Create a reservation order alias. |
Extension | GA |
| az billing-benefits reservation-order-aliases show |
Get a reservation order alias. |
Extension | GA |
| az billing-benefits reservation-order-aliases wait |
Place the CLI in a waiting state until a condition is met. |
Extension | GA |
az billing-benefits reservation-order-aliases create
Create a reservation order alias.
az billing-benefits reservation-order-aliases create --order-alias-name
[--applied-scope-prop]
[--applied-scope-type {ManagementGroup, Shared, Single}]
[--billing-plan {P1M}]
[--billing-scope-id]
[--display-name]
[--instance-flexibility {Off, On}]
[--location]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--quantity]
[--renew {0, 1, f, false, n, no, t, true, y, yes}]
[--reserved-resource-type {AVS, AppService, AzureDataExplorer, AzureFiles, BlockBlob, CosmosDb, DataFactory, Databricks, DedicatedHost, ManagedDisk, MariaDb, MySql, NetAppStorage, PostgreSql, RedHat, RedHatOsa, RedisCache, SapHana, SqlAzureHybridBenefit, SqlDataWarehouse, SqlDatabases, SqlEdge, SuseLinux, VMwareCloudSimple, VirtualMachineSoftware, VirtualMachines}]
[--review-date-time]
[--sku]
[--term {P1Y, P3Y, P5Y}]Examples
Create a Reservation
az billing-benefits reservation-order-aliases create --order-alias-name TestRO --location westus --applied-scope-type Single --applied-scope-prop "{subscription-id:/subscriptions/30000000-aaaa-bbbb-cccc-200000000004}" --billing-plan P1M --billing-scope-id /subscriptions/30000000-aaaa-bbbb-cccc-200000000004 --display-name TestRO --quantity 1 --renew false --reserved-resource-type VirtualMachines --sku Standard_B1ls --term P1Y --instance-flexibility OnRequired Parameters
Name of the reservation order alias.
Optional Parameters
Properties specific to applied scope type. Not required if not applicable. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Type of the Applied Scope.
Represents the billing plan in ISO 8601 format. Required only for monthly billing plans.
Subscription that will be charged for purchasing the benefit.
Display name.
Turning this on will apply the reservation discount to other VMs in the same VM size group.
The Azure Region where the reservation benefits are applied to.
Do not wait for the long-running operation to finish.
Total Quantity of the SKUs purchased in the Reservation.
Setting this to true will automatically purchase a new benefit on the expiration date time.
The type of the resource that is being reserved.
This is the date-time when the Azure Hybrid Benefit needs to be reviewed.
Name of the SKU to be applied.
Represent benefit term in ISO 8601 format.
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 billing-benefits reservation-order-aliases show
Get a reservation order alias.
az billing-benefits reservation-order-aliases show --order-alias-nameExamples
Show the details of a reservation order alias
az billing-benefits order-aliases show --reservation-order-alias-name TestRORequired Parameters
Name of the reservation order alias.
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 billing-benefits reservation-order-aliases wait
Place the CLI in a waiting state until a condition is met.
az billing-benefits reservation-order-aliases wait --order-alias-name
[--created]
[--custom]
[--deleted]
[--exists]
[--interval]
[--timeout]
[--updated]Required Parameters
Name of the reservation order alias.
Optional Parameters
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
Wait until the resource exists.
Polling interval in seconds.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
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.
