De API gebruiken om koolstofoptimalisatie te exporteren in Azure-emissiegegevens

Dit artikel helpt u de nieuwste Carbon Service REST API te begrijpen en te gebruiken voor het exporteren van koolstofoptimalisatie in Azure-emissiegegevens. Emissiegegevens zijn beschikbaar voor de vorige maand op dag 19 van de huidige maand.

Als u emissiegegevens wilt exporteren met behulp van de REST API, moet u een service-principal maken en autoriseren voor toegang tot uw emissiegegevens. Vervolgens kunt u de service-principal gebruiken om een autorisatietoken op te halen en vervolgens emissiegegevens te exporteren met behulp van de REST API.

Een service-principal maken en autoriseren

Een service-principal is een toepassing waarvan tokens kunnen worden gebruikt om te verifiëren en toegang te verlenen tot specifieke Azure-resources met behulp van Microsoft Entra-id. Resources omvatten gebruikersapps, -services of automatiseringstools.

Maak een Microsoft Entra-toepassing en service-principal die toegang heeft tot middelen.
Sla de tenant-id, de nieuwe client-id en de waarde van het clientgeheim voor uw app op voor gebruik in tokenaanvragen.
Aan de app moet de Carbon Optimization Reader rol worden toegewezen voor de resources waarvoor u emissiegegevens wilt exporteren. Als u de app wilt gebruiken om emissiegegevens voor veel resources te exporteren, kunt u de rol toewijzen op abonnementsniveau. Zie Azure-rollen toewijzen met behulp van De Azure-portal en toegang tot Carbon Optimization in Azure toewijzen voor meer informatie.

Een autorisatietoken ophalen

Verzend de volgende POST aanvraag in de opdrachtprompt of met behulp van een client. Gebruik de resource-URL https://management.azure.com om een toegangstoken op te halen voor de resourcebeheer-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'

De hoofdtekst van het antwoord wordt als volgt weergegeven:

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

Gebruik het toegangstoken uit het antwoord voor gebruik in de volgende HTTP-aanvragen.

Emissiegegevens exporteren met behulp van de REST API

Gebruik de volgende POST aanvraag om emissiegegevens te exporteren.

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

Voorbeeld van aanvraag en antwoord

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

Voorbeelduitvoer

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

Hier volgt een curl-voorbeeld:

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

Voorbeeld van curl-uitvoer:

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

Rapporttypen

Koolstofoptimalisatie biedt verschillende rapporttypen om u te helpen uw emissiegegevens te analyseren. Elk rapporttype heeft een ander doel en wordt gebruikt voor uw specifieke behoeften:

Rapporttype	Beschrijving	Wanneer te gebruiken
AlgeheelSamenvattingRapport	Biedt totale koolstofuitstoot voor het opgegeven datumbereik en queryparameters, en vergelijkende waarden voor een algemeen overzicht. Dit rapporttype accepteert verschillende waarden in de begin- en eindvelden in DateRange. Begin bijvoorbeeld: 2024-03-01 en eind: 2024-06-01.	Rapportgegevens op hoog niveau vereist
MaandelijksSamenvattingsRapport	Levert gegevens over koolstofemissies per maand voor de opgegeven queryparameters. Dit rapporttype accepteert verschillende waarden in de begin- en eindvelden in DateRange. Begin bijvoorbeeld: 2024-03-01 en eind: 2024-06-01.	Details voor een opgegeven maand
Samenvattend Rapport Topartikelen	Geeft de N hoogste-emitterende items voor de gespecificeerde queryfilters. Dit rapport retourneert gegevens voor één maand tegelijk, dus vereist het dezelfde waarden voor de begin- en eindvelden binnen DateRange. Er worden maximaal N=10 items tegelijk geretourneerd.	Gegevens voor de belangrijkste items per categorie
TopItemsMaandelijksSamenvattingsrapport	Biedt de N hoogste-emitterende items per maand voor het opgegeven queryfilter. Retourneert emissiegegevens voor de belangrijkste N-items per maand binnen het opgegeven datumbereik. Er worden maximaal N=10 items tegelijk geretourneerd.	Gegevens voor de belangrijkste items per categorie en maand
RapportItemdetails	Een gedetailleerde lijst met items op basis van het opgegeven CategoryType (waaronder: Resource, ResourceGroup, ResourceType, Location of Subscription) voor het queryfilter. U kunt slechts één maand tegelijk een query uitvoeren. De DateRange vereist dezelfde waarden voor de begin- en eindvelden.	Emissiegegevens per categorie

