Package com.azure.resourcemanager.consumption.models

Interface ReservationsSummaries

public interface ReservationsSummaries

Resource collection API of ReservationsSummaries.

Method Summary

Modifier and Type	Method	Description
com.azure.core.http.rest.PagedIterable<ReservationSummary>	list(String scope, Datagrain grain)	Lists the reservations summaries for the defined scope daily or monthly grain.
com.azure.core.http.rest.PagedIterable<ReservationSummary>	list(String scope, Datagrain grain, String startDate, String endDate, String filter, String reservationId, String reservationOrderId, com.azure.core.util.Context context)	Lists the reservations summaries for the defined scope daily or monthly grain.
com.azure.core.http.rest.PagedIterable<ReservationSummary>	listByReservationOrder(String reservationOrderId, Datagrain grain)	Lists the reservations summaries for daily or monthly grain.
com.azure.core.http.rest.PagedIterable<ReservationSummary>	listByReservationOrder(String reservationOrderId, Datagrain grain, String filter, com.azure.core.util.Context context)	Lists the reservations summaries for daily or monthly grain.
com.azure.core.http.rest.PagedIterable<ReservationSummary>	listByReservationOrderAndReservation(String reservationOrderId, String reservationId, Datagrain grain)	Lists the reservations summaries for daily or monthly grain.
com.azure.core.http.rest.PagedIterable<ReservationSummary>	listByReservationOrderAndReservation(String reservationOrderId, String reservationId, Datagrain grain, String filter, com.azure.core.util.Context context)	Lists the reservations summaries for daily or monthly grain.

Method Detail

listByReservationOrder

com.azure.core.http.rest.PagedIterable<ReservationSummary> listByReservationOrder(String reservationOrderId,
                                                                                  Datagrain grain)

Lists the reservations summaries for daily or monthly grain.

Parameters:

reservationOrderId - Order Id of the reservation.

grain - Can be daily or monthly.

Returns:

result of listing reservation summaries.

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<ReservationSummary> listByReservationOrder(String reservationOrderId,
                                                                                  Datagrain grain,
                                                                                  String filter,
                                                                                  com.azure.core.util.Context context)

Lists the reservations summaries for daily or monthly grain.

Parameters:

reservationOrderId - Order Id of the reservation.

grain - Can be daily or monthly.

filter - Required only for daily grain. 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 summaries.

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<ReservationSummary> listByReservationOrderAndReservation(String reservationOrderId,
                                                                                                String reservationId,
                                                                                                Datagrain grain)

Lists the reservations summaries for daily or monthly grain.

Parameters:

reservationOrderId - Order Id of the reservation.

reservationId - Id of the reservation.

grain - Can be daily or monthly.

Returns:

result of listing reservation summaries.

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<ReservationSummary> listByReservationOrderAndReservation(String reservationOrderId,
                                                                                                String reservationId,
                                                                                                Datagrain grain,
                                                                                                String filter,
                                                                                                com.azure.core.util.Context context)

Lists the reservations summaries for daily or monthly grain.

Parameters:

reservationOrderId - Order Id of the reservation.

reservationId - Id of the reservation.

grain - Can be daily or monthly.

filter - Required only for daily grain. 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 summaries.

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<ReservationSummary> list(String scope,
                                                                Datagrain grain)

Lists the reservations summaries for the defined scope daily or monthly grain.

Parameters:

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

grain - Can be daily or monthly.

Returns:

result of listing reservation summaries.

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<ReservationSummary> list(String scope,
                                                                Datagrain grain,
                                                                String startDate,
                                                                String endDate,
                                                                String filter,
                                                                String reservationId,
                                                                String reservationOrderId,
                                                                com.azure.core.util.Context context)

Lists the reservations summaries for the defined scope daily or monthly grain.

Parameters:

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

grain - Can be daily or monthly.

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

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

filter - Required only for daily grain. 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 summaries.

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.