Carbon Service - List Carbon Emission Reports

Reference

Service:: Carbon optimization

API Version:: 2023-04-01-preview

API for Carbon Emissions Reports

POST https://management.azure.com/providers/Microsoft.Carbon/carbonEmissionReports?api-version=2023-04-01-preview

URI Parameters

Name	In	Required	Type	Description
api-version	query	True	string	The API version to use for this operation.

Request Body

The request body can be one of the following:

Name	Description
ItemDetailsQueryFilter	Query Parameters for Detailed carbon emissions by pageSize
MonthlySummaryReportQueryFilter	Query Parameters for Monthly Carbon Emissions Summary
OverallSummaryReportQueryFilter	Query Parameters for Overall Carbon Emissions Summary
TopItemsMonthlySummaryReportQueryFilter	Query Parameters for Top Items Carbon Emissions by Month
TopItemsSummaryReportQueryFilter	Query Parameters for Top Items Carbon Emission by Category Type

ItemDetailsQueryFilter

Query Parameters for Detailed carbon emissions by pageSize

Name	Required	Type	Description
carbonScopeList	True	EmissionScopeEnum[]	Carbon emission scope for carbon emissions data
categoryType	True	CategoryTypeEnum	Item Category type
dateRange	True	DateRange	The start date and end date for carbon emissions data
groupCategory	True	string	Group category name
orderBy	True	string	Order by column name
pageSize	True	integer	Number of items to return
reportType	True	string: ItemDetailsReport	Report type
sortDirection	True	string	Direction for sorting
subscriptionList	True	string[]	SubscriptionId list for carbon emissions data
resourceGroupUrlList		string[]	resourceGroupUrl list for carbon emissions data
skipToken		string	The number of result items to skip

MonthlySummaryReportQueryFilter

Query Parameters for Monthly Carbon Emissions Summary

Name	Required	Type	Description
carbonScopeList	True	EmissionScopeEnum[]	Carbon emission scope for carbon emissions data
dateRange	True	DateRange	The start date and end date for carbon emissions data
reportType	True	string: MonthlySummaryReport	Report type
subscriptionList	True	string[]	SubscriptionId list for carbon emissions data
resourceGroupUrlList		string[]	resourceGroupUrl list for carbon emissions data

OverallSummaryReportQueryFilter

Query Parameters for Overall Carbon Emissions Summary

Name	Required	Type	Description
carbonScopeList	True	EmissionScopeEnum[]	Carbon emission scope for carbon emissions data
dateRange	True	DateRange	The start date and end date for carbon emissions data
reportType	True	string: OverallSummaryReport	Report type
subscriptionList	True	string[]	SubscriptionId list for carbon emissions data
resourceGroupUrlList		string[]	resourceGroupUrl list for carbon emissions data

TopItemsMonthlySummaryReportQueryFilter

Query Parameters for Top Items Carbon Emissions by Month

Name	Required	Type	Description
carbonScopeList	True	EmissionScopeEnum[]	Carbon emission scope for carbon emissions data
categoryType	True	CategoryTypeEnum	Item Category type
dateRange	True	DateRange	The start date and end date for carbon emissions data
reportType	True	string: TopItemsMonthlySummaryReport	Report type
subscriptionList	True	string[]	SubscriptionId list for carbon emissions data
topItems	True	integer	Number of top items to return. The value should be between 5 and 100
resourceGroupUrlList		string[]	resourceGroupUrl list for carbon emissions data

TopItemsSummaryReportQueryFilter

Query Parameters for Top Items Carbon Emission by Category Type

Name	Required	Type	Description
carbonScopeList	True	EmissionScopeEnum[]	Carbon emission scope for carbon emissions data
categoryType	True	CategoryTypeEnum	Item Category type
dateRange	True	DateRange	The start date and end date for carbon emissions data
reportType	True	string: TopItemsSummaryReport	Report type
subscriptionList	True	string[]	SubscriptionId list for carbon emissions data
topItems	True	integer	Number of top items to return. The value should be between 5 and 100
resourceGroupUrlList		string[]	resourceGroupUrl list for carbon emissions data

