Share via


CarbonEmissionTopItemMonthlySummary Class

Definition

Response for Top Items Carbon Emissions by Month.

public class CarbonEmissionTopItemMonthlySummary : Azure.ResourceManager.CarbonOptimization.Models.CarbonEmission, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.CarbonOptimization.Models.CarbonEmissionTopItemMonthlySummary>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.CarbonOptimization.Models.CarbonEmissionTopItemMonthlySummary>
type CarbonEmissionTopItemMonthlySummary = class
    inherit CarbonEmission
    interface IJsonModel<CarbonEmissionTopItemMonthlySummary>
    interface IPersistableModel<CarbonEmissionTopItemMonthlySummary>
Public Class CarbonEmissionTopItemMonthlySummary
Inherits CarbonEmission
Implements IJsonModel(Of CarbonEmissionTopItemMonthlySummary), IPersistableModel(Of CarbonEmissionTopItemMonthlySummary)
Inheritance
CarbonEmissionTopItemMonthlySummary
Implements

Properties

CategoryType

Item category, see supported type value defined in CategoryTypeEnum.

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.

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).

(Inherited from CarbonEmission)
MonthlyEmissionsChangeValue

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

(Inherited from CarbonEmission)
MonthOverMonthEmissionsChangeRatio

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

(Inherited from CarbonEmission)
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.

(Inherited from CarbonEmission)

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

IJsonModel<CarbonEmission>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

(Inherited from CarbonEmission)
IJsonModel<CarbonEmission>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

(Inherited from CarbonEmission)
IJsonModel<CarbonEmissionTopItemMonthlySummary>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<CarbonEmissionTopItemMonthlySummary>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<CarbonEmission>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

(Inherited from CarbonEmission)
IPersistableModel<CarbonEmission>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

(Inherited from CarbonEmission)
IPersistableModel<CarbonEmission>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

(Inherited from CarbonEmission)
IPersistableModel<CarbonEmissionTopItemMonthlySummary>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<CarbonEmissionTopItemMonthlySummary>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<CarbonEmissionTopItemMonthlySummary>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to