Menggunakan API untuk mengekspor pengoptimalan Karbon dalam data emisi Azure

Artikel ini membantu Anda memahami dan menggunakan CARBON Service REST API terbaru untuk mengekspor pengoptimalan Karbon dalam data emisi Azure. Data emisi tersedia untuk bulan sebelumnya berdasarkan hari ke-19 dari bulan ini.

Untuk mengekspor data emisi menggunakan REST API, Anda harus membuat dan mengotorisasi perwakilan layanan untuk mengakses data emisi Anda. Anda kemudian dapat menggunakan perwakilan layanan untuk mendapatkan token otorisasi lalu mengekspor data emisi menggunakan REST API.

Membuat dan mengotorisasi prinsipal layanan

Perwakilan layanan adalah aplikasi yang tokennya dapat digunakan untuk mengautentikasi dan memberikan akses ke sumber daya Azure tertentu dengan menggunakan ID Microsoft Entra. Sumber daya termasuk aplikasi pengguna, layanan, atau alat otomatisasi.

Buat aplikasi Microsoft Entra dan perwakilan layanan yang dapat mengakses sumber daya.
Simpan ID penyewa, ID klien baru, dan nilai rahasia klien untuk aplikasi Anda untuk digunakan dalam permintaan token.
Aplikasi harus diberi peran Carbon Optimization Reader untuk sumber daya yang ingin Anda ekspor data emisinya. Jika Anda ingin menggunakan aplikasi untuk mengekspor data emisi untuk banyak sumber daya, Anda dapat menetapkan peran di tingkat langganan. Untuk informasi selengkapnya, lihat Menetapkan peran Azure dengan menggunakan portal Microsoft Azure dan Menetapkan akses ke pengoptimalan Karbon di Azure.

Mendapatkan token otorisasi

Kirim permintaan berikut POST di prompt perintah atau dengan menggunakan klien. Gunakan URL https://management.azure.com sumber daya untuk mendapatkan token akses untuk API manajemen sumber daya.

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'

Isi respons muncul sebagai berikut:

{
    "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"
}

Gunakan token akses dari respons untuk digunakan dalam permintaan HTTP berikut.

Mengekspor data emisi menggunakan REST API

Gunakan permintaan berikut POST untuk mengekspor data emisi.

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

Contoh permintaan dan respons

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"
  }
}

Contoh keluaran

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

Berikut adalah contoh 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
}
'

Sampel output 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=="
}

Jenis laporan

Pengoptimalan karbon menyediakan berbagai jenis laporan untuk membantu Anda menganalisis data emisi Anda. Setiap jenis laporan melayani tujuan yang berbeda dan digunakan untuk kebutuhan spesifik Anda:

Jenis laporan	Deskripsi	Kapan harus menggunakan
Laporan Ringkasan Keseluruhan	Menyediakan total emisi karbon untuk rentang tanggal dan parameter kueri yang ditentukan, dan nilai komparatif untuk gambaran umum tingkat tinggi. Jenis laporan ini menerima nilai yang berbeda di bidang awal dan akhir dalam DateRange. Misalnya, mulai: 2024-03-01 dan berakhir: 2024-06-01.	Data laporan tingkat tinggi diperlukan
Laporan Ringkasan Bulanan	Menyediakan data emisi karbon berdasarkan bulan untuk parameter kueri yang ditentukan. Jenis laporan ini menerima nilai yang berbeda di bidang awal dan akhir dalam DateRange. Misalnya, mulai: 2024-03-01 dan berakhir: 2024-06-01.	Detail untuk bulan tertentu
Laporan Ringkasan Barang Teratas	Menghasilkan item dengan emisi tertinggi N berdasarkan filter kueri yang ditentukan. Laporan ini mengembalikan data untuk satu bulan sekaligus, sehingga memerlukan nilai yang sama untuk bidang awal dan akhir dalam DateRange. Maksimum item N=10 dikembalikan pada satu waktu.	Data untuk item teratas menurut kategori
Laporan Ringkasan Bulanan Barang Teratas	Menyediakan item dengan emisi tertinggi N per bulan untuk filter kueri yang ditentukan. Mengembalikan data emisi untuk item N teratas menurut bulan dalam rentang tanggal yang diberikan. Maksimum item N=10 dikembalikan pada satu waktu.	Data untuk item teratas menurut kategori dan bulan
Laporan Detail Barang	Daftar item terperinci berdasarkan CategoryType yang ditentukan (termasuk: Sumber Daya, ResourceGroup, ResourceType, Lokasi, atau Langganan) untuk filter kueri. Anda hanya bisa mengajukan permintaan satu bulan sekali waktu. DateRange memerlukan nilai yang sama untuk bidang awal dan akhir.	Data emisi menurut kategori