Responses

Name	Type	Description
200 OK	CarbonEmissionDataListResult	The request has succeeded.
Other Status Codes	ErrorResponse	An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

CarbonService_ListCarbonEmissionReports

Sample Request

HTTP

POST https://management.azure.com/providers/Microsoft.Carbon/carbonEmissionReports?api-version=2023-04-01-preview

{
  "reportType": "OverallSummaryReport",
  "subscriptionList": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "carbonScopeList": [
    "Scope1"
  ],
  "dateRange": {
    "start": "2023-06-01",
    "end": "2023-06-15"
  }
}

Sample Response

Status code:: 200

{
  "value": [
    {
      "dataType": "OverallSummaryData",
      "totalCarbonEmission": 0,
      "totalCarbonEmissionLastMonth": 0,
      "changeRatioForLastMonth": 0,
      "totalCarbonEmission12MonthsAgo": 0,
      "changeRatioFor12Months": 0,
      "changeValueMonthOverMonth": 0
    }
  ],
  "nextLink": "https://example.nextpage.com/test?token=test"
}

Definitions

Name	Description
CarbonEmissionDataListResult	List of carbon emission results
CarbonEmissionItemDetailData	Response for detailed carbon emissions
CarbonEmissionMonthlySummaryData	Response for Monthly Carbon Emissions Summary
CarbonEmissionOverallSummaryData	Response for Overall Carbon Emissions Summary
CarbonEmissionTopItemMonthlySummaryData	Response for Top Items Carbon Emissions by Month
CarbonEmissionTopItemsSummaryData	Response for Top Items by Category Type
CategoryTypeEnum	Supported category types to be used with QueryParameter
DateRange	Date range to be used with QueryParameter
EmissionScopeEnum	Supported emission scopes to be used with QueryParameter
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ItemDetailsQueryFilter	Query Parameters for Detailed carbon emissions by pageSize
MonthlySummaryReportQueryFilter	Query Parameters for Monthly Carbon Emissions Summary
OverallSummaryReportQueryFilter	Query Parameters for Overall Carbon Emissions Summary
ResourceCarbonEmissionItemDetailData	Response for Resource detailed carbon emissions
ResourceCarbonEmissionTopItemMonthlySummaryData	Response for Top Items Carbon Emissions by Month for ResourceType
ResourceCarbonEmissionTopItemsSummaryData	Response for Top Items For Resource
ResourceGroupCarbonEmissionItemDetailData	Response for Resource Group detailed carbon emissions
ResourceGroupCarbonEmissionTopItemMonthlySummaryData	Response for Top Items Carbon Emissions by Month for ResourceGroupType
ResourceGroupCarbonEmissionTopItemsSummaryData	Response for Top Items For ResourceGroup
TopItemsMonthlySummaryReportQueryFilter	Query Parameters for Top Items Carbon Emissions by Month
TopItemsSummaryReportQueryFilter	Query Parameters for Top Items Carbon Emission by Category Type

CarbonEmissionDataListResult

List of carbon emission results

Name	Type	Description
nextLink	string	The link to the next page of items
skipToken	string	The number of result items to skip for next page
value	CarbonEmissionData[]: CarbonEmissionItemDetailData[] CarbonEmissionMonthlySummaryData[] CarbonEmissionOverallSummaryData[] CarbonEmissionTopItemMonthlySummaryData[] CarbonEmissionTopItemsSummaryData[] ResourceCarbonEmissionItemDetailData[] ResourceCarbonEmissionTopItemMonthlySummaryData[] ResourceCarbonEmissionTopItemsSummaryData[] ResourceGroupCarbonEmissionItemDetailData[] ResourceGroupCarbonEmissionTopItemMonthlySummaryData[] ResourceGroupCarbonEmissionTopItemsSummaryData[]	The CarbonEmissionData items on this page

