Condividi tramite


Usare l'API per esportare l'ottimizzazione del carbonio nei dati sulle emissioni di Azure

Questo articolo illustra come comprendere e usare la versione più recente dell'API REST carbon service per esportare l'ottimizzazione del carbonio nei dati sulle emissioni di Azure. I dati sulle emissioni sono disponibili per il mese precedente entro il giorno 19 del mese corrente.

Per esportare i dati sulle emissioni usando l'API REST, è necessario creare e autorizzare un'entità servizio ad accedere ai dati sulle emissioni. È quindi possibile usare l'entità servizio per ottenere un token di autorizzazione e quindi esportare i dati sulle emissioni usando l'API REST.

Creare e autorizzare un'entità servizio

L'entità principale del servizio è un'applicazione i cui token possono essere usati per autenticare e concedere l'accesso a risorse di Azure specifiche usando Microsoft Entra ID. Le risorse includono app utente, servizi o strumenti di automazione.

  1. Creare un'applicazione Microsoft Entra e un principal del servizio che possano accedere alle risorse.
  2. Salvare l'ID tenant, il nuovo ID client e il valore del segreto client della tua app per l'utilizzo delle richieste di token.
  3. All'app deve essere assegnato il ruolo Carbon Optimization Reader per le risorse per cui si vogliono esportare i dati sulle emissioni. Se si vuole usare l'app per esportare i dati sulle emissioni per molte risorse, è possibile assegnare il ruolo a livello di sottoscrizione. Per altre informazioni, vedere Assegnare ruoli di Azure utilizzando il portale di Azure e Assegnare l'accesso all'ottimizzazione del carbonio in Azure.

Ottenere un token di autorizzazione

Inviare la richiesta seguente POST al prompt dei comandi o usando un client. Usare l'URL https://management.azure.com della risorsa per ottenere un token di accesso per l'API di gestione delle risorse.

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'

Il corpo della risposta viene visualizzato come segue:

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

Usare il token di accesso dalla risposta da usare nelle richieste HTTP seguenti.

Esportare i dati sulle emissioni usando l'API REST

Utilizzare la richiesta seguente POST per esportare i dati sulle emissioni.

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

Richiesta e risposta di esempio

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

Output di esempio

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

Ecco un esempio di comando curl:

curl --location 'https://management.azure.com/providers/Microsoft.Carbon/carbonEmissionReports?api-version=2025-04-01' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJ0eXA...2-KgVBNrsvg' \
--data '{
  "reportType": "ItemDetailsReport",
  "subscriptionList": [
    "00000000-0000-0000-0000-000000000000",
    "00000000-0000-0000-0000-000000000001,",
    "00000000-0000-0000-0000-000000000002",
    "00000000-0000-0000-0000-000000000003",
    "00000000-0000-0000-0000-000000000004",
    "00000000-0000-0000-0000-000000000005",
    "00000000-0000-0000-0000-000000000006",
    "00000000-0000-0000-0000-000000000007",
    "00000000-0000-0000-0000-000000000008"
  ],
  "carbonScopeList": [
    "Scope1",
    "Scope3"
  ],
  "dateRange": {
    "start": "2024-05-01",
    "end": "2024-05-01"
  },
  "categoryType": "Resource",
  "orderBy": "LatestMonthEmissions",
  "sortDirection": "Desc",
  "pageSize": 100
}
'

Output curl di esempio:

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

Tipi di report

L'ottimizzazione del carbonio offre diversi tipi di report che consentono di analizzare i dati sulle emissioni. Ogni tipo di report ha uno scopo diverso e viene usato per esigenze specifiche:

Tipo di report Descrizione Quando utilizzare
Rapporto di sintesi complessivo Fornisce emissioni di carbonio totali per l'intervallo di date e i parametri di query specificati e i valori comparativi per una panoramica generale. Questo tipo di report accetta valori diversi nei campi iniziale e finale all'interno di DateRange. Ad esempio, start: 2024-03-01 e fine: 2024-06-01. Dati di report di alto livello necessari
ReportMensileDiSintesi Fornisce i dati sulle emissioni di carbonio per mese per i parametri di query specificati. Questo tipo di report accetta valori diversi nei campi iniziale e finale all'interno di DateRange. Ad esempio, start: 2024-03-01 e fine: 2024-06-01. Dettagli per un mese specificato
Rapporto Sommario Articoli Principali Fornisce gli N elementi di emissione più alti per i filtri di query specificati. Questo report restituisce i dati per un singolo mese alla volta, quindi richiede gli stessi valori per i campi di inizio e fine all'interno di DateRange. Viene restituito un massimo di N=10 elementi alla volta. Dati per gli elementi principali per categoria
Rapporto mensile di riepilogo sugli articoli principali Fornisce gli N elementi con emissione massima per mese per il filtro di query specificato. Restituisce i dati sulle emissioni per i primi N elementi al mese entro l'intervallo di date specificato. Viene restituito un massimo di N=10 elementi alla volta. Dati per gli elementi principali per categoria e mese
Rapporto dettagli dell’articolo Elenco granulare di elementi in base al tipo di categoria specificato (tra cui Resource, ResourceGroup, ResourceType, Location o Subscription) per il filtro di query. È possibile eseguire una query per un solo mese alla volta. DateRange richiede gli stessi valori per i campi iniziale e finale. Dati sulle emissioni per categoria

Esportare i parametri dell'API per le emissioni

Per ogni reportType, vengono definiti parametri di query diversi. Nelle sezioni seguenti vengono fornite informazioni dettagliate sui parametri di query per ogni reportTypeoggetto .

Nome Descrizione
ItemDetailsQueryFilter Parametri di query per ItemDetailsReport
MonthlySummaryReportQueryFilter Parametri di filtro delle query per configurare MonthlySummaryReport le query.
OverallSummaryReportQueryFilter Parametri di filtro delle query per configurare OverallSummaryReport le query.
TopItemsMonthlySummaryReportQueryFilter Parametri di filtro delle query per configurare TopItemsMonthlySummaryReport le query.
TopItemsSummaryReportQueryFilter Parametri di filtro delle query per configurare TopItemsSummaryReport le query.

Per altre informazioni sui report dell'API REST, vedere Carbon Service - Elencare i report sulle emissioni di carbonio.

Filtro di Ricerca Dettagli Articolo

Ecco i parametri di query per ItemDetailsReport.

Nome Obbligatorio Tipo Descrizione
carbonScopeList Vero EmissionScopeEnum[] Elenco degli ambiti di emissione di carbonio. Obbligatorio. Accetta uno o più valori da EmissionScopeEnum. Ad esempio, Scope1, Scope2, Scope3 nel formato elenco. L'output include le emissioni totali per gli ambiti specificati.
tipoCategoria Vero CategoryTypeEnum Specifica il tipo di categoria per i dati dettagliati sulle emissioni, ad esempio Resource, ResourceGroup, ResourceType, Location o Subscription. Vedi i tipi supportati in CategoryTypeEnum.
intervallo di date Vero DateRange Date di inizio e fine per i dati sulle emissioni di carbonio. Obbligatorio. Per ItemDetailsReport e TopItemsSummaryReport, è supportato un solo mese di dati alla volta, pertanto le date di inizio e di fine devono essere uguali all'interno DateRangedi . Ad esempio, start: 2024-06-01 e fine: 2024-06-01.
orderBy Vero OrderByColumnEnum Nome della colonna in base al quale ordinare i risultati. Vedere i valori supportati in OrderByColumnEnum.
dimensione della pagina Vero integer (int32)

minimo: 1
massimo: 5000
Numero di elementi da restituire in una richiesta, il valore massimo è 5000.
reportType Vero corda:

