ReservationsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

BillingManagementClient's

<xref:reservations> attribute.

Constructor

ReservationsOperations(*args, **kwargs)

Methods

list_by_billing_account	Lists the reservations for a billing account and the roll up counts of reservations group by provisioning states.
list_by_billing_profile	Lists the reservations for a billing profile and the roll up counts of reservations group by provisioning state.

list_by_billing_account

Lists the reservations for a billing account and the roll up counts of reservations group by provisioning states.

list_by_billing_account(billing_account_name: str, filter: str | None = None, orderby: str | None = None, refresh_summary: str | None = None, selected_state: str | None = None, **kwargs: Any) -> Iterable[Reservation]

Parameters

Name	Description
billing_account_name Required	str The ID that uniquely identifies a billing account. Required.
filter Required	str May be used to filter by reservation properties. The filter supports 'eq', 'or', and 'and'. It does not currently support 'ne', 'gt', 'le', 'ge', or 'not'. Default value is None.
orderby Required	str May be used to sort order by reservation properties. Default value is None.
refresh_summary Required	str To indicate whether to refresh the roll up counts of the reservations group by provisioning states. Default value is None.
selected_state Required	str The selected provisioning state. 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
ItemPaged[Reservation]	An iterator like instance of either Reservation or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_billing_profile

Lists the reservations for a billing profile and the roll up counts of reservations group by provisioning state.

list_by_billing_profile(billing_account_name: str, billing_profile_name: str, filter: str | None = None, orderby: str | None = None, refresh_summary: str | None = None, selected_state: str | None = None, **kwargs: Any) -> Iterable[Reservation]

Parameters

Name	Description
billing_account_name Required	str The ID that uniquely identifies a billing account. Required.
billing_profile_name Required	str The ID that uniquely identifies a billing profile. Required.
filter Required	str May be used to filter by reservation properties. The filter supports 'eq', 'or', and 'and'. It does not currently support 'ne', 'gt', 'le', 'ge', or 'not'. Default value is None.
orderby Required	str May be used to sort order by reservation properties. Default value is None.
refresh_summary Required	str To indicate whether to refresh the roll up counts of the reservations group by provisioning state. Default value is None.
selected_state Required	str The selected provisioning state. 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
ItemPaged[Reservation]	An iterator like instance of either Reservation or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.billing.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.10\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv72\\Lib\\site-packages\\azure\\mgmt\\billing\\models\\__init__.py'>