price_sheets
Creates, updates, deletes, gets or lists a price_sheets resource.
Overview
| Name | price_sheets |
| Type | Resource |
| Id | azure.cost_management.price_sheets |
Fields
The following fields are returned by SELECT queries:
SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
download_by_invoice | exec | billingAccountName, billingProfileName, invoiceName | Gets a URL to download the pricesheet for an invoice. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement. | |
download_by_billing_profile | exec | billingAccountName, billingProfileName | Gets a URL to download the current month's pricesheet for a billing profile. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement. You can use the new 2023-09-01 API version for billing periods January 2023 onwards. Azure Reserved Instance (RI) pricing is only available through the new version of the API. Due to Azure product growth, the Azure price sheet download experience in this preview version will be updated from a single csv/json file to a Zip file containing multiple csv/json files, each with max size of 75MB. | |
download_by_billing_account | exec | billingAccountId, billingPeriodName | Generates the pricesheet for the provided billing period asynchronously based on the Enrollment ID. This is for Enterprise Agreement customers. You can use the new 2023-09-01 API version at '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingPeriods/{billingPeriodName}/providers/Microsoft.CostManagement/pricesheets/default/download' for billing periods January 2023 onwards. With a new schema detailed below, the new price sheet provides more information and includes prices for Azure Reserved Instances (RI) for the current billing period. We recommend downloading an Azure Price Sheet for when entering a new billing period if you would maintain a record of past Azure Reserved Instance (RI) pricing. Due to Azure product growth, the Azure price sheet download experience in this preview version will be updated from a single .csv file to a zip file containing multiple csv files, each with max size of 75MB. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
billingAccountId | string | BillingAccount ID |
billingAccountName | string | The ID that uniquely identifies a billing account. |
billingPeriodName | string | Billing Period Name. |
billingProfileName | string | The ID that uniquely identifies a billing profile. |
invoiceName | string | The ID that uniquely identifies an invoice. |
Lifecycle Methods
- download_by_invoice
- download_by_billing_profile
- download_by_billing_account
Gets a URL to download the pricesheet for an invoice. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
EXEC azure.cost_management.price_sheets.download_by_invoice
@billingAccountName='{{ billingAccountName }}' --required,
@billingProfileName='{{ billingProfileName }}' --required,
@invoiceName='{{ invoiceName }}' --required
;
Gets a URL to download the current month's pricesheet for a billing profile. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
You can use the new 2023-09-01 API version for billing periods January 2023 onwards. Azure Reserved Instance (RI) pricing is only available through the new version of the API.
Due to Azure product growth, the Azure price sheet download experience in this preview version will be updated from a single csv/json file to a Zip file containing multiple csv/json files, each with max size of 75MB.
EXEC azure.cost_management.price_sheets.download_by_billing_profile
@billingAccountName='{{ billingAccountName }}' --required,
@billingProfileName='{{ billingProfileName }}' --required
;
Generates the pricesheet for the provided billing period asynchronously based on the Enrollment ID. This is for Enterprise Agreement customers.
You can use the new 2023-09-01 API version at '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingPeriods/{billingPeriodName}/providers/Microsoft.CostManagement/pricesheets/default/download' for billing periods January 2023 onwards. With a new schema detailed below, the new price sheet provides more information and includes prices for Azure Reserved Instances (RI) for the current billing period.
We recommend downloading an Azure Price Sheet for when entering a new billing period if you would maintain a record of past Azure Reserved Instance (RI) pricing. Due to Azure product growth, the Azure price sheet download experience in this preview version will be updated from a single .csv file to a zip file containing multiple csv files, each with max size of 75MB.
EXEC azure.cost_management.price_sheets.download_by_billing_account
@billingAccountId='{{ billingAccountId }}' --required,
@billingPeriodName='{{ billingPeriodName }}' --required
;