CarbonEmissionItemDetailData

Response for detailed carbon emissions

Name	Type	Description
categoryType	CategoryTypeEnum	Item category
changeRatioFor12Months	number	Change ratio between totalCarbonEmission and totalCarbonEmission12MonthsAgo
changeRatioForLastMonth	number	Change ratio between totalCarbonEmission and totalCarbonEmissionLastMonth
changeValueMonthOverMonth	number	Change Value between totalCarbonEmission and totalCarbonEmissionLastMonth
dataType	string: ItemDetailsData	Query result data type name
groupName	string	Item group name
itemName	string	Item name
totalCarbonEmission	number	Total carbon emissions for given query parameters
totalCarbonEmission12MonthsAgo	number	Total carbon emissions for 12 months ago for given query parameters
totalCarbonEmissionLastMonth	number	Total carbon emission for last month for given query parameters

CarbonEmissionMonthlySummaryData

Response for Monthly Carbon Emissions Summary

Name	Type	Description
carbonIntensity	number	Carbon Intensity
changeRatioFor12Months	number	Change ratio between totalCarbonEmission and totalCarbonEmission12MonthsAgo
changeRatioForLastMonth	number	Change ratio between totalCarbonEmission and totalCarbonEmissionLastMonth
changeValueMonthOverMonth	number	Change Value between totalCarbonEmission and totalCarbonEmissionLastMonth
dataType	string: MonthlySummaryData	Query result data type name
date	string	Monthly date string
totalCarbonEmission	number	Total carbon emissions for given query parameters
totalCarbonEmission12MonthsAgo	number	Total carbon emissions for 12 months ago for given query parameters
totalCarbonEmissionLastMonth	number	Total carbon emission for last month for given query parameters

CarbonEmissionOverallSummaryData

Response for Overall Carbon Emissions Summary

Name	Type	Description
changeRatioFor12Months	number	Change ratio between totalCarbonEmission and totalCarbonEmission12MonthsAgo
changeRatioForLastMonth	number	Change ratio between totalCarbonEmission and totalCarbonEmissionLastMonth
changeValueMonthOverMonth	number	Change Value between totalCarbonEmission and totalCarbonEmissionLastMonth
dataType	string: OverallSummaryData	Query result data type name
totalCarbonEmission	number	Total carbon emissions for given query parameters
totalCarbonEmission12MonthsAgo	number	Total carbon emissions for 12 months ago for given query parameters
totalCarbonEmissionLastMonth	number	Total carbon emission for last month for given query parameters

CarbonEmissionTopItemMonthlySummaryData

Response for Top Items Carbon Emissions by Month

Name	Type	Description
categoryType	CategoryTypeEnum	Item category
changeRatioFor12Months	number	Change ratio between totalCarbonEmission and totalCarbonEmission12MonthsAgo
changeRatioForLastMonth	number	Change ratio between totalCarbonEmission and totalCarbonEmissionLastMonth
changeValueMonthOverMonth	number	Change Value between totalCarbonEmission and totalCarbonEmissionLastMonth
dataType	string: TopItemsMonthlySummaryData	Query result data type name
date	string	Month date
itemName	string	Item name
totalCarbonEmission	number	Total carbon emissions for given query parameters
totalCarbonEmission12MonthsAgo	number	Total carbon emissions for 12 months ago for given query parameters
totalCarbonEmissionLastMonth	number	Total carbon emission for last month for given query parameters

CarbonEmissionTopItemsSummaryData

Response for Top Items by Category Type