Mengekspor parameter API emisi

Untuk setiap reportType, parameter kueri yang berbeda ditentukan. Bagian berikut ini menyediakan informasi terperinci tentang parameter kueri untuk setiap reportType.

Nama	Deskripsi
ItemDetailsQueryFilter	Parameter kueri untuk `ItemDetailsReport`
MonthlySummaryReportQueryFilter	Parameter filter untuk mengonfigurasi kueri `MonthlySummaryReport`.
OverallSummaryReportQueryFilter	Parameter filter untuk mengonfigurasi kueri `OverallSummaryReport`.
TopItemsMonthlySummaryReportQueryFilter	Parameter filter untuk mengonfigurasi kueri `TopItemsMonthlySummaryReport`.
TopItemsSummaryReportQueryFilter	Parameter filter untuk mengonfigurasi kueri `TopItemsSummaryReport`.

Untuk informasi selengkapnya tentang laporan REST API, lihat Carbon Service - Daftar Laporan Emisi Karbon.

ItemDetailsQueryFilter

Berikut adalah parameter kueri untuk ItemDetailsReport.

Nama	Diperlukan	Jenis	Deskripsi
carbonScopeList	Benar	EmissionScopeEnum[]	Daftar cakupan emisi karbon. Dibutuhkan. Menerima satu atau beberapa nilai dari `EmissionScopeEnum`. Misalnya, Scope1, Scope2, Scope3 dalam bentuk daftar. Hasil mencakup total emisi untuk cakupan yang ditentukan.
categoryType	Benar	CategoryTypeEnum	Menentukan jenis kategori untuk data emisi terperinci, seperti Sumber Daya, ResourceGroup, ResourceType, Lokasi, atau Langganan. Lihat jenis yang didukung di `CategoryTypeEnum`.
rentang tanggal	Benar	DateRange	Tanggal mulai dan berakhir untuk data emisi karbon. Dibutuhkan. Untuk `ItemDetailsReport` dan `TopItemsSummaryReport`, hanya satu bulan data yang didukung pada satu waktu, jadi tanggal mulai dan berakhir harus sama dalam `DateRange`. Misalnya, mulai: 2024-06-01 dan berakhir: 2024-06-01.
urutkan berdasarkan	Benar	OrderByColumnEnum	Nama kolom untuk mengurutkan hasilnya. Lihat nilai yang didukung di `OrderByColumnEnum`.
ukuran halaman	Benar	bilangan bulat (int32) minimum: 1 maksimum: 5000	Jumlah item yang akan dikembalikan dalam satu permintaan, nilai maksimum adalah 5000.
jenisLaporan	Benar	tali: Laporan Detail Barang	ReportType meminta data emisi karbon. Dibutuhkan. Menentukan bagaimana data dikumpulkan dan ditampilkan dalam output, seperti yang dijelaskan dalam `ReportTypeEnum`.
sortDirection	Benar	SortDirectionEnum	Arah untuk mengurutkan hasil. Lihat nilai yang didukung di `SortDirectionEnum`.
daftar langganan	Benar	string[]	Daftar ID langganan tempat data emisi karbon diminta. Dibutuhkan. Setiap ID langganan harus dalam format huruf kecil. Panjang maksimum daftar adalah 100.
daftar lokasi		string[]	Daftar lokasi (nama tampilan Wilayah Azure) untuk data emisi karbon, dengan setiap lokasi ditentukan dalam huruf kecil. Contohnya, `east us`. Fakultatif. Anda dapat menggunakan perintah `az account list-locations -o table` untuk menemukan nama tampilan Wilayah Azure.
Daftar URL Grup Sumber Daya		string[]	Daftar URL grup sumber daya untuk data emisi karbon. Fakultatif. Setiap URL harus mengikuti format `/subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}`, dan harus dalam huruf kecil semua.
resourceTypeList		string[]	Daftar jenis sumber daya untuk data emisi karbon. Fakultatif. Setiap jenis sumber daya harus ditentukan dalam huruf kecil, mengikuti format `microsoft.{service}/{resourceType}`. Contohnya, `microsoft.storage/storageaccounts`.
skipToken		string	Token penomoran halaman untuk mengambil halaman data berikutnya. Token ini dapat diubah ke null dan dikembalikan dalam respons sebelumnya jika halaman data lain tersedia.

FilterKueriLaporanRingkasanBulanan

Berikut adalah parameter filter untuk mengonfigurasi kueri MonthlySummaryReport.

Nama	Diperlukan	Jenis	Deskripsi
carbonScopeList	Benar	EmissionScopeEnum[]	Daftar cakupan emisi karbon. Dibutuhkan. Menerima satu atau beberapa nilai dari `EmissionScopeEnum`. Misalnya, Scope1, Scope2, Scope3 dalam bentuk daftar. Hasil mencakup total emisi untuk cakupan yang ditentukan.
rentang tanggal	Benar	DateRange	Tanggal mulai dan berakhir untuk data emisi karbon. Dibutuhkan. Untuk `ItemDetailsReport` dan `TopItemsSummaryReport`, hanya satu bulan data yang didukung pada satu waktu, jadi tanggal mulai dan berakhir harus sama dalam `DateRange`. Misalnya, mulai: 2024-06-01 dan berakhir: 2024-06-01.
jenisLaporan	Benar	tali: Laporan Ringkasan Bulanan	ReportType meminta data emisi karbon. Dibutuhkan. Menentukan bagaimana data dikumpulkan dan ditampilkan dalam output, seperti yang dijelaskan dalam `ReportTypeEnum`.
daftar langganan	Benar	string[]	Daftar ID langganan tempat data emisi karbon diminta. Dibutuhkan. Setiap ID langganan harus dalam format huruf kecil. Panjang maksimum daftar adalah 100.
daftar lokasi		string[]	Daftar lokasi (nama tampilan Wilayah Azure) untuk data emisi karbon, dengan setiap lokasi ditentukan dalam huruf kecil. Contohnya, `east us`. Fakultatif. Anda dapat menggunakan perintah `az account list-locations -o table` untuk menemukan nama tampilan Wilayah Azure.
Daftar URL Grup Sumber Daya		string[]	Daftar URL grup sumber daya untuk data emisi karbon. Fakultatif. Setiap URL harus mengikuti format `/subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}`, dan harus dalam huruf kecil semua.
resourceTypeList		string[]	Daftar jenis sumber daya untuk data emisi karbon. Fakultatif. Setiap jenis sumber daya harus ditentukan dalam huruf kecil, mengikuti format `microsoft.{service}/{resourceType}`. Contohnya, `microsoft.storage/storageaccounts`.

FilterKuariLaporanRingkasanKeseluruhan

Berikut adalah parameter penyaringan kueri untuk mengonfigurasi kueri laporan Ringkasan Keseluruhan.

Nama	Diperlukan	Jenis	Deskripsi
carbonScopeList	Benar	EmissionScopeEnum[]	Daftar cakupan emisi karbon. Dibutuhkan. Menerima satu atau beberapa nilai dari `EmissionScopeEnum`. Misalnya, Scope1, Scope2, Scope3 dalam bentuk daftar. Hasil mencakup total emisi untuk cakupan yang ditentukan.
rentang tanggal	Benar	DateRange	Tanggal mulai dan berakhir untuk data emisi karbon. Dibutuhkan. Untuk `ItemDetailsReport` dan `TopItemsSummaryReport`, hanya satu bulan data yang didukung pada satu waktu, jadi tanggal mulai dan berakhir harus sama dalam `DateRange`. Misalnya, mulai: 2024-06-01 dan berakhir: 2024-06-01.
jenisLaporan	Benar	tali: Laporan Ringkasan Keseluruhan	ReportType meminta data emisi karbon. Dibutuhkan. Menentukan bagaimana data dikumpulkan dan ditampilkan dalam output, seperti yang dijelaskan dalam `ReportTypeEnum`.
daftar langganan	Benar	string[]	Daftar ID langganan tempat data emisi karbon diminta. Dibutuhkan. Setiap ID langganan harus dalam format huruf kecil. Panjang maksimum daftar adalah 100.
daftar lokasi		string[]	Daftar lokasi (nama tampilan Wilayah Azure) untuk data emisi karbon, dengan setiap lokasi ditentukan dalam huruf kecil. Contohnya, `east us`. Fakultatif. Anda dapat menggunakan perintah `az account list-locations -o table` untuk menemukan nama tampilan Wilayah Azure.
Daftar URL Grup Sumber Daya		string[]	Daftar URL grup sumber daya untuk data emisi karbon. Fakultatif. Setiap URL harus mengikuti format `/subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}`, dan harus dalam huruf kecil semua.
resourceTypeList		string[]	Daftar jenis sumber daya untuk data emisi karbon. Fakultatif. Setiap jenis sumber daya harus ditentukan dalam huruf kecil, mengikuti format `microsoft.{service}/{resourceType}`. Contohnya, `microsoft.storage/storageaccounts`.

FilterKueriLaporanRingkasanBulananTopItems

Berikut adalah parameter filter untuk mengonfigurasi kueri TopItemsMonthlySummaryReport.

Nama	Diperlukan	Jenis	Deskripsi
carbonScopeList	Benar	EmissionScopeEnum[]	Daftar cakupan emisi karbon. Dibutuhkan. Menerima satu atau beberapa nilai dari `EmissionScopeEnum`. Misalnya, Scope1, Scope2, Scope3 dalam bentuk daftar. Hasil mencakup total emisi untuk cakupan yang ditentukan.
categoryType	Benar	CategoryTypeEnum	Menentukan jenis kategori untuk mengambil item yang memancarkan teratas, diagregasi menurut bulan. Lihat jenis yang didukung di `CategoryTypeEnum`.
rentang tanggal	Benar	DateRange	Tanggal mulai dan berakhir untuk data emisi karbon. Dibutuhkan. Untuk `ItemDetailsReport` dan `TopItemsSummaryReport`, hanya satu bulan data yang didukung pada satu waktu, jadi tanggal mulai dan berakhir harus sama dalam `DateRange`. Misalnya, mulai: 2024-06-01 dan berakhir: 2024-06-01.
jenisLaporan	Benar	tali: Laporan Ringkasan Bulanan Barang Teratas	ReportType meminta data emisi karbon. Dibutuhkan. Menentukan bagaimana data dikumpulkan dan ditampilkan dalam output, seperti yang dijelaskan dalam `ReportTypeEnum`.
daftar langganan	Benar	string[]	Daftar ID langganan tempat data emisi karbon diminta. Dibutuhkan. Setiap ID langganan harus dalam format huruf kecil. Panjang maksimum daftar adalah 100.
topItems	Benar	bilangan bulat (int32) minimum: 1 maksimum: 10	Jumlah item teratas yang akan dikembalikan, berdasarkan emisi. Harus antara 1 dan 10.
daftar lokasi		string[]	Daftar lokasi (nama tampilan Wilayah Azure) untuk data emisi karbon, dengan setiap lokasi ditentukan dalam huruf kecil. Contohnya, `east us`. Fakultatif. Anda dapat menggunakan perintah `az account list-locations -o table` untuk menemukan nama tampilan Wilayah Azure.
Daftar URL Grup Sumber Daya		string[]	Daftar URL grup sumber daya untuk data emisi karbon. Fakultatif. Setiap URL harus mengikuti format `/subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}`, dan harus dalam huruf kecil semua.
resourceTypeList		string[]	Daftar jenis sumber daya untuk data emisi karbon. Fakultatif. Setiap jenis sumber daya harus ditentukan dalam huruf kecil, mengikuti format `microsoft.{service}/{resourceType}`. Contohnya, `microsoft.storage/storageaccounts`.

FilterKueriLaporanRingkasanTopItem

Berikut adalah parameter filter kueri untuk mengonfigurasi TopItemsSummaryReport queries.

Nama	Diperlukan	Jenis	Deskripsi
carbonScopeList	Benar	EmissionScopeEnum[]	Daftar cakupan emisi karbon. Dibutuhkan. Menerima satu atau beberapa nilai dari `EmissionScopeEnum`. Misalnya, Scope1, Scope2, Scope3 dalam bentuk daftar. Hasil mencakup total emisi untuk cakupan yang ditentukan.
categoryType	Benar	CategoryTypeEnum	Menentukan jenis kategori untuk mengambil item pemancar teratas. Lihat nilai yang didukung yang ditentukan dalam `CategoryTypeEnum`.
rentang tanggal	Benar	DateRange	Tanggal mulai dan berakhir untuk data emisi karbon. Dibutuhkan. Untuk `ItemDetailsReport` dan `TopItemsSummaryReport`, hanya satu bulan data yang didukung pada satu waktu, jadi tanggal mulai dan berakhir harus sama dalam `DateRange`. Misalnya, mulai: 2024-06-01 dan berakhir: 2024-06-01.
jenisLaporan	Benar	tali: Laporan Ringkasan Barang Teratas	ReportType meminta data emisi karbon. Dibutuhkan. Menentukan bagaimana data dikumpulkan dan ditampilkan dalam output, seperti yang dijelaskan dalam `ReportTypeEnum`.
daftar langganan	Benar	string[]	Daftar ID langganan tempat data emisi karbon diminta. Dibutuhkan. Setiap ID langganan harus dalam format huruf kecil. Panjang maksimum daftar adalah 100.
topItems	Benar	bilangan bulat (int32) minimum: 1 maksimum: 10	Jumlah item teratas yang akan dikembalikan, berdasarkan emisi. Nilai ini harus antara 1 dan 10.
daftar lokasi		string[]	Daftar lokasi (nama tampilan Wilayah Azure) untuk data emisi karbon, dengan setiap lokasi ditentukan dalam huruf kecil. Contohnya, `east us`. Fakultatif. Anda dapat menggunakan perintah `az account list-locations -o table` untuk menemukan nama tampilan Wilayah Azure.
Daftar URL Grup Sumber Daya		string[]	Daftar URL grup sumber daya untuk data emisi karbon. Fakultatif. Setiap URL harus mengikuti format `/subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}`, dan harus dalam huruf kecil semua.
resourceTypeList		string[]	Daftar jenis sumber daya untuk data emisi karbon. Fakultatif. Setiap jenis sumber daya harus ditentukan dalam huruf kecil, mengikuti format `microsoft.{service}/{resourceType}`. Contohnya, `microsoft.storage/storageaccounts`.

Contoh laporan

Bagian berikut menunjukkan contoh permintaan dan respons untuk setiap jenis laporan.

Semua laporan menyertakan subscriptionAccessDecisionList tanggapan. Bidang ini menunjukkan keputusan akses untuk tiap langganan masukan.

Laporan Ringkasan Keseluruhan

Laporan menunjukkan total emisi untuk semua cakupan langganan dan rentang tanggal yang ditentukan dalam input. Gunakan laporan saat Anda memerlukan data laporan tingkat tinggi.

Permohonan sampel

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"
  }
}

Contoh tanggapan

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

Laporan Ringkasan Bulanan

Laporan menunjukkan emisi untuk semua langganan dan cakupan emisi untuk bulan yang ditentukan dalam rentang tanggal. Gunakan laporan saat Anda memerlukan detail untuk bulan tertentu.

Permohonan sampel

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"
  }
}

Contoh tanggapan

{
  "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
    }
  ]
}

Laporan Ringkasan Barang Teratas

Laporan menunjukkan emisi dari X item teratas yang dikumpulkan berdasarkan langganan, emisi, cakupan, kategori, dan rentang tanggal yang telah ditentukan, serta diuraikan menurut kategori. Gunakan laporan saat Anda memerlukan data untuk item teratas menurut kategori.

Permohonan sampel

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
}

Contoh tanggapan

{
  "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"
    }
  ]
}

Laporan Ringkasan Bulanan Barang Teratas

Laporan menunjukkan emisi item X teratas yang dikumpulkan di seluruh langganan, emisi, cakupan, dan kategori untuk setiap bulan yang ditentukan dalam rentang tanggal. Emisi dipecah berdasarkan kategori. Item X teratas didasarkan pada emisi bulan lalu. Gunakan laporan saat Anda memerlukan data untuk item teratas menurut kategori dan bulan.

Permohonan sampel

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
}

Contoh tanggapan

{
  "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"
    }
  ]
}

Laporan Detail Barang

Laporan menunjukkan emisi yang dikumpulkan di seluruh cakupan dan ID langganan yang dipilih untuk rentang tanggal tertentu dan diuraikan berdasarkan kategori tertentu. Gunakan laporan saat Anda memerlukan data emisi berdasarkan kategori dan untuk mendapatkan grup sumber daya dan data tingkat sumber daya.

Permohonan sampel

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
}

Contoh tanggapan

{
  "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"
    }
  ]
}

Saran dan Komentar

Apakah halaman ini membantu?

Last updated on 2025-10-07

Bagikan melalui

Menggunakan API untuk mengekspor pengoptimalan Karbon dalam data emisi Azure

Membuat dan mengotorisasi prinsipal layanan

Mendapatkan token otorisasi

Mengekspor data emisi menggunakan REST API

Contoh permintaan dan respons

Jenis laporan

Mengekspor parameter API emisi

ItemDetailsQueryFilter

FilterKueriLaporanRingkasanBulanan

FilterKuariLaporanRingkasanKeseluruhan

FilterKueriLaporanRingkasanBulananTopItems

FilterKueriLaporanRingkasanTopItem

Contoh laporan

Laporan Ringkasan Keseluruhan

Permohonan sampel

Contoh tanggapan

Laporan Ringkasan Bulanan

Permohonan sampel

Contoh tanggapan

Laporan Ringkasan Barang Teratas

Permohonan sampel

Contoh tanggapan

Laporan Ringkasan Bulanan Barang Teratas

Permohonan sampel

Contoh tanggapan

Laporan Detail Barang

Permohonan sampel

Contoh tanggapan

Konten terkait

Saran dan Komentar

Sumber Daya Tambahan: