Använda API:et för att exportera koldioxidoptimering i Azure-utsläppsdata

Den här artikeln hjälper dig att förstå och använda det senaste REST-API :et för Carbon Service för att exportera koldioxidoptimering i Azure-utsläppsdata. Utsläppsdata är tillgängliga för föregående månad per dag 19 i den aktuella månaden.

Om du vill exportera utsläppsdata med hjälp av REST-API:et måste du skapa och auktorisera ett huvudnamn för tjänsten för att få åtkomst till dina utsläppsdata. Du kan sedan använda tjänstens huvudnamn för att hämta en auktoriseringstoken och sedan exportera utsläppsdata med hjälp av REST-API:et.

Skapa och auktorisera ett huvudnamn för tjänsten

Ett huvudnamn för tjänsten är ett program vars token kan användas för att autentisera och bevilja åtkomst till specifika Azure-resurser med hjälp av Microsoft Entra-ID. Resurser omfattar användarappar, tjänster eller automatiseringsverktyg.

Skapa ett Microsoft Entra-program och ett tjänsthuvudkonto som kan komma åt resurser.
Lagra hyresgäst-ID, nytt klient-ID och klienthemlighet för din app för användning i tokenbegäranden.
Appen måste tilldelas rollen Carbon Optimization Reader för de resurser som du vill exportera utsläppsdata för. Om du vill använda appen för att exportera utsläppsdata för många resurser kan du tilldela rollen på prenumerationsnivå. Mer information finns i Tilldela Azure-roller med hjälp av Azure-portalen och Tilldela åtkomst till koldioxidoptimering i Azure.

Hämta en auktoriseringstoken

Skicka följande POST begäran i kommandotolken eller med hjälp av en klient. Använd resurs-URL:en https://management.azure.com för att hämta en åtkomsttoken för resurshanterings-API:et.

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'

Svarstexten visas på följande sätt:

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

Använd åtkomsttoken från svaret för användning i följande HTTP-begäranden.

Exportera utsläppsdata med hjälp av REST-API:et

Använd följande POST begäran för att exportera utsläppsdata.

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

Exempel på begäran och svar

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

Exempelresultat

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

Här är ett curl-exempel:

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

Exempel på curl-utdata:

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

Rapporttyper

Koldioxidoptimering ger olika rapporttyper som hjälper dig att analysera dina utsläppsdata. Varje rapporttyp har olika syften och används för dina specifika behov:

Rapporttyp	Beskrivning	När man ska använda
Övergripande Sammanfattningsrapport	Ger totala koldioxidutsläpp för det angivna datumintervallet och frågeparametrar samt jämförande värden för en översikt på hög nivå. Den här rapporttypen accepterar olika värden i start- och slutfälten i DateRange. Till exempel start: 2024-03-01 och slut: 2024-06-01.	Rapportdata på hög nivå krävs
Månadssammanfattningsrapport	Tillhandahåller data om koldioxidutsläpp per månad för de angivna frågeparametrarna. Den här rapporttypen accepterar olika värden i start- och slutfälten i DateRange. Till exempel start: 2024-03-01 och slut: 2024-06-01.	Information för en angiven månad
Sammanfattningsrapport för topprankade objekt	Innehåller de N-objekt som genererar mest för de angivna frågefiltren. Den här rapporten returnerar data för en månad i taget, så det kräver samma värden för start- och slutfälten i DateRange. Högst N=10 objekt returneras åt gången.	Data för de översta objekten efter kategori
Månadsrapport för topplistor över artiklar	Innehåller de N högst avgivande objekten per månad för det angivna frågefiltret. Returnerar utsläppsdata för de översta N objekten per månad inom det angivna datumintervallet. Högst N=10 objekt returneras åt gången.	Data för de översta objekten efter kategori och månad
ArtikelDetaljrapport	En detaljerad lista över objekt baserat på den angivna CategoryType (inklusive: Resurs, ResourceGroup, ResourceType, Plats eller Prenumeration) för frågefiltret. Du kan bara fråga i en månad i taget. DateRange kräver samma värden för start- och slutfälten.	Utsläppsdata efter kategori