Name	Type	Description
categoryType	CategoryTypeEnum	Item category
changeRatioFor12Months	number	Change ratio between totalCarbonEmission and totalCarbonEmission12MonthsAgo
changeRatioForLastMonth	number	Change ratio between totalCarbonEmission and totalCarbonEmissionLastMonth
changeValueMonthOverMonth	number	Change Value between totalCarbonEmission and totalCarbonEmissionLastMonth
dataType	string: TopItemsSummaryData	Query result data type name
itemName	string	Item name
totalCarbonEmission	number	Total carbon emissions for given query parameters
totalCarbonEmission12MonthsAgo	number	Total carbon emissions for 12 months ago for given query parameters
totalCarbonEmissionLastMonth	number	Total carbon emission for last month for given query parameters

CategoryTypeEnum

Supported category types to be used with QueryParameter

Name	Type	Description
Location	string	Location level aggregation granularity
Resource	string	Resource level aggregation granularity
ResourceGroup	string	ResourceGroup level aggregation granularity
ServiceType	string	ServiceType level aggregation granularity
Subscription	string	Subscription level aggregation granularity

DateRange

Date range to be used with QueryParameter

Name	Type	Description
end	string	End date parameter, format is yyyy-MM-dd
start	string	Start date parameter, format is yyyy-MM-dd

EmissionScopeEnum

Supported emission scopes to be used with QueryParameter

Name	Type	Description
Scope1	string	Scope1 carbon emission
Scope2	string	Scope2 carbon emission
Scope3	string	Scope3 carbon emission

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

ItemDetailsQueryFilter

Query Parameters for Detailed carbon emissions by pageSize

Name	Type	Description
carbonScopeList	EmissionScopeEnum[]	Carbon emission scope for carbon emissions data
categoryType	CategoryTypeEnum	Item Category type
dateRange	DateRange	The start date and end date for carbon emissions data
groupCategory	string	Group category name
orderBy	string	Order by column name
pageSize	integer	Number of items to return
reportType	string: ItemDetailsReport	Report type
resourceGroupUrlList	string[]	resourceGroupUrl list for carbon emissions data
skipToken	string	The number of result items to skip
sortDirection	string	Direction for sorting
subscriptionList	string[]	SubscriptionId list for carbon emissions data

MonthlySummaryReportQueryFilter

Query Parameters for Monthly Carbon Emissions Summary

Name	Type	Description
carbonScopeList	EmissionScopeEnum[]	Carbon emission scope for carbon emissions data
dateRange	DateRange	The start date and end date for carbon emissions data
reportType	string: MonthlySummaryReport	Report type
resourceGroupUrlList	string[]	resourceGroupUrl list for carbon emissions data
subscriptionList	string[]	SubscriptionId list for carbon emissions data

OverallSummaryReportQueryFilter

Query Parameters for Overall Carbon Emissions Summary

Name	Type	Description
carbonScopeList	EmissionScopeEnum[]	Carbon emission scope for carbon emissions data
dateRange	DateRange	The start date and end date for carbon emissions data
reportType	string: OverallSummaryReport	Report type
resourceGroupUrlList	string[]	resourceGroupUrl list for carbon emissions data
subscriptionList	string[]	SubscriptionId list for carbon emissions data

ResourceCarbonEmissionItemDetailData

Response for Resource detailed carbon emissions

Name	Type	Description
categoryType	CategoryTypeEnum	Item category
changeRatioFor12Months	number	Change ratio between totalCarbonEmission and totalCarbonEmission12MonthsAgo
changeRatioForLastMonth	number	Change ratio between totalCarbonEmission and totalCarbonEmissionLastMonth
changeValueMonthOverMonth	number	Change Value between totalCarbonEmission and totalCarbonEmissionLastMonth
dataType	string: ResourceItemDetailsData	Query result data type name
groupName	string	Item group name
itemName	string	Item name
location	string	Resource Location
resourceGroup	string	Resource Group
resourceId	string	Resource Id Url
resourceProvider	string	Resource Provider
resourceType	string	Resource Type
subscriptionId	string	Subscription Id
totalCarbonEmission	number	Total carbon emissions for given query parameters
totalCarbonEmission12MonthsAgo	number	Total carbon emissions for 12 months ago for given query parameters
totalCarbonEmissionLastMonth	number	Total carbon emission for last month for given query parameters

