az billing product

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

Billing product.

Commands

Name	Description	Type	Status
az billing product list	List the products for a billing account. These don't include products billed based on usage. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Partner Agreement.	Core	Preview
az billing product move	Moves a product's charges to a new invoice section. The new invoice section must belong to the same billing profile as the existing invoice section. This operation is supported only for products that are purchased with a recurring charge and for billing accounts with agreement type Microsoft Customer Agreement.	Core	Preview
az billing product show	Get a product by ID. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.	Core	Preview
az billing product update	Update the properties of a Product. Currently, auto renew can be updated. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.	Core	Preview
az billing product validate-move	Validate if a product's charges can be moved to a new invoice section. This operation is supported only for products that are purchased with a recurring charge and for billing accounts with agreement type Microsoft Customer Agreement.	Core	Preview

az billing product list

Preview

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

List the products for a billing account. These don't include products billed based on usage. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Partner Agreement.

az billing product list --account-name
                        [--customer-name]
                        [--filter]
                        [--invoice-section-name]
                        [--profile-name]

Examples

List products by invoice name

az billing product list --account-name "{billingAccountName}" --profile-name "{billingProfileName}" --invoice-section-name "{invoiceSectionName}"

Required Parameters

--account-name

The ID that uniquely identifies a billing account.

Optional Parameters

--customer-name

The ID that uniquely identifies a customer.

--filter

May be used to filter by product type. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value are separated by a colon (:).

--invoice-section-name

The ID that uniquely identifies an invoice section.

--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 product move

Preview

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

Moves a product's charges to a new invoice section. The new invoice section must belong to the same billing profile as the existing invoice section. This operation is supported only for products that are purchased with a recurring charge and for billing accounts with agreement type Microsoft Customer Agreement.

az billing product move --account-name
                        --name
                        [--destination-invoice-section-id]

Examples

Move a product's charges to a new invoice section

az billing product move --account-name "{billingAccountName}" --destination-invoice-section-id "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{newInvoiceSectionName}" --name "{productName}"

Required Parameters

--account-name

The ID that uniquely identifies a billing account.

--name --product-name -n

The ID that uniquely identifies a product.

Optional Parameters

--destination-invoice-section-id

The destination invoice section id.

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

Preview

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

Get a product by ID. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.

az billing product show --account-name
                        --name

Examples

Shgow a product information

az billing product show --account-name "{billingAccountName}" --name "{productName}"

Required Parameters

--account-name

The ID that uniquely identifies a billing account.

--name --product-name -n

The ID that uniquely identifies a product.

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

Preview

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

Update the properties of a Product. Currently, auto renew can be updated. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.

az billing product update --account-name
                          --name
                          [--auto-renew {Off, On}]
                          [--billing-frequency {Monthly, OneTime, UsageBased}]
                          [--status {Active, AutoRenew, Cancelled, Disabled, Expired, Expiring, Inactive, PastDue}]

Examples

Update properties of a product

az billing product update --account-name "{billingAccountName}" --auto-renew "Off" --name "{productName}"

Required Parameters

--account-name

The ID that uniquely identifies a billing account.

--name --product-name -n

The ID that uniquely identifies a product.

Optional Parameters

--auto-renew

Indicates whether auto renewal is turned on or off for a product.

Accepted values: Off, On

--billing-frequency

The frequency at which the product will be billed.

Accepted values: Monthly, OneTime, UsageBased

--status

The current status of the product.

Accepted values: Active, AutoRenew, Cancelled, Disabled, Expired, Expiring, Inactive, PastDue

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 product validate-move

Preview

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

Validate if a product's charges can be moved to a new invoice section. This operation is supported only for products that are purchased with a recurring charge and for billing accounts with agreement type Microsoft Customer Agreement.

az billing product validate-move --account-name
                                 --name
                                 [--destination-invoice-section-id]

Examples

Validate if a product's charges can be moved to a new invoice section

az billing product validate-move --account-name "{billingAccountName}" --destination-invoice-section-id "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{newInvoiceSectionName}" --name "{productName}"

Validate if a product's charges can be moved to a new invoice section

az billing product validate-move --account-name "{billingAccountName}" --destination-invoice-section-id "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{newInvoiceSectionName}" --name "{productName}"

Required Parameters

--account-name

The ID that uniquely identifies a billing account.

--name --product-name -n

The ID that uniquely identifies a product.

Optional Parameters

--destination-invoice-section-id

The destination invoice section id.

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.