price_sheets

Creates, updates, deletes, gets or lists a price_sheets resource.

Overview

Name	price_sheets
Type	Resource
Id	azure.consumption.price_sheets

Fields

The following fields are returned by SELECT queries:

get_by_billing_period

OK. The request has succeeded.

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
properties	object	price sheet result. It contains the pricesheet associated with billing period (title: Price sheet properties)
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

get

OK. The request has succeeded.

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
properties	object	price sheet result. It contains the pricesheet associated with billing period (title: Price sheet properties)
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_by_billing_period	select	subscriptionId, billingPeriodName	$expand, $skiptoken, $top	Get the price sheet for a scope by subscriptionId and billing period. Price sheet is available via this API only for May 1, 2014 or later.
get	select	subscriptionId	$expand, $skiptoken, $top	Gets the price sheet for a subscription. Price sheet is available via this API only for May 1, 2014 or later.
download_by_billing_account_period	exec	billingAccountId, billingPeriodName		Generates the pricesheet for the provided billing period asynchronously based on the enrollment id

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
billingPeriodName	string	Billing Period Name.
subscriptionId	string	Azure Subscription ID.
$expand	string	May be used to expand the properties/meterDetails within a price sheet. By default, these fields are not included when returning price sheet.
$skiptoken	string	Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.
$top	integer (int32)	May be used to limit the number of results to the top N results.

SELECT examples

get_by_billing_period

Get the price sheet for a scope by subscriptionId and billing period. Price sheet is available via this API only for May 1, 2014 or later.

SELECT
id,
name,
properties,
type
FROM azure.consumption.price_sheets
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND billingPeriodName = '{{ billingPeriodName }}' -- required
AND $expand = '{{ $expand }}'
AND $skiptoken = '{{ $skiptoken }}'
AND $top = '{{ $top }}'
;

get

Gets the price sheet for a subscription. Price sheet is available via this API only for May 1, 2014 or later.

SELECT
id,
name,
properties,
type
FROM azure.consumption.price_sheets
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND $expand = '{{ $expand }}'
AND $skiptoken = '{{ $skiptoken }}'
AND $top = '{{ $top }}'
;

Lifecycle Methods

download_by_billing_account_period

Generates the pricesheet for the provided billing period asynchronously based on the enrollment id

EXEC azure.consumption.price_sheets.download_by_billing_account_period 
@billingAccountId='{{ billingAccountId }}' --required, 
@billingPeriodName='{{ billingPeriodName }}' --required
;