ReservationsSummariesOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
<xref:reservations_summaries> attribute.
Constructor
ReservationsSummariesOperations(*args, **kwargs)Methods
| list |
Lists the reservations summaries for the defined scope daily or monthly grain. Note: ARM has a payload size limit of 12MB, so currently callers get 400 when the response size exceeds the ARM limit. In such cases, API call should be made with smaller date ranges. |
| list_by_reservation_order |
Lists the reservations summaries for daily or monthly grain. Note: ARM has a payload size limit of 12MB, so currently callers get 400 when the response size exceeds the ARM limit. In such cases, API call should be made with smaller date ranges. |
| list_by_reservation_order_and_reservation |
Lists the reservations summaries for daily or monthly grain. Note: ARM has a payload size limit of 12MB, so currently callers get 400 when the response size exceeds the ARM limit. In such cases, API call should be made with smaller date ranges. |
list
Lists the reservations summaries for the defined scope daily or monthly grain. Note: ARM has a payload size limit of 12MB, so currently callers get 400 when the response size exceeds the ARM limit. In such cases, API call should be made with smaller date ranges.
list(resource_scope: str, *, grain: str | Datagrain, start_date: str | None = None, end_date: str | None = None, filter: str | None = None, reservation_id: str | None = None, reservation_order_id: str | None = None, **kwargs: Any) -> ItemPaged[ReservationSummary]Parameters
| Name | Description |
|---|---|
|
resource_scope
Required
|
The fully qualified Azure Resource manager identifier of the resource. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
grain
|
Can be daily or monthly. Known values are: "daily" and "monthly". Required. |
|
start_date
|
Start date. Only applicable when querying with billing profile. Default value is None. Default value: None
|
|
end_date
|
End date. Only applicable when querying with billing profile. Default value is None. Default value: None
|
|
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. Default value is None. Default value: None
|
|
reservation_id
|
Reservation Id GUID. Only valid if reservationOrderId is also provided. Filter to a specific reservation. Default value is None. Default value: None
|
|
reservation_order_id
|
Reservation Order Id GUID. Required if reservationId is provided. Filter to a specific reservation order. Default value is None. Default value: None
|
Returns
| Type | Description |
|---|---|
|
An iterator like instance of ReservationSummary |
Exceptions
| Type | Description |
|---|---|
list_by_reservation_order
Lists the reservations summaries for daily or monthly grain. Note: ARM has a payload size limit of 12MB, so currently callers get 400 when the response size exceeds the ARM limit. In such cases, API call should be made with smaller date ranges.
list_by_reservation_order(reservation_order_id: str, *, grain: str | Datagrain, filter: str | None = None, **kwargs: Any) -> ItemPaged[ReservationSummary]Parameters
| Name | Description |
|---|---|
|
reservation_order_id
Required
|
Order Id of the reservation. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
grain
|
Can be daily or monthly. Known values are: "daily" and "monthly". Required. |
|
filter
|
Required only for daily grain. The properties/UsageDate for start date and end date. The filter supports 'le' and 'ge'. Default value is None. Default value: None
|
Returns
| Type | Description |
|---|---|
|
An iterator like instance of ReservationSummary |
Exceptions
| Type | Description |
|---|---|
list_by_reservation_order_and_reservation
Lists the reservations summaries for daily or monthly grain. Note: ARM has a payload size limit of 12MB, so currently callers get 400 when the response size exceeds the ARM limit. In such cases, API call should be made with smaller date ranges.
list_by_reservation_order_and_reservation(reservation_order_id: str, reservation_id: str, *, grain: str | Datagrain, filter: str | None = None, **kwargs: Any) -> ItemPaged[ReservationSummary]Parameters
| Name | Description |
|---|---|
|
reservation_order_id
Required
|
Order Id of the reservation. Required. |
|
reservation_id
Required
|
Id of the reservation. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
grain
|
Can be daily or monthly. Known values are: "daily" and "monthly". Required. |
|
filter
|
Required only for daily grain. The properties/UsageDate for start date and end date. The filter supports 'le' and 'ge'. Default value is None. Default value: None
|
Returns
| Type | Description |
|---|---|
|
An iterator like instance of ReservationSummary |
Exceptions
| Type | Description |
|---|---|
