Share via

ReservationSummary interface

  • Reference
Package:
@azure/arm-consumption

reservation summary resource.

Extends
Resource

Properties

avgUtilizationPercentage

This is average utilization for the entire time range. (day or month depending on the grain) NOTE: This property will not be serialized. It can only be populated by the server.
kind

The reservation kind. NOTE: This property will not be serialized. It can only be populated by the server.
maxUtilizationPercentage

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. NOTE: This property will not be serialized. It can only be populated by the server.
minUtilizationPercentage

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 NOTE: This property will not be serialized. It can only be populated by the server.
purchasedQuantity

This is the purchased quantity for the reservationId. NOTE: This property will not be serialized. It can only be populated by the server.
remainingQuantity

This is the remaining quantity for the reservationId. NOTE: This property will not be serialized. It can only be populated by the server.
reservationId

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. NOTE: This property will not be serialized. It can only be populated by the server.
reservationOrderId

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. NOTE: This property will not be serialized. It can only be populated by the server.
reservedHours

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 NOTE: This property will not be serialized. It can only be populated by the server.
skuName

This is the ARM Sku name. It can be used to join with the serviceType field in additional info in usage records. NOTE: This property will not be serialized. It can only be populated by the server.
totalReservedQuantity

This is the total count of instances that are reserved for the reservationId. NOTE: This property will not be serialized. It can only be populated by the server.
usageDate

Data corresponding to the utilization record. If the grain of data is monthly, it will be first day of month. NOTE: This property will not be serialized. It can only be populated by the server.
usedHours

Total used hours by the reservation NOTE: This property will not be serialized. It can only be populated by the server.
usedQuantity

This is the used quantity for the reservationId. NOTE: This property will not be serialized. It can only be populated by the server.
utilizedPercentage

This is the utilized percentage for the reservation Id. NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

etag

The etag for the resource. NOTE: This property will not be serialized. It can only be populated by the server.
id

The full qualified ARM ID of an event. NOTE: This property will not be serialized. It can only be populated by the server.
name

The ID that uniquely identifies an event. NOTE: This property will not be serialized. It can only be populated by the server.
tags

Resource tags. NOTE: This property will not be serialized. It can only be populated by the server.
type

Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

avgUtilizationPercentage

This is average utilization for the entire time range. (day or month depending on the grain) NOTE: This property will not be serialized. It can only be populated by the server.

avgUtilizationPercentage?: number

Property Value

number

kind

The reservation kind. NOTE: This property will not be serialized. It can only be populated by the server.

kind?: string

Property Value

string

maxUtilizationPercentage

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. NOTE: This property will not be serialized. It can only be populated by the server.

maxUtilizationPercentage?: number

Property Value

number

minUtilizationPercentage

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 NOTE: This property will not be serialized. It can only be populated by the server.

minUtilizationPercentage?: number

Property Value

number

purchasedQuantity

This is the purchased quantity for the reservationId. NOTE: This property will not be serialized. It can only be populated by the server.

purchasedQuantity?: number

Property Value

number

remainingQuantity

This is the remaining quantity for the reservationId. NOTE: This property will not be serialized. It can only be populated by the server.

remainingQuantity?: number

Property Value

number

reservationId

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. NOTE: This property will not be serialized. It can only be populated by the server.

reservationId?: string

Property Value

string

reservationOrderId

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. NOTE: This property will not be serialized. It can only be populated by the server.

reservationOrderId?: string

Property Value

string

reservedHours

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 NOTE: This property will not be serialized. It can only be populated by the server.

reservedHours?: number

Property Value

number

skuName

This is the ARM Sku name. It can be used to join with the serviceType field in additional info in usage records. NOTE: This property will not be serialized. It can only be populated by the server.

skuName?: string

Property Value

string

totalReservedQuantity

This is the total count of instances that are reserved for the reservationId. NOTE: This property will not be serialized. It can only be populated by the server.

totalReservedQuantity?: number

Property Value

number

usageDate

Data corresponding to the utilization record. If the grain of data is monthly, it will be first day of month. NOTE: This property will not be serialized. It can only be populated by the server.

usageDate?: Date

Property Value

Date

usedHours

Total used hours by the reservation NOTE: This property will not be serialized. It can only be populated by the server.

usedHours?: number

Property Value

number

usedQuantity

This is the used quantity for the reservationId. NOTE: This property will not be serialized. It can only be populated by the server.

usedQuantity?: number

Property Value

number

utilizedPercentage

This is the utilized percentage for the reservation Id. NOTE: This property will not be serialized. It can only be populated by the server.

utilizedPercentage?: number

Property Value

number

Inherited Property Details

etag

The etag for the resource. NOTE: This property will not be serialized. It can only be populated by the server.

etag?: string

Property Value

string

Inherited From Resource.etag

id

The full qualified ARM ID of an event. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From Resource.id

name

The ID that uniquely identifies an event. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From Resource.name

tags

Resource tags. NOTE: This property will not be serialized. It can only be populated by the server.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From Resource.tags

type

Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From Resource.type