ConsumptionExtensions.GetConsumptionReservationsDetails Method

Definition

Namespace:

Azure.ResourceManager.Consumption

Assembly:

Azure.ResourceManager.Consumption.dll

Package:

Azure.ResourceManager.Consumption v1.1.0-beta.2

Source:

ConsumptionExtensions.cs

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 static Azure.Pageable<Azure.ResourceManager.Consumption.Models.ConsumptionReservationDetail> GetConsumptionReservationsDetails (this Azure.ResourceManager.ArmClient client, Azure.Core.ResourceIdentifier scope, string startDate = default, string endDate = default, string filter = default, string reservationId = default, string reservationOrderId = default, System.Threading.CancellationToken cancellationToken = default);

static member GetConsumptionReservationsDetails : Azure.ResourceManager.ArmClient * Azure.Core.ResourceIdentifier * string * string * string * string * string * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.Consumption.Models.ConsumptionReservationDetail>

<Extension()>
Public Function GetConsumptionReservationsDetails (client As ArmClient, 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 Pageable(Of ConsumptionReservationDetail)

Parameters

client

ArmClient

The ArmClient instance the method will execute against.

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

Pageable<ConsumptionReservationDetail>

Exceptions

ArgumentNullException

client is null.