ReservationsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

BillingManagementClient's

<xref:reservations> attribute.

Inheritance

builtins.object

ReservationsOperations

Constructor

ReservationsOperations(*args, **kwargs)

Methods

begin_update_by_billing_account	Update reservation by billing account.
get_by_reservation_order	Get Reservation details in the billing account. Get specific Reservation details in the billing account.
list_by_billing_account	Lists the reservations in the 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_reservation_order	Get Reservations in a given reservation Order in the billing account. List Reservations within a single ReservationOrder in the billing account.

begin_update_by_billing_account

Update reservation by billing account.

begin_update_by_billing_account(billing_account_name: str, reservation_order_id: str, reservation_id: str, body: _models.Patch, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.Reservation]

Parameters

Name	Description
billing_account_name Required	str The ID that uniquely identifies a billing account. Required.
reservation_order_id Required	str Order Id of the reservation. Required.
reservation_id Required	str Id of the reservation item. Required.
body Required	Patch or IO[bytes] Request body for patching a reservation. Is either a Patch type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[Reservation]	An instance of LROPoller that returns either Reservation or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_by_reservation_order

Get Reservation details in the billing account.

Get specific Reservation details in the billing account.

get_by_reservation_order(billing_account_name: str, reservation_order_id: str, reservation_id: str, expand: str | None = None, **kwargs: Any) -> Reservation

Parameters

Name	Description
billing_account_name Required	str The ID that uniquely identifies a billing account. Required.
reservation_order_id Required	str Order Id of the reservation. Required.
reservation_id Required	str Id of the reservation item. Required.
expand Required	str May be used to expand the detail information of some properties. Default value is None.

Returns

Type	Description
Reservation	Reservation or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_billing_account

Lists the reservations in the 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, order_by: str | None = None, skiptoken: float | None = None, refresh_summary: str | None = None, selected_state: str | None = None, take: float | 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 The filter query option allows clients to filter a collection of resources that are addressed by a request URL. Default value is None.
order_by Required	str The orderby query option allows clients to request resources in a particular order. Default value is None.
skiptoken Required	float The number of reservations to skip from the list before returning results. 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.
take Required	float The number of reservations to return in API response. Default value is None.

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, order_by: str | None = None, skiptoken: float | None = None, refresh_summary: str | None = None, selected_state: str | None = None, take: float | 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 The filter query option allows clients to filter a collection of resources that are addressed by a request URL. Default value is None.
order_by Required	str The orderby query option allows clients to request resources in a particular order. Default value is None.
skiptoken Required	float The number of reservations to skip from the list before returning results. 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.
take Required	float The number of reservations to return in API response. Default value is None.

Returns

Type	Description
ItemPaged[Reservation]	An iterator like instance of either Reservation or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_reservation_order

Get Reservations in a given reservation Order in the billing account.

List Reservations within a single ReservationOrder in the billing account.

list_by_reservation_order(billing_account_name: str, reservation_order_id: str, **kwargs: Any) -> Iterable[Reservation]

Parameters

Name	Description
billing_account_name Required	str The ID that uniquely identifies a billing account. Required.
reservation_order_id Required	str Order Id of the reservation. Required.

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.9\\x64\\Lib\\site-packages\\azure\\mgmt\\billing\\models\\__init__.py'>