ReservationSummary interface

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)
etag	The etag for the resource.
kind	The reservation kind.
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.
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
purchasedQuantity	This is the purchased quantity for the reservationId.
remainingQuantity	This is the remaining quantity for the reservationId.
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.
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.
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
skuName	This is the ARM Sku name. It can be used to join with the serviceType field in additional info in usage records.
tags	Resource tags.
totalReservedQuantity	This is the total count of instances that are reserved for the reservationId.
usageDate	Data corresponding to the utilization record. If the grain of data is monthly, it will be first day of month.
usedHours	Total used hours by the reservation
usedQuantity	This is the used quantity for the reservationId.
utilizedPercentage	This is the utilized percentage for the reservation Id.

Inherited Properties

id	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	The name of the resource
systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Property Details

avgUtilizationPercentage

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

avgUtilizationPercentage?: number

Property Value

number

etag

The etag for the resource.

etag?: string

Property Value

string

kind

The reservation kind.

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.

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

minUtilizationPercentage?: number

Property Value

number

purchasedQuantity

This is the purchased quantity for the reservationId.

purchasedQuantity?: number

Property Value

number

remainingQuantity

This is the remaining quantity for the reservationId.

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.

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.

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

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.

skuName?: string

Property Value

string

tags

Resource tags.

tags?: Record<string, string>

Property Value

Record<string, string>

totalReservedQuantity

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

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.

usageDate?: Date

Property Value

Date

usedHours

Total used hours by the reservation

usedHours?: number

Property Value

number

usedQuantity

This is the used quantity for the reservationId.

usedQuantity?: number

Property Value

number

utilizedPercentage

This is the utilized percentage for the reservation Id.

utilizedPercentage?: number

Property Value

number

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

id?: string

Property Value

string

Inherited From Resource.id

name

The name of the resource

name?: string

Property Value

string

Inherited From Resource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

systemData?: SystemData

Property Value

SystemData

Inherited From Resource.systemData

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

type?: string

Property Value

string

Inherited From Resource.type