Share via


MonthlySummaryReportQueryFilter Class

Definition

Query filter parameter to configure MonthlySummaryReport queries.

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

Constructors

MonthlySummaryReportQueryFilter(CarbonEmissionQueryDateRange, IEnumerable<String>, IEnumerable<CarbonEmissionScope>)

Initializes a new instance of MonthlySummaryReportQueryFilter.

Properties

CarbonScopeList

List of carbon emission scopes. Required. Accepts one or more values from EmissionScopeEnum (e.g., Scope1, Scope2, Scope3) in list form. The output will include the total emissions for the specified scopes.

(Inherited from CarbonEmissionQueryFilter)
DateRange

The start and end dates for carbon emissions data. Required. For ItemDetailsReport and TopItemsSummaryReport, only one month of data is supported at a time, so start and end dates should be equal within DateRange (e.g., start: 2024-06-01 and end: 2024-06-01).

(Inherited from CarbonEmissionQueryFilter)
LocationList

List of locations(Azure Region Display Name) for carbon emissions data, with each location specified in lowercase (e.g., 'east us'). Optional. You can use the command 'az account list-locations -o table' to find Azure Region Display Names.

(Inherited from CarbonEmissionQueryFilter)
ResourceGroupUrlList

List of resource group URLs for carbon emissions data. Optional. Each URL must follow the format '/subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}', and should be in all lowercase.

(Inherited from CarbonEmissionQueryFilter)
ResourceTypeList

List of resource types for carbon emissions data. Optional. Each resource type should be specified in lowercase, following the format 'microsoft.{service}/{resourceType}', e.g., 'microsoft.storage/storageaccounts'.

(Inherited from CarbonEmissionQueryFilter)
SubscriptionList

List of subscription IDs for which carbon emissions data is requested. Required. Each subscription ID should be in lowercase format. The max length of list is 100.

(Inherited from CarbonEmissionQueryFilter)

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

IJsonModel<CarbonEmissionQueryFilter>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

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

Writes the model to the provided Utf8JsonWriter.

(Inherited from CarbonEmissionQueryFilter)
IJsonModel<MonthlySummaryReportQueryFilter>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

IJsonModel<MonthlySummaryReportQueryFilter>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<CarbonEmissionQueryFilter>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

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

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

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

Writes the model into a BinaryData.

(Inherited from CarbonEmissionQueryFilter)
IPersistableModel<MonthlySummaryReportQueryFilter>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<MonthlySummaryReportQueryFilter>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<MonthlySummaryReportQueryFilter>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to