ReservationTransactionsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

ConsumptionManagementClient's

<xref:reservation_transactions> attribute.

Constructor

ReservationTransactionsOperations(*args, **kwargs)

Methods

list

List of transactions for reserved instances on billing account scope. Note: The refund transactions are posted along with its purchase transaction (i.e. in the purchase billing month). For example, The refund is requested in May 2021. This refund transaction will have event date as May 2021 but the billing month as April 2020 when the reservation purchase was made. Note: ARM has a payload size limit of 12MB, so currently callers get 400 when the response size exceeds the ARM limit. In such cases, API call should be made with smaller date ranges.

list_by_billing_profile

List of transactions for reserved instances on billing profile scope. The refund transactions are posted along with its purchase transaction (i.e. in the purchase billing month). For example, The refund is requested in May 2021. This refund transaction will have event date as May 2021 but the billing month as April 2020 when the reservation purchase was made. Note: ARM has a payload size limit of 12MB, so currently callers get 400 when the response size exceeds the ARM limit. In such cases, API call should be made with smaller date ranges.

list

List of transactions for reserved instances on billing account scope. Note: The refund transactions are posted along with its purchase transaction (i.e. in the purchase billing month). For example, The refund is requested in May 2021. This refund transaction will have event date as May 2021 but the billing month as April 2020 when the reservation purchase was made. Note: ARM has a payload size limit of 12MB, so currently callers get 400 when the response size exceeds the ARM limit. In such cases, API call should be made with smaller date ranges.

list(billing_account_id: str, *, filter: str | None = None, use_markup_if_partner: bool | None = None, preview_markup_percentage: Decimal | None = None, **kwargs: Any) -> ItemPaged[ReservationTransaction]

Parameters

Name Description
billing_account_id
Required
str

BillingAccount ID. Required.

Keyword-Only Parameters

Name Description
filter
str

Filter reservation transactions by date range. The properties/EventDate for start date and end date. The filter supports 'le' and 'ge'. Note: API returns data for the entire start date's and end date's billing month. For example, filter properties/eventDate+ge+2020-01-01+AND+properties/eventDate+le+2020-12-29 will include data for the entire December 2020 month (i.e. will contain records for dates December 30 and 31). Default value is None.

Default value: None
use_markup_if_partner

Applies mark up to the transactions if the caller is a partner. Default value is None.

Default value: None
preview_markup_percentage

Preview markup percentage to be applied. Default value is None.

Default value: None

Returns

Type Description

An iterator like instance of ReservationTransaction

Exceptions

Type Description

list_by_billing_profile

List of transactions for reserved instances on billing profile scope. The refund transactions are posted along with its purchase transaction (i.e. in the purchase billing month). For example, The refund is requested in May 2021. This refund transaction will have event date as May 2021 but the billing month as April 2020 when the reservation purchase was made. Note: ARM has a payload size limit of 12MB, so currently callers get 400 when the response size exceeds the ARM limit. In such cases, API call should be made with smaller date ranges.

list_by_billing_profile(billing_account_id: str, billing_profile_id: str, *, filter: str | None = None, **kwargs: Any) -> ItemPaged[ModernReservationTransaction]

Parameters

Name Description
billing_account_id
Required
str

BillingAccount ID. Required.

billing_profile_id
Required
str

Azure Billing Profile ID. Required.

Keyword-Only Parameters

Name Description
filter
str

Filter reservation transactions by date range. The properties/EventDate for start date and end date. The filter supports 'le' and 'ge'. Note: API returns data for the entire start date's and end date's billing month. For example, filter properties/eventDate+ge+2020-01-01+AND+properties/eventDate+le+2020-12-29 will include data for entire December 2020 month (i.e. will contain records for dates December 30 and 31). Default value is None.

Default value: None

Returns

Type Description

An iterator like instance of ModernReservationTransaction

Exceptions

Type Description