共用方式為

使用 API 導出 Azure 排放數據中的碳優化

本文可協助您瞭解並使用最新的 碳服務 REST API 來匯出 Azure 排放數據中的碳優化。 在本月的第 19 天之前，上個月的排放數據會提供出來。

若要使用 REST API 匯出排放數據，您必須建立並授權服務主體存取您的排放數據。 接著，您可以使用服務主體來取得授權令牌，然後使用 REST API 匯出排放數據。

建立和授權服務主體

服務主體是一個應用程式，其令牌可用來使用 Microsoft Entra ID 來驗證和授與特定 Azure 資源的存取權。 資源包括使用者應用程式、服務或自動化工具。

  1. 建立可存取資源的Microsoft Entra 應用程式和服務主體 。
  2. 儲存應用程式的租使用者標識碼、新的用戶端標識碼和客戶端密碼值，以用於令牌要求。
  3. 應用程式必須針對您想要匯出排放數據的資源指派 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=="
}

報表類型

碳優化提供各種報告類型，可協助您分析排放數據。 每個報表類型都有不同的用途，並用於您的特定需求：

報表類型 說明 使用時機
總結報告 提供指定日期範圍和查詢參數的碳排放總量，以及高階概觀的比較值。 此報表類型會接受 DateRange 內開始和結束欄位中的不同值。 例如，start：2024-03-01 和 end：2024-06-01。 需要高階報表數據
月度摘要報告 依月份提供指定查詢參數的碳排放數據。 此報表類型會接受 DateRange 內開始和結束欄位中的不同值。 例如，start：2024-03-01 和 end：2024-06-01。 指定月份的詳細數據
熱門項目摘要報告 提供符合指定查詢篩選條件的 N 個最高排放項目。 此報表會一次傳回單一月的數據，因此它需要 DateRange 內開始和結束欄位的相同值。 一次最多會傳回 N=10 個項目。 依類別排序的最上層項目數據
熱門項目每月摘要報告 針對指定的查詢篩選，提供每月 N 個排放量最高的項目。 依指定日期範圍內月份傳回前 N 個專案的排放數據。 一次最多會傳回 N=10 個項目。 依類別和月份排序的最上層項目數據
項目詳細報告 根據查詢過濾器中指定的 CategoryType（包括：Resource、ResourceGroup、ResourceType、Location 或 Subscription）所列出的細項清單。 您一次只能查詢一個月。 DateRange 需要開始和結束欄位的相同值。 依類別的排放數據

匯出排放 API 參數

針對每個 reportType，會定義不同的查詢參數。 下列各節提供每個 reportType查詢參數的詳細資訊。

名字 描述
ItemDetailsQueryFilter ItemDetailsReport 的查詢參數
MonthlySummaryReportQueryFilter 用來設定 MonthlySummaryReport 查詢的查詢篩選參數。
OverallSummaryReportQueryFilter 用來設定 OverallSummaryReport 查詢的查詢篩選參數。
熱門項目每月摘要報告查詢篩選器 用來設定 TopItemsMonthlySummaryReport 查詢的查詢篩選參數。
最佳項目彙總報告查詢過濾器 用來設定 TopItemsSummaryReport 查詢的查詢篩選參數。

如需 REST API 報告的詳細資訊，請參閱 碳服務 - 列出碳排放報告。

項目詳情查詢過濾器

以下是 的 ItemDetailsReport查詢參數。

名字 必填 類型 描述
carbonScopeList 對 EmissionScopeEnum[] 碳排放範圍清單。 必須的。 接受 來自 EmissionScopeEnum的一或多個值。 例如，以列表形式的 Scope1、Scope2、Scope3。 輸出包含指定範圍的總排放量。
類別類型 對 CategoryTypeEnum 指定詳細排放數據的類別類型，例如 Resource、ResourceGroup、ResourceType、Location 或 Subscription。 請參閱 中 CategoryTypeEnum支援的類型。
日期範圍 對 DateRange 碳排放數據的開始和結束日期。 必須的。 針對 ItemDetailsReport 和 TopItemsSummaryReport，一次只支援一個月的數據，因此開始和結束日期應該在 內 DateRange相等。 例如，start：2024-06-01 和 end：2024-06-01。
排序依據 對 OrderByColumnEnum 要排序結果的數據行名稱。 請參閱 中 OrderByColumnEnum支援的值。
頁面大小 對 整數（int32）

最小值：1
最大值：5000		 在一個要求中傳回的項目數，最大值為 5000。
報告類型 對 字串：

項目詳細報告		 針對碳排放數據所要求的 ReportType。 必須的。 指定如何在輸出中匯總和顯示數據，如 中所述 ReportTypeEnum。
sortDirection 對 SortDirectionEnum 排序結果的方向。 請參閱 中 SortDirectionEnum支援的值。
訂閱列表 對 字串[] 要求碳排放數據的訂用帳戶標識符清單。 必須的。 每個訂用帳戶標識碼都應該以小寫格式。 清單的最大長度為 100。
locationList 字串[] 碳排放數據的位置清單（Azure 區域顯示名稱），每個位置都以小寫指定。 例如： east us 。 選擇性。 您可以使用 命令 az account list-locations -o table 來尋找 Azure 區域顯示名稱。
資源群組網址列表 字串[] 碳排放數據的資源群組 URL 清單。 選擇性。 每個 URL 都必須遵循 格式 /subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}，而且應該全都以小寫為單位。
資源類型列表 字串[] 碳排放數據的資源類型清單。 選擇性。 每個資源類型都應該以小寫指定，格式為 microsoft.{service}/{resourceType}。 例如： microsoft.storage/storageaccounts 。
skipToken 字串 擷取下一頁數據的分頁令牌。 此令牌可為 Null，如果其他數據頁可供使用，則會在先前的回應中傳回。

每月摘要報告查詢篩選器

以下是用來設定 MonthlySummaryReport 查詢的查詢篩選參數。

名字 必填 類型 描述
carbonScopeList 對 EmissionScopeEnum[] 碳排放範圍清單。 必須的。 接受 來自 EmissionScopeEnum的一或多個值。 例如，以列表形式的 Scope1、Scope2、Scope3。 輸出包含指定範圍的總排放量。
日期範圍 對 DateRange 碳排放數據的開始和結束日期。 必須的。 針對 ItemDetailsReport 和 TopItemsSummaryReport，一次只支援一個月的數據，因此開始和結束日期應該在 內 DateRange相等。 例如，start：2024-06-01 和 end：2024-06-01。
報告類型 對 字串：

月度摘要報告		 針對碳排放數據所要求的 ReportType。 必須的。 指定如何在輸出中匯總和顯示數據，如 中所述 ReportTypeEnum。
訂閱列表 對 字串[] 要求碳排放數據的訂用帳戶標識符清單。 必須的。 每個訂用帳戶標識碼都應該以小寫格式。 清單的最大長度為 100。
locationList 字串[] 碳排放數據的位置清單（Azure 區域顯示名稱），每個位置都以小寫指定。 例如： east us 。 選擇性。 您可以使用 命令 az account list-locations -o table 來尋找 Azure 區域顯示名稱。
資源群組網址列表 字串[] 碳排放數據的資源群組 URL 清單。 選擇性。 每個 URL 都必須遵循 格式 /subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}，而且應該全都以小寫為單位。
資源類型列表 字串[] 碳排放數據的資源類型清單。 選擇性。 每個資源類型都應該以小寫指定，格式為 microsoft.{service}/{resourceType}。 例如： microsoft.storage/storageaccounts 。

總體摘要報告查詢篩選器

以下是設定 OverallSummaryReport 查詢的查詢篩選參數。

名字 必填 類型 描述
carbonScopeList 對 EmissionScopeEnum[] 碳排放範圍清單。 必須的。 接受 來自 EmissionScopeEnum的一或多個值。 例如，以列表形式的 Scope1、Scope2、Scope3。 輸出包含指定範圍的總排放量。
日期範圍 對 DateRange 碳排放數據的開始和結束日期。 必須的。 針對 ItemDetailsReport 和 TopItemsSummaryReport，一次只支援一個月的數據，因此開始和結束日期應該在 內 DateRange相等。 例如，start：2024-06-01 和 end：2024-06-01。
報告類型 對 字串：

總結報告		 針對碳排放數據所要求的 ReportType。 必須的。 指定如何在輸出中匯總和顯示數據，如 中所述 ReportTypeEnum。
訂閱列表 對 字串[] 要求碳排放數據的訂用帳戶標識符清單。 必須的。 每個訂用帳戶標識碼都應該以小寫格式。 清單的最大長度為 100。
locationList 字串[] 碳排放數據的位置清單（Azure 區域顯示名稱），每個位置都以小寫指定。 例如： east us 。 選擇性。 您可以使用 命令 az account list-locations -o table 來尋找 Azure 區域顯示名稱。
資源群組網址列表 字串[] 碳排放數據的資源群組 URL 清單。 選擇性。 每個 URL 都必須遵循 格式 /subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}，而且應該全都以小寫為單位。
資源類型列表 字串[] 碳排放數據的資源類型清單。 選擇性。 每個資源類型都應該以小寫指定，格式為 microsoft.{service}/{resourceType}。 例如： microsoft.storage/storageaccounts 。

