ReservationsDetailsClient Interface

Package:

com.azure.resourcemanager.consumption.fluent

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-consumption:1.0.0

public interface ReservationsDetailsClient

An instance of this class provides access to all the operations defined in ReservationsDetailsClient.

Method Summary

Modifier and Type	Method and Description
abstract PagedIterable<ReservationDetailInner>	list(String resourceScope) Lists the reservations details for the defined scope and provided date range.
abstract PagedIterable<ReservationDetailInner>	list(String resourceScope, String startDate, String endDate, String filter, String reservationId, String reservationOrderId, Context context) Lists the reservations details for the defined scope and provided date range.
abstract PagedIterable<ReservationDetailInner>	listByReservationOrder(String reservationOrderId, String filter) Lists the reservations details for provided date range.
abstract PagedIterable<ReservationDetailInner>	listByReservationOrder(String reservationOrderId, String filter, Context context) Lists the reservations details for provided date range.
abstract PagedIterable<ReservationDetailInner>	listByReservationOrderAndReservation(String reservationOrderId, String reservationId, String filter) Lists the reservations details for provided date range.
abstract PagedIterable<ReservationDetailInner>	listByReservationOrderAndReservation(String reservationOrderId, String reservationId, String filter, Context context) Lists the reservations details for provided date range.

Method Details

list

public abstract PagedIterable<ReservationDetailInner> list(String resourceScope)

Lists the reservations details for the defined scope and provided date range. 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:

resourceScope - The scope associated with reservations details operations. This includes '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for BillingAccount scope (legacy), and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope (modern).

Returns:

result of listing reservation details as paginated response with PagedIterable<T>.

list

public abstract PagedIterable<ReservationDetailInner> list(String resourceScope, String startDate, String endDate, String filter, String reservationId, String reservationOrderId, Context context)

Lists the reservations details for the defined scope and provided date range. 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:

resourceScope - The scope associated with reservations details operations. This includes '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for BillingAccount scope (legacy), and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope (modern).

startDate - Start date. Only applicable when querying with billing profile.

endDate - End date. Only applicable when querying with billing profile.

filter - Filter reservation details by date range. The properties/UsageDate for start date and end date. The filter supports 'le' and 'ge'. Not applicable when querying with billing profile.

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

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

context - The context to associate with this operation.

Returns:

result of listing reservation details as paginated response with PagedIterable<T>.

listByReservationOrder

public abstract PagedIterable<ReservationDetailInner> listByReservationOrder(String reservationOrderId, String filter)

Lists the reservations details for provided date range. 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:

reservationOrderId - Order Id of the reservation.

filter - Filter reservation details by date range. The properties/UsageDate for start date and end date. The filter supports 'le' and 'ge'.

Returns:

result of listing reservation details as paginated response with PagedIterable<T>.

listByReservationOrder

public abstract PagedIterable<ReservationDetailInner> listByReservationOrder(String reservationOrderId, String filter, Context context)

Lists the reservations details for provided date range. 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:

reservationOrderId - Order Id of the reservation.

filter - Filter reservation details by date range. The properties/UsageDate for start date and end date. The filter supports 'le' and 'ge'.

context - The context to associate with this operation.

Returns:

result of listing reservation details as paginated response with PagedIterable<T>.

listByReservationOrderAndReservation

public abstract PagedIterable<ReservationDetailInner> listByReservationOrderAndReservation(String reservationOrderId, String reservationId, String filter)

Lists the reservations details for provided date range. 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:

reservationOrderId - Order Id of the reservation.

reservationId - Id of the reservation.

filter - Filter reservation details by date range. The properties/UsageDate for start date and end date. The filter supports 'le' and 'ge'.

Returns:

result of listing reservation details as paginated response with PagedIterable<T>.

listByReservationOrderAndReservation

public abstract PagedIterable<ReservationDetailInner> listByReservationOrderAndReservation(String reservationOrderId, String reservationId, String filter, Context context)

Lists the reservations details for provided date range. 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:

reservationOrderId - Order Id of the reservation.

reservationId - Id of the reservation.

filter - Filter reservation details by date range. The properties/UsageDate for start date and end date. The filter supports 'le' and 'ge'.

context - The context to associate with this operation.

Returns:

result of listing reservation details as paginated response with PagedIterable<T>.