Rapporto dettagli dell’articolo
ReportType ha richiesto i dati sulle emissioni di carbonio. Obbligatorio. Specifica la modalità di aggregazione e visualizzazione dei dati nell'output, come illustrato in ReportTypeEnum.
sortDirection Vero SortDirectionEnum Direzione per l'ordinamento dei risultati. Vedere i valori supportati in SortDirectionEnum.
elenco abbonamenti Vero string[] Elenco degli ID sottoscrizione per i quali sono richiesti i dati sulle emissioni di carbonio. Obbligatorio. Ogni ID sottoscrizione deve essere in formato minuscolo. La lunghezza massima dell'elenco è 100.
locationList string[] Elenco di località (nome visualizzato dell'area di Azure) per i dati sulle emissioni di carbonio, con ogni località specificata in lettere minuscole. Ad esempio: east us. Opzionale. È possibile usare il comando az account list-locations -o table per trovare i nomi visualizzati dell'area di Azure.
resourceGroupUrlList string[] Elenco degli URL del gruppo di risorse per i dati sulle emissioni di carbonio. Opzionale. Ogni URL deve seguire il formato /subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}e deve essere in lettere minuscole.
resourceTypeList string[] Elenco dei tipi di risorse per i dati sulle emissioni di carbonio. Opzionale. Ogni tipo di risorsa deve essere specificato in lettere minuscole, seguendo il formato microsoft.{service}/{resourceType}. Ad esempio: microsoft.storage/storageaccounts.
skipToken corda Token di paginazione per il recupero della pagina successiva dei dati. Questo token è nullabile e viene restituito nella risposta precedente se sono disponibili altre pagine di dati.

FiltroDiQueryPerRapportoDiSintesiMensile

Ecco i parametri di filtro delle query per configurare MonthlySummaryReport.

Nome Obbligatorio Tipo Descrizione
carbonScopeList Vero EmissionScopeEnum[] Elenco degli ambiti di emissione di carbonio. Obbligatorio. Accetta uno o più valori da EmissionScopeEnum. Ad esempio, Scope1, Scope2, Scope3 nel formato elenco. L'output include le emissioni totali per gli ambiti specificati.
intervallo di date Vero DateRange Date di inizio e fine per i dati sulle emissioni di carbonio. Obbligatorio. Per ItemDetailsReport e TopItemsSummaryReport, è supportato un solo mese di dati alla volta, pertanto le date di inizio e di fine devono essere uguali all'interno DateRangedi . Ad esempio, start: 2024-06-01 e fine: 2024-06-01.
reportType Vero corda:

ReportMensileDiSintesi
ReportType ha richiesto i dati sulle emissioni di carbonio. Obbligatorio. Specifica la modalità di aggregazione e visualizzazione dei dati nell'output, come illustrato in ReportTypeEnum.
elenco abbonamenti Vero string[] Elenco degli ID sottoscrizione per i quali sono richiesti i dati sulle emissioni di carbonio. Obbligatorio. Ogni ID sottoscrizione deve essere in formato minuscolo. La lunghezza massima dell'elenco è 100.
locationList string[] Elenco di località (nome visualizzato dell'area di Azure) per i dati sulle emissioni di carbonio, con ogni località specificata in lettere minuscole. Ad esempio: east us. Opzionale. È possibile usare il comando az account list-locations -o table per trovare i nomi visualizzati dell'area di Azure.
resourceGroupUrlList string[] Elenco degli URL del gruppo di risorse per i dati sulle emissioni di carbonio. Opzionale. Ogni URL deve seguire il formato /subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}e deve essere in lettere minuscole.
resourceTypeList string[] Elenco dei tipi di risorse per i dati sulle emissioni di carbonio. Opzionale. Ogni tipo di risorsa deve essere specificato in lettere minuscole, seguendo il formato microsoft.{service}/{resourceType}. Ad esempio: microsoft.storage/storageaccounts.

FiltroQueryReportRiepilogoGenerale

Ecco i parametri del filtro di query per configurare le query OverallSummaryReport.

Nome Obbligatorio Tipo Descrizione
carbonScopeList Vero EmissionScopeEnum[] Elenco degli ambiti di emissione di carbonio. Obbligatorio. Accetta uno o più valori da EmissionScopeEnum. Ad esempio, Scope1, Scope2, Scope3 nel formato elenco. L'output include le emissioni totali per gli ambiti specificati.
intervallo di date Vero DateRange Date di inizio e fine per i dati sulle emissioni di carbonio. Obbligatorio. Per ItemDetailsReport e TopItemsSummaryReport, è supportato un solo mese di dati alla volta, pertanto le date di inizio e di fine devono essere uguali all'interno DateRangedi . Ad esempio, start: 2024-06-01 e fine: 2024-06-01.
reportType Vero corda:

