az billing instruction

  • Preview
  • Reference

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

Manage billing instruction.

Commands

Name Description Type Status
az billing instruction create

Create an instruction. These are custom billing instructions and are only applicable for certain customers.

 Core Preview
az billing instruction list

List the instructions by billing profile id.

 Core Preview
az billing instruction show

Show the instruction by name. These are custom billing instructions and are only applicable for certain customers.

 Core Preview
az billing instruction update

Update an instruction. These are custom billing instructions and are only applicable for certain customers.

 Core Preview

az billing instruction create

Edit
Preview

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

Create an instruction. These are custom billing instructions and are only applicable for certain customers.

az billing instruction create --account-name
                              --name
                              --profile-name
                              [--amount]
                              [--creation-date]
                              [--end-date]
                              [--start-date]

Examples

Create an instruction

az billing instruction create --account-name "{billingAccountName}" --profile-name "{billingProfileName}" --name "{instructionName}" --amount 5000 --end-date "2020-12-30T21:26:47.997Z" --start-date "2019-12-30T21:26:47.997Z"

Required Parameters

--account-name

The ID that uniquely identifies a billing account.

--name -n

Instruction Name.

--profile-name

The ID that uniquely identifies a billing profile.

Optional Parameters

--amount

The amount budgeted for this billing instruction.

--creation-date

The date this billing instruction was created.

--end-date

The date this billing instruction is no longer in effect.

--start-date

The date this billing instruction goes into effect.

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 instruction list

Edit
Preview

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

List the instructions by billing profile id.

az billing instruction list --account-name
                            --profile-name

Examples

List instructions by billing profile

az billing instruction list --account-name "{billingAccountName}" --profile-name "{billingProfileName}"

Required Parameters

--account-name

The ID that uniquely identifies a billing account.

--profile-name

The ID that uniquely identifies a billing profile.

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 instruction show

Edit
Preview

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

Show the instruction by name. These are custom billing instructions and are only applicable for certain customers.

az billing instruction show --account-name
                            --name
                            --profile-name

Examples

Instruction

az billing instruction show --account-name "{billingAccountName}" --profile-name "{billingProfileName}" --name "{instructionName}"

Required Parameters

--account-name

The ID that uniquely identifies a billing account.

--name -n

Instruction Name.

--profile-name

The ID that uniquely identifies a billing profile.

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 instruction update

Edit
Preview

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

Update an instruction. These are custom billing instructions and are only applicable for certain customers.

az billing instruction update --account-name
                              --name
                              --profile-name
                              [--add]
                              [--amount]
                              [--creation-date]
                              [--end-date]
                              [--force-string]
                              [--remove]
                              [--set]
                              [--start-date]

Examples

Create an instruction

az billing instruction update --account-name "{billingAccountName}" --profile-name "{billingProfileName}" --name "{instructionName}" --amount 5000

Required Parameters

--account-name

The ID that uniquely identifies a billing account.

--name -n

Instruction Name.

--profile-name

The ID that uniquely identifies a billing profile.

Optional Parameters

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

default value: []
--amount

The amount budgeted for this billing instruction.

--creation-date

The date this billing instruction was created.

--end-date

The date this billing instruction is no longer in effect.

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

default value: False
--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

default value: []
--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

default value: []
--start-date

The date this billing instruction goes into effect.

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.