使用 API 导出 Azure 排放数据中的碳优化

本文可帮助你了解和使用最新的碳服务 REST API 在 Azure 排放数据中导出碳优化。本月19日之前可以获得上个月的排放数据。

若要使用 REST API 导出排放数据，必须创建并授权服务主体访问排放数据。然后，可以使用服务主体获取授权令牌，然后使用 REST API 导出排放数据。

创建服务主体并为其授权

服务主体是一个应用程序，其令牌可用于使用 Microsoft Entra ID 对特定 Azure 资源进行身份验证和授予访问权限。资源包括用户应用、服务或自动化工具。

创建可访问资源的Microsoft Entra 应用程序和服务主体。
保存应用的租户 ID、新客户端 ID 和客户端机密值，以便在令牌请求中使用。
应用必须被分配 Carbon Optimization Reader 角色，用于你要导出排放数据的资源。如果要使用应用导出许多资源的排放数据，可以在订阅级别分配角色。有关详细信息，请参阅使用 Azure 门户分配 Azure 角色，并在 Azure 中分配对碳优化的访问权限。

获取授权令牌

在命令提示符中或使用客户端发送以下 POST 请求。使用资源 URL https://management.azure.com 获取资源管理 API 的访问令牌。

curl -X POST 'https://login.microsoftonline.com/<tennant ID>/oauth2/token' \
-H 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=client_credentials' \
--data-urlencode 'client_id=<your apps client ID>' \
--data-urlencode 'client_secret=<your apps client secret' \
--data-urlencode 'resource=https://management.azure.com'

响应正文如下所示：

{
    "token_type": "Bearer",
    "expires_in": "86399",
    "ext_expires_in": "86399",
    "expires_on": "1672826207",
    "not_before": "1672739507",
    "resource": "https://management.azure.com",
    "access_token": "eyJ0eXAiOiJKV1Qi....gpHWoRzeDdVQd2OE3dNsLIvUIxQ"
}

使用从响应中获取的访问令牌进行后续的 HTTP 请求。

使用 REST API 导出排放数据

POST使用以下请求导出排放数据。

POST /providers/Microsoft.Carbon/carbonEmissionReports?api-version=2025-04-01
Host: management.azure.com
Content-Type: application/json
Authorization: Bearer \<token value\>

示例请求和响应

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

{
  "reportType": "MonthlySummaryReport",
  "subscriptionList": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "carbonScopeList": [
    "Scope1",
    "Scope3"
  ],
  "dateRange": {
    "start": "2024-03-01",
    "end": "2024-05-01"
  }
}

示例输出

{
  "subscriptionAccessDecisionList": [
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000000",
      "decision": "Allowed"
    }
  ],
  "value": [
    {
      "dataType": "OverallSummaryData",
      "latestMonthEmissions": 0.1,
      "previousMonthEmissions": 0.05,
      "monthOverMonthEmissionsChangeRatio": 1,
      "monthlyEmissionsChangeValue": 0.05
    }
  ]
}

以下是 curl 示例：

curl --location 'https://management.azure.com/providers/Microsoft.Carbon/carbonEmissionReports?api-version=2025-04-01' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJ0eXA...2-KgVBNrsvg' \
--data '{
  "reportType": "ItemDetailsReport",
  "subscriptionList": [
    "00000000-0000-0000-0000-000000000000",
    "00000000-0000-0000-0000-000000000001,",
    "00000000-0000-0000-0000-000000000002",
    "00000000-0000-0000-0000-000000000003",
    "00000000-0000-0000-0000-000000000004",
    "00000000-0000-0000-0000-000000000005",
    "00000000-0000-0000-0000-000000000006",
    "00000000-0000-0000-0000-000000000007",
    "00000000-0000-0000-0000-000000000008"
  ],
  "carbonScopeList": [
    "Scope1",
    "Scope3"
  ],
  "dateRange": {
    "start": "2024-05-01",
    "end": "2024-05-01"
  },
  "categoryType": "Resource",
  "orderBy": "LatestMonthEmissions",
  "sortDirection": "Desc",
  "pageSize": 100
}
'

示例 curl 输出：

