ReservationsDetailsOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
<xref:reservations_details> attribute.
Constructor
ReservationsDetailsOperations(*args, **kwargs)Methods
| list |
Lists the reservations details for provided date range. Note: ARM has a payload size limit of 12MB, so currently callers get 400 when the response size exceeds the ARM limit. If the data size is too large, customers may also get 504 as the API timed out preparing the data. In such cases, API call should be made with smaller date ranges or a call to Generate Reservation Details Report API should be made as it is asynchronous and will not run into response size time outs. |
| list_by_reservation_order |
Lists the reservations details for provided date range. Note: ARM has a payload size limit of 12MB, so currently callers get 400 when the response size exceeds the ARM limit. If the data size is too large, customers may also get 504 as the API timed out preparing the data. In such cases, API call should be made with smaller date ranges or a call to Generate Reservation Details Report API should be made as it is asynchronous and will not run into response size time outs. |
| list_by_reservation_order_and_reservation |
Lists the reservations details for provided date range. Note: ARM has a payload size limit of 12MB, so currently callers get 400 when the response size exceeds the ARM limit. If the data size is too large, customers may also get 504 as the API timed out preparing the data. In such cases, API call should be made with smaller date ranges or a call to Generate Reservation Details Report API should be made as it is asynchronous and will not run into response size time outs. |
list
Lists the reservations details for provided date range. Note: ARM has a payload size limit of 12MB, so currently callers get 400 when the response size exceeds the ARM limit. If the data size is too large, customers may also get 504 as the API timed out preparing the data. In such cases, API call should be made with smaller date ranges or a call to Generate Reservation Details Report API should be made as it is asynchronous and will not run into response size time outs.
list(resource_scope: str, *, 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[ReservationDetail]Parameters
| Name | Description |
|---|---|
|
resource_scope
Required
|
The fully qualified Azure Resource manager identifier of the resource. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
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
|
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. 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 ReservationDetail |
Exceptions
| Type | Description |
|---|---|
list_by_reservation_order
Lists the reservations details for provided date range. Note: ARM has a payload size limit of 12MB, so currently callers get 400 when the response size exceeds the ARM limit. If the data size is too large, customers may also get 504 as the API timed out preparing the data. In such cases, API call should be made with smaller date ranges or a call to Generate Reservation Details Report API should be made as it is asynchronous and will not run into response size time outs.
list_by_reservation_order(reservation_order_id: str, *, filter: str, **kwargs: Any) -> ItemPaged[ReservationDetail]Parameters
| Name | Description |
|---|---|
|
reservation_order_id
Required
|
Order Id of the reservation. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
filter
|
Filter reservation details by date range. The properties/UsageDate for start date and end date. The filter supports 'le' and 'ge'. Required. |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of ReservationDetail |
Exceptions
| Type | Description |
|---|---|
list_by_reservation_order_and_reservation
Lists the reservations details for provided date range. Note: ARM has a payload size limit of 12MB, so currently callers get 400 when the response size exceeds the ARM limit. If the data size is too large, customers may also get 504 as the API timed out preparing the data. In such cases, API call should be made with smaller date ranges or a call to Generate Reservation Details Report API should be made as it is asynchronous and will not run into response size time outs.
list_by_reservation_order_and_reservation(reservation_order_id: str, reservation_id: str, *, filter: str, **kwargs: Any) -> ItemPaged[ReservationDetail]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 |
|---|---|
|
filter
|
Filter reservation details by date range. The properties/UsageDate for start date and end date. The filter supports 'le' and 'ge'. Required. |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of ReservationDetail |
Exceptions
| Type | Description |
|---|---|
