PriceSheetOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

ConsumptionManagementClient's

<xref:price_sheet> attribute.

Inheritance
builtins.object
PriceSheetOperations

Constructor

PriceSheetOperations(*args, **kwargs)

Methods

get

Gets the price sheet for a subscription. Price sheet is available via this API only for May 1, 2014 or later.
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.

get

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

get(expand: str | None = None, skiptoken: str | None = None, top: int | None = None, **kwargs: Any) -> PriceSheetResult

Parameters

Name Description
expand
Required
str

May be used to expand the properties/meterDetails within a price sheet. By default, these fields are not included when returning price sheet. Default value is None.
skiptoken
Required
str

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. Default value is None.
top
Required
int

May be used to limit the number of results to the top N results. Default value is None.

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
PriceSheetResult

PriceSheetResult, or the result of cls(response)

Exceptions

Type Description
HttpResponseError

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.

get_by_billing_period(billing_period_name: str, expand: str | None = None, skiptoken: str | None = None, top: int | None = None, **kwargs: Any) -> PriceSheetResult

Parameters

Name Description
billing_period_name
Required
str

Billing Period Name.
expand
Required
str

May be used to expand the properties/meterDetails within a price sheet. By default, these fields are not included when returning price sheet. Default value is None.
skiptoken
Required
str

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. Default value is None.
top
Required
int

May be used to limit the number of results to the top N results. Default value is None.

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
PriceSheetResult

PriceSheetResult, or the result of cls(response)

Exceptions

Type Description
HttpResponseError

Attributes

models 

models = <module 'azure.mgmt.consumption.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\consumption\\models\\__init__.py'>