Share via


CarbonEmissionTopItemsSummary Class

Definition

Response for Top Items by Category Type.

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

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

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.

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<CarbonEmissionTopItemsSummary>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

IJsonModel<CarbonEmissionTopItemsSummary>.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<CarbonEmissionTopItemsSummary>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<CarbonEmissionTopItemsSummary>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<CarbonEmissionTopItemsSummary>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to