Share via

SingleScopeBenefitRecommendationProperties interface

  • Reference
Package:
@azure/arm-costmanagement

The properties of the benefit recommendations when scope is 'Single'.

Extends
BenefitRecommendationProperties

Properties

resourceGroup

The resource group that this single scope recommendation is for. Applicable only if recommendation is for 'Single' scope and 'ResourceGroup' request scope. NOTE: This property will not be serialized. It can only be populated by the server.
scope

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

The subscription ID that this single scope recommendation is for. Applicable only if recommendation is for 'Single' scope. NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

allRecommendationDetails

The list of all benefit recommendations with the recommendation details. NOTE: This property will not be serialized. It can only be populated by the server.
armSkuName

ARM SKU name. 'Compute_Savings_Plan' for SavingsPlan. NOTE: This property will not be serialized. It can only be populated by the server.
commitmentGranularity

Grain of the proposed commitment amount. Supported values: 'Hourly'
costWithoutBenefit

The current cost without benefit, corresponds to 'totalHours' in the look-back period. NOTE: This property will not be serialized. It can only be populated by the server.
currencyCode

An ISO 4217 currency code identifier for the costs and savings amounts. NOTE: This property will not be serialized. It can only be populated by the server.
firstConsumptionDate

The first usage date used for looking back for computing the recommendations. NOTE: This property will not be serialized. It can only be populated by the server.
lastConsumptionDate

The last usage date used for looking back for computing the recommendations. NOTE: This property will not be serialized. It can only be populated by the server.
lookBackPeriod

The number of days of usage evaluated for computing the recommendations.
recommendationDetails

The details of the proposed recommendation.
term

Term period of the benefit. For example, P1Y or P3Y.
totalHours

The total hours for which the cost is covered. Its equal to number of records in a property 'properties/usage/charges'. NOTE: This property will not be serialized. It can only be populated by the server.
usage

On-demand charges between firstConsumptionDate and lastConsumptionDate that were used for computing benefit recommendations.

Property Details

resourceGroup

The resource group that this single scope recommendation is for. Applicable only if recommendation is for 'Single' scope and 'ResourceGroup' request scope. NOTE: This property will not be serialized. It can only be populated by the server.

resourceGroup?: string

Property Value

string

scope

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

scope: "Single"

Property Value

"Single"

subscriptionId

The subscription ID that this single scope recommendation is for. Applicable only if recommendation is for 'Single' scope. NOTE: This property will not be serialized. It can only be populated by the server.

subscriptionId?: string

Property Value

string

Inherited Property Details

allRecommendationDetails

The list of all benefit recommendations with the recommendation details. NOTE: This property will not be serialized. It can only be populated by the server.

allRecommendationDetails?: AllSavingsList

Property Value

AllSavingsList

Inherited From BenefitRecommendationProperties.allRecommendationDetails

armSkuName

ARM SKU name. 'Compute_Savings_Plan' for SavingsPlan. NOTE: This property will not be serialized. It can only be populated by the server.

armSkuName?: string

Property Value

string

Inherited From BenefitRecommendationProperties.armSkuName

commitmentGranularity

Grain of the proposed commitment amount. Supported values: 'Hourly'

commitmentGranularity?: string

Property Value

string

Inherited From BenefitRecommendationProperties.commitmentGranularity

costWithoutBenefit

The current cost without benefit, corresponds to 'totalHours' in the look-back period. NOTE: This property will not be serialized. It can only be populated by the server.

costWithoutBenefit?: number

Property Value

number

Inherited From BenefitRecommendationProperties.costWithoutBenefit

currencyCode

An ISO 4217 currency code identifier for the costs and savings amounts. NOTE: This property will not be serialized. It can only be populated by the server.

currencyCode?: string

Property Value

string

Inherited From BenefitRecommendationProperties.currencyCode

firstConsumptionDate

The first usage date used for looking back for computing the recommendations. NOTE: This property will not be serialized. It can only be populated by the server.

firstConsumptionDate?: Date

Property Value

Date

Inherited From BenefitRecommendationProperties.firstConsumptionDate

lastConsumptionDate

The last usage date used for looking back for computing the recommendations. NOTE: This property will not be serialized. It can only be populated by the server.

lastConsumptionDate?: Date

Property Value

Date

Inherited From BenefitRecommendationProperties.lastConsumptionDate

lookBackPeriod

The number of days of usage evaluated for computing the recommendations.

lookBackPeriod?: string

Property Value

string

Inherited From BenefitRecommendationProperties.lookBackPeriod

recommendationDetails

The details of the proposed recommendation.

recommendationDetails?: AllSavingsBenefitDetails

Property Value

AllSavingsBenefitDetails

Inherited From BenefitRecommendationProperties.recommendationDetails

term

Term period of the benefit. For example, P1Y or P3Y.

term?: string

Property Value

string

Inherited From BenefitRecommendationProperties.term

totalHours

The total hours for which the cost is covered. Its equal to number of records in a property 'properties/usage/charges'. NOTE: This property will not be serialized. It can only be populated by the server.

totalHours?: number

Property Value

number

Inherited From BenefitRecommendationProperties.totalHours

usage

On-demand charges between firstConsumptionDate and lastConsumptionDate that were used for computing benefit recommendations.

usage?: RecommendationUsageDetails

Property Value

RecommendationUsageDetails

Inherited From BenefitRecommendationProperties.usage