Partager via

Utiliser l’API pour exporter l’optimisation du carbone dans les données d’émissions Azure

Cet article vous aide à comprendre et à utiliser la dernière API REST Carbon Service pour exporter l’optimisation du carbone dans les données d’émissions Azure. Les données sur les émissions sont disponibles pour le mois précédent par jour 19 du mois en cours.

Pour exporter des données d’émission à l’aide de l’API REST, vous devez créer et autoriser un principal de service à accéder à vos données d’émission. Vous pouvez ensuite utiliser le principal de service pour obtenir un jeton d’autorisation, puis exporter des données d’émission à l’aide de l’API REST.

Créer et autoriser un principal de service

Un principal de service est une application dont les jetons peuvent être utilisés pour authentifier et accorder l’accès à des ressources Azure spécifiques à l’aide de l’ID Microsoft Entra. Les ressources incluent des applications utilisateur, des services ou des outils d’automatisation.

  1. Créer une application Microsoft Entra et un principal de service qui peuvent accéder aux ressources.
  2. Enregistrez l’ID de locataire, le nouvel ID client et la valeur de clé secrète client pour votre application à utiliser dans les demandes de jetons.
  3. L’application doit être affectée au rôle Carbon Optimization Reader pour les ressources pour lesquelles vous souhaitez exporter les données d’émission. Si vous souhaitez utiliser l’application pour exporter des données d’émission pour de nombreuses ressources, vous pouvez attribuer le rôle au niveau de l’abonnement. Pour plus d’informations, consultez Affecter des rôles Azure à l’aide du portail Azure et Attribuer l’accès à l’optimisation du carbone dans Azure.

Obtenir un jeton d’autorisation

Envoyez la requête suivante POST dans l’invite de commandes ou à l’aide d’un client. Utilisez l’URL https://management.azure.com de ressource pour obtenir un jeton d’accès pour l’API de gestion des ressources.

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'

Le corps de la réponse apparaît comme ceci :

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

Utilisez le jeton d’accès à partir de la réponse à utiliser dans les requêtes HTTP suivantes.

Exporter des données d’émission à l’aide de l’API REST

Utilisez la demande suivante POST pour exporter les données d’émission.

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

Exemple de demande et de réponse

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

Exemple de sortie

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

Voici un exemple de « 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
}
'

Exemple de sortie curl :

{
  "subscriptionAccessDecisionList": [
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000000",
      "decision": "Allowed"
    },
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000001",
      "decision": "Allowed"
    },
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000002",
      "decision": "Allowed"
    },
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000003",
      "decision": "Allowed"
    },
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000004",
      "decision": "Allowed"
    },
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000005",
      "decision": "Allowed"
    },
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000006",
      "decision": "Denied"
    },
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000007",
      "decision": "Denied"
    },
    {
      "subscriptionId": "00000000-0000-0000-0000-000000000008",
      "decision": "Denied",
      "denialReason": "Carbon Optimization Reader permisison required"
    }
  ],
  "value": [
    {
      "dataType": "ResourceItemDetailsData",
      "latestMonthEmissions": 0.1,
      "previousMonthEmissions": 0.05,
      "monthOverMonthEmissionsChangeRatio": 1,
      "monthlyEmissionsChangeValue": 0.05,
      "itemName": "rgName1",
      "resourceGroup": "rgGroup",
      "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgGroup/providers/microsoft.storage/storageaccounts/rgName1",
      "subscriptionId": "00000000-0000-0000-0000-000000000000",
      "categoryType": "Resource",
      "resourceType": "microsoft.storage/storageaccounts",
      "location": "east us"
    },
    {
      "dataType": "ResourceItemDetailsData",
      "latestMonthEmissions": 0.1,
      "previousMonthEmissions": 0.05,
      "monthOverMonthEmissionsChangeRatio": 1,
      "monthlyEmissionsChangeValue": 0.05,
      "itemName": "rgName2",
      "resourceGroup": "rgGroup",
      "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgGroup/providers/microsoft.storage/storageaccounts/rgName2",
      "subscriptionId": "00000000-0000-0000-0000-000000000000",
      "categoryType": "Resource",
      "resourceType": "microsoft.storage/storageaccounts",
      "location": "east us"
    },
    {
      "dataType": "ResourceItemDetailsData",
      "latestMonthEmissions": 0.1,
      "previousMonthEmissions": 0.05,
      "monthOverMonthEmissionsChangeRatio": 1,
      "monthlyEmissionsChangeValue": 0.05,
      "itemName": "rgName3",
      "resourceGroup": "rgGroup",
      "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgGroup/providers/microsoft.storage/storageaccounts/rgName3",
      "subscriptionId": "00000000-0000-0000-0000-000000000000",
      "categoryType": "Resource",
      "resourceType": "microsoft.storage/storageaccounts",
      "location": "east us"
    },
    {
      "dataType": "ResourceItemDetailsData",
      "latestMonthEmissions": 0.1,
      "previousMonthEmissions": 0.05,
      "monthOverMonthEmissionsChangeRatio": 1,
      "monthlyEmissionsChangeValue": 0.05,
      "itemName": "rgName4",
      "resourceGroup": "rgGroup",
      "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000002/resourceGroups/rgGroup/providers/microsoft.storage/storageaccounts/rgName4",
      "subscriptionId": "00000000-0000-0000-0000-000000000002",
      "categoryType": "Resource",
      "resourceType": "microsoft.storage/storageaccounts",
      "location": "east us"
    },
    {
      "dataType": "ResourceItemDetailsData",
      "latestMonthEmissions": 0.1,
      "previousMonthEmissions": 0.05,
      "monthOverMonthEmissionsChangeRatio": 1,
      "monthlyEmissionsChangeValue": 0.05,
      "itemName": "rgName5",
      "resourceGroup": "rgGroup",
      "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000002/resourceGroups/rgGroup/providers/microsoft.storage/storageaccounts/rgName5",
      "subscriptionId": "00000000-0000-0000-0000-000000000002",
      "categoryType": "Resource",
      "resourceType": "microsoft.storage/storageaccounts",
      "location": "east us"
    }
  ],
  "skipToken": "dGVzZGZhZGZzZnNkZg=="
}

Types de rapports

L’optimisation du carbone fournit différents types de rapports pour vous aider à analyser vos données d’émissions. Chaque type de rapport sert un but différent et est utilisé pour vos besoins spécifiques :

Type de rapport Descriptif Quand utiliser
Rapport de Résumé Global Fournit le total des émissions de carbone pour la plage de dates et les paramètres de requête spécifiés, ainsi que des valeurs comparatives pour une vue d’ensemble générale. Ce type de rapport accepte différentes valeurs dans les champs de début et de fin dans DateRange. Par exemple, commencez : 2024-03-01 et fin : 2024-06-01. Données de rapport de haut niveau requises
Rapport mensuel de synthèse Fournit des données d’émissions de carbone par mois pour les paramètres de requête spécifiés. Ce type de rapport accepte différentes valeurs dans les champs de début et de fin dans DateRange. Par exemple, commencez : 2024-03-01 et fin : 2024-06-01. Détails d’un mois spécifié
Rapport récapitulatif des articles principaux Fournit les éléments n les plus émis pour les filtres de requête spécifiés. Ce rapport retourne des données d’un seul mois à la fois, ce qui nécessite les mêmes valeurs pour les champs de début et de fin dans DateRange. Un maximum de N=10 éléments est retourné à la fois. Données pour les éléments principaux par catégorie
Résumé Mensuel des Articles Principaux Fournit les éléments n les plus émis par mois pour le filtre de requête spécifié. Retourne les données d’émission pour les principaux éléments N par mois dans la plage de dates donnée. Un maximum de N=10 éléments est retourné à la fois. Données pour les éléments principaux par catégorie et par mois
Rapport de détails de l'article Liste granulaire d’éléments en fonction du CategoryType spécifié (notamment : Ressource, ResourceGroup, ResourceType, Emplacement ou Abonnement) pour le filtre de requête. Vous ne pouvez demander qu’un seul mois à la fois. DateRange nécessite les mêmes valeurs pour les champs de début et de fin. Données d’émission par catégorie

Exporter les paramètres de l’API d’émission

Pour chaque reportType, différents paramètres de requête sont définis. Les sections suivantes fournissent des informations détaillées sur les paramètres de requête pour chaque reportType.

Nom Description
ItemDetailsQueryFilter Paramètres de requête pour ItemDetailsReport
MonthlySummaryReportQueryFilter Paramètres de filtre pour configurer les requêtes MonthlySummaryReport.
OverallSummaryReportQueryFilter Paramètres de filtre pour configurer les requêtes OverallSummaryReport.
SommaireMensuelDesArticlesPrincipauxFiltreDeRequêteRapport Paramètres de filtre pour configurer les requêtes TopItemsMonthlySummaryReport.
TopItemsSummaryReportQueryFilter Paramètres de filtre pour configurer les requêtes TopItemsSummaryReport.

Pour plus d’informations sur les rapports de l’API REST, consultez Service carbone - Répertorier les rapports d’émission de carbone.

FiltreRequêteDétailsÉlément

Voici les paramètres de requête pour ItemDetailsReport.

Nom Obligatoire Type Description
carbonScopeList Vrai EmissionScopeEnum[] Liste des étendues d’émissions de carbone. Obligatoire. Accepte une ou plusieurs valeurs à partir de EmissionScopeEnum. Par exemple, Scope1, Scope2, Scope3 sous forme de liste. Le résultat inclut le total des émissions pour les périmètres spécifiés.
type de catégorie Vrai CategoryTypeEnum Spécifie le type de catégorie pour les données d’émissions détaillées, telles que Resource, ResourceGroup, ResourceType, Location ou Subscription. Consultez les types pris en charge dans CategoryTypeEnum.
plage de dates Vrai DateRange Dates de début et de fin des données sur les émissions de carbone. Obligatoire. Pour ItemDetailsReport et TopItemsSummaryReport, un seul mois de données est pris en charge à la fois, donc les dates de début et de fin doivent être égales dans DateRange. Par exemple, commencez : 2024-06-01 et fin : 2024-06-01.
trier par Vrai OrderByColumnEnum Nom de colonne par lequel classer les résultats. Consultez les valeurs prises en charge dans OrderByColumnEnum.
Taille de page Vrai entier (int32)

minimum : 1
maximum : 5 000		 Nombre d’éléments à retourner dans une requête, la valeur maximale est 5 000.
Type de rapport Vrai corde:

Rapport de détails de l'article		 ReportType demandé pour les données d’émissions de carbone. Obligatoire. Spécifie comment les données sont agrégées et affichées dans la sortie, comme expliqué dans le ReportTypeEnum.
sortDirection Vrai SortDirectionEnum Direction du tri des résultats. Consultez les valeurs prises en charge dans SortDirectionEnum.
liste d'abonnement Vrai chaîne de caractères[] Liste des ID d’abonnement pour lesquels les données sur les émissions de carbone sont demandées. Obligatoire. Chaque ID d’abonnement doit être au format minuscule. La longueur maximale de la liste est de 100.
liste de lieux chaîne de caractères[] Liste des emplacements (nom complet de la région Azure) pour les données d’émissions de carbone, avec chaque emplacement spécifié en minuscules. Par exemple : east us. Optionnel. Vous pouvez utiliser la commande az account list-locations -o table pour rechercher les noms d’affichage de région Azure.
listeDesUrlsDuGroupeDeRessources chaîne de caractères[] Liste des URL de groupe de ressources pour les données d’émissions de carbone. Optionnel. Chaque URL doit suivre le format /subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}et doit être en minuscules.
ListeDesTypesDeRessources chaîne de caractères[] Liste des types de ressources pour les données d’émissions de carbone. Optionnel. Chaque type de ressource doit être spécifié en minuscules, en suivant le format microsoft.{service}/{resourceType}. Par exemple : microsoft.storage/storageaccounts.
skipToken ficelle Jeton de pagination pour extraire la page suivante des données. Ce jeton est nullable et est retourné dans la réponse précédente si d’autres pages de données sont disponibles.

FiltreRequêteRapportSynthèseMensuel

Voici les paramètres de filtre de requête pour configurer MonthlySummaryReport les requêtes.

Nom Obligatoire Type Description
carbonScopeList Vrai EmissionScopeEnum[] Liste des étendues d’émissions de carbone. Obligatoire. Accepte une ou plusieurs valeurs à partir de EmissionScopeEnum. Par exemple, Scope1, Scope2, Scope3 sous forme de liste. Le résultat inclut le total des émissions pour les périmètres spécifiés.
plage de dates Vrai DateRange Dates de début et de fin des données sur les émissions de carbone. Obligatoire. Pour ItemDetailsReport et TopItemsSummaryReport, un seul mois de données est pris en charge à la fois, donc les dates de début et de fin doivent être égales dans DateRange. Par exemple, commencez : 2024-06-01 et fin : 2024-06-01.
Type de rapport Vrai corde:

Rapport mensuel de synthèse		 ReportType demandé pour les données d’émissions de carbone. Obligatoire. Spécifie comment les données sont agrégées et affichées dans la sortie, comme expliqué dans le ReportTypeEnum.
liste d'abonnement Vrai chaîne de caractères[] Liste des ID d’abonnement pour lesquels les données sur les émissions de carbone sont demandées. Obligatoire. Chaque ID d’abonnement doit être au format minuscule. La longueur maximale de la liste est de 100.
liste de lieux chaîne de caractères[] Liste des emplacements (nom complet de la région Azure) pour les données d’émissions de carbone, avec chaque emplacement spécifié en minuscules. Par exemple : east us. Optionnel. Vous pouvez utiliser la commande az account list-locations -o table pour rechercher les noms d’affichage de région Azure.
listeDesUrlsDuGroupeDeRessources chaîne de caractères[] Liste des URL de groupe de ressources pour les données d’émissions de carbone. Optionnel. Chaque URL doit suivre le format /subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}et doit être en minuscules.
ListeDesTypesDeRessources chaîne de caractères[] Liste des types de ressources pour les données d’émissions de carbone. Optionnel. Chaque type de ressource doit être spécifié en minuscules, en suivant le format microsoft.{service}/{resourceType}. Par exemple : microsoft.storage/storageaccounts.

FiltreDeRequêtePourRapportRésuméGlobal

Voici les paramètres de filtre de requête pour configurer les requêtes OverallSummaryReport.

Nom Obligatoire Type Description
carbonScopeList Vrai EmissionScopeEnum[] Liste des étendues d’émissions de carbone. Obligatoire. Accepte une ou plusieurs valeurs à partir de EmissionScopeEnum. Par exemple, Scope1, Scope2, Scope3 sous forme de liste. Le résultat inclut le total des émissions pour les périmètres spécifiés.
plage de dates Vrai DateRange Dates de début et de fin des données sur les émissions de carbone. Obligatoire. Pour ItemDetailsReport et TopItemsSummaryReport, un seul mois de données est pris en charge à la fois, donc les dates de début et de fin doivent être égales dans DateRange. Par exemple, commencez : 2024-06-01 et fin : 2024-06-01.
Type de rapport Vrai corde:

Rapport de Résumé Global		 ReportType demandé pour les données d’émissions de carbone. Obligatoire. Spécifie comment les données sont agrégées et affichées dans la sortie, comme expliqué dans le ReportTypeEnum.
liste d'abonnement Vrai chaîne de caractères[] Liste des ID d’abonnement pour lesquels les données sur les émissions de carbone sont demandées. Obligatoire. Chaque ID d’abonnement doit être au format minuscule. La longueur maximale de la liste est de 100.
liste de lieux chaîne de caractères[] Liste des emplacements (nom complet de la région Azure) pour les données d’émissions de carbone, avec chaque emplacement spécifié en minuscules. Par exemple : east us. Optionnel. Vous pouvez utiliser la commande az account list-locations -o table pour rechercher les noms d’affichage de région Azure.
listeDesUrlsDuGroupeDeRessources chaîne de caractères[] Liste des URL de groupe de ressources pour les données d’émissions de carbone. Optionnel. Chaque URL doit suivre le format /subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}et doit être en minuscules.
ListeDesTypesDeRessources chaîne de caractères[] Liste des types de ressources pour les données d’émissions de carbone. Optionnel. Chaque type de ressource doit être spécifié en minuscules, en suivant le format microsoft.{service}/{resourceType}. Par exemple : microsoft.storage/storageaccounts.

FiltreDeRequêteRésuméMensuelDesArticlesPrincipaux

Voici les paramètres de filtre de requête pour configurer TopItemsMonthlySummaryReport les requêtes.

Nom Obligatoire Type Description
carbonScopeList Vrai EmissionScopeEnum[] Liste des étendues d’émissions de carbone. Obligatoire. Accepte une ou plusieurs valeurs à partir de EmissionScopeEnum. Par exemple, Scope1, Scope2, Scope3 sous forme de liste. Le résultat inclut le total des émissions pour les périmètres spécifiés.
type de catégorie Vrai CategoryTypeEnum Spécifie le type de catégorie pour récupérer les éléments à émission supérieure, agrégés par mois. Consultez les types pris en charge dans CategoryTypeEnum.
plage de dates Vrai DateRange Dates de début et de fin des données sur les émissions de carbone. Obligatoire. Pour ItemDetailsReport et TopItemsSummaryReport, un seul mois de données est pris en charge à la fois, donc les dates de début et de fin doivent être égales dans DateRange. Par exemple, commencez : 2024-06-01 et fin : 2024-06-01.
Type de rapport Vrai corde:

Résumé Mensuel des Articles Principaux		 ReportType demandé pour les données d’émissions de carbone. Obligatoire. Spécifie comment les données sont agrégées et affichées dans la sortie, comme expliqué dans le ReportTypeEnum.
liste d'abonnement Vrai chaîne de caractères[] Liste des ID d’abonnement pour lesquels les données sur les émissions de carbone sont demandées. Obligatoire. Chaque ID d’abonnement doit être au format minuscule. La longueur maximale de la liste est de 100.
articles principaux Vrai entier (int32)

minimum : 1
maximum : 10		 Nombre d’éléments principaux à retourner, en fonction des émissions. Doit être compris entre 1 et 10.
liste de lieux chaîne de caractères[] Liste des emplacements (nom complet de la région Azure) pour les données d’émissions de carbone, avec chaque emplacement spécifié en minuscules. Par exemple : east us. Optionnel. Vous pouvez utiliser la commande az account list-locations -o table pour rechercher les noms d’affichage de région Azure.
listeDesUrlsDuGroupeDeRessources chaîne de caractères[] Liste des URL de groupe de ressources pour les données d’émissions de carbone. Optionnel. Chaque URL doit suivre le format /subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}et doit être en minuscules.
ListeDesTypesDeRessources chaîne de caractères[] Liste des types de ressources pour les données d’émissions de carbone. Optionnel. Chaque type de ressource doit être spécifié en minuscules, en suivant le format microsoft.{service}/{resourceType}. Par exemple : microsoft.storage/storageaccounts.

Résumé du rapport sur la requête des articles principaux

Voici les paramètres de filtre de requête à configurer TopItemsSummaryReport queries.

Nom Obligatoire Type Description
carbonScopeList Vrai EmissionScopeEnum[] Liste des étendues d’émissions de carbone. Obligatoire. Accepte une ou plusieurs valeurs à partir de EmissionScopeEnum. Par exemple, Scope1, Scope2, Scope3 sous forme de liste. Le résultat inclut le total des émissions pour les périmètres spécifiés.
type de catégorie Vrai CategoryTypeEnum Spécifie le type de catégorie pour lequel récupérer les éléments à émission supérieure. Voir les valeurs prises en charge définies dans CategoryTypeEnum.
plage de dates Vrai DateRange Dates de début et de fin des données sur les émissions de carbone. Obligatoire. Pour ItemDetailsReport et TopItemsSummaryReport, un seul mois de données est pris en charge à la fois, donc les dates de début et de fin doivent être égales dans DateRange. Par exemple, commencez : 2024-06-01 et fin : 2024-06-01.
Type de rapport Vrai corde:

Rapport récapitulatif des articles principaux		 ReportType demandé pour les données d’émissions de carbone. Obligatoire. Spécifie comment les données sont agrégées et affichées dans la sortie, comme expliqué dans le ReportTypeEnum.
liste d'abonnement Vrai chaîne de caractères[] Liste des ID d’abonnement pour lesquels les données sur les émissions de carbone sont demandées. Obligatoire. Chaque ID d’abonnement doit être au format minuscule. La longueur maximale de la liste est de 100.
articles principaux Vrai entier (int32)

minimum : 1
maximum : 10		 Nombre d’éléments principaux à retourner, en fonction des émissions. Cette valeur doit être comprise entre 1 et 10.
liste de lieux chaîne de caractères[] Liste des emplacements (nom complet de la région Azure) pour les données d’émissions de carbone, avec chaque emplacement spécifié en minuscules. Par exemple : east us. Optionnel. Vous pouvez utiliser la commande az account list-locations -o table pour rechercher les noms d’affichage de région Azure.
listeDesUrlsDuGroupeDeRessources chaîne de caractères[] Liste des URL de groupe de ressources pour les données d’émissions de carbone. Optionnel. Chaque URL doit suivre le format /subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}et doit être en minuscules.
ListeDesTypesDeRessources chaîne de caractères[] Liste des types de ressources pour les données d’émissions de carbone. Optionnel. Chaque type de ressource doit être spécifié en minuscules, en suivant le format microsoft.{service}/{resourceType}. Par exemple : microsoft.storage/storageaccounts.

Exemples de rapports

Les sections suivantes présentent des exemples de demandes et de réponses pour chaque type de rapport.

Tous les rapports incluent la subscriptionAccessDecisionList réponse. Le champ affiche la décision d’accès pour chaque abonnement d’entrée.

Rapport de Résumé Global

Le rapport affiche les émissions totales pour toutes les étendues d’abonnements et la plage de dates spécifiées dans l’entrée. Utilisez le rapport lorsque vous avez besoin de données de rapport de haut niveau.

Exemple de requête

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

Exemple de réponse

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

Rapport mensuel de synthèse

Le rapport affiche les émissions de tous les abonnements et étendues d’émissions pour le mois spécifié dans la plage de dates. Utilisez le rapport lorsque vous avez besoin de détails pour un mois spécifié.

Exemple de requête

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

Exemple de réponse

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

Rapport récapitulatif des articles principaux

Le rapport affiche les émissions des principaux éléments X agrégés entre les abonnements, les émissions, l’étendue, la catégorie et la plage de dates spécifiée, réparties par catégorie. Utilisez le rapport lorsque vous avez besoin de données pour les éléments principaux par catégorie.

Exemple de requête

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
}

Exemple de réponse

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

Résumé Mensuel des Articles Principaux

Le rapport affiche les émissions des principaux éléments X agrégés entre les abonnements, les émissions, les étendues et la catégorie pour chaque mois spécifié dans la plage de dates. Les émissions sont décomposées par catégorie. Les principaux éléments X sont basés sur les émissions du mois dernier. Utilisez le rapport lorsque vous avez besoin de données pour les éléments principaux par catégorie et par mois.

Exemple de requête

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
}

Exemple de réponse

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

Rapport de détails de l'article

Le rapport affiche les émissions agrégées entre les étendues sélectionnées et les ID d’abonnement pour une plage de dates donnée et décomposée par catégorie spécifiée. Utilisez le rapport lorsque vous avez besoin de données d’émission par catégorie et pour obtenir des données de groupe de ressources et de niveau ressource.

Exemple de requête

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
}

Exemple de réponse

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

Contenu connexe

  • Last updated on