API-parameters voor exportuitstoot

Voor elke reportTypequery worden verschillende queryparameters gedefinieerd. De volgende secties bevatten gedetailleerde informatie over de queryparameters voor elke reportTypeparameter.

Naam	Beschrijving
ItemDetailsQueryFilter	Queryparameters voor `ItemDetailsReport`
MonthlySummaryReportQueryFilter	Queryfilterparameters voor het configureren van `MonthlySummaryReport` query's.
OverallSummaryReportQueryFilter	Queryfilterparameters voor het configureren van `OverallSummaryReport` query's.
TopItemsMaandelijkseSamenvattingRapportQueryFilter	Queryfilterparameters voor het configureren van `TopItemsMonthlySummaryReport` query's.
TopItemsSummaryReportQueryFilter	Queryfilterparameters voor het configureren van `TopItemsSummaryReport` query's.

Zie Carbon Service - Lijst van koolstofemissierapporten voor meer informatie over de rapporten van de REST API.

ItemdetailsQueryFilter

Hier volgen de queryparameters voor ItemDetailsReport.

Naam	Vereist	Typ	Beschrijving
koolstofbereiklijst	Klopt	EmissionScopeEnum[]	Lijst met koolstofuitgiftebereiken. Verplicht. Accepteert een of meer waarden van `EmissionScopeEnum`. Bijvoorbeeld Scope1, Scope2, Scope3 in lijstvorm. De uitvoer omvat de totale emissies voor de opgegeven reikwijdten.
categoryType	Klopt	CategorieTypeEnum	Hiermee geeft u het categorietype op voor gedetailleerde emissiegegevens, zoals Resource, ResourceGroup, ResourceType, Locatie of Abonnement. Zie ondersteunde typen in `CategoryTypeEnum`.
datumbereik	Klopt	DateRange	De begin- en einddatums voor koolstofuitstootgegevens. Verplicht. Voor `ItemDetailsReport` en `TopItemsSummaryReport`, wordt slechts één maand aan gegevens tegelijk ondersteund, dus begin- en einddatums moeten gelijk zijn binnen `DateRange`. Begin bijvoorbeeld: 2024-06-01 en eind: 2024-06-01.
sorterenOp	Klopt	OrderByColumnEnum	De kolomnaam waarop de resultaten moeten worden gerangschikt. Bekijk ondersteunde waarden in `OrderByColumnEnum`.
Paginagrootte	Klopt	geheel getal (int32) minimum: 1 maximum: 5000	Het aantal items dat in één aanvraag moet worden geretourneerd, is de maximumwaarde 5000.
rapporttype	Klopt	snaar: RapportItemdetails	Het ReportType heeft om koolstofuitstootgegevens gevraagd. Verplicht. Hiermee geeft u op hoe gegevens worden geaggregeerd en weergegeven in de uitvoer, zoals wordt uitgelegd in de `ReportTypeEnum`.
sortDirection	Klopt	SortDirectionEnum	Richting voor het sorteren van resultaten. Bekijk ondersteunde waarden in `SortDirectionEnum`.
abonnementenlijst	Klopt	tekenreeks[]	Lijst met abonnements-id's waarvoor koolstofuitstootgegevens worden aangevraagd. Verplicht. Elke abonnements-id moet een kleine letter hebben. De maximale lengte van de lijst is 100.
locatielijst		tekenreeks[]	Lijst met locaties (weergavenaam azure-regio) voor koolstofuitstootgegevens, waarbij elke locatie in kleine letters is opgegeven. Bijvoorbeeld: `east us`. Facultatief. U kunt de opdracht `az account list-locations -o table` gebruiken om weergavenamen van Azure-regio's te vinden.
resourceGroepUrlLijst		tekenreeks[]	Lijst met URL's van resourcegroepen voor koolstofuitstootgegevens. Facultatief. Elke URL moet de indeling `/subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}`volgen en moet in kleine letters staan.
resourceTypelijst		tekenreeks[]	Lijst met resourcetypen voor koolstofuitstootgegevens. Facultatief. Elk resourcetype moet worden opgegeven in kleine letters, volgens de indeling `microsoft.{service}/{resourceType}`. Bijvoorbeeld: `microsoft.storage/storageaccounts`.
skipToken		touw	Pagineringstoken voor het ophalen van de volgende pagina met gegevens. Dit token is nullable en wordt geretourneerd in het vorige antwoord als er andere gegevenspagina's beschikbaar zijn.

