Share via

SavingsPlanUtilizationSummary interface

  • Reference
Package:
@azure/arm-costmanagement

Savings plan utilization summary resource.

Extends
BenefitUtilizationSummary

Properties

armSkuName

ARM SKU name. For example, 'Compute_Savings_Plan' for savings plan. NOTE: This property will not be serialized. It can only be populated by the server.
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 > 2022-10-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. NOTE: This property will not be serialized. It can only be populated by the server.
benefitId

The benefit ID is the identifier of the benefit. NOTE: This property will not be serialized. It can only be populated by the server.
benefitOrderId

The benefit order ID is the identifier for a benefit purchase. NOTE: This property will not be serialized. It can only be populated by the server.
benefitType

The benefit type. Supported values: 'SavingsPlan'.
kind

Polymorphic discriminator, which specifies the different types this object can be
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 > 2022-10-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%. NOTE: This property will not be serialized. It can only be populated by the server.
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 > 2022-10-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%. NOTE: This property will not be serialized. It can only be populated by the server.
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. NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.
name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

armSkuName

ARM SKU name. For example, 'Compute_Savings_Plan' for savings plan. NOTE: This property will not be serialized. It can only be populated by the server.

armSkuName?: string

Property Value

string

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

avgUtilizationPercentage?: number

Property Value

number

benefitId

The benefit ID is the identifier of the benefit. NOTE: This property will not be serialized. It can only be populated by the server.

benefitId?: string

Property Value

string

benefitOrderId

The benefit order ID is the identifier for a benefit purchase. NOTE: This property will not be serialized. It can only be populated by the server.

benefitOrderId?: string

Property Value

string

benefitType

The benefit type. Supported values: 'SavingsPlan'.

benefitType?: string

Property Value

string

kind

Polymorphic discriminator, which specifies the different types this object can be

kind: "SavingsPlan"

Property Value

"SavingsPlan"

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 > 2022-10-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%. 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 for each date range that corresponds to given grain (Daily, Monthly). Suppose the API call is for usageDate > 2022-10-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%. NOTE: This property will not be serialized. It can only be populated by the server.

minUtilizationPercentage?: number

Property Value

number

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

usageDate?: Date

Property Value

Date

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From BenefitUtilizationSummary.id

name

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

name?: string

Property Value

string

Inherited From BenefitUtilizationSummary.name

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From BenefitUtilizationSummary.type