Share via


MockableConsumptionArmClient.GetConsumptionReservationsDetailsAsync Method

Definition

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 502 when the response size exceeds the ARM limit. In such cases, API call should be made with smaller date ranges.

  • Request Path: /{resourceScope}/providers/Microsoft.Consumption/reservationDetails
  • Operation Id: ReservationsDetails_List
public virtual Azure.AsyncPageable<Azure.ResourceManager.Consumption.Models.ConsumptionReservationDetail> GetConsumptionReservationsDetailsAsync (Azure.Core.ResourceIdentifier scope, string startDate = default, string endDate = default, string filter = default, string reservationId = default, string reservationOrderId = default, System.Threading.CancellationToken cancellationToken = default);
abstract member GetConsumptionReservationsDetailsAsync : Azure.Core.ResourceIdentifier * string * string * string * string * string * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.Consumption.Models.ConsumptionReservationDetail>
override this.GetConsumptionReservationsDetailsAsync : Azure.Core.ResourceIdentifier * string * string * string * string * string * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.Consumption.Models.ConsumptionReservationDetail>
Public Overridable Function GetConsumptionReservationsDetailsAsync (scope As ResourceIdentifier, Optional startDate As String = Nothing, Optional endDate As String = Nothing, Optional filter As String = Nothing, Optional reservationId As String = Nothing, Optional reservationOrderId As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of ConsumptionReservationDetail)

Parameters

scope
ResourceIdentifier

The scope that the resource will apply against.

startDate
String

Start date. Only applicable when querying with billing profile.

endDate
String

End date. Only applicable when querying with billing profile.

filter
String

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
String

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

reservationOrderId
String

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

cancellationToken
CancellationToken

The cancellation token to use.

Returns

An async collection of ConsumptionReservationDetail that may take multiple service requests to iterate over.

Exceptions

scope is null.

Applies to