Exportera API-parametrar för utsläpp

För varje reportTypedefinieras olika frågeparametrar. Följande avsnitt innehåller detaljerad information om frågeparametrarna för varje reportType.

Namn	Beskrivning
ItemDetailsQueryFilter	Frågeparametrar för `ItemDetailsReport`
MonthlySummaryReportQueryFilter	Frågefilterparametrar för att konfigurera `MonthlySummaryReport` frågor.
OverallSummaryReportQueryFilter	Frågefilterparametrar för att konfigurera `OverallSummaryReport` frågor.
ToppVarorMånadsSammanfattningRapportFrågaFilter	Frågefilterparametrar för att konfigurera `TopItemsMonthlySummaryReport` frågor.
Sammanfattningsrapport för toppobjekt - Frågefilter	Frågefilterparametrar för att konfigurera `TopItemsSummaryReport` frågor.

Mer information om REST API-rapporterna finns i Carbon Service – List Carbon Emission Reports.

ArtikelDetaljerFrågeFilter

Här är frågeparametrarna för ItemDetailsReport.

Namn	Obligatoriskt	Typ	Beskrivning
carbonScopeList	Sann	EmissionScopeEnum[]	Lista över omfång för koldioxidutsläpp. Obligatoriskt. Accepterar ett eller flera värden från `EmissionScopeEnum`. Till exempel Scope1, Scope2, Scope3 i listformulär. Utdata inkluderar de totala utsläppen för de angivna områdena.
kategori typ	Sann	CategoryTypeEnum	Anger kategoritypen för detaljerade utsläppsdata, till exempel Resurs, Resursgrupp, ResourceType, Plats eller Prenumeration. Se typer som stöds i `CategoryTypeEnum`.
datumintervall	Sann	DateRange	Start- och slutdatum för koldioxidutsläppsdata. Obligatoriskt. För `ItemDetailsReport` och `TopItemsSummaryReport`stöds endast en månad med data åt gången, så start- och slutdatum bör vara lika med inom `DateRange`. Till exempel start: 2024-06-01 och slut: 2024-06-01.
ordna efter	Sann	OrderByColumnEnum	Kolumnnamnet som resultatet ska sorteras efter. Se värden som stöds i `OrderByColumnEnum`.
pageSize	Sann	heltal (int32) minimum: 1 max: 5 000	Antal objekt som ska returneras i en begäran, maximalt värde är 5 000.
rapporttyp	Sann	sträng: ArtikelDetaljrapport	Den ReportType som begärdes för data om koldioxidutsläpp. Obligatoriskt. Anger hur data aggregeras och visas i utdata, enligt beskrivningen i `ReportTypeEnum`.
sorteringsriktning	Sann	SortDirectionEnum	Riktning för sortering av resultat. Se värden som stöds i `SortDirectionEnum`.
prenumerationslista	Sann	string[]	Lista över prenumerations-ID:t för vilka data om koldioxidutsläpp begärs. Obligatoriskt. Varje prenumerations-ID ska vara i gemener. Listans maximala längd är 100.
platslista		string[]	Lista över platser (visningsnamn för Azure-region) för data om koldioxidutsläpp, med varje plats angiven i små bokstäver. Till exempel `east us`. Valfritt. Du kan använda kommandot `az account list-locations -o table` för att hitta visningsnamn för Azure Region.
resursgruppURLlista		string[]	Lista över resursgrupp-URL:er för koldioxidutsläppsdata. Valfritt. Varje URL måste följa formatet `/subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}` och ska vara i alla gemener.
resurstyplista		string[]	Lista över resurstyper för data om koldioxidutsläpp. Valfritt. Varje resurstyp ska anges i gemener, enligt formatet `microsoft.{service}/{resourceType}`. Till exempel `microsoft.storage/storageaccounts`.
skipToken		snöre	Sidnumreringstoken för att hämta nästa sida med data. Den här token är null och returneras i föregående svar om andra datasidor är tillgängliga.

Månadsöversiktsrapportfrågefilter

Här är parametrarna för frågefilter för att konfigurera MonthlySummaryReport frågor.

