TopItemsSummaryReportQueryFilter interface

Package:

@azure/arm-carbonoptimization

Query filter parameter to configure TopItemsSummaryReport queries.

Extends

QueryFilter

Properties

categoryType	Specifies the category type for which to retrieve top-emitting items. See supported values defined in CategoryTypeEnum.
reportType	Specifies that the report type is a top items summary report for carbon emissions data, aggregated by category type.
topItems	The number of top items to return, based on emissions. This value must be between 1 and 10.

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

categoryType

Specifies the category type for which to retrieve top-emitting items. See supported values defined in CategoryTypeEnum.

categoryType: string

Property Value

string

reportType

Specifies that the report type is a top items summary report for carbon emissions data, aggregated by category type.

reportType: "TopItemsSummaryReport"

Property Value

"TopItemsSummaryReport"

topItems

The number of top items to return, based on emissions. This value must be between 1 and 10.

topItems: number

Property Value

number

Inherited 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[]

Inherited From QueryFilter.carbonScopeList

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

Inherited From QueryFilter.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[]

Inherited From QueryFilter.locationList

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[]

Inherited From QueryFilter.resourceGroupUrlList

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[]

Inherited From QueryFilter.resourceTypeList

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[]

Inherited From QueryFilter.subscriptionList