az billing profile
This command group is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Manage profile.
Commands
Name | Description | Type | Status |
---|---|---|---|
az billing profile create |
Creates or updates a billing profile. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Partner Agreement. |
Core | Preview |
az billing profile list |
List the billing profiles that a user has access to. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Partner Agreement. |
Core | Preview |
az billing profile reservation |
Manage profile reservation. |
Core | Preview |
az billing profile reservation list |
List the reservations for a billing profile and the roll up counts of reservations group by provisioning state. |
Core | Preview |
az billing profile show |
Get a billing profile by its ID. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Partner Agreement. |
Core | Preview |
az billing profile update |
Creates or updates a billing profile. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Partner Agreement. |
Core | Preview |
az billing profile wait |
Place the CLI in a waiting state until a condition of the billing profile is met. |
Core | Preview |
az billing profile create
Command group 'billing profile' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Creates or updates a billing profile. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Partner Agreement.
az billing profile create --account-name
--name
[--bill-to]
[--display-name]
[--enabled-azure-plans]
[--invoice-email-opt-in {false, true}]
[--invoice-sections-value]
[--no-wait]
[--po-number]
Examples
Create a billing profile
az billing profile create --account-name "{billingAccountName}" --name "{billingProfileName}" --bill-to address-line1="Test Address 1" city="Redmond" country="US" first-name="Test" last-name="User" postal-code="12345" region="WA" --display-name "Finance" --enabled-azure-plans sku-id="0001" --enabled-azure-plans sku-id="0002" --invoice-email-opt-in true --po-number "ABC12345"
Required Parameters
The ID that uniquely identifies a billing account.
The ID that uniquely identifies a billing profile.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Billing address.
Usage: --bill-to first-name=XX last-name=XX company-name=XX address-line1=XX address-line2=XX address-line3=XX city=XX district=XX region=XX country=XX postal-code=XX email=XX phone-number=XX.
The name of the billing profile.
Information about the enabled azure plans.
Usage: --enabled-azure-plans sku-id=XX sku-id: The sku id. Multiple actions can be specified by using more than one --enabled-azure-plans argument.
Flag controlling whether the invoices for the billing profile are sent through email.
Property | Value |
---|---|
Accepted values: | false, true |
The invoice sections associated to the billing profile. Expected value: json-string/@json-file.
Do not wait for the long-running operation to finish.
Property | Value |
---|---|
Default value: | False |
The purchase order name that will appear on the invoices generated for the billing profile.
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 profile list
Command group 'billing profile' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
List the billing profiles that a user has access to. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Partner Agreement.
az billing profile list --account-name
[--expand]
Examples
List billing profiles with default properties
az billing profile list --account-name "{billingAccountName}"
List billing profiles with desired expanded properties
az billing profile list --expand "invoiceSections" --account-name "{billingAccountName}"
Required Parameters
The ID that uniquely identifies a billing account.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
May be used to expand the invoice sections.
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 profile show
Command group 'billing profile' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Get a billing profile by its ID. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Partner Agreement.
az billing profile show --account-name
--name
[--expand]
Examples
Show a billing profile with default properties
az billing profile show --account-name "{billingAccountName}" --name "{billingProfileName}"
Show a billing profile with expaned properties
az billing profile show --expand "invoiceSections" --account-name "{billingAccountName}" --name "{billingProfileName}"
Required Parameters
The ID that uniquely identifies a billing account.
The ID that uniquely identifies a billing profile.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
May be used to expand the invoice sections.
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 profile update
Command group 'billing profile' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Creates or updates a billing profile. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Partner Agreement.
az billing profile update --account-name
--name
[--bill-to]
[--display-name]
[--enabled-azure-plans]
[--invoice-email-opt-in {false, true}]
[--invoice-sections-value]
[--no-wait]
[--po-number]
Required Parameters
The ID that uniquely identifies a billing account.
The ID that uniquely identifies a billing profile.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Billing address.
Usage: --bill-to first-name=XX last-name=XX company-name=XX address-line1=XX address-line2=XX address-line3=XX city=XX district=XX region=XX country=XX postal-code=XX email=XX phone-number=XX.
The name of the billing profile.
Information about the enabled azure plans.
Usage: --enabled-azure-plans sku-id=XX sku-id: The sku id. Multiple actions can be specified by using more than one --enabled-azure-plans argument.
Flag controlling whether the invoices for the billing profile are sent through email.
Property | Value |
---|---|
Accepted values: | false, true |
The invoice sections associated to the billing profile. Expected value: json-string/@json-file.
Do not wait for the long-running operation to finish.
Property | Value |
---|---|
Default value: | False |
The purchase order name that will appear on the invoices generated for the billing profile.
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 profile wait
Command group 'billing profile' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Place the CLI in a waiting state until a condition of the billing profile is met.
az billing profile wait --account-name
--name
[--created]
[--custom]
[--deleted]
[--exists]
[--expand]
[--interval]
[--timeout]
[--updated]
Examples
Pause executing next line of CLI script until the billing profile is successfully created.
az billing profile wait --expand "invoiceSections" --account-name "{billingAccountName}" --name "{billingProfileName}" --created
Pause executing next line of CLI script until the billing profile is successfully updated.
az billing profile wait --expand "invoiceSections" --account-name "{billingAccountName}" --name "{billingProfileName}" --updated
Required Parameters
The ID that uniquely identifies a billing account.
The ID that uniquely identifies a billing profile.
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 |
May be used to expand the invoice sections.
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 |