Rapporto di sintesi complessivo
ReportType ha richiesto i dati sulle emissioni di carbonio. Obbligatorio. Specifica la modalità di aggregazione e visualizzazione dei dati nell'output, come illustrato in ReportTypeEnum.
elenco abbonamenti Vero string[] Elenco degli ID sottoscrizione per i quali sono richiesti i dati sulle emissioni di carbonio. Obbligatorio. Ogni ID sottoscrizione deve essere in formato minuscolo. La lunghezza massima dell'elenco è 100.
locationList string[] Elenco di località (nome visualizzato dell'area di Azure) per i dati sulle emissioni di carbonio, con ogni località specificata in lettere minuscole. Ad esempio: east us. Opzionale. È possibile usare il comando az account list-locations -o table per trovare i nomi visualizzati dell'area di Azure.
resourceGroupUrlList string[] Elenco degli URL del gruppo di risorse per i dati sulle emissioni di carbonio. Opzionale. Ogni URL deve seguire il formato /subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}e deve essere in lettere minuscole.
resourceTypeList string[] Elenco dei tipi di risorse per i dati sulle emissioni di carbonio. Opzionale. Ogni tipo di risorsa deve essere specificato in lettere minuscole, seguendo il formato microsoft.{service}/{resourceType}. Ad esempio: microsoft.storage/storageaccounts.

FiltroDiInterrogazioneRapportoDiSintesiMensileOggettiPrincipali

Ecco i parametri di filtro delle query per configurare TopItemsMonthlySummaryReport.

Nome Obbligatorio Tipo Descrizione
carbonScopeList Vero EmissionScopeEnum[] Elenco degli ambiti di emissione di carbonio. Obbligatorio. Accetta uno o più valori da EmissionScopeEnum. Ad esempio, Scope1, Scope2, Scope3 nel formato elenco. L'output include le emissioni totali per gli ambiti specificati.
tipoCategoria Vero CategoryTypeEnum Specifica il tipo di categoria per recuperare gli elementi di creazione principale, aggregati per mese. Vedi i tipi supportati in CategoryTypeEnum.
intervallo di date Vero DateRange Date di inizio e fine per i dati sulle emissioni di carbonio. Obbligatorio. Per ItemDetailsReport e TopItemsSummaryReport, è supportato un solo mese di dati alla volta, pertanto le date di inizio e di fine devono essere uguali all'interno DateRangedi . Ad esempio, start: 2024-06-01 e fine: 2024-06-01.
reportType Vero corda:

Rapporto mensile di riepilogo sugli articoli principali
ReportType ha richiesto i dati sulle emissioni di carbonio. Obbligatorio. Specifica la modalità di aggregazione e visualizzazione dei dati nell'output, come illustrato in ReportTypeEnum.
elenco abbonamenti Vero string[] Elenco degli ID sottoscrizione per i quali sono richiesti i dati sulle emissioni di carbonio. Obbligatorio. Ogni ID sottoscrizione deve essere in formato minuscolo. La lunghezza massima dell'elenco è 100.
elementi principali Vero integer (int32)

minimo: 1
massimo: 10
Numero di articoli principali da restituire, in base alle emissioni. Deve essere compreso tra 1 e 10.
locationList string[] Elenco di località (nome visualizzato dell'area di Azure) per i dati sulle emissioni di carbonio, con ogni località specificata in lettere minuscole. Ad esempio: east us. Opzionale. È possibile usare il comando az account list-locations -o table per trovare i nomi visualizzati dell'area di Azure.
resourceGroupUrlList string[] Elenco degli URL del gruppo di risorse per i dati sulle emissioni di carbonio. Opzionale. Ogni URL deve seguire il formato /subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}e deve essere in lettere minuscole.
resourceTypeList string[] Elenco dei tipi di risorse per i dati sulle emissioni di carbonio. Opzionale. Ogni tipo di risorsa deve essere specificato in lettere minuscole, seguendo il formato microsoft.{service}/{resourceType}. Ad esempio: microsoft.storage/storageaccounts.

FiltroQueryReportSommarioElementiPrincipali

Ecco i parametri del filtro di query per configurare TopItemsSummaryReport queries.

Nome Obbligatorio Tipo Descrizione
carbonScopeList Vero EmissionScopeEnum[] Elenco degli ambiti di emissione di carbonio. Obbligatorio. Accetta uno o più valori da EmissionScopeEnum. Ad esempio, Scope1, Scope2, Scope3 nel formato elenco. L'output include le emissioni totali per gli ambiti specificati.
tipoCategoria Vero CategoryTypeEnum Specifica il tipo di categoria per cui recuperare gli elementi che generano l'inizio. Vedere i valori supportati definiti in CategoryTypeEnum.
intervallo di date Vero DateRange Date di inizio e fine per i dati sulle emissioni di carbonio. Obbligatorio. Per ItemDetailsReport e TopItemsSummaryReport, è supportato un solo mese di dati alla volta, pertanto le date di inizio e di fine devono essere uguali all'interno DateRangedi . Ad esempio, start: 2024-06-01 e fine: 2024-06-01.
reportType Vero corda:

Rapporto Sommario Articoli Principali
ReportType ha richiesto i dati sulle emissioni di carbonio. Obbligatorio. Specifica la modalità di aggregazione e visualizzazione dei dati nell'output, come illustrato in ReportTypeEnum.
elenco abbonamenti Vero string[] Elenco degli ID sottoscrizione per i quali sono richiesti i dati sulle emissioni di carbonio. Obbligatorio. Ogni ID sottoscrizione deve essere in formato minuscolo. La lunghezza massima dell'elenco è 100.
elementi principali Vero integer (int32)

minimo: 1
massimo: 10
Numero di articoli principali da restituire, in base alle emissioni. Questo valore deve essere compreso tra 1 e 10.
locationList string[] Elenco di località (nome visualizzato dell'area di Azure) per i dati sulle emissioni di carbonio, con ogni località specificata in lettere minuscole. Ad esempio: east us. Opzionale. È possibile usare il comando az account list-locations -o table per trovare i nomi visualizzati dell'area di Azure.
resourceGroupUrlList string[] Elenco degli URL del gruppo di risorse per i dati sulle emissioni di carbonio. Opzionale. Ogni URL deve seguire il formato /subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}e deve essere in lettere minuscole.
resourceTypeList string[] Elenco dei tipi di risorse per i dati sulle emissioni di carbonio. Opzionale. Ogni tipo di risorsa deve essere specificato in lettere minuscole, seguendo il formato microsoft.{service}/{resourceType}. Ad esempio: microsoft.storage/storageaccounts.

Esempi di report

Le sezioni seguenti illustrano le richieste e le risposte di esempio per ogni tipo di report.

Tutti i report includono risposta subscriptionAccessDecisionList. Il campo mostra la decisione di accesso per ogni abbonamento di input.

Rapporto di sintesi complessivo

Il report mostra le emissioni totali per tutti gli ambiti delle sottoscrizioni e l'intervallo di date specificato nell'input. Utilizzare il report quando sono necessari i dati del report di alto livello.

Esempio di richiesta

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

Risposta di esempio

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

ReportMensileDiSintesi

Il report mostra le emissioni per tutte le sottoscrizioni e gli ambiti delle emissioni per il mese specificato nell'intervallo di date. Usare il report quando sono necessari dettagli per un mese specificato.

Esempio di richiesta

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

Risposta di esempio

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

Rapporto Sommario Articoli Principali

Il report mostra le emissioni dei primi X elementi aggregati tra sottoscrizioni, emissioni, ambito, categoria e intervallo di date specificato, suddiviso per categoria. Usare il report quando sono necessari dati per gli elementi principali per categoria.

Esempio di richiesta

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
}

Risposta di esempio

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

Rapporto mensile di riepilogo sugli articoli principali

Il report mostra le emissioni degli elementi X principali aggregati tra sottoscrizioni, emissioni, ambiti e categoria per ogni mese specificato nell'intervallo di date. Le emissioni vengono suddivise per categoria. Gli elementi X principali sono basati sulle emissioni del mese scorso. Usare il report quando sono necessari dati per gli elementi principali per categoria e mese.

Esempio di richiesta

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
}

Risposta di esempio

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

Rapporto dettagli dell’articolo

Il report mostra le emissioni aggregate tra ambiti selezionati e ID sottoscrizione per un determinato intervallo di date e suddiviso in base alla categoria specificata. Usare il report quando sono necessari dati sulle emissioni per categoria e per ottenere dati a livello di risorsa e gruppo di risorse.

Esempio di richiesta

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
}

Risposta di esempio

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