{
  "subscriptionAccessDecisionList": [
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000000",
      "decision": "Allowed"
    },
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000001",
      "decision": "Allowed"
    },
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000002",
      "decision": "Allowed"
    },
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000003",
      "decision": "Allowed"
    },
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000004",
      "decision": "Allowed"
    },
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000005",
      "decision": "Allowed"
    },
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000006",
      "decision": "Denied"
    },
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000007",
      "decision": "Denied"
    },
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000008",
      "decision": "Denied",
      "denialReason": "Carbon Optimization Reader permisison required"
    }
  ],
  "value": [
    {
      "dataType": "ResourceItemDetailsData",
      "latestMonthEmissions": 0.1,
      "previousMonthEmissions": 0.05,
      "monthOverMonthEmissionsChangeRatio": 1,
      "monthlyEmissionsChangeValue": 0.05,
      "itemName": "rgName1",
      "resourceGroup": "rgGroup",
      "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgGroup/providers/microsoft.storage/storageaccounts/rgName1",
      "subscriptionId": "00000000-0000-0000-0000-000000000000",
      "categoryType": "Resource",
      "resourceType": "microsoft.storage/storageaccounts",
      "location": "east us"
    },
    {
      "dataType": "ResourceItemDetailsData",
      "latestMonthEmissions": 0.1,
      "previousMonthEmissions": 0.05,
      "monthOverMonthEmissionsChangeRatio": 1,
      "monthlyEmissionsChangeValue": 0.05,
      "itemName": "rgName2",
      "resourceGroup": "rgGroup",
      "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgGroup/providers/microsoft.storage/storageaccounts/rgName2",
      "subscriptionId": "00000000-0000-0000-0000-000000000000",
      "categoryType": "Resource",
      "resourceType": "microsoft.storage/storageaccounts",
      "location": "east us"
    },
    {
      "dataType": "ResourceItemDetailsData",
      "latestMonthEmissions": 0.1,
      "previousMonthEmissions": 0.05,
      "monthOverMonthEmissionsChangeRatio": 1,
      "monthlyEmissionsChangeValue": 0.05,
      "itemName": "rgName3",
      "resourceGroup": "rgGroup",
      "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgGroup/providers/microsoft.storage/storageaccounts/rgName3",
      "subscriptionId": "00000000-0000-0000-0000-000000000000",
      "categoryType": "Resource",
      "resourceType": "microsoft.storage/storageaccounts",
      "location": "east us"
    },
    {
      "dataType": "ResourceItemDetailsData",
      "latestMonthEmissions": 0.1,
      "previousMonthEmissions": 0.05,
      "monthOverMonthEmissionsChangeRatio": 1,
      "monthlyEmissionsChangeValue": 0.05,
      "itemName": "rgName4",
      "resourceGroup": "rgGroup",
      "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000002/resourceGroups/rgGroup/providers/microsoft.storage/storageaccounts/rgName4",
      "subscriptionId": "00000000-0000-0000-0000-000000000002",
      "categoryType": "Resource",
      "resourceType": "microsoft.storage/storageaccounts",
      "location": "east us"
    },
    {
      "dataType": "ResourceItemDetailsData",
      "latestMonthEmissions": 0.1,
      "previousMonthEmissions": 0.05,
      "monthOverMonthEmissionsChangeRatio": 1,
      "monthlyEmissionsChangeValue": 0.05,
      "itemName": "rgName5",
      "resourceGroup": "rgGroup",
      "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000002/resourceGroups/rgGroup/providers/microsoft.storage/storageaccounts/rgName5",
      "subscriptionId": "00000000-0000-0000-0000-000000000002",
      "categoryType": "Resource",
      "resourceType": "microsoft.storage/storageaccounts",
      "location": "east us"
    }
  ],
  "skipToken": "dGVzZGZhZGZzZnNkZg=="
}

报表类型

碳优化提供了各种报告类型，可帮助你分析排放数据。每个报表类型都用途不同，并用于特定需求：