ResourceCarbonEmissionTopItemMonthlySummaryData

Response for Top Items Carbon Emissions by Month for ResourceType

Name	Type	Description
categoryType	CategoryTypeEnum	Item category
changeRatioFor12Months	number	Change ratio between totalCarbonEmission and totalCarbonEmission12MonthsAgo
changeRatioForLastMonth	number	Change ratio between totalCarbonEmission and totalCarbonEmissionLastMonth
changeValueMonthOverMonth	number	Change Value between totalCarbonEmission and totalCarbonEmissionLastMonth
dataType	string: ResourceTopItemsMonthlySummaryData	Query result data type name
date	string	Month date
itemName	string	Item name
resourceGroup	string	Resource Group
subscriptionId	string	Subscription Id
totalCarbonEmission	number	Total carbon emissions for given query parameters
totalCarbonEmission12MonthsAgo	number	Total carbon emissions for 12 months ago for given query parameters
totalCarbonEmissionLastMonth	number	Total carbon emission for last month for given query parameters

ResourceCarbonEmissionTopItemsSummaryData

Response for Top Items For Resource

Name	Type	Description
categoryType	CategoryTypeEnum	Item category
changeRatioFor12Months	number	Change ratio between totalCarbonEmission and totalCarbonEmission12MonthsAgo
changeRatioForLastMonth	number	Change ratio between totalCarbonEmission and totalCarbonEmissionLastMonth
changeValueMonthOverMonth	number	Change Value between totalCarbonEmission and totalCarbonEmissionLastMonth
dataType	string: ResourceTopItemsSummaryData	Query result data type name
itemName	string	Item name
resourceGroup	string	Resource Group
subscriptionId	string	Subscription Id
totalCarbonEmission	number	Total carbon emissions for given query parameters
totalCarbonEmission12MonthsAgo	number	Total carbon emissions for 12 months ago for given query parameters
totalCarbonEmissionLastMonth	number	Total carbon emission for last month for given query parameters

ResourceGroupCarbonEmissionItemDetailData

Response for Resource Group detailed carbon emissions

Name	Type	Description
categoryType	CategoryTypeEnum	Item category
changeRatioFor12Months	number	Change ratio between totalCarbonEmission and totalCarbonEmission12MonthsAgo
changeRatioForLastMonth	number	Change ratio between totalCarbonEmission and totalCarbonEmissionLastMonth
changeValueMonthOverMonth	number	Change Value between totalCarbonEmission and totalCarbonEmissionLastMonth
dataType	string: ResourceGroupItemDetailsData	Query result data type name
groupName	string	Item group name
itemName	string	Item name
subscriptionId	string	Subscription Id
totalCarbonEmission	number	Total carbon emissions for given query parameters
totalCarbonEmission12MonthsAgo	number	Total carbon emissions for 12 months ago for given query parameters
totalCarbonEmissionLastMonth	number	Total carbon emission for last month for given query parameters

ResourceGroupCarbonEmissionTopItemMonthlySummaryData

Response for Top Items Carbon Emissions by Month for ResourceGroupType

Name	Type	Description
categoryType	CategoryTypeEnum	Item category
changeRatioFor12Months	number	Change ratio between totalCarbonEmission and totalCarbonEmission12MonthsAgo
changeRatioForLastMonth	number	Change ratio between totalCarbonEmission and totalCarbonEmissionLastMonth
changeValueMonthOverMonth	number	Change Value between totalCarbonEmission and totalCarbonEmissionLastMonth
dataType	string: ResourceGroupTopItemsMonthlySummaryData	Query result data type name
date	string	Month date
itemName	string	Item name
subscriptionId	string	Subscription Id
totalCarbonEmission	number	Total carbon emissions for given query parameters
totalCarbonEmission12MonthsAgo	number	Total carbon emissions for 12 months ago for given query parameters
totalCarbonEmissionLastMonth	number	Total carbon emission for last month for given query parameters

