ReservationsDetailsOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
<xref:reservations_details> attribute.
- Inheritance
-
builtins.objectReservationsDetailsOperations
Constructor
ReservationsDetailsOperations(*args, **kwargs)
Methods
list |
Lists the reservations details for the defined scope and provided date range. |
list_by_reservation_order |
Lists the reservations details for provided date range. |
list_by_reservation_order_and_reservation |
Lists the reservations details for provided date range. |
list
Lists the reservations details for the defined scope and provided date range.
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) -> Iterable[ReservationDetailsListResult]
Parameters
Name | Description |
---|---|
resource_scope
Required
|
The scope associated with reservations details operations. This includes '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for BillingAccount scope (legacy), and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope (modern). |
start_date
Required
|
Start date. Only applicable when querying with billing profile. Default value is None. |
end_date
Required
|
End date. Only applicable when querying with billing profile. Default value is None. |
filter
Required
|
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. |
reservation_id
Required
|
Reservation Id GUID. Only valid if reservationOrderId is also provided. Filter to a specific reservation. Default value is None. |
reservation_order_id
Required
|
Reservation Order Id GUID. Required if reservationId is provided. Filter to a specific reservation order. Default value is None. |
Keyword-Only Parameters
Name | Description |
---|---|
cls
|
A custom type or function that will be passed the direct response |
Returns
Type | Description |
---|---|
An iterator like instance of either ReservationDetailsListResult or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_by_reservation_order
Lists the reservations details for provided date range.
list_by_reservation_order(reservation_order_id: str, filter: str, **kwargs: Any) -> Iterable[ReservationDetailsListResult]
Parameters
Name | Description |
---|---|
reservation_order_id
Required
|
Order Id of the reservation. |
filter
Required
|
Filter reservation details by date range. The properties/UsageDate for start date and end date. The filter supports 'le' and 'ge'. |
Keyword-Only Parameters
Name | Description |
---|---|
cls
|
A custom type or function that will be passed the direct response |
Returns
Type | Description |
---|---|
An iterator like instance of either ReservationDetailsListResult or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_by_reservation_order_and_reservation
Lists the reservations details for provided date range.
list_by_reservation_order_and_reservation(reservation_order_id: str, reservation_id: str, filter: str, **kwargs: Any) -> Iterable[ReservationDetailsListResult]
Parameters
Name | Description |
---|---|
reservation_order_id
Required
|
Order Id of the reservation. |
reservation_id
Required
|
Id of the reservation. |
filter
Required
|
Filter reservation details by date range. The properties/UsageDate for start date and end date. The filter supports 'le' and 'ge'. |
Keyword-Only Parameters
Name | Description |
---|---|
cls
|
A custom type or function that will be passed the direct response |
Returns
Type | Description |
---|---|
An iterator like instance of either ReservationDetailsListResult or the result of cls(response) |
Exceptions
Type | Description |
---|---|
Attributes
models
models = <module 'azure.mgmt.consumption.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\consumption\\models\\__init__.py'>
Azure SDK for Python