Del via

az billing-benefits savings-plan-order-aliases

  • Reference

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 savings-plan-order-aliases command. Learn more about extensions.

Azure billing benefits savings plan order aliases commands.

Commands

Name Description Type Status
az billing-benefits savings-plan-order-aliases create

Create a savings plan. Learn more about permissions needed at https://go.microsoft.com/fwlink/?linkid=2215851.

 Extension GA
az billing-benefits savings-plan-order-aliases show

Get a savings plan order alias.

 Extension GA
az billing-benefits savings-plan-order-aliases wait

Place the CLI in a waiting state until a condition is met.

 Extension GA

az billing-benefits savings-plan-order-aliases create

Create a savings plan. Learn more about permissions needed at https://go.microsoft.com/fwlink/?linkid=2215851.

az billing-benefits savings-plan-order-aliases create --order-alias-name
                                                      [--applied-scope-prop]
                                                      [--applied-scope-type {ManagementGroup, Shared, Single}]
                                                      [--billing-plan {P1M}]
                                                      [--billing-scope-id]
                                                      [--commitment]
                                                      [--display-name]
                                                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                      [--sku]
                                                      [--term {P1Y, P3Y, P5Y}]

Examples

Create a Shared scope savings plan

az billing-benefits savings-plan-order-aliases create --order-alias-name "cliTest" --applied-scope-type Shared --billing-plan P1M --billing-scope-id /subscriptions/30000000-aaaa-bbbb-cccc-200000000004 --commitment "{amount:10.0,currency-code:USD,grain:Hourly}" --display-name "cliTest" --term P1Y --sku Compute_Savings_Plan

Create a Single scope savings plan

az billing-benefits savings-plan-order-aliases create --order-alias-name "cliTest" --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 --commitment "{amount:10.0,currency-code:USD,grain:Hourly}" --display-name "cliTest" --term P1Y --sku Compute_Savings_Plan

Create a Single Resource group scope savings plan

az billing-benefits savings-plan-order-aliases create --order-alias-name "cliTest" --applied-scope-type Single --applied-scope-prop "{subscription-id:/subscriptions/30000000-aaaa-bbbb-cccc-200000000004/resourceGroups/rgName}" --billing-plan P1M --billing-scope-id /subscriptions/30000000-aaaa-bbbb-cccc-200000000004 --commitment "{amount:10.0,currency-code:USD,grain:Hourly}" --display-name "cliTest" --term P1Y --sku Compute_Savings_Plan

Create a ManagementGroup savings plan

az billing-benefits savings-plan-order-aliases create --order-alias-name "cliTest" --applied-scope-type ManagementGroup --applied-scope-prop "{tenantId:10000000-aaaa-bbbb-cccc-20000000006,managementGroupId:/providers/Microsoft.Management/managementGroups/TestRg}" --billing-plan P1M --billing-scope-id /subscriptions/30000000-aaaa-bbbb-cccc-200000000004 --commitment "{amount:10.0,currency-code:USD,grain:Hourly}" --display-name "cliTest" --term P1Y --sku Compute_Savings_Plan

Required Parameters

--order-alias-name

Name of the savings plan order alias.

Optional Parameters

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

--applied-scope-type

Type of the Applied Scope.

Accepted values: ManagementGroup, Shared, Single
--billing-plan

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

Accepted values: P1M
--billing-scope-id

Subscription that will be charged for purchasing the benefit.

--commitment

Commitment towards the benefit. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--display-name

Display name.

--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--sku

Name of the SKU to be applied.

--term

Represent benefit term in ISO 8601 format.

Accepted values: P1Y, P3Y, P5Y
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 billing-benefits savings-plan-order-aliases show

Get a savings plan order alias.

az billing-benefits savings-plan-order-aliases show --order-alias-name

Examples

Get a savings plan order alias

az billing-benefits savings-plan-order-aliases show --order-alias-name aliasName

Required Parameters

--order-alias-name

Name of the savings plan order alias.

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 billing-benefits savings-plan-order-aliases wait

Place the CLI in a waiting state until a condition is met.

az billing-benefits savings-plan-order-aliases wait --order-alias-name
                                                    [--created]
                                                    [--custom]
                                                    [--deleted]
                                                    [--exists]
                                                    [--interval]
                                                    [--timeout]
                                                    [--updated]

Required Parameters

--order-alias-name

Name of the savings plan order alias.

Optional Parameters

--created

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

Default value: False
--custom

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

--deleted

Wait until deleted.

Default value: False
--exists

Wait until the resource exists.

Default value: False
--interval

Polling interval in seconds.

Default value: 30
--timeout

Maximum wait in seconds.

Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

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.