SavingsPlanUtilizationSummaryProperties interface

Package:

@azure/arm-costmanagement

Savings plan utilization summary properties.

Extends

BenefitUtilizationSummaryProperties

Properties

avgUtilizationPercentage	This is the average hourly utilization for each date range that corresponds to given grain (Daily, Monthly). Suppose the API call is for usageDate > 2025-03-01 and usageDate < 2022-10-31 at a daily granularity. There will be one record per benefit id for each day. For a single day, the avgUtilizationPercentage value will be equal to the average of the set of values where the set contains 24 utilization percentage entries one for each hour in a specific day.
maxUtilizationPercentage	This is the maximum hourly utilization for each date range that corresponds to given grain (Daily, Monthly). Suppose the API call is for usageDate > 2025-03-01 and usageDate < 2022-10-31 at a daily granularity. There will be one record per benefit id for each day. For a single day, the maxUtilizationPercentage value will be equal to the largest in the set of values where the set contains 24 utilization percentage entries one for each hour in a specific day. If on the day 2022-10-18, the largest utilization percentage was 90% at hour 5, then the value for the maxUtilizationPercentage in the response will be 90%.
minUtilizationPercentage	This is the minimum hourly utilization for each date range that corresponds to given grain (Daily, Monthly). Suppose the API call is for usageDate > 2025-03-01 and usageDate < 2022-10-31 at a daily granularity. There will be one record per benefit id for each day. For a single day, the minUtilizationPercentage value will be equal to the smallest in the set of values where the set contains 24 utilization percentage entries one for each hour in a specific day. If on the day 2022-10-18, the lowest utilization percentage was 10% at hour 4, then the value for the minUtilizationPercentage in the response will be 10%.

Inherited Properties

armSkuName	ARM SKU name. For example, 'Compute_Savings_Plan' for savings plan.
benefitId	The benefit ID is the identifier of the benefit.
benefitOrderId	The benefit order ID is the identifier for a benefit purchase.
benefitType	The benefit type. Supported values: 'SavingsPlan'.
usageDate	Date corresponding to the utilization summary record. If the grain of data is monthly, value for this field will be first day of the month.

Property Details

avgUtilizationPercentage

This is the average hourly utilization for each date range that corresponds to given grain (Daily, Monthly). Suppose the API call is for usageDate > 2025-03-01 and usageDate < 2022-10-31 at a daily granularity. There will be one record per benefit id for each day. For a single day, the avgUtilizationPercentage value will be equal to the average of the set of values where the set contains 24 utilization percentage entries one for each hour in a specific day.

avgUtilizationPercentage?: number

Property Value

number

maxUtilizationPercentage

This is the maximum hourly utilization for each date range that corresponds to given grain (Daily, Monthly). Suppose the API call is for usageDate > 2025-03-01 and usageDate < 2022-10-31 at a daily granularity. There will be one record per benefit id for each day. For a single day, the maxUtilizationPercentage value will be equal to the largest in the set of values where the set contains 24 utilization percentage entries one for each hour in a specific day. If on the day 2022-10-18, the largest utilization percentage was 90% at hour 5, then the value for the maxUtilizationPercentage in the response will be 90%.

maxUtilizationPercentage?: number

Property Value

number

minUtilizationPercentage

This is the minimum hourly utilization for each date range that corresponds to given grain (Daily, Monthly). Suppose the API call is for usageDate > 2025-03-01 and usageDate < 2022-10-31 at a daily granularity. There will be one record per benefit id for each day. For a single day, the minUtilizationPercentage value will be equal to the smallest in the set of values where the set contains 24 utilization percentage entries one for each hour in a specific day. If on the day 2022-10-18, the lowest utilization percentage was 10% at hour 4, then the value for the minUtilizationPercentage in the response will be 10%.

minUtilizationPercentage?: number

Property Value

number

Inherited Property Details

armSkuName

ARM SKU name. For example, 'Compute_Savings_Plan' for savings plan.

armSkuName?: string

Property Value

string

Inherited From BenefitUtilizationSummaryProperties.armSkuName

benefitId

The benefit ID is the identifier of the benefit.

benefitId?: string

Property Value

string

Inherited From BenefitUtilizationSummaryProperties.benefitId

benefitOrderId

The benefit order ID is the identifier for a benefit purchase.

benefitOrderId?: string

Property Value

string

Inherited From BenefitUtilizationSummaryProperties.benefitOrderId

benefitType

The benefit type. Supported values: 'SavingsPlan'.

benefitType?: string

Property Value

string

Inherited From BenefitUtilizationSummaryProperties.benefitType

usageDate

Date corresponding to the utilization summary record. If the grain of data is monthly, value for this field will be first day of the month.

usageDate?: Date

Property Value

Date

Inherited From BenefitUtilizationSummaryProperties.usageDate