ReservationsSummaries Interface

Package:

com.azure.resourcemanager.consumption.models

Maven Artifact:

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

public interface ReservationsSummaries

Resource collection API of ReservationsSummaries.

Method Summary

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

Method Details

list

public abstract PagedIterable<ReservationSummary> list(String resourceScope, Datagrain grain)

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

Parameters:

resourceScope - 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 as paginated response with PagedIterable<T>.

list

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

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

Parameters:

resourceScope - 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 as paginated response with PagedIterable<T>.

listByReservationOrder

public abstract 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 as paginated response with PagedIterable<T>.

listByReservationOrder

public abstract PagedIterable<ReservationSummary> listByReservationOrder(String reservationOrderId, Datagrain grain, String filter, 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 as paginated response with PagedIterable<T>.

listByReservationOrderAndReservation

public abstract 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 as paginated response with PagedIterable<T>.

listByReservationOrderAndReservation

public abstract PagedIterable<ReservationSummary> listByReservationOrderAndReservation(String reservationOrderId, String reservationId, Datagrain grain, String filter, 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 as paginated response with PagedIterable<T>.