Share via

ReservationsSummaries Interface

  • Reference
Package:
com.azure.resourcemanager.consumption.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-consumption:1.0.0-beta.3

public interface ReservationsSummaries

Resource collection API of ReservationsSummaries.

Method Summary

Modifier and Type Method and Description
abstract PagedIterable<ReservationSummary> list(String scope, Datagrain grain)

Lists the reservations summaries for the defined scope daily or monthly grain.
abstract PagedIterable<ReservationSummary> list(String scope, 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 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.

list

public abstract PagedIterable list(String scope, 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:

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.

listByReservationOrder

public abstract PagedIterable 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.

listByReservationOrder

public abstract PagedIterable 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.

listByReservationOrderAndReservation

public abstract PagedIterable 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.

listByReservationOrderAndReservation

public abstract PagedIterable 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.

Applies to