ResourceGroupCarbonEmissionTopItemsSummaryData

Response for Top Items For ResourceGroup

Name	Type	Description
categoryType	CategoryTypeEnum	Item category
changeRatioFor12Months	number	Change ratio between totalCarbonEmission and totalCarbonEmission12MonthsAgo
changeRatioForLastMonth	number	Change ratio between totalCarbonEmission and totalCarbonEmissionLastMonth
changeValueMonthOverMonth	number	Change Value between totalCarbonEmission and totalCarbonEmissionLastMonth
dataType	string: ResourceGroupTopItemsSummaryData	Query result data type name
itemName	string	Item name
subscriptionId	string	Subscription Id
totalCarbonEmission	number	Total carbon emissions for given query parameters
totalCarbonEmission12MonthsAgo	number	Total carbon emissions for 12 months ago for given query parameters
totalCarbonEmissionLastMonth	number	Total carbon emission for last month for given query parameters

TopItemsMonthlySummaryReportQueryFilter

Query Parameters for Top Items Carbon Emissions by Month

Name	Type	Description
carbonScopeList	EmissionScopeEnum[]	Carbon emission scope for carbon emissions data
categoryType	CategoryTypeEnum	Item Category type
dateRange	DateRange	The start date and end date for carbon emissions data
reportType	string: TopItemsMonthlySummaryReport	Report type
resourceGroupUrlList	string[]	resourceGroupUrl list for carbon emissions data
subscriptionList	string[]	SubscriptionId list for carbon emissions data
topItems	integer	Number of top items to return. The value should be between 5 and 100

TopItemsSummaryReportQueryFilter

Query Parameters for Top Items Carbon Emission by Category Type

Name	Type	Description
carbonScopeList	EmissionScopeEnum[]	Carbon emission scope for carbon emissions data
categoryType	CategoryTypeEnum	Item Category type
dateRange	DateRange	The start date and end date for carbon emissions data
reportType	string: TopItemsSummaryReport	Report type
resourceGroupUrlList	string[]	resourceGroupUrl list for carbon emissions data
subscriptionList	string[]	SubscriptionId list for carbon emissions data
topItems	integer	Number of top items to return. The value should be between 5 and 100

Share via

Carbon Service - List Carbon Emission Reports

URI Parameters

Request Body

ItemDetailsQueryFilter

MonthlySummaryReportQueryFilter

OverallSummaryReportQueryFilter

TopItemsMonthlySummaryReportQueryFilter

TopItemsSummaryReportQueryFilter

Responses

Security

azure_auth

Scopes

Examples

CarbonService_ListCarbonEmissionReports

Sample Request

Sample Response

Definitions

CarbonEmissionDataListResult

CarbonEmissionItemDetailData

CarbonEmissionMonthlySummaryData

CarbonEmissionOverallSummaryData

CarbonEmissionTopItemMonthlySummaryData

CarbonEmissionTopItemsSummaryData

CategoryTypeEnum

DateRange

EmissionScopeEnum

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ItemDetailsQueryFilter

MonthlySummaryReportQueryFilter

OverallSummaryReportQueryFilter

ResourceCarbonEmissionItemDetailData

ResourceCarbonEmissionTopItemMonthlySummaryData

ResourceCarbonEmissionTopItemsSummaryData

ResourceGroupCarbonEmissionItemDetailData

ResourceGroupCarbonEmissionTopItemMonthlySummaryData

ResourceGroupCarbonEmissionTopItemsSummaryData

TopItemsMonthlySummaryReportQueryFilter

TopItemsSummaryReportQueryFilter

Additional resources