ReservationsSummariesOperations Class

ReservationsSummariesOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance

builtins.object

ReservationsSummariesOperations

Constructor

ReservationsSummariesOperations(client, config, serializer, deserializer)

Parameters

client

Required

Client for service requests.

config

Required

Configuration of service client.

serializer

Required

An object model serializer.

deserializer

Required

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

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(scope: str, grain: Union[str, _models.Datagrain], start_date: Optional[str] = None, end_date: Optional[str] = None, filter: Optional[str] = None, reservation_id: Optional[str] = None, reservation_order_id: Optional[str] = None, **kwargs: Any) -> Iterable[_models.ReservationSummariesListResult]

Parameters

scope

str

Required

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

str or Datagrain

Required

Can be daily or monthly.

start_date

str

default value: None

Start date. Only applicable when querying with billing profile.

end_date

str

default value: None

End date. Only applicable when querying with billing profile.

filter

str

default value: None

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.

reservation_id

str

default value: None

Reservation Id GUID. Only valid if reservationOrderId is also provided. Filter to a specific reservation.

reservation_order_id

str

default value: None

Reservation Order Id GUID. Required if reservationId is provided. Filter to a specific reservation order.

cls

callable

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

Returns

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

Return type

ItemPaged[ReservationSummariesListResult]

Exceptions

HttpResponseError

list_by_reservation_order

Lists the reservations summaries for daily or monthly grain.

list_by_reservation_order(reservation_order_id: str, grain: Union[str, _models.Datagrain], filter: Optional[str] = None, **kwargs: Any) -> Iterable[_models.ReservationSummariesListResult]

Parameters

reservation_order_id

str

Required

Order Id of the reservation.

grain

str or Datagrain

Required

Can be daily or monthly.

filter

str

default value: None

Required only for daily grain. The properties/UsageDate for start date and end date. The filter supports 'le' and 'ge'.

cls

callable

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

Returns

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

Return type

ItemPaged[ReservationSummariesListResult]

Exceptions

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: Union[str, _models.Datagrain], filter: Optional[str] = None, **kwargs: Any) -> Iterable[_models.ReservationSummariesListResult]

Parameters

reservation_order_id

str

Required

Order Id of the reservation.

reservation_id

str

Required

Id of the reservation.

grain

str or Datagrain

Required

Can be daily or monthly.

filter

str

default value: None

Required only for daily grain. The properties/UsageDate for start date and end date. The filter supports 'le' and 'ge'.

cls

callable

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

Returns

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

Return type

ItemPaged[ReservationSummariesListResult]

Exceptions

HttpResponseError

Attributes

models

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