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 On

Required Parameters

--order-alias-name

Name of the reservation order alias.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--applied-scope-prop

Properties specific to applied scope type. Not required if not applicable. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--applied-scope-type

Type of the Applied Scope.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	ManagementGroup, Shared, Single

--billing-plan

Represents the billing plan in ISO 8601 format. Required only for monthly billing plans.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	P1M

--billing-scope-id

Subscription that will be charged for purchasing the benefit.

Property	Value
Parameter group:	Properties Arguments

--display-name

Display name.

Property	Value
Parameter group:	Properties Arguments

--instance-flexibility

Turning this on will apply the reservation discount to other VMs in the same VM size group.

Property	Value
Parameter group:	ReservedResourceProperties Arguments
Accepted values:	Off, On

--location -l

The Azure Region where the reservation benefits are applied to.

Property	Value
Parameter group:	Body Arguments

--no-wait

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

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--quantity

Total Quantity of the SKUs purchased in the Reservation.

Property	Value
Parameter group:	Properties Arguments

--renew

Setting this to true will automatically purchase a new benefit on the expiration date time.

Property	Value
Parameter group:	Properties Arguments
Default value:	False
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--reserved-resource-type

The type of the resource that is being reserved.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	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

This is the date-time when the Azure Hybrid Benefit needs to be reviewed.

Property	Value
Parameter group:	Properties Arguments

--sku

Name of the SKU to be applied.

--term

Represent benefit term in ISO 8601 format.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	P1Y, P3Y, P5Y

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

az billing-benefits reservation-order-aliases show

Get a reservation order alias.

az billing-benefits reservation-order-aliases show --order-alias-name

Examples

Show the details of a reservation order alias

az billing-benefits order-aliases show --reservation-order-alias-name TestRO

Required Parameters

--order-alias-name

Name of the reservation order alias.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

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

--order-alias-name

Name of the reservation order alias.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Property	Value
Parameter group:	Wait Condition Arguments

--deleted

Wait until deleted.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--exists

Wait until the resource exists.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	30

--timeout

Maximum wait in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False