MaandelijkseSamenvattingRapportQueryFilter

Dit zijn de queryfilterparameters voor het configureren van MonthlySummaryReport query's.

Naam	Vereist	Typ	Beschrijving
koolstofbereiklijst	Klopt	EmissionScopeEnum[]	Lijst met koolstofuitgiftebereiken. Verplicht. Accepteert een of meer waarden van `EmissionScopeEnum`. Bijvoorbeeld Scope1, Scope2, Scope3 in lijstvorm. De uitvoer omvat de totale emissies voor de opgegeven reikwijdten.
datumbereik	Klopt	DateRange	De begin- en einddatums voor koolstofuitstootgegevens. Verplicht. Voor `ItemDetailsReport` en `TopItemsSummaryReport`, wordt slechts één maand aan gegevens tegelijk ondersteund, dus begin- en einddatums moeten gelijk zijn binnen `DateRange`. Begin bijvoorbeeld: 2024-06-01 en eind: 2024-06-01.
rapporttype	Klopt	snaar: MaandelijksSamenvattingsRapport	Het ReportType heeft om koolstofuitstootgegevens gevraagd. Verplicht. Hiermee geeft u op hoe gegevens worden geaggregeerd en weergegeven in de uitvoer, zoals wordt uitgelegd in de `ReportTypeEnum`.
abonnementenlijst	Klopt	tekenreeks[]	Lijst met abonnements-id's waarvoor koolstofuitstootgegevens worden aangevraagd. Verplicht. Elke abonnements-id moet een kleine letter hebben. De maximale lengte van de lijst is 100.
locatielijst		tekenreeks[]	Lijst met locaties (weergavenaam azure-regio) voor koolstofuitstootgegevens, waarbij elke locatie in kleine letters is opgegeven. Bijvoorbeeld: `east us`. Facultatief. U kunt de opdracht `az account list-locations -o table` gebruiken om weergavenamen van Azure-regio's te vinden.
resourceGroepUrlLijst		tekenreeks[]	Lijst met URL's van resourcegroepen voor koolstofuitstootgegevens. Facultatief. Elke URL moet de indeling `/subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}`volgen en moet in kleine letters staan.
resourceTypelijst		tekenreeks[]	Lijst met resourcetypen voor koolstofuitstootgegevens. Facultatief. Elk resourcetype moet worden opgegeven in kleine letters, volgens de indeling `microsoft.{service}/{resourceType}`. Bijvoorbeeld: `microsoft.storage/storageaccounts`.

AlgemeenSamenvattingsRapportQueryFilter

Dit zijn de queryfilterparameters voor het configureren van OverallSummaryReport-query's.

