CarbonEmissionTopItemMonthlySummaryData interface

Package:

@azure/arm-carbonoptimization

Response for Top Items Carbon Emissions by Month

Extends

CarbonEmissionData

Properties

categoryType	Item category, see supported type value defined in CategoryTypeEnum
dataType	Top items Monthly summary data
date	The date, representing the month, for which the emissions data is reported, formatted as yyyy-MM-dd (e.g., 2024-03-01)
itemName	Item name, it can be resource name, resource type name, location, resource group name or subscriptionId. It depends on category type.

Inherited Properties

latestMonthEmissions	Total carbon emissions for the specified query parameters, measured in kgCO2E. This value represents total emissions over the specified date range (e.g., March-June).
monthlyEmissionsChangeValue	The change in carbon emissions between the current and previous period, calculated as: latestMonthEmissions - previousMonthEmissions.
monthOverMonthEmissionsChangeRatio	The percentage change in carbon emissions between the current and previous DateRange. This is calculated as: (latestMonthEmissions - previousMonthEmissions) / previousMonthEmissions.
previousMonthEmissions	Total carbon emissions for the previous month’s date range, which is the same period as the specified date range but shifted left by one month (e.g., if the specified range is March - June, the previous month’s range will be Feb - May). The value is measured in kgCO2E.

Property Details

categoryType

Item category, see supported type value defined in CategoryTypeEnum

categoryType: string

Property Value

string

dataType

Top items Monthly summary data

dataType: "TopItemsMonthlySummaryData"

Property Value

"TopItemsMonthlySummaryData"

date

The date, representing the month, for which the emissions data is reported, formatted as yyyy-MM-dd (e.g., 2024-03-01)

date: string

Property Value

string

itemName

Item name, it can be resource name, resource type name, location, resource group name or subscriptionId. It depends on category type.

itemName: string

Property Value

string

Inherited Property Details

latestMonthEmissions

Total carbon emissions for the specified query parameters, measured in kgCO2E. This value represents total emissions over the specified date range (e.g., March-June).

latestMonthEmissions: number

Property Value

number

Inherited From CarbonEmissionData.latestMonthEmissions

monthlyEmissionsChangeValue

The change in carbon emissions between the current and previous period, calculated as: latestMonthEmissions - previousMonthEmissions.

monthlyEmissionsChangeValue?: number

Property Value

number

Inherited From CarbonEmissionData.monthlyEmissionsChangeValue

monthOverMonthEmissionsChangeRatio

The percentage change in carbon emissions between the current and previous DateRange. This is calculated as: (latestMonthEmissions - previousMonthEmissions) / previousMonthEmissions.

monthOverMonthEmissionsChangeRatio?: number

Property Value

number

Inherited From CarbonEmissionData.monthOverMonthEmissionsChangeRatio

previousMonthEmissions

Total carbon emissions for the previous month’s date range, which is the same period as the specified date range but shifted left by one month (e.g., if the specified range is March - June, the previous month’s range will be Feb - May). The value is measured in kgCO2E.

previousMonthEmissions: number

Property Value

number

Inherited From CarbonEmissionData.previousMonthEmissions