Package com.azure.resourcemanager.consumption.models

Interface ReservationsDetails

public interface ReservationsDetails

Resource collection API of ReservationsDetails.

Method Summary

Modifier and Type	Method	Description
com.azure.core.http.rest.PagedIterable<ReservationDetail>	list(String scope)	Lists the reservations details for the defined scope and provided date range.
com.azure.core.http.rest.PagedIterable<ReservationDetail>	list(String scope, String startDate, String endDate, String filter, String reservationId, String reservationOrderId, com.azure.core.util.Context context)	Lists the reservations details for the defined scope and provided date range.
com.azure.core.http.rest.PagedIterable<ReservationDetail>	listByReservationOrder(String reservationOrderId, String filter)	Lists the reservations details for provided date range.
com.azure.core.http.rest.PagedIterable<ReservationDetail>	listByReservationOrder(String reservationOrderId, String filter, com.azure.core.util.Context context)	Lists the reservations details for provided date range.
com.azure.core.http.rest.PagedIterable<ReservationDetail>	listByReservationOrderAndReservation(String reservationOrderId, String reservationId, String filter)	Lists the reservations details for provided date range.
com.azure.core.http.rest.PagedIterable<ReservationDetail>	listByReservationOrderAndReservation(String reservationOrderId, String reservationId, String filter, com.azure.core.util.Context context)	Lists the reservations details for provided date range.

Method Detail

listByReservationOrder

com.azure.core.http.rest.PagedIterable<ReservationDetail> listByReservationOrder(String reservationOrderId,
                                                                                 String filter)

Lists the reservations details for provided date range.

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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listByReservationOrder

com.azure.core.http.rest.PagedIterable<ReservationDetail> listByReservationOrder(String reservationOrderId,
                                                                                 String filter,
                                                                                 com.azure.core.util.Context context)

Lists the reservations details for provided date range.

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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listByReservationOrderAndReservation

com.azure.core.http.rest.PagedIterable<ReservationDetail> listByReservationOrderAndReservation(String reservationOrderId,
                                                                                               String reservationId,
                                                                                               String filter)

Lists the reservations details for provided date range.

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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listByReservationOrderAndReservation

com.azure.core.http.rest.PagedIterable<ReservationDetail> listByReservationOrderAndReservation(String reservationOrderId,
                                                                                               String reservationId,
                                                                                               String filter,
                                                                                               com.azure.core.util.Context context)

Lists the reservations details for provided date range.

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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

list

com.azure.core.http.rest.PagedIterable<ReservationDetail> list(String scope)

Lists the reservations details for the defined scope and provided date range.

Parameters:

scope - 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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

list

com.azure.core.http.rest.PagedIterable<ReservationDetail> list(String scope,
                                                               String startDate,
                                                               String endDate,
                                                               String filter,
                                                               String reservationId,
                                                               String reservationOrderId,
                                                               com.azure.core.util.Context context)

Lists the reservations details for the defined scope and provided date range.

Parameters:

scope - 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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.