az billing-benefits savings-plan-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 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
Name of the savings plan 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.
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 |
Type of the Applied Scope.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Accepted values: | ManagementGroup, Shared, Single |
Represents the billing plan in ISO 8601 format. Required only for monthly billing plans.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Accepted values: | P1M |
Subscription that will be charged for purchasing the benefit.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Commitment towards the benefit. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Display name.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Do not wait for the long-running operation to finish.
Property | Value |
---|---|
Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
Name of the SKU to be applied.
Property | Value |
---|---|
Parameter group: | Sku Arguments |
Represent benefit term in ISO 8601 format.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Accepted values: | P1Y, P3Y, P5Y |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
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.
Property | Value |
---|---|
Default value: | False |
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
Name of the savings plan order alias.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
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.
Property | Value |
---|---|
Default value: | False |
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
Name of the savings plan 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.
Wait until created with 'provisioningState' at 'Succeeded'.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | False |
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 |
Wait until deleted.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | False |
Wait until the resource exists.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | False |
Polling interval in seconds.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | 30 |
Maximum wait in seconds.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | 3600 |
Wait until updated with provisioningState at 'Succeeded'.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | False |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
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.
Property | Value |
---|---|
Default value: | False |