熱門項目月度摘要報告查詢過濾器

以下是用來設定 TopItemsMonthlySummaryReport 查詢的查詢篩選參數。

名字 必填 類型 描述
carbonScopeList 對 EmissionScopeEnum[] 碳排放範圍清單。 必須的。 接受 來自 EmissionScopeEnum的一或多個值。 例如，以列表形式的 Scope1、Scope2、Scope3。 輸出包含指定範圍的總排放量。
類別類型 對 CategoryTypeEnum 指定要擷取依月份匯總的最上層發出項目的類別類型。 請參閱 中 CategoryTypeEnum支援的類型。
日期範圍 對 DateRange 碳排放數據的開始和結束日期。 必須的。 針對 ItemDetailsReport 和 TopItemsSummaryReport，一次只支援一個月的數據，因此開始和結束日期應該在 內 DateRange相等。 例如，start：2024-06-01 和 end：2024-06-01。
報告類型 對 字串：

熱門項目每月摘要報告		 針對碳排放數據所要求的 ReportType。 必須的。 指定如何在輸出中匯總和顯示數據，如 中所述 ReportTypeEnum。
訂閱列表 對 字串[] 要求碳排放數據的訂用帳戶標識符清單。 必須的。 每個訂用帳戶標識碼都應該以小寫格式。 清單的最大長度為 100。
熱門項目 對 整數（int32）

最小值：1
最大值：10		 要根據排放傳回的最上層項目數目。 必須介於 1 到 10 之間。
locationList 字串[] 碳排放數據的位置清單（Azure 區域顯示名稱），每個位置都以小寫指定。 例如： east us 。 選擇性。 您可以使用 命令 az account list-locations -o table 來尋找 Azure 區域顯示名稱。
資源群組網址列表 字串[] 碳排放數據的資源群組 URL 清單。 選擇性。 每個 URL 都必須遵循 格式 /subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}，而且應該全都以小寫為單位。
資源類型列表 字串[] 碳排放數據的資源類型清單。 選擇性。 每個資源類型都應該以小寫指定，格式為 microsoft.{service}/{resourceType}。 例如： microsoft.storage/storageaccounts 。

項目摘要報告查詢篩選器

以下是要設定 TopItemsSummaryReport queries的查詢篩選參數。

名字 必填 類型 描述
carbonScopeList 對 EmissionScopeEnum[] 碳排放範圍清單。 必須的。 接受 來自 EmissionScopeEnum的一或多個值。 例如，以列表形式的 Scope1、Scope2、Scope3。 輸出包含指定範圍的總排放量。
類別類型 對 CategoryTypeEnum 指定要擷取最上層發出項目的類別類型。 請參閱 中 CategoryTypeEnum定義的支援值。
日期範圍 對 DateRange 碳排放數據的開始和結束日期。 必須的。 針對 ItemDetailsReport 和 TopItemsSummaryReport，一次只支援一個月的數據，因此開始和結束日期應該在 內 DateRange相等。 例如，start：2024-06-01 和 end：2024-06-01。
報告類型 對 字串：

熱門項目摘要報告		 針對碳排放數據所要求的 ReportType。 必須的。 指定如何在輸出中匯總和顯示數據，如 中所述 ReportTypeEnum。
訂閱列表 對 字串[] 要求碳排放數據的訂用帳戶標識符清單。 必須的。 每個訂用帳戶標識碼都應該以小寫格式。 清單的最大長度為 100。
熱門項目 對 整數（int32）

最小值：1
最大值：10		 要根據排放傳回的最上層項目數目。 此值必須介於 1 到 10 之間。
locationList 字串[] 碳排放數據的位置清單（Azure 區域顯示名稱），每個位置都以小寫指定。 例如： east us 。 選擇性。 您可以使用 命令 az account list-locations -o table 來尋找 Azure 區域顯示名稱。
資源群組網址列表 字串[] 碳排放數據的資源群組 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
    }
  ]
}

熱門項目摘要報告

報告顯示前 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"
    }
  ]
}

熱門項目每月摘要報告

報告會顯示在所指定的日期範圍內，每個月就訂閱、排放、範圍和類別匯總的排放量最多的前 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"
    }
  ]
}

項目詳細報告

報告顯示在指定日期範圍內，所選範疇和訂閱帳戶 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