Namn	Obligatoriskt	Typ	Beskrivning
carbonScopeList	Sann	EmissionScopeEnum[]	Lista över omfång för koldioxidutsläpp. Obligatoriskt. Accepterar ett eller flera värden från `EmissionScopeEnum`. Till exempel Scope1, Scope2, Scope3 i listformulär. Utdata inkluderar de totala utsläppen för de angivna områdena.
datumintervall	Sann	DateRange	Start- och slutdatum för koldioxidutsläppsdata. Obligatoriskt. För `ItemDetailsReport` och `TopItemsSummaryReport`stöds endast en månad med data åt gången, så start- och slutdatum bör vara lika med inom `DateRange`. Till exempel start: 2024-06-01 och slut: 2024-06-01.
rapporttyp	Sann	sträng: Månadssammanfattningsrapport	Den ReportType som begärdes för data om koldioxidutsläpp. Obligatoriskt. Anger hur data aggregeras och visas i utdata, enligt beskrivningen i `ReportTypeEnum`.
prenumerationslista	Sann	string[]	Lista över prenumerations-ID:t för vilka data om koldioxidutsläpp begärs. Obligatoriskt. Varje prenumerations-ID ska vara i gemener. Listans maximala längd är 100.
platslista		string[]	Lista över platser (visningsnamn för Azure-region) för data om koldioxidutsläpp, med varje plats angiven i små bokstäver. Till exempel `east us`. Valfritt. Du kan använda kommandot `az account list-locations -o table` för att hitta visningsnamn för Azure Region.
resursgruppURLlista		string[]	Lista över resursgrupp-URL:er för koldioxidutsläppsdata. Valfritt. Varje URL måste följa formatet `/subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}` och ska vara i alla gemener.
resurstyplista		string[]	Lista över resurstyper för data om koldioxidutsläpp. Valfritt. Varje resurstyp ska anges i gemener, enligt formatet `microsoft.{service}/{resourceType}`. Till exempel `microsoft.storage/storageaccounts`.

Översiktssammanställningsrapportfrågefilter

Här är frågefilterparametrarna för att konfigurera OverallSummaryReport-frågor.

Namn	Obligatoriskt	Typ	Beskrivning
carbonScopeList	Sann	EmissionScopeEnum[]	Lista över omfång för koldioxidutsläpp. Obligatoriskt. Accepterar ett eller flera värden från `EmissionScopeEnum`. Till exempel Scope1, Scope2, Scope3 i listformulär. Utdata inkluderar de totala utsläppen för de angivna områdena.
datumintervall	Sann	DateRange	Start- och slutdatum för koldioxidutsläppsdata. Obligatoriskt. För `ItemDetailsReport` och `TopItemsSummaryReport`stöds endast en månad med data åt gången, så start- och slutdatum bör vara lika med inom `DateRange`. Till exempel start: 2024-06-01 och slut: 2024-06-01.
rapporttyp	Sann	sträng: Övergripande Sammanfattningsrapport	Den ReportType som begärdes för data om koldioxidutsläpp. Obligatoriskt. Anger hur data aggregeras och visas i utdata, enligt beskrivningen i `ReportTypeEnum`.
prenumerationslista	Sann	string[]	Lista över prenumerations-ID:t för vilka data om koldioxidutsläpp begärs. Obligatoriskt. Varje prenumerations-ID ska vara i gemener. Listans maximala längd är 100.
platslista		string[]	Lista över platser (visningsnamn för Azure-region) för data om koldioxidutsläpp, med varje plats angiven i små bokstäver. Till exempel `east us`. Valfritt. Du kan använda kommandot `az account list-locations -o table` för att hitta visningsnamn för Azure Region.
resursgruppURLlista		string[]	Lista över resursgrupp-URL:er för koldioxidutsläppsdata. Valfritt. Varje URL måste följa formatet `/subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}` och ska vara i alla gemener.
resurstyplista		string[]	Lista över resurstyper för data om koldioxidutsläpp. Valfritt. Varje resurstyp ska anges i gemener, enligt formatet `microsoft.{service}/{resourceType}`. Till exempel `microsoft.storage/storageaccounts`.

ToppposterMånatligSammanfattningsRapportFrågefilter

Här är parametrarna för frågefilter för att konfigurera TopItemsMonthlySummaryReport frågor.

Namn	Obligatoriskt	Typ	Beskrivning
carbonScopeList	Sann	EmissionScopeEnum[]	Lista över omfång för koldioxidutsläpp. Obligatoriskt. Accepterar ett eller flera värden från `EmissionScopeEnum`. Till exempel Scope1, Scope2, Scope3 i listformulär. Utdata inkluderar de totala utsläppen för de angivna områdena.
kategori typ	Sann	CategoryTypeEnum	Anger kategoritypen för att hämta objekt som genereras mest, aggregerade per månad. Se typer som stöds i `CategoryTypeEnum`.
datumintervall	Sann	DateRange	Start- och slutdatum för koldioxidutsläppsdata. Obligatoriskt. För `ItemDetailsReport` och `TopItemsSummaryReport`stöds endast en månad med data åt gången, så start- och slutdatum bör vara lika med inom `DateRange`. Till exempel start: 2024-06-01 och slut: 2024-06-01.
rapporttyp	Sann	sträng: Månadsrapport för topplistor över artiklar	Den ReportType som begärdes för data om koldioxidutsläpp. Obligatoriskt. Anger hur data aggregeras och visas i utdata, enligt beskrivningen i `ReportTypeEnum`.
prenumerationslista	Sann	string[]	Lista över prenumerations-ID:t för vilka data om koldioxidutsläpp begärs. Obligatoriskt. Varje prenumerations-ID ska vara i gemener. Listans maximala längd är 100.
Topprodukter	Sann	heltal (int32) minimum: 1 max: 10	Antalet viktigaste poster som ska returneras, baserat på utsläpp. Måste vara mellan 1 och 10.
platslista		string[]	Lista över platser (visningsnamn för Azure-region) för data om koldioxidutsläpp, med varje plats angiven i små bokstäver. Till exempel `east us`. Valfritt. Du kan använda kommandot `az account list-locations -o table` för att hitta visningsnamn för Azure Region.
resursgruppURLlista		string[]	Lista över resursgrupp-URL:er för koldioxidutsläppsdata. Valfritt. Varje URL måste följa formatet `/subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}` och ska vara i alla gemener.
resurstyplista		string[]	Lista över resurstyper för data om koldioxidutsläpp. Valfritt. Varje resurstyp ska anges i gemener, enligt formatet `microsoft.{service}/{resourceType}`. Till exempel `microsoft.storage/storageaccounts`.

ToppföremålSammanfattningsRapportFrågeFilter

Här är parametrarna för frågefilter för att konfigurera TopItemsSummaryReport queries.

Namn	Obligatoriskt	Typ	Beskrivning
carbonScopeList	Sann	EmissionScopeEnum[]	Lista över omfång för koldioxidutsläpp. Obligatoriskt. Accepterar ett eller flera värden från `EmissionScopeEnum`. Till exempel Scope1, Scope2, Scope3 i listformulär. Utdata inkluderar de totala utsläppen för de angivna områdena.
kategori typ	Sann	CategoryTypeEnum	Anger den kategorityp som du vill hämta objekt som genereras högst upp. Se de definierade värden som stöds i `CategoryTypeEnum`.
datumintervall	Sann	DateRange	Start- och slutdatum för koldioxidutsläppsdata. Obligatoriskt. För `ItemDetailsReport` och `TopItemsSummaryReport`stöds endast en månad med data åt gången, så start- och slutdatum bör vara lika med inom `DateRange`. Till exempel start: 2024-06-01 och slut: 2024-06-01.
rapporttyp	Sann	sträng: Sammanfattningsrapport för topprankade objekt	Den ReportType som begärdes för data om koldioxidutsläpp. Obligatoriskt. Anger hur data aggregeras och visas i utdata, enligt beskrivningen i `ReportTypeEnum`.
prenumerationslista	Sann	string[]	Lista över prenumerations-ID:t för vilka data om koldioxidutsläpp begärs. Obligatoriskt. Varje prenumerations-ID ska vara i gemener. Listans maximala längd är 100.
Topprodukter	Sann	heltal (int32) minimum: 1 max: 10	Antalet viktigaste poster som ska returneras, baserat på utsläpp. Det här värdet måste vara mellan 1 och 10.
platslista		string[]	Lista över platser (visningsnamn för Azure-region) för data om koldioxidutsläpp, med varje plats angiven i små bokstäver. Till exempel `east us`. Valfritt. Du kan använda kommandot `az account list-locations -o table` för att hitta visningsnamn för Azure Region.
resursgruppURLlista		string[]	Lista över resursgrupp-URL:er för koldioxidutsläppsdata. Valfritt. Varje URL måste följa formatet `/subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}` och ska vara i alla gemener.
resurstyplista		string[]	Lista över resurstyper för data om koldioxidutsläpp. Valfritt. Varje resurstyp ska anges i gemener, enligt formatet `microsoft.{service}/{resourceType}`. Till exempel `microsoft.storage/storageaccounts`.

Exempelrapporter

I följande avsnitt visas exempelbegäranden och svar för varje rapporttyp.

Alla rapporter innehåller svaret subscriptionAccessDecisionList . Fältet visar åtkomstbeslutet för varje indataprenumeration.

Övergripande Sammanfattningsrapport

Rapporten visar totala utsläpp för alla prenumerationsomfång och datumintervall som anges i indata. Använd rapporten när du behöver rapportdata på hög nivå.

Exempelbegäran

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

Exempelsvar

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

Månadssammanfattningsrapport

Rapporten visar utsläpp för alla prenumerationer och utsläppsomfång för den månad som anges i datumintervallet. Använd rapporten när du behöver information för en angiven månad.

Exempelbegäran

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

Exempelsvar

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

Sammanfattningsrapport för topprankade objekt

Rapporten visar utsläpp av de översta X-objekten aggregerade mellan prenumerationer, utsläpp, omfattning, kategori och angivet datumintervall, uppdelade efter kategori. Använd rapporten när du behöver data för de översta objekten efter kategori.

Exempelbegäran

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
}

Exempelsvar

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

Månadsrapport för topplistor över artiklar

Rapporten visar utsläpp av de översta X-objekten aggregerade mellan prenumerationer, utsläpp, omfattningar och kategori för varje månad som anges i datumintervallet. Utsläppen delas upp efter kategori. De översta X-objekten baseras på förra månadens utsläpp. Använd rapporten när du behöver data för de översta objekten efter kategori och månad.

Exempelbegäran

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
}

Exempelsvar

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

ArtikelDetaljrapport

Rapporten visar utsläpp aggregerade över valda omfång och prenumerations-ID:t för ett visst datumintervall och uppdelade efter angiven kategori. Använd rapporten när du behöver utsläppsdata efter kategori och för att hämta resursgrupps- och resursnivådata.

Exempelbegäran

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
}

Exempelsvar

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

Var den här sidan hjälpsam?

Last updated on 2025-10-07

Dela via

Använda API:et för att exportera koldioxidoptimering i Azure-utsläppsdata

Skapa och auktorisera ett huvudnamn för tjänsten

Hämta en auktoriseringstoken

Exportera utsläppsdata med hjälp av REST-API:et

Exempel på begäran och svar

Rapporttyper

Exportera API-parametrar för utsläpp

ArtikelDetaljerFrågeFilter

Månadsöversiktsrapportfrågefilter

Översiktssammanställningsrapportfrågefilter

ToppposterMånatligSammanfattningsRapportFrågefilter

ToppföremålSammanfattningsRapportFrågeFilter

Exempelrapporter

Övergripande Sammanfattningsrapport

Exempelbegäran

Exempelsvar

Månadssammanfattningsrapport

Exempelbegäran

Exempelsvar

Sammanfattningsrapport för topprankade objekt

Exempelbegäran

Exempelsvar

Månadsrapport för topplistor över artiklar

Exempelbegäran

Exempelsvar

ArtikelDetaljrapport

Exempelbegäran

Exempelsvar

Relaterat innehåll

Feedback

Ytterligare resurser