Compartilhar via

ReservationsSummariesOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

ConsumptionManagementClient's

<xref:reservations_summaries> attribute.

Inheritance
builtins.object
ReservationsSummariesOperations

Constructor

ReservationsSummariesOperations(*args, **kwargs)

Methods

list

Lists the reservations summaries for the defined scope daily or monthly grain.
list_by_reservation_order

Lists the reservations summaries for daily or monthly grain.
list_by_reservation_order_and_reservation

Lists the reservations summaries for daily or monthly grain.

list

Lists the reservations summaries for the defined scope daily or monthly grain.

list(resource_scope: str, grain: str | Datagrain, start_date: str | None = None, end_date: str | None = None, filter: str | None = None, reservation_id: str | None = None, reservation_order_id: str | None = None, **kwargs: Any) -> AsyncIterable[ReservationSummariesListResult]

Parameters

Name Description
resource_scope
Required
str

The scope associated with reservations summaries operations. This includes '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for BillingAccount scope (legacy), and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope (modern).
grain
Required
str or Datagrain

Can be daily or monthly.
start_date
Required
str

Start date. Only applicable when querying with billing profile. Default value is None.
end_date
Required
str

End date. Only applicable when querying with billing profile. Default value is None.
filter
Required
str

Required only for daily grain. The properties/UsageDate for start date and end date. The filter supports 'le' and 'ge'. Not applicable when querying with billing profile. Default value is None.
reservation_id
Required
str

Reservation Id GUID. Only valid if reservationOrderId is also provided. Filter to a specific reservation. Default value is None.
reservation_order_id
Required
str

Reservation Order Id GUID. Required if reservationId is provided. Filter to a specific reservation order. 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
AsyncItemPaged[ReservationSummariesListResult]

An iterator like instance of either ReservationSummariesListResult or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_by_reservation_order

Lists the reservations summaries for daily or monthly grain.

list_by_reservation_order(reservation_order_id: str, grain: str | Datagrain, filter: str | None = None, **kwargs: Any) -> AsyncIterable[ReservationSummariesListResult]

Parameters

Name Description
reservation_order_id
Required
str

Order Id of the reservation.
grain
Required
str or Datagrain

Can be daily or monthly.
filter
Required
str

Required only for daily grain. The properties/UsageDate for start date and end date. The filter supports 'le' and 'ge'. 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
AsyncItemPaged[ReservationSummariesListResult]

An iterator like instance of either ReservationSummariesListResult or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_by_reservation_order_and_reservation

Lists the reservations summaries for daily or monthly grain.

list_by_reservation_order_and_reservation(reservation_order_id: str, reservation_id: str, grain: str | Datagrain, filter: str | None = None, **kwargs: Any) -> AsyncIterable[ReservationSummariesListResult]

Parameters

Name Description
reservation_order_id
Required
str

Order Id of the reservation.
reservation_id
Required
str

Id of the reservation.
grain
Required
str or Datagrain

Can be daily or monthly.
filter
Required
str

Required only for daily grain. The properties/UsageDate for start date and end date. The filter supports 'le' and 'ge'. 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
AsyncItemPaged[ReservationSummariesListResult]

An iterator like instance of either ReservationSummariesListResult 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'>