报表类型	DESCRIPTION	何时使用
总体总结报告	为指定日期范围和查询参数提供总碳排放量，并为概要概述提供比较值。此报表类型接受 DateRange 中开始和结束字段中的不同值。例如，start：2024-03-01 和 end：2024-06-01。	所需的高级报告数据
月度总结报告	按月份为指定的查询参数提供碳排放数据。此报表类型接受 DateRange 中开始和结束字段中的不同值。例如，start：2024-03-01 和 end：2024-06-01。	指定月份的详细信息
TopItemsSummaryReport	为指定的查询筛选器提供排放量最高的 N 个项目。此报表一次返回单个月的数据，因此它需要 DateRange 中开始和结束字段的相同值。每次返回最多 N=10 个项目。	按类别排名前几的项目的数据
TopItemsMonthlySummaryReport	为指定的查询筛选器每月提供 N 个排放量最高的物品。返回给定日期范围内按月统计的前 N 个项目的排放数据。每次返回最多 N=10 个项目。	按类别和月份划分的顶级项的数据
ItemDetailsReport	基于指定 CategoryType 的项目的细粒度列表（包括：Resource、ResourceGroup、ResourceType、Location 或 Subscription），用于查询筛选器。一次只能查询一个月。 DateRange 需要开始和结束字段的相同值。	按类别划分的排放数据

导出排放 API 参数

对于每个 reportType参数，定义不同的查询参数。以下各节提供有关每个 reportType查询参数的详细信息。

名字	描述
ItemDetailsQueryFilter	`ItemDetailsReport` 的查询参数
MonthlySummaryReportQueryFilter	配置 `MonthlySummaryReport` 查询的查询筛选参数。
OverallSummaryReportQueryFilter	配置 `OverallSummaryReport` 查询的查询筛选参数。
TopItems月度总结报告查询过滤器	配置 `TopItemsMonthlySummaryReport` 查询的查询筛选参数。
热门项目摘要报告查询筛选器	配置 `TopItemsSummaryReport` 查询的查询筛选参数。

有关 REST API 报告的详细信息，请参阅碳服务 - 列出碳排放报告。

ItemDetailsQueryFilter

下面是 ItemDetailsReport 的查询参数。

名字	必填	类型	描述
carbonScopeList	True	EmissionScopeEnum[]	碳排放范围列表。必填。接受来自`EmissionScopeEnum`的一个或多个值。例如，Scope1、Scope2、Scope3 按列表形式排列。输出包括指定范围的排放总量。
categoryType	True	CategoryTypeEnum	指定详细排放数据的类别类型，例如 Resource、ResourceGroup、ResourceType、Location 或 Subscription。请参阅中 `CategoryTypeEnum`支持的类型。
dateRange	True	DateRange	碳排放数据的开始日期和结束日期。必填。对于 `ItemDetailsReport` 和 `TopItemsSummaryReport`，一次仅支持一个月的数据，因此在 `DateRange` 中，开始日期和结束日期必须相等。例如，start：2024-06-01 和 end：2024-06-01。
orderBy	True	OrderByColumnEnum	用于排序结果的列名。请参阅中 `OrderByColumnEnum`支持的值。
页面大小	True	整数（int32）最小值：1 最大值：5000	要在一个请求中返回的项目数，最大值为 5000。
报告类型	True	字符串： ItemDetailsReport	请求的碳排放数据报告类型。必填。指定如何在输出中聚合和显示数据，详见`ReportTypeEnum`。
sortDirection	True	SortDirectionEnum	排序结果的方向。请参阅中 `SortDirectionEnum`支持的值。
订阅列表	True	字符串[]	请求碳排放数据的订阅 ID 列表。必填。每个订阅 ID 应采用小写格式。列表的最大长度为 100。
locationList		字符串[]	碳排放数据的位置列表（Azure 区域显示名称），每个位置都以小写形式指定。例如，`east us`。可选。可以使用该命令 `az account list-locations -o table` 查找 Azure 区域显示名称。
resourceGroupUrlList		字符串[]	碳排放数据的资源组 URL 列表。可选。每个 URL 必须遵循格式 `/subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}`，并且应采用所有小写形式。
资源类型列表		字符串[]	碳排放数据的资源类型列表。可选。应按小写形式指定每个资源类型，格式如下 `microsoft.{service}/{resourceType}`。例如，`microsoft.storage/storageaccounts`。
skipToken		字符串	用于获取下一页数据的分页令牌。此令牌可为 null，如果其他数据页可用，则会在上一响应中返回。

月度概要报告查询筛选器

下面是用于配置 MonthlySummaryReport 查询的查询筛选器参数。

