Share via

CarbonEmissionTopItemsSummaryData interface

Package:
@azure/arm-carbonoptimization

Response for Top Items by Category Type

Extends
CarbonEmissionData

Properties

categoryType

The category type of the item. This defines which dimension the emissions are aggregated by, and the supported values are defined in CategoryTypeEnum (e.g., Subscription, ResourceGroup, Resource, etc.).
dataType

Top items summary data
itemName

The identifier of the item being reported on, which could refer to the resource name, resource type name, location, resource group name, or subscription ID, depending on the specified 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

The category type of the item. This defines which dimension the emissions are aggregated by, and the supported values are defined in CategoryTypeEnum (e.g., Subscription, ResourceGroup, Resource, etc.).

categoryType: string

Property Value

string

dataType

Top items summary data

dataType: "TopItemsSummaryData"

Property Value

"TopItemsSummaryData"

itemName

The identifier of the item being reported on, which could refer to the resource name, resource type name, location, resource group name, or subscription ID, depending on the specified 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