reservation_transactions

Creates, updates, deletes, gets or lists a reservation_transactions resource.

Overview

Name	reservation_transactions
Type	Resource
Id	azure.consumption.reservation_transactions

Fields

The following fields are returned by SELECT queries:

list_by_billing_profile

OK. The request has succeeded.

Name	Datatype	Description
id	string	Resource Id.
name	string	Resource name.
properties	object	The properties of a modern reservation transaction. (title: Reservation Transaction properties)
tags	array	Resource tags.
type	string	Resource type.

list

OK. The request has succeeded.

Name	Datatype	Description
id	string	Resource Id.
name	string	Resource name.
properties	object	The properties of a legacy reservation transaction. (title: Reservation Transaction properties)
tags	array	Resource tags.
type	string	Resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_by_billing_profile	select	billingAccountId, billingProfileId	$filter	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	select	billingAccountId	$filter, useMarkupIfPartner, previewMarkupPercentage	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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
billingAccountId	string	BillingAccount ID
billingProfileId	string	Azure Billing Profile ID.
$filter	string	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)
previewMarkupPercentage	number (decimal)	Preview markup percentage to be applied.
useMarkupIfPartner	boolean	Applies mark up to the transactions if the caller is a partner.

SELECT examples

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.

SELECT
id,
name,
properties,
tags,
type
FROM azure.consumption.reservation_transactions
WHERE billingAccountId = '{{ billingAccountId }}' -- required
AND billingProfileId = '{{ billingProfileId }}' -- required
AND $filter = '{{ $filter }}'
;

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.

SELECT
id,
name,
properties,
tags,
type
FROM azure.consumption.reservation_transactions
WHERE billingAccountId = '{{ billingAccountId }}' -- required
AND $filter = '{{ $filter }}'
AND useMarkupIfPartner = '{{ useMarkupIfPartner }}'
AND previewMarkupPercentage = '{{ previewMarkupPercentage }}'
;