ReservationSummaryProperties Class

The properties of the reservation summary.

Constructor

ReservationSummaryProperties(*args: Any, **kwargs: Any)

Variables

Name Description
reservation_order_id
str

The reservation order ID is the identifier for a reservation purchase. Each reservation order ID represents a single purchase transaction. A reservation order contains reservations. The reservation order specifies the VM size and region for the reservations.

reservation_id
str

The reservation ID is the identifier of a reservation within a reservation order. Each reservation is the grouping for applying the benefit scope and also specifies the number of instances to which the reservation benefit can be applied to.

sku_name
str

This is the ARM Sku name. It can be used to join with the serviceType field in additional info in usage records.

reserved_hours

This is the total hours reserved. E.g. if reservation for 1 instance was made on 1 PM, this will be 11 hours for that day and 24 hours from subsequent days.

usage_date

Data corresponding to the utilization record. If the grain of data is monthly, it will be first day of month.

used_hours

Total used hours by the reservation.

min_utilization_percentage

This is the minimum hourly utilization in the usage time (day or month). E.g. if usage record corresponds to 12/10/2017 and on that for hour 4 and 5, utilization was 10%, this field will return 10% for that day.

avg_utilization_percentage

This is average utilization for the entire time range. (day or month depending on the grain).

max_utilization_percentage

This is the maximum hourly utilization in the usage time (day or month). E.g. if usage record corresponds to 12/10/2017 and on that for hour 4 and 5, utilization was 100%, this field will return 100% for that day.

kind
str

The reservation kind.

purchased_quantity

This is the purchased quantity for the reservationId.

remaining_quantity

This is the remaining quantity for the reservationId.

total_reserved_quantity

This is the total count of instances that are reserved for the reservationId.

used_quantity

This is the used quantity for the reservationId.

utilized_percentage

This is the utilized percentage for the reservation Id.

Attributes

avg_utilization_percentage

This is average utilization for the entire time range. (day or month depending on the grain).

avg_utilization_percentage: Decimal | None

kind

The reservation kind.

kind: str | None

max_utilization_percentage

This is the maximum hourly utilization in the usage time (day or month). E.g. if usage record corresponds to 12/10/2017 and on that for hour 4 and 5, utilization was 100%, this field will return 100% for that day.

max_utilization_percentage: Decimal | None

min_utilization_percentage

This is the minimum hourly utilization in the usage time (day or month). E.g. if usage record corresponds to 12/10/2017 and on that for hour 4 and 5, utilization was 10%, this field will return 10% for that day.

min_utilization_percentage: Decimal | None

purchased_quantity

This is the purchased quantity for the reservationId.

purchased_quantity: Decimal | None

remaining_quantity

This is the remaining quantity for the reservationId.

remaining_quantity: Decimal | None

reservation_id

The reservation ID is the identifier of a reservation within a reservation order. Each reservation is the grouping for applying the benefit scope and also specifies the number of instances to which the reservation benefit can be applied to.

reservation_id: str | None

reservation_order_id

The reservation order ID is the identifier for a reservation purchase. Each reservation order ID represents a single purchase transaction. A reservation order contains reservations. The reservation order specifies the VM size and region for the reservations.

reservation_order_id: str | None

reserved_hours

This is the total hours reserved. E.g. if reservation for 1 instance was made on 1 PM, this will be 11 hours for that day and 24 hours from subsequent days.

reserved_hours: Decimal | None

sku_name

This is the ARM Sku name. It can be used to join with the serviceType field in additional info in usage records.

sku_name: str | None

total_reserved_quantity

This is the total count of instances that are reserved for the reservationId.

total_reserved_quantity: Decimal | None

usage_date

Data corresponding to the utilization record. If the grain of data is monthly, it will be first day of month.

usage_date: datetime | None

used_hours

Total used hours by the reservation.

used_hours: Decimal | None

used_quantity

This is the used quantity for the reservationId.

used_quantity: Decimal | None

utilized_percentage

This is the utilized percentage for the reservation Id.

utilized_percentage: Decimal | None