Aracılığıyla paylaş

Azure emisyon verilerinde Karbon iyileştirmesini dışarı aktarmak için API'yi kullanma

Bu makale, Azure emisyon verilerindeki Karbon iyileştirmesini dışarı aktarmak için en son Karbon Hizmeti REST API'sini anlamanıza ve kullanmanıza yardımcı olur. Emisyon verileri önceki ay için mevcut ayın 19. gününe kadar kullanılabilir hale gelir.

REST API kullanarak emisyon verilerini dışarı aktarmak için bir hizmet sorumlusu oluşturup emisyon verilerinize erişme yetkisi vermeniz gerekir. Ardından hizmet sorumlusunu kullanarak yetkilendirme belirteci alabilir ve ardından REST API'yi kullanarak emisyon verilerini dışarı aktarabilirsiniz.

Hizmet sorumlusu oluşturma ve yetkilendirme

Hizmet sorumlusu, belirteçleri Microsoft Entra Id kullanılarak kimlik doğrulaması yapmak ve belirli Azure kaynaklarına erişim vermek için kullanılabilen bir uygulamadır. Kaynaklar arasında kullanıcı uygulamaları, hizmetler veya otomasyon araçları bulunur.

  1. Kaynaklara erişebilen bir Microsoft Entra uygulaması ve hizmet sorumlusu oluşturun.
  2. Jeton isteklerinde kullanmak üzere uygulamanız için kiracı kimliğini, yeni istemci kimliğini ve istemci gizli anahtarı değerini kaydedin.
  3. Emisyon verilerini dışarı aktarmak istediğiniz kaynaklar için uygulamaya Carbon Optimization Reader rolü atanmalıdır. Uygulamayı kullanarak birçok kaynak için emisyon verilerini dışarı aktarmak istiyorsanız, rolü abonelik düzeyinde atayabilirsiniz. Daha fazla bilgi için bkz. Azure portalını kullanarak Azure rollerini atama ve Azure'da Karbon iyileştirmesine erişim atama.

Bir yetkilendirme belirteci al

Komut isteminde veya bir istemci kullanarak aşağıdaki POST isteği gönderin. Kaynak yönetimi API'si için erişim belirteci almak için kaynak URL'sini https://management.azure.com kullanın.

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'

Yanıt gövdesi aşağıdaki gibi görünür:

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

Aşağıdaki HTTP isteklerinde kullanmak için yanıttan erişim belirtecini kullanın.

REST API kullanarak emisyon verilerini dışarı aktarma

Emisyon verilerini dışarı aktarmak için aşağıdaki POST isteği kullanın.

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

Örnek istek ve yanıt

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

Örnek çıkış verisi

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

İşte bir curl örneği:

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

Örnek curl çıkışı:

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

Rapor türleri

Karbon iyileştirmesi, emisyon verilerinizi analiz etmeye yardımcı olmak için çeşitli rapor türleri sağlar. Her rapor türü farklı bir amaca hizmet eder ve özel gereksinimleriniz için kullanılır:

Rapor türü Açıklama Ne zaman kullanılır?
Genel Özet Raporu Belirtilen tarih aralığı ve sorgu parametreleri için toplam karbon emisyonları ve üst düzey genel bakış için karşılaştırmalı değerler sağlar. Bu rapor türü DateRange içindeki başlangıç ve bitiş alanlarındaki farklı değerleri kabul eder. Örneğin, başlangıç: 2024-03-01 ve bitiş: 2024-06-01. Üst düzey rapor verileri gerekiyor
AylıkÖzetRaporu Belirtilen sorgu parametreleri için aya göre karbon emisyon verileri sağlar. Bu rapor türü DateRange içindeki başlangıç ve bitiş alanlarındaki farklı değerleri kabul eder. Örneğin, başlangıç: 2024-03-01 ve bitiş: 2024-06-01. Belirtilen ayın ayrıntıları
En İyi Öğeler Özeti Raporu Belirtilen sorgu filtreleri için N en fazla yayılım yapan öğeleri sağlar. Bu rapor tek seferde tek bir ayın verilerini döndürür, bu nedenle DateRange içindeki başlangıç ve bitiş alanları için aynı değerleri gerektirir. Aynı anda en fazla N=10 öğe döndürülür. Kategoriye göre en çok kullanılan öğelere ilişkin veriler
PopülerÖgelerAylıkÖzetRaporu Belirtilen sorgu filtresi için aylık en fazla yayılan N öğeyi sunmaktadır. Belirtilen tarih aralığındaki ilk N öğe için aya göre emisyon verilerini döndürür. Aynı anda en fazla N=10 öğe döndürülür. Kategoriye ve aya göre en çok kullanılan öğelere ilişkin veriler
Ürün Detayları Raporu Sorgu filtresi için belirtilen CategoryType 'a (Resource, ResourceGroup, ResourceType, Location veya Subscription dahil) dayalı öğelerin ayrıntılı listesi. Bir kerede yalnızca bir ay sorgulayabilirsiniz. DateRange, başlangıç ve bitiş alanları için aynı değerleri gerektirir. Kategoriye göre emisyon verileri

Emisyon API'si parametrelerini dışarı aktarma

Her reportTypeiçin farklı sorgu parametreleri tanımlanır. Aşağıdaki bölümlerde, her reportTypeiçin sorgu parametreleri hakkında ayrıntılı bilgi sağlanır.

İsim Açıklama
ItemDetailsQueryFilter için sorgu parametreleri ItemDetailsReport
MonthlySummaryReportQueryFilter Sorgu filtresi parametreleri MonthlySummaryReport sorguları yapılandırmak için.
OverallSummaryReportQueryFilter Sorgu filtresi parametreleri OverallSummaryReport sorguları yapılandırmak için.
EnPopülerÖğelerAylıkÖzetRaporSorguFiltresi Sorgu filtresi parametreleri TopItemsMonthlySummaryReport sorguları yapılandırmak için.
Üst Öğeler Özet Rapor Sorgu Filtresi Sorgu filtresi parametreleri TopItemsSummaryReport sorguları yapılandırmak için.

REST API raporları hakkında daha fazla bilgi için bkz. Carbon Service - Karbon Emisyon Raporları Listesi.

Öğe Detayları Sorgu Filtresi

için sorgu parametreleri aşağıdadır ItemDetailsReport.

İsim Zorunlu Türü Açıklama
carbonScopeList Doğru EmissionScopeEnum[] Karbon emisyon kapsamlarının listesi. Gerekli. 'den EmissionScopeEnumbir veya daha fazla değeri kabul eder. Örneğin, liste biçiminde Kapsam1, Kapsam2, Kapsam3. Sonuç, belirtilen kapsamlar için toplam emisyonları içerir.
kategoriTürü Doğru CategoryTypeEnum Resource, ResourceGroup, ResourceType, Location veya Subscription gibi ayrıntılı emisyon verileri için kategori türünü belirtir. 'de desteklenen türler bölümüne CategoryTypeEnumbakın.
tarih aralığı Doğru DateRange Karbon emisyonu verilerinin başlangıç ve bitiş tarihleri. Gerekli. ItemDetailsReport ve TopItemsSummaryReport için aynı anda yalnızca bir aylık veri desteklenir; bu sebeple DateRange içinde başlangıç ve bitiş tarihleri eşit olmalıdır. Örneğin, başlangıç: 2024-06-01 ve bitiş: 2024-06-01.
sıralama Doğru OrderByColumnEnum Sonuçları sıralamak için sütun adı. 'de desteklenen değerlere OrderByColumnEnumbakın.
sayfa boyutu Doğru tamsayı (int32)

minimum: 1
maksimum: 5000		 Tek bir istekte döndürülecek öğe sayısı; maksimum değer 5000'dir.
RaporTürü Doğru dizgi:

Ürün Detayları Raporu		 Karbon emisyonu verileri için Istenen ReportType. Gerekli. çıktısında açıklandığı ReportTypeEnumgibi verilerin nasıl toplanıp görüntüleneceğini belirtir.
sıralama yönü Doğru SortDirectionEnum Sonuçları sıralama yönü. 'de desteklenen değerlere SortDirectionEnumbakın.
abonelikListesi Doğru string[] Karbon emisyonu verilerinin istendiği abonelik kimliklerinin listesi. Gerekli. Her abonelik kimliği küçük harf biçiminde olmalıdır. Listenin uzunluğu üst sınırı 100'dür.
konum listesi string[] Karbon emisyonu verileri için konumların listesi (Azure Bölgesi görünen adı), her konum küçük harfle belirtilir. Örneğin, east us. Opsiyonel. Şu az account list-locations -o table komutunu kullanarak Azure Bölgesi görünen adlarını bulabilirsiniz.
kaynakGrubuUrlListesi string[] Karbon emisyonu verilerinin kaynak grubu URL'lerinin listesi. Opsiyonel. Her URL biçiminde /subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}olmalı ve küçük harfle yazılmalıdır.
kaynakTürüListesi string[] Karbon emisyonu verilerinin kaynak türleri listesi. Opsiyonel. Her kaynak türü, biçiminden microsoft.{service}/{resourceType}sonra küçük harfle belirtilmelidir. Örneğin, microsoft.storage/storageaccounts.
skipToken String Sonraki veri sayfasını getirmek için sayfalandırma belirteci. Bu belirteç null olabilir ve diğer veri sayfaları mevcutsa önceki yanıtta döndürülür.

AylıkÖzetRaporSorguFiltre

Sorguları yapılandırmak MonthlySummaryReport için sorgu filtresi parametreleri aşağıdadır.

İsim Zorunlu Türü Açıklama
carbonScopeList Doğru EmissionScopeEnum[] Karbon emisyon kapsamlarının listesi. Gerekli. 'den EmissionScopeEnumbir veya daha fazla değeri kabul eder. Örneğin, liste biçiminde Kapsam1, Kapsam2, Kapsam3. Sonuç, belirtilen kapsamlar için toplam emisyonları içerir.
tarih aralığı Doğru DateRange Karbon emisyonu verilerinin başlangıç ve bitiş tarihleri. Gerekli. ItemDetailsReport ve TopItemsSummaryReport için aynı anda yalnızca bir aylık veri desteklenir; bu sebeple DateRange içinde başlangıç ve bitiş tarihleri eşit olmalıdır. Örneğin, başlangıç: 2024-06-01 ve bitiş: 2024-06-01.
RaporTürü Doğru dizgi:

AylıkÖzetRaporu		 Karbon emisyonu verileri için Istenen ReportType. Gerekli. çıktısında açıklandığı ReportTypeEnumgibi verilerin nasıl toplanıp görüntüleneceğini belirtir.
abonelikListesi Doğru string[] Karbon emisyonu verilerinin istendiği abonelik kimliklerinin listesi. Gerekli. Her abonelik kimliği küçük harf biçiminde olmalıdır. Listenin uzunluğu üst sınırı 100'dür.
konum listesi string[] Karbon emisyonu verileri için konumların listesi (Azure Bölgesi görünen adı), her konum küçük harfle belirtilir. Örneğin, east us. Opsiyonel. Şu az account list-locations -o table komutunu kullanarak Azure Bölgesi görünen adlarını bulabilirsiniz.
kaynakGrubuUrlListesi string[] Karbon emisyonu verilerinin kaynak grubu URL'lerinin listesi. Opsiyonel. Her URL biçiminde /subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}olmalı ve küçük harfle yazılmalıdır.
kaynakTürüListesi string[] Karbon emisyonu verilerinin kaynak türleri listesi. Opsiyonel. Her kaynak türü, biçiminden microsoft.{service}/{resourceType}sonra küçük harfle belirtilmelidir. Örneğin, microsoft.storage/storageaccounts.

Genel Özet Raporu Sorgu Filtresi

OverallSummaryReport sorgularını yapılandırmak için sorgu filtresi parametreleri aşağıdadır.

İsim Zorunlu Türü Açıklama
carbonScopeList Doğru EmissionScopeEnum[] Karbon emisyon kapsamlarının listesi. Gerekli. 'den EmissionScopeEnumbir veya daha fazla değeri kabul eder. Örneğin, liste biçiminde Kapsam1, Kapsam2, Kapsam3. Sonuç, belirtilen kapsamlar için toplam emisyonları içerir.
tarih aralığı Doğru DateRange Karbon emisyonu verilerinin başlangıç ve bitiş tarihleri. Gerekli. ItemDetailsReport ve TopItemsSummaryReport için aynı anda yalnızca bir aylık veri desteklenir; bu sebeple DateRange içinde başlangıç ve bitiş tarihleri eşit olmalıdır. Örneğin, başlangıç: 2024-06-01 ve bitiş: 2024-06-01.
RaporTürü Doğru dizgi:

Genel Özet Raporu		 Karbon emisyonu verileri için Istenen ReportType. Gerekli. çıktısında açıklandığı ReportTypeEnumgibi verilerin nasıl toplanıp görüntüleneceğini belirtir.
abonelikListesi Doğru string[] Karbon emisyonu verilerinin istendiği abonelik kimliklerinin listesi. Gerekli. Her abonelik kimliği küçük harf biçiminde olmalıdır. Listenin uzunluğu üst sınırı 100'dür.
konum listesi string[] Karbon emisyonu verileri için konumların listesi (Azure Bölgesi görünen adı), her konum küçük harfle belirtilir. Örneğin, east us. Opsiyonel. Şu az account list-locations -o table komutunu kullanarak Azure Bölgesi görünen adlarını bulabilirsiniz.
kaynakGrubuUrlListesi string[] Karbon emisyonu verilerinin kaynak grubu URL'lerinin listesi. Opsiyonel. Her URL biçiminde /subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}olmalı ve küçük harfle yazılmalıdır.
kaynakTürüListesi string[] Karbon emisyonu verilerinin kaynak türleri listesi. Opsiyonel. Her kaynak türü, biçiminden microsoft.{service}/{resourceType}sonra küçük harfle belirtilmelidir. Örneğin, microsoft.storage/storageaccounts.

EnİyiÖğelerAylıkÖzetRaporuSorguFiltresi

Sorguları yapılandırmak TopItemsMonthlySummaryReport için sorgu filtresi parametreleri aşağıdadır.

İsim Zorunlu Türü Açıklama
carbonScopeList Doğru EmissionScopeEnum[] Karbon emisyon kapsamlarının listesi. Gerekli. 'den EmissionScopeEnumbir veya daha fazla değeri kabul eder. Örneğin, liste biçiminde Kapsam1, Kapsam2, Kapsam3. Sonuç, belirtilen kapsamlar için toplam emisyonları içerir.
kategoriTürü Doğru CategoryTypeEnum Aya göre toplanmış en çok yayan öğeleri almak için kategori türünü belirtir. 'de desteklenen türler bölümüne CategoryTypeEnumbakın.
tarih aralığı Doğru DateRange Karbon emisyonu verilerinin başlangıç ve bitiş tarihleri. Gerekli. ItemDetailsReport ve TopItemsSummaryReport için aynı anda yalnızca bir aylık veri desteklenir; bu sebeple DateRange içinde başlangıç ve bitiş tarihleri eşit olmalıdır. Örneğin, başlangıç: 2024-06-01 ve bitiş: 2024-06-01.
RaporTürü Doğru dizgi:

PopülerÖgelerAylıkÖzetRaporu		 Karbon emisyonu verileri için Istenen ReportType. Gerekli. çıktısında açıklandığı ReportTypeEnumgibi verilerin nasıl toplanıp görüntüleneceğini belirtir.
abonelikListesi Doğru string[] Karbon emisyonu verilerinin istendiği abonelik kimliklerinin listesi. Gerekli. Her abonelik kimliği küçük harf biçiminde olmalıdır. Listenin uzunluğu üst sınırı 100'dür.
topItems Doğru tamsayı (int32)

minimum: 1
maksimum: 10		 Emisyonlara göre döndürülecek en önemli öğelerin sayısı. 1 ile 10 arasında olmalıdır.
konum listesi string[] Karbon emisyonu verileri için konumların listesi (Azure Bölgesi görünen adı), her konum küçük harfle belirtilir. Örneğin, east us. Opsiyonel. Şu az account list-locations -o table komutunu kullanarak Azure Bölgesi görünen adlarını bulabilirsiniz.
kaynakGrubuUrlListesi string[] Karbon emisyonu verilerinin kaynak grubu URL'lerinin listesi. Opsiyonel. Her URL biçiminde /subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}olmalı ve küçük harfle yazılmalıdır.
kaynakTürüListesi string[] Karbon emisyonu verilerinin kaynak türleri listesi. Opsiyonel. Her kaynak türü, biçiminden microsoft.{service}/{resourceType}sonra küçük harfle belirtilmelidir. Örneğin, microsoft.storage/storageaccounts.

En İyi Ürünler Özet Raporu Sorgu Filtresi

Yapılandıracak sorgu filtresi parametreleri aşağıdadır TopItemsSummaryReport queries.

İsim Zorunlu Türü Açıklama
carbonScopeList Doğru EmissionScopeEnum[] Karbon emisyon kapsamlarının listesi. Gerekli. 'den EmissionScopeEnumbir veya daha fazla değeri kabul eder. Örneğin, liste biçiminde Kapsam1, Kapsam2, Kapsam3. Sonuç, belirtilen kapsamlar için toplam emisyonları içerir.
kategoriTürü Doğru CategoryTypeEnum En çok yayılan öğelerin alındığı kategori türünü belirtir. Desteklenen değerleri içinde tanımlanan CategoryTypeEnum bölümünde görebilirsiniz.
tarih aralığı Doğru DateRange Karbon emisyonu verilerinin başlangıç ve bitiş tarihleri. Gerekli. ItemDetailsReport ve TopItemsSummaryReport için aynı anda yalnızca bir aylık veri desteklenir; bu sebeple DateRange içinde başlangıç ve bitiş tarihleri eşit olmalıdır. Örneğin, başlangıç: 2024-06-01 ve bitiş: 2024-06-01.
RaporTürü Doğru dizgi:

En İyi Öğeler Özeti Raporu		 Karbon emisyonu verileri için Istenen ReportType. Gerekli. çıktısında açıklandığı ReportTypeEnumgibi verilerin nasıl toplanıp görüntüleneceğini belirtir.
abonelikListesi Doğru string[] Karbon emisyonu verilerinin istendiği abonelik kimliklerinin listesi. Gerekli. Her abonelik kimliği küçük harf biçiminde olmalıdır. Listenin uzunluğu üst sınırı 100'dür.
topItems Doğru tamsayı (int32)

minimum: 1
maksimum: 10		 Emisyonlara göre döndürülecek en önemli öğelerin sayısı. Bu değer 1 ile 10 arasında olmalıdır.
konum listesi string[] Karbon emisyonu verileri için konumların listesi (Azure Bölgesi görünen adı), her konum küçük harfle belirtilir. Örneğin, east us. Opsiyonel. Şu az account list-locations -o table komutunu kullanarak Azure Bölgesi görünen adlarını bulabilirsiniz.
kaynakGrubuUrlListesi string[] Karbon emisyonu verilerinin kaynak grubu URL'lerinin listesi. Opsiyonel. Her URL biçiminde /subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}olmalı ve küçük harfle yazılmalıdır.
kaynakTürüListesi string[] Karbon emisyonu verilerinin kaynak türleri listesi. Opsiyonel. Her kaynak türü, biçiminden microsoft.{service}/{resourceType}sonra küçük harfle belirtilmelidir. Örneğin, microsoft.storage/storageaccounts.

Örnek raporlar

Aşağıdaki bölümlerde her rapor türü için örnek istekler ve yanıtlar gösterilmektedir.

Tüm raporlar subscriptionAccessDecisionList yanıtını içerir. Alan, her abonelik girişi için erişim kararını gösterir.

Genel Özet Raporu

Rapor, girişte belirtilen tüm abonelik kapsamları ve tarih aralığı için toplam emisyonları gösterir. Üst düzey rapor verilerine ihtiyacınız olduğunda raporu kullanın.

Numune isteği

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

Örnek yanıt

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

AylıkÖzetRaporu

Rapor, tüm aboneliklerin emisyonlarını ve tarih aralığında belirtilen aya ilişkin emisyon kapsamlarını gösterir. Belirtilen ayın ayrıntılarına ihtiyacınız olduğunda raporu kullanın.

Numune isteği

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

Örnek yanıt

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

En İyi Öğeler Özeti Raporu

Rapor, abonelikler, emisyonlar, kapsam, kategori ve belirtilen tarih aralığı genelinde toplanan ve kategoriye göre ayrılmış ilk X öğelerinin emisyonlarını gösterir. Kategoriye göre en çok kullanılan öğeler için verilere ihtiyacınız olduğunda raporu kullanın.

Numune isteği

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
}

Örnek yanıt

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

PopülerÖgelerAylıkÖzetRaporu

Rapor, tarih aralığında belirtilen her ay için abonelikler, emisyonlar, kapsamlar ve kategori genelinde toplanan en iyi X öğelerinin emisyonlarını gösterir. Emisyonlar kategoriye göre bölünmektedir. En önemli X öğeleri geçen ayın emisyonlarını temel alır. Kategoriye ve aya göre en çok kullanılan öğeler için verilere ihtiyacınız olduğunda raporu kullanın.

Numune isteği

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
}

Örnek yanıt

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

Ürün Detayları Raporu

Rapor, belirli bir tarih aralığı için seçilen kapsamlar ve abonelik kimlikleri arasında toplanan ve belirtilen kategoriye göre ayrılmış emisyonları gösterir. Kategoriye göre emisyon verilerine ihtiyacınız olduğunda ve kaynak grubu ile kaynak düzeyinde veri almak için raporu kullanın.

Numune isteği

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
}

Örnek yanıt

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

İlgili içerik

  • Last updated on