名字	必填	类型	描述
carbonScopeList	True	EmissionScopeEnum[]	碳排放范围列表。必填。接受来自`EmissionScopeEnum`的一个或多个值。例如，Scope1、Scope2、Scope3 按列表形式排列。输出包括指定范围的排放总量。
dateRange	True	DateRange	碳排放数据的开始日期和结束日期。必填。对于 `ItemDetailsReport` 和 `TopItemsSummaryReport`，一次仅支持一个月的数据，因此在 `DateRange` 中，开始日期和结束日期必须相等。例如，start：2024-06-01 和 end：2024-06-01。
报告类型	True	字符串：月度总结报告	请求的碳排放数据报告类型。必填。指定如何在输出中聚合和显示数据，详见`ReportTypeEnum`。
订阅列表	True	字符串[]	请求碳排放数据的订阅 ID 列表。必填。每个订阅 ID 应采用小写格式。列表的最大长度为 100。
locationList		字符串[]	碳排放数据的位置列表（Azure 区域显示名称），每个位置都以小写形式指定。例如，`east us`。可选。可以使用该命令 `az account list-locations -o table` 查找 Azure 区域显示名称。
resourceGroupUrlList		字符串[]	碳排放数据的资源组 URL 列表。可选。每个 URL 必须遵循格式 `/subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}`，并且应采用所有小写形式。
资源类型列表		字符串[]	碳排放数据的资源类型列表。可选。应按小写形式指定每个资源类型，格式如下 `microsoft.{service}/{resourceType}`。例如，`microsoft.storage/storageaccounts`。

OverallSummaryReportQueryFilter

下面是用于配置 OverallSummaryReport 查询的查询筛选器参数。

名字	必填	类型	描述
carbonScopeList	True	EmissionScopeEnum[]	碳排放范围列表。必填。接受来自`EmissionScopeEnum`的一个或多个值。例如，Scope1、Scope2、Scope3 按列表形式排列。输出包括指定范围的排放总量。
dateRange	True	DateRange	碳排放数据的开始日期和结束日期。必填。对于 `ItemDetailsReport` 和 `TopItemsSummaryReport`，一次仅支持一个月的数据，因此在 `DateRange` 中，开始日期和结束日期必须相等。例如，start：2024-06-01 和 end：2024-06-01。
报告类型	True	字符串：总体总结报告	请求的碳排放数据报告类型。必填。指定如何在输出中聚合和显示数据，详见`ReportTypeEnum`。
订阅列表	True	字符串[]	要请求碳排放数据的订阅 ID 列表。必填。每个订阅 ID 应采用小写格式。列表的最大长度为 100。
locationList		字符串[]	碳排放数据的位置列表（Azure 区域显示名称），每个位置都以小写形式指定。例如，`east us`。可选。可以使用该命令 `az account list-locations -o table` 查找 Azure 区域显示名称。
resourceGroupUrlList		字符串[]	碳排放数据的资源组 URL 列表。可选。每个 URL 必须遵循格式 `/subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}`，并且应采用所有小写形式。
资源类型列表		字符串[]	碳排放数据的资源类型列表。可选。应按小写形式指定每个资源类型，格式如下 `microsoft.{service}/{resourceType}`。例如，`microsoft.storage/storageaccounts`。

TopItemsMonthlySummaryReportQueryFilter

下面是用于配置 TopItemsMonthlySummaryReport 查询的查询筛选器参数。

