QueryFilter interface

Package:

@azure/arm-carbonoptimization

Shared query filter parameter to configure carbon emissions data queries for all different report type defined in ReportTypeEnum.

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.
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).
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.
reportType	The discriminator possible values: OverallSummaryReport, MonthlySummaryReport, TopItemsSummaryReport, TopItemsMonthlySummaryReport, ItemDetailsReport
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.
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'.
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.

Property Details

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.

carbonScopeList: string[]

Property Value

string[]

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

dateRange: DateRange

Property Value

DateRange

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.

locationList?: string[]

Property Value

string[]

reportType

The discriminator possible values: OverallSummaryReport, MonthlySummaryReport, TopItemsSummaryReport, TopItemsMonthlySummaryReport, ItemDetailsReport

reportType: string

Property Value

string

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.

resourceGroupUrlList?: string[]

Property Value

string[]

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

resourceTypeList?: string[]

Property Value

string[]

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.

subscriptionList: string[]

Property Value

string[]