Naam	Vereist	Typ	Beschrijving
koolstofbereiklijst	Klopt	EmissionScopeEnum[]	Lijst met koolstofuitgiftebereiken. Verplicht. Accepteert een of meer waarden van `EmissionScopeEnum`. Bijvoorbeeld Scope1, Scope2, Scope3 in lijstvorm. De uitvoer omvat de totale emissies voor de opgegeven reikwijdten.
datumbereik	Klopt	DateRange	De begin- en einddatums voor koolstofuitstootgegevens. Verplicht. Voor `ItemDetailsReport` en `TopItemsSummaryReport`, wordt slechts één maand aan gegevens tegelijk ondersteund, dus begin- en einddatums moeten gelijk zijn binnen `DateRange`. Begin bijvoorbeeld: 2024-06-01 en eind: 2024-06-01.
rapporttype	Klopt	snaar: AlgeheelSamenvattingRapport	Het ReportType heeft om koolstofuitstootgegevens gevraagd. Verplicht. Hiermee geeft u op hoe gegevens worden geaggregeerd en weergegeven in de uitvoer, zoals wordt uitgelegd in de `ReportTypeEnum`.
abonnementenlijst	Klopt	tekenreeks[]	Lijst met abonnements-id's waarvoor koolstofuitstootgegevens worden aangevraagd. Verplicht. Elke abonnements-id moet een kleine letter hebben. De maximale lengte van de lijst is 100.
locatielijst		tekenreeks[]	Lijst met locaties (weergavenaam azure-regio) voor koolstofuitstootgegevens, waarbij elke locatie in kleine letters is opgegeven. Bijvoorbeeld: `east us`. Facultatief. U kunt de opdracht `az account list-locations -o table` gebruiken om weergavenamen van Azure-regio's te vinden.
resourceGroepUrlLijst		tekenreeks[]	Lijst met URL's van resourcegroepen voor koolstofuitstootgegevens. Facultatief. Elke URL moet de indeling `/subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}`volgen en moet in kleine letters staan.
resourceTypelijst		tekenreeks[]	Lijst met resourcetypen voor koolstofuitstootgegevens. Facultatief. Elk resourcetype moet worden opgegeven in kleine letters, volgens de indeling `microsoft.{service}/{resourceType}`. Bijvoorbeeld: `microsoft.storage/storageaccounts`.

TopItemsMaandelijksSamenvattingRapportQueryFilter

Dit zijn de queryfilterparameters voor het configureren van TopItemsMonthlySummaryReport query's.

Naam	Vereist	Typ	Beschrijving
koolstofbereiklijst	Klopt	EmissionScopeEnum[]	Lijst met koolstofuitgiftebereiken. Verplicht. Accepteert een of meer waarden van `EmissionScopeEnum`. Bijvoorbeeld Scope1, Scope2, Scope3 in lijstvorm. De uitvoer omvat de totale emissies voor de opgegeven reikwijdten.
categoryType	Klopt	CategorieTypeEnum	Hiermee geeft u het categorietype op voor het ophalen van items die het meest worden verzonden, geaggregeerd per maand. Zie ondersteunde typen in `CategoryTypeEnum`.
datumbereik	Klopt	DateRange	De begin- en einddatums voor koolstofuitstootgegevens. Verplicht. Voor `ItemDetailsReport` en `TopItemsSummaryReport`, wordt slechts één maand aan gegevens tegelijk ondersteund, dus begin- en einddatums moeten gelijk zijn binnen `DateRange`. Begin bijvoorbeeld: 2024-06-01 en eind: 2024-06-01.
rapporttype	Klopt	snaar: TopItemsMaandelijksSamenvattingsrapport	Het ReportType heeft om koolstofuitstootgegevens gevraagd. Verplicht. Hiermee geeft u op hoe gegevens worden geaggregeerd en weergegeven in de uitvoer, zoals wordt uitgelegd in de `ReportTypeEnum`.
abonnementenlijst	Klopt	tekenreeks[]	Lijst met abonnements-id's waarvoor koolstofuitstootgegevens worden aangevraagd. Verplicht. Elke abonnements-id moet een kleine letter hebben. De maximale lengte van de lijst is 100.
topartikelen	Klopt	geheel getal (int32) minimum: 1 maximum: 10	Het aantal topitems dat moet worden geretourneerd, op basis van emissies. Moet tussen 1 en 10 zijn.
locatielijst		tekenreeks[]	Lijst met locaties (weergavenaam azure-regio) voor koolstofuitstootgegevens, waarbij elke locatie in kleine letters is opgegeven. Bijvoorbeeld: `east us`. Facultatief. U kunt de opdracht `az account list-locations -o table` gebruiken om weergavenamen van Azure-regio's te vinden.
resourceGroepUrlLijst		tekenreeks[]	Lijst met URL's van resourcegroepen voor koolstofuitstootgegevens. Facultatief. Elke URL moet de indeling `/subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}`volgen en moet in kleine letters staan.
resourceTypelijst		tekenreeks[]	Lijst met resourcetypen voor koolstofuitstootgegevens. Facultatief. Elk resourcetype moet worden opgegeven in kleine letters, volgens de indeling `microsoft.{service}/{resourceType}`. Bijvoorbeeld: `microsoft.storage/storageaccounts`.

TopItemsSamenvattingsrapportQueryFilter

Dit zijn de queryfilterparameters die u wilt configureren TopItemsSummaryReport queries.

Naam	Vereist	Typ	Beschrijving
koolstofbereiklijst	Klopt	EmissionScopeEnum[]	Lijst met koolstofuitgiftebereiken. Verplicht. Accepteert een of meer waarden van `EmissionScopeEnum`. Bijvoorbeeld Scope1, Scope2, Scope3 in lijstvorm. De uitvoer omvat de totale emissies voor de opgegeven reikwijdten.
categoryType	Klopt	CategorieTypeEnum	Hiermee geeft u het categorietype op waarvoor items die het meest worden verzonden, moeten worden opgehaald. Bekijk ondersteunde waarden die zijn gedefinieerd in `CategoryTypeEnum`.
datumbereik	Klopt	DateRange	De begin- en einddatums voor koolstofuitstootgegevens. Verplicht. Voor `ItemDetailsReport` en `TopItemsSummaryReport`, wordt slechts één maand aan gegevens tegelijk ondersteund, dus begin- en einddatums moeten gelijk zijn binnen `DateRange`. Begin bijvoorbeeld: 2024-06-01 en eind: 2024-06-01.
rapporttype	Klopt	snaar: Samenvattend Rapport Topartikelen	Het ReportType heeft om koolstofuitstootgegevens gevraagd. Verplicht. Hiermee geeft u op hoe gegevens worden geaggregeerd en weergegeven in de uitvoer, zoals wordt uitgelegd in de `ReportTypeEnum`.
abonnementenlijst	Klopt	tekenreeks[]	Lijst met abonnements-id's waarvoor koolstofuitstootgegevens worden aangevraagd. Verplicht. Elke abonnements-id moet een kleine letter hebben. De maximale lengte van de lijst is 100.
topartikelen	Klopt	geheel getal (int32) minimum: 1 maximum: 10	Het aantal topitems dat moet worden geretourneerd, op basis van emissies. Deze waarde moet tussen 1 en 10 zijn.
locatielijst		tekenreeks[]	Lijst met locaties (weergavenaam azure-regio) voor koolstofuitstootgegevens, waarbij elke locatie in kleine letters is opgegeven. Bijvoorbeeld: `east us`. Facultatief. U kunt de opdracht `az account list-locations -o table` gebruiken om weergavenamen van Azure-regio's te vinden.
resourceGroepUrlLijst		tekenreeks[]	Lijst met URL's van resourcegroepen voor koolstofuitstootgegevens. Facultatief. Elke URL moet de indeling `/subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}`volgen en moet in kleine letters staan.
resourceTypelijst		tekenreeks[]	Lijst met resourcetypen voor koolstofuitstootgegevens. Facultatief. Elk resourcetype moet worden opgegeven in kleine letters, volgens de indeling `microsoft.{service}/{resourceType}`. Bijvoorbeeld: `microsoft.storage/storageaccounts`.

-voorbeeldrapporten

In de volgende secties ziet u voorbeeldaanvragen en antwoorden voor elk rapporttype.

Alle rapporten bevatten het subscriptionAccessDecisionList antwoord. In het veld ziet u de toegangsbeslissing voor elk invoerabonnement.

AlgeheelSamenvattingRapport

Het rapport bevat de totale emissies voor alle abonnementenbereiken en het datumbereik dat is opgegeven in de invoer. Gebruik het rapport wanneer u rapportgegevens op hoog niveau nodig hebt.

Voorbeeldaanvraag

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

Voorbeeldantwoord

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

MaandelijksSamenvattingsRapport

Het rapport bevat emissies voor alle abonnementen en emissiebereiken voor de maand die is opgegeven in het datumbereik. Gebruik het rapport wanneer u details nodig hebt voor een opgegeven maand.

Voorbeeldaanvraag

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

Voorbeeldantwoord

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

Samenvattend Rapport Topartikelen

In het rapport ziet u de emissies van de belangrijkste X-items die zijn geaggregeerd in abonnementen, emissies, bereik, categorie en opgegeven datumbereik, onderverdeeld per categorie. Gebruik het rapport wanneer u gegevens nodig hebt voor de belangrijkste items per categorie.

Voorbeeldaanvraag

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
}

Voorbeeldantwoord

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

TopItemsMaandelijksSamenvattingsrapport

In het rapport ziet u de emissies van de belangrijkste X-items die zijn geaggregeerd over abonnementen, emissies, reikwijdtes en categorieën voor elke maand die in het datumbereik is opgegeven. Emissies worden onderverdeeld per categorie. De belangrijkste X-items zijn gebaseerd op de emissies van vorige maand. Gebruik het rapport wanneer u gegevens nodig hebt voor de belangrijkste items per categorie en maand.

Voorbeeldaanvraag

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
}

Voorbeeldantwoord

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

RapportItemdetails

In het rapport worden emissies weergegeven die zijn geaggregeerd over geselecteerde reikwijdtes en abonnements-ID's voor een bepaald datumbereik, en opgesplitst in de opgegeven categorie. Gebruik het rapport wanneer u emissiegegevens per categorie nodig hebt en om gegevens op resourcegroep en resourceniveau op te halen.

Voorbeeldaanvraag

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
}

Voorbeeldantwoord

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

Feedback

Is deze pagina nuttig?

Last updated on 2025-10-07

Delen via

De API gebruiken om koolstofoptimalisatie te exporteren in Azure-emissiegegevens

Een service-principal maken en autoriseren

Een autorisatietoken ophalen

Emissiegegevens exporteren met behulp van de REST API

Voorbeeld van aanvraag en antwoord

Rapporttypen

API-parameters voor exportuitstoot

ItemdetailsQueryFilter

MaandelijkseSamenvattingRapportQueryFilter

AlgemeenSamenvattingsRapportQueryFilter

TopItemsMaandelijksSamenvattingRapportQueryFilter

TopItemsSamenvattingsrapportQueryFilter

-voorbeeldrapporten

AlgeheelSamenvattingRapport

Voorbeeldaanvraag

Voorbeeldantwoord

MaandelijksSamenvattingsRapport

Voorbeeldaanvraag

Voorbeeldantwoord

Samenvattend Rapport Topartikelen

Voorbeeldaanvraag

Voorbeeldantwoord

TopItemsMaandelijksSamenvattingsrapport

Voorbeeldaanvraag

Voorbeeldantwoord

RapportItemdetails

Voorbeeldaanvraag

Voorbeeldantwoord

Verwante inhoud

Feedback

Aanvullende resources