名字	必填	类型	描述
carbonScopeList	True	EmissionScopeEnum[]	碳排放范围列表。必填。接受来自`EmissionScopeEnum`的一个或多个值。例如，Scope1、Scope2、Scope3 按列表形式排列。输出包括指定范围的排放总量。
categoryType	True	CategoryTypeEnum	指定用于检索按月聚合的排放量最高项的类别类型。请参阅中 `CategoryTypeEnum`支持的类型。
dateRange	True	DateRange	碳排放数据的开始日期和结束日期。必填。对于 `ItemDetailsReport` 和 `TopItemsSummaryReport`，一次仅支持一个月的数据，因此在 `DateRange` 中，开始日期和结束日期必须相等。例如，start：2024-06-01 和 end：2024-06-01。
报告类型	True	字符串： TopItemsMonthlySummaryReport	请求的碳排放数据报告类型。必填。指定如何在输出中聚合和显示数据，详见`ReportTypeEnum`。
订阅列表	True	字符串[]	为其请求碳排放数据的订阅 ID 列表。必填。每个订阅 ID 应采用小写格式。列表的最大长度为 100。
topItems	True	整数（int32）最小值：1 最大值：10	基于排放返回的顶级项目数量。必须介于 1 到 10 之间。
locationList		字符串[]	碳排放数据的位置列表（Azure 区域显示名称），每个位置都以小写形式指定。例如，`east us`。可选。可以使用该命令 `az account list-locations -o table` 查找 Azure 区域显示名称。
resourceGroupUrlList		字符串[]	碳排放数据的资源组 URL 列表。可选。每个 URL 必须遵循格式 `/subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}`，并且应采用所有小写形式。
资源类型列表		字符串[]	碳排放数据的资源类型列表。可选。应按小写形式指定每个资源类型，格式如下 `microsoft.{service}/{resourceType}`。例如，`microsoft.storage/storageaccounts`。

TopItemsSummaryReportQueryFilter

要配置的查询筛选器参数如下 TopItemsSummaryReport queries。

名字	必填	类型	描述
carbonScopeList	True	EmissionScopeEnum[]	碳排放范围列表。必填。接受来自`EmissionScopeEnum`的一个或多个值。例如，Scope1、Scope2、Scope3 按列表形式排列。输出包括指定范围的排放总量。
categoryType	True	CategoryTypeEnum	指定要检索排放最高的项目的类别类型。请参阅中 `CategoryTypeEnum`定义的受支持值。
dateRange	True	DateRange	碳排放数据的开始日期和结束日期。必填。对于 `ItemDetailsReport` 和 `TopItemsSummaryReport`，一次仅支持一个月的数据，因此在 `DateRange` 中，开始日期和结束日期必须相等。例如，start：2024-06-01 和 end：2024-06-01。
报告类型	True	字符串： TopItemsSummaryReport	请求的碳排放数据报告类型。必填。指定如何在输出中聚合和显示数据，详见`ReportTypeEnum`。
订阅列表	True	字符串[]	请求碳排放数据的订阅 ID 列表。必填。每个订阅 ID 应采用小写格式。列表的最大长度为 100。
topItems	True	整数（int32）最小值：1 最大值：10	基于排放返回的顶级项目数量。此值必须介于 1 和 10 之间。
locationList		字符串[]	碳排放数据的位置列表（Azure 区域显示名称），每个位置都以小写形式指定。例如，`east us`。可选。可以使用该命令 `az account list-locations -o table` 查找 Azure 区域显示名称。
resourceGroupUrlList		字符串[]	碳排放数据的资源组 URL 列表。可选。每个 URL 必须遵循格式 `/subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}`，并且应采用所有小写形式。
资源类型列表		字符串[]	碳排放数据的资源类型列表。可选。应按小写形式指定每个资源类型，格式如下 `microsoft.{service}/{resourceType}`。例如，`microsoft.storage/storageaccounts`。

示例报表

以下部分显示了每个报表类型的示例请求和响应。

所有报告都包括 subscriptionAccessDecisionList 响应。该字段显示每个输入订阅的访问决策。

总体总结报告

报告显示输入中指定的所有订阅范围和日期范围的总排放量。如果需要高级别报表数据，请使用此报表。

示例请求

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

{
  "reportType": "MonthlySummaryReport",
  "subscriptionList": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "carbonScopeList": [
    "Scope1",
    "Scope3"
  ],
  "dateRange": {
    "start": "2024-03-01",
    "end": "2024-05-01"
  }
}

示例响应

{
  "subscriptionAccessDecisionList": [
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000000",
      "decision": "Allowed"
    }
  ],
  "value": [
    {
      "dataType": "OverallSummaryData",
      "latestMonthEmissions": 0.1,
      "previousMonthEmissions": 0.05,
      "monthOverMonthEmissionsChangeRatio": 1,
      "monthlyEmissionsChangeValue": 0.05
    }
  ]
}

月度总结报告

报告显示日期范围指定月份的所有订阅和排放范围的排放。如果需要指定月份的详细信息，请使用报表。

示例请求

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

{
  "reportType": "MonthlySummaryReport",
  "subscriptionList": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "carbonScopeList": [
    "Scope1",
    "Scope3"
  ],
  "dateRange": {
    "start": "2024-03-01",
    "end": "2024-05-01"
  }
}

示例响应

{
  "subscriptionAccessDecisionList": [
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000000",
      "decision": "Allowed"
    }
  ],
  "value": [
    {
      "dataType": "MonthlySummaryData",
      "latestMonthEmissions": 0.1,
      "previousMonthEmissions": 0.05,
      "monthOverMonthEmissionsChangeRatio": 1,
      "monthlyEmissionsChangeValue": 0.05,
      "date": "2024-05-01",
      "carbonIntensity": 22
    },
    {
      "dataType": "MonthlySummaryData",
      "latestMonthEmissions": 0.1,
      "previousMonthEmissions": 0.05,
      "monthOverMonthEmissionsChangeRatio": 1,
      "monthlyEmissionsChangeValue": 0.05,
      "date": "2024-04-01",
      "carbonIntensity": 22
    },
    {
      "dataType": "MonthlySummaryData",
      "latestMonthEmissions": 0.1,
      "previousMonthEmissions": 0.05,
      "monthOverMonthEmissionsChangeRatio": 1,
      "monthlyEmissionsChangeValue": 0.05,
      "date": "2024-03-01",
      "carbonIntensity": 22
    }
  ]
}

TopItemsSummaryReport

报告显示跨订阅、排放、范围、类别和指定日期范围汇总的顶级 X 项目的排放，按类别细分。当需要按类别显示顶部项的数据时，请使用报表。

示例请求

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

{
  "reportType": "TopItemsSummaryReport",
  "subscriptionList": [
    "00000000-0000-0000-0000-000000000000",
    "00000000-0000-0000-0000-000000000001,",
    "00000000-0000-0000-0000-000000000002",
    "00000000-0000-0000-0000-000000000003",
    "00000000-0000-0000-0000-000000000004",
    "00000000-0000-0000-0000-000000000005",
    "00000000-0000-0000-0000-000000000006",
    "00000000-0000-0000-0000-000000000007",
    "00000000-0000-0000-0000-000000000008"
  ],
  "carbonScopeList": [
    "Scope1",
    "Scope3"
  ],
  "dateRange": {
    "start": "2024-05-01",
    "end": "2024-05-01"
  },
  "categoryType": "Location",
  "topItems": 5
}

示例响应

{
  "subscriptionAccessDecisionList": [
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000000",
      "decision": "Allowed"
    },
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000001",
      "decision": "Allowed"
    },
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000002",
      "decision": "Allowed"
    },
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000003",
      "decision": "Allowed"
    },
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000004",
      "decision": "Allowed"
    },
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000005",
      "decision": "Allowed"
    },
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000006",
      "decision": "Denied"
    },
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000007",
      "decision": "Denied"
    },
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000008",
      "decision": "Denied",
      "denialReason": "Carbon Optimization Reader permission required"
    }
  ],
  "value": [
    {
      "dataType": "TopItemsSummaryData",
      "latestMonthEmissions": 0.1,
      "previousMonthEmissions": 0.05,
      "monthOverMonthEmissionsChangeRatio": 1,
      "monthlyEmissionsChangeValue": 0.05,
      "itemName": "east us",
      "categoryType": "Location"
    },
    {
      "dataType": "TopItemsSummaryData",
      "latestMonthEmissions": 0.1,
      "previousMonthEmissions": 0.05,
      "monthOverMonthEmissionsChangeRatio": 1,
      "monthlyEmissionsChangeValue": 0.05,
      "itemName": "west us",
      "categoryType": "Location"
    },
    {
      "dataType": "TopItemsSummaryData",
      "latestMonthEmissions": 0.1,
      "previousMonthEmissions": 0.05,
      "monthOverMonthEmissionsChangeRatio": 1,
      "monthlyEmissionsChangeValue": 0.05,
      "itemName": "west us 2",
      "categoryType": "Location"
    },
    {
      "dataType": "TopItemsSummaryData",
      "latestMonthEmissions": 0.1,
      "previousMonthEmissions": 0.05,
      "monthOverMonthEmissionsChangeRatio": 1,
      "monthlyEmissionsChangeValue": 0.05,
      "itemName": "west us 3",
      "categoryType": "Location"
    },
    {
      "dataType": "TopItemsSummaryData",
      "latestMonthEmissions": 0.1,
      "previousMonthEmissions": 0.05,
      "monthOverMonthEmissionsChangeRatio": 1,
      "monthlyEmissionsChangeValue": 0.05,
      "itemName": "east us 2",
      "categoryType": "Location"
    }
  ]
}

TopItemsMonthlySummaryReport

报告显示日期范围中每个月的跨订阅、排放、范围和类别汇总的顶级 X 项目的排放。排放按类别细分。顶级 X 项目基于上个月的排放。当需要按类别和月份划分的顶级项的数据时，请使用报表。

示例请求

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

{
  "reportType": "TopItemsMonthlySummaryReport",
  "subscriptionList": [
    "00000000-0000-0000-0000-000000000000",
    "00000000-0000-0000-0000-000000000001,",
    "00000000-0000-0000-0000-000000000002",
    "00000000-0000-0000-0000-000000000003",
    "00000000-0000-0000-0000-000000000004",
    "00000000-0000-0000-0000-000000000005",
    "00000000-0000-0000-0000-000000000006",
    "00000000-0000-0000-0000-000000000007",
    "00000000-0000-0000-0000-000000000008"
  ],
  "carbonScopeList": [
    "Scope1",
    "Scope3"
  ],
  "dateRange": {
    "start": "2024-03-01",
    "end": "2024-05-01"
  },
  "categoryType": "Location",
  "topItems": 2
}

示例响应

{
  "subscriptionAccessDecisionList": [
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000000",
      "decision": "Allowed"
    },
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000001",
      "decision": "Allowed"
    },
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000002",
      "decision": "Allowed"
    },
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000003",
      "decision": "Allowed"
    },
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000004",
      "decision": "Allowed"
    },
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000005",
      "decision": "Allowed"
    },
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000006",
      "decision": "Denied"
    },
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000007",
      "decision": "Denied"
    },
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000008",
      "decision": "Denied",
      "denialReason": "Carbon Optimization Reader permission required"
    }
  ],
  "value": [
    {
      "dataType": "TopItemsMonthlySummaryData",
      "latestMonthEmissions": 0.1,
      "previousMonthEmissions": 0.05,
      "monthOverMonthEmissionsChangeRatio": 1,
      "monthlyEmissionsChangeValue": 0.05,
      "itemName": "east us",
      "categoryType": "Location",
      "date": "2024-05-01"
    },
    {
      "dataType": "TopItemsMonthlySummaryData",
      "latestMonthEmissions": 0.1,
      "previousMonthEmissions": 0.05,
      "monthOverMonthEmissionsChangeRatio": 1,
      "monthlyEmissionsChangeValue": 0.05,
      "itemName": "east us",
      "categoryType": "Location",
      "date": "2024-04-01"
    },
    {
      "dataType": "TopItemsMonthlySummaryData",
      "latestMonthEmissions": 0.1,
      "previousMonthEmissions": 0.05,
      "monthOverMonthEmissionsChangeRatio": 1,
      "monthlyEmissionsChangeValue": 0.05,
      "itemName": "east us",
      "categoryType": "Location",
      "date": "2024-03-01"
    },
    {
      "dataType": "TopItemsMonthlySummaryData",
      "latestMonthEmissions": 0.1,
      "previousMonthEmissions": 0.05,
      "monthOverMonthEmissionsChangeRatio": 1,
      "monthlyEmissionsChangeValue": 0.05,
      "itemName": "west us",
      "categoryType": "Location",
      "date": "2024-05-01"
    },
    {
      "dataType": "TopItemsMonthlySummaryData",
      "latestMonthEmissions": 0.1,
      "previousMonthEmissions": 0.05,
      "monthOverMonthEmissionsChangeRatio": 1,
      "monthlyEmissionsChangeValue": 0.05,
      "itemName": "west us",
      "categoryType": "Location",
      "date": "2024-04-01"
    },
    {
      "dataType": "TopItemsMonthlySummaryData",
      "latestMonthEmissions": 0.1,
      "previousMonthEmissions": 0.05,
      "monthOverMonthEmissionsChangeRatio": 1,
      "monthlyEmissionsChangeValue": 0.05,
      "itemName": "west us",
      "categoryType": "Location",
      "date": "2024-03-01"
    }
  ]
}

ItemDetailsReport

报告显示给定日期范围内跨所选范围和订阅 ID 聚合的排放，并按指定类别细分。当需要按类别划分的排放数据并获取资源组和资源级数据时，请使用报表。

示例请求

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

{
  "reportType": "ItemDetailsReport",
  "subscriptionList": [
    "00000000-0000-0000-0000-000000000000",
    "00000000-0000-0000-0000-000000000001,",
    "00000000-0000-0000-0000-000000000002",
    "00000000-0000-0000-0000-000000000003",
    "00000000-0000-0000-0000-000000000004",
    "00000000-0000-0000-0000-000000000005",
    "00000000-0000-0000-0000-000000000006",
    "00000000-0000-0000-0000-000000000007",
    "00000000-0000-0000-0000-000000000008"
  ],
  "carbonScopeList": [
    "Scope1",
    "Scope3"
  ],
  "dateRange": {
    "start": "2024-05-01",
    "end": "2024-05-01"
  },
  "categoryType": "Location",
  "orderBy": "LatestMonthEmissions",
  "sortDirection": "Desc",
  "pageSize": 100
}

示例响应

{
  "subscriptionAccessDecisionList": [
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000000",
      "decision": "Allowed"
    },
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000001",
      "decision": "Allowed"
    },
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000002",
      "decision": "Allowed"
    },
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000003",
      "decision": "Allowed"
    },
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000004",
      "decision": "Allowed"
    },
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000005",
      "decision": "Allowed"
    },
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000006",
      "decision": "Denied"
    },
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000007",
      "decision": "Denied"
    },
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000008",
      "decision": "Denied",
      "denialReason": "Carbon Optimization Reader permission required"
    }
  ],
  "value": [
    {
      "dataType": "ItemDetailsData",
      "latestMonthEmissions": 0.1,
      "previousMonthEmissions": 0.05,
      "monthOverMonthEmissionsChangeRatio": 1,
      "monthlyEmissionsChangeValue": 0.05,
      "itemName": "east us",
      "categoryType": "Location"
    },
    {
      "dataType": "ItemDetailsData",
      "latestMonthEmissions": 0.1,
      "previousMonthEmissions": 0.05,
      "monthOverMonthEmissionsChangeRatio": 1,
      "monthlyEmissionsChangeValue": 0.05,
      "itemName": "west us",
      "categoryType": "Location"
    },
    {
      "dataType": "ItemDetailsData",
      "latestMonthEmissions": 0.1,
      "previousMonthEmissions": 0.05,
      "monthOverMonthEmissionsChangeRatio": 1,
      "monthlyEmissionsChangeValue": 0.05,
      "itemName": "west us 2",
      "categoryType": "Location"
    },
    {
      "dataType": "ItemDetailsData",
      "latestMonthEmissions": 0.1,
      "previousMonthEmissions": 0.05,
      "monthOverMonthEmissionsChangeRatio": 1,
      "monthlyEmissionsChangeValue": 0.05,
      "itemName": "west us 3",
      "categoryType": "Location"
    },
    {
      "dataType": "ItemDetailsData",
      "latestMonthEmissions": 0.1,
      "previousMonthEmissions": 0.05,
      "monthOverMonthEmissionsChangeRatio": 1,
      "monthlyEmissionsChangeValue": 0.05,
      "itemName": "east us 2",
      "categoryType": "Location"
    }
  ]
}

反馈

此页面是否有帮助？

Last updated on 2026-07-02

使用 API 导出 Azure 排放数据中的碳优化

创建服务主体并为其授权

获取授权令牌

使用 REST API 导出排放数据

示例请求和响应

报表类型

导出排放 API 参数

ItemDetailsQueryFilter

月度概要报告查询筛选器

OverallSummaryReportQueryFilter

TopItemsMonthlySummaryReportQueryFilter

TopItemsSummaryReportQueryFilter

示例报表

总体总结报告

示例请求

示例响应

月度总结报告

示例请求

示例响应

TopItemsSummaryReport

示例请求

示例响应

TopItemsMonthlySummaryReport

示例请求

示例响应

ItemDetailsReport

示例请求

示例响应

相关内容

反馈

其他资源