Compartir a través de

Uso de la API para exportar la optimización del carbono en los datos de emisiones de Azure

Este artículo le ayuda a comprender y usar la API REST de Carbon Service más reciente para exportar la optimización del carbono en los datos de emisiones de Azure. Los datos de emisiones están disponibles para el mes anterior en el día 19 del mes actual.

Para exportar datos de emisiones mediante la API REST, debe crear y autorizar a una entidad de servicio para acceder a los datos de emisiones. Posteriormente, puede usar la entidad de servicio para obtener un token de autorización y, a continuación, exportar los datos de emisiones mediante la API REST.

Crear y autorizar una entidad de servicio

Una entidad de servicio es una aplicación cuyos tokens se pueden usar para autenticar y conceder acceso a recursos específicos de Azure mediante Microsoft Entra ID. Los recursos incluyen aplicaciones de usuario, servicios o herramientas de automatización.

  1. Crear una aplicación de Microsoft Entra y un principal de servicio que pueda acceder a recursos.
  2. Guarde el identificador de inquilino, el nuevo identificador de cliente y el valor del secreto de cliente de la aplicación para usarlo en las solicitudes de token.
  3. A la aplicación se le debe asignar el rol de Carbon Optimization Reader para los recursos para los que desea exportar los datos de emisiones. Si desea usar la aplicación para exportar datos de emisiones para muchos recursos, puede asignar el rol en el nivel de suscripción. Para más información, consulte Asignación de roles de Azure mediante Azure Portal y Asignación de acceso a la optimización de carbono en Azure.

Obtención de un token de autorización

Envíe la siguiente POST solicitud en el símbolo del sistema o mediante un cliente. Use la dirección URL https://management.azure.com del recurso para obtener un token de acceso para la API de administración de recursos.

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'

El cuerpo de la respuesta aparece de la siguiente manera:

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

Use el token de acceso de la respuesta para su uso en las siguientes solicitudes HTTP.

Exportación de datos de emisiones mediante la API REST

Use la siguiente POST solicitud para exportar datos de emisiones.

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

Solicitud y respuesta de ejemplo

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

Salida de ejemplo

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

Este es un ejemplo 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
}
'

Salida de curl de ejemplo:

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

Tipos de informe

La optimización del carbono proporciona varios tipos de informes que le ayudarán a analizar los datos de emisiones. Cada tipo de informe tiene un propósito diferente y se usa para sus necesidades específicas:

Tipo de informe Descripción Cuándo usar
InformeResumenGeneral Proporciona emisiones totales de carbono para el intervalo de fechas y los parámetros de consulta especificados, así como los valores comparativos para obtener información general de alto nivel. Este tipo de informe acepta valores diferentes en los campos start y end dentro de DateRange. Por ejemplo, inicio: 2024-03-01 y fin: 2024-06-01. Datos de informes de alto nivel necesarios
InformeMensualDeResumen Proporciona datos de emisiones de carbono por mes para los parámetros de consulta especificados. Este tipo de informe acepta valores diferentes en los campos start y end dentro de DateRange. Por ejemplo, inicio: 2024-03-01 y fin: 2024-06-01. Detalles de un mes especificado
Informe de Resumen de Artículos Principales Proporciona los N elementos que más emiten para los filtros de consulta especificados. Este informe devuelve datos de un solo mes a la vez, por lo que requiere los mismos valores para los campos de inicio y finalización dentro de DateRange. Se devuelve un máximo de N=10 elementos a la vez. Datos de los elementos principales por categoría
InformeResumenMensualDeArtículosPrincipales Proporciona los N elementos emisores más altos por mes para el filtro de consulta especificado. Devuelve los datos de emisiones de los N elementos principales por mes dentro del intervalo de fechas especificado. Se devuelve un máximo de N=10 elementos a la vez. Datos de los elementos principales por categoría y mes
Informe de Detalles del Artículo Una lista granular de elementos basada en el tipo de categoría especificado (incluidos: Recurso, Grupo de Recursos, Tipo de Recurso, Ubicación o Suscripción) para el filtro de consulta. Puede consultar solo un mes a la vez. DateRange requiere los mismos valores para los campos de inicio y finalización. Datos de emisiones por categoría

Exportación de parámetros de la API de emisiones

Para cada reportType, se definen parámetros de consulta diferentes. En las secciones siguientes se proporciona información detallada sobre los parámetros de consulta de cada reportType.

Nombre Descripción
ItemDetailsQueryFilter Parámetros de consulta para ItemDetailsReport
MonthlySummaryReportQueryFilter Parámetros de filtro de consulta para configurar MonthlySummaryReport consultas.
OverallSummaryReportQueryFilter Parámetros de filtro de consulta para configurar OverallSummaryReport consultas.
TopItemsMonthlySummaryReportQueryFilter Parámetros de filtro de consulta para configurar TopItemsMonthlySummaryReport consultas.
TopItemsSummaryReportQueryFilter Parámetros de filtro de consulta para configurar TopItemsSummaryReport consultas.

Para obtener más información sobre los informes de la API REST, consulte Carbon Service - Lista de informes de emisiones de carbono.

FiltroDeConsultaDeDetallesDelArticulo

Estos son los parámetros de consulta para ItemDetailsReport.

Nombre Obligatorio Tipo Descripción
carbonScopeList Cierto EmissionScopeEnum[] Lista de ámbitos de emisión de carbono. Obligatorio. Acepta uno o varios valores de EmissionScopeEnum. Por ejemplo, Scope1, Scope2, Scope3 en forma de lista. La salida incluye las emisiones totales de los ámbitos especificados.
tipoDeCategoría Cierto CategoryTypeEnum Especifica el tipo de categoría para datos detallados de emisiones, como Resource, ResourceGroup, ResourceType, Location o Subscription. Vea los tipos admitidos en CategoryTypeEnum.
rango de fechas Cierto DateRange Las fechas de inicio y finalización de los datos de emisiones de carbono. Obligatorio. Para ItemDetailsReport y TopItemsSummaryReport, solo se admite un mes de datos a la vez, por lo que las fechas de inicio y finalización deben ser iguales dentro de DateRange. Por ejemplo, inicio: 2024-06-01 y fin: 2024-06-01.
ordenarPor Cierto OrderByColumnEnum Nombre de columna por el que ordenar los resultados. Consulte los valores admitidos en OrderByColumnEnum.
tamaño de página Cierto entero (int32)

mínimo: 1
máximo: 5000		 Número de elementos que se van a devolver en una solicitud, el valor máximo es 5000.
tipoDeInforme Cierto cuerda:

Informe de Detalles del Artículo		 ReportType solicitó datos de emisiones de carbono. Obligatorio. Especifica cómo se agregan y muestran los datos en la salida, como se explica en .ReportTypeEnum
sortDirection Cierto SortDirectionEnum Dirección para ordenar los resultados. Consulte los valores admitidos en SortDirectionEnum.
lista de suscripciones Cierto string[] Lista de identificadores de suscripción para los que se solicitan los datos de emisiones de carbono. Obligatorio. Cada identificador de suscripción debe estar en minúsculas. La longitud máxima de la lista es 100.
lista de ubicaciones string[] Lista de localizaciones (nombre de visualización de la región de Azure) para los datos de emisiones de carbono, con cada localización especificada en minúsculas. Por ejemplo: east us. Opcional. Puede usar el comando az account list-locations -o table para buscar nombres visuales de región de Azure.
ListaDeUrlDelGrupoDeRecursos string[] Lista de direcciones URL del grupo de recursos para los datos de emisiones de carbono. Opcional. Cada dirección URL debe seguir el formato /subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}y debe estar en minúsculas.
listaDeTiposDeRecursos string[] Lista de tipos de recursos para los datos de emisiones de carbono. Opcional. Cada tipo de recurso debe especificarse en minúsculas, siguiendo el formato microsoft.{service}/{resourceType}. Por ejemplo: microsoft.storage/storageaccounts.
skipToken cuerda / cadena Token de paginación para capturar la siguiente página de datos. Este token es anulable y se devuelve en la respuesta previa si hay otras páginas de datos disponibles.

FiltroDeConsultaDeInformeDeResumenMensual

Estos son los parámetros de filtro de consulta para configurar MonthlySummaryReport las consultas.

Nombre Obligatorio Tipo Descripción
carbonScopeList Cierto EmissionScopeEnum[] Lista de ámbitos de emisión de carbono. Obligatorio. Acepta uno o varios valores de EmissionScopeEnum. Por ejemplo, Scope1, Scope2, Scope3 en forma de lista. La salida incluye las emisiones totales de los ámbitos especificados.
rango de fechas Cierto DateRange Las fechas de inicio y finalización de los datos de emisiones de carbono. Obligatorio. Para ItemDetailsReport y TopItemsSummaryReport, solo se admite un mes de datos a la vez, por lo que las fechas de inicio y finalización deben ser iguales dentro de DateRange. Por ejemplo, inicio: 2024-06-01 y fin: 2024-06-01.
tipoDeInforme Cierto cuerda:

InformeMensualDeResumen		 ReportType solicitó datos de emisiones de carbono. Obligatorio. Especifica cómo se agregan y muestran los datos en la salida, como se explica en .ReportTypeEnum
lista de suscripciones Cierto string[] Lista de identificadores de suscripción para los que se solicitan los datos de emisiones de carbono. Obligatorio. Cada identificador de suscripción debe estar en minúsculas. La longitud máxima de la lista es 100.
lista de ubicaciones string[] Lista de localizaciones (nombre de visualización de la región de Azure) para los datos de emisiones de carbono, con cada localización especificada en minúsculas. Por ejemplo: east us. Opcional. Puede usar el comando az account list-locations -o table para buscar nombres visuales de región de Azure.
ListaDeUrlDelGrupoDeRecursos string[] Lista de direcciones URL del grupo de recursos para los datos de emisiones de carbono. Opcional. Cada dirección URL debe seguir el formato /subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}y debe estar en minúsculas.
listaDeTiposDeRecursos string[] Lista de tipos de recursos para los datos de emisiones de carbono. Opcional. Cada tipo de recurso debe especificarse en minúsculas, siguiendo el formato microsoft.{service}/{resourceType}. Por ejemplo: microsoft.storage/storageaccounts.

FiltroDeConsultaDeInformeDeResumenGeneral

Estos son los parámetros de filtro de consulta para configurar las consultas OverallSummaryReport.

Nombre Obligatorio Tipo Descripción
carbonScopeList Cierto EmissionScopeEnum[] Lista de ámbitos de emisión de carbono. Obligatorio. Acepta uno o varios valores de EmissionScopeEnum. Por ejemplo, Scope1, Scope2, Scope3 en forma de lista. La salida incluye las emisiones totales de los ámbitos especificados.
rango de fechas Cierto DateRange Las fechas de inicio y finalización de los datos de emisiones de carbono. Obligatorio. Para ItemDetailsReport y TopItemsSummaryReport, solo se admite un mes de datos a la vez, por lo que las fechas de inicio y finalización deben ser iguales dentro de DateRange. Por ejemplo, inicio: 2024-06-01 y fin: 2024-06-01.
tipoDeInforme Cierto cuerda:

InformeResumenGeneral		 ReportType solicitó datos de emisiones de carbono. Obligatorio. Especifica cómo se agregan y muestran los datos en la salida, como se explica en .ReportTypeEnum
lista de suscripciones Cierto string[] Lista de identificadores de suscripción para los que se solicitan los datos de emisiones de carbono. Obligatorio. Cada identificador de suscripción debe estar en minúsculas. La longitud máxima de la lista es 100.
lista de ubicaciones string[] Lista de localizaciones (nombre de visualización de la región de Azure) para los datos de emisiones de carbono, con cada localización especificada en minúsculas. Por ejemplo: east us. Opcional. Puede usar el comando az account list-locations -o table para buscar nombres visuales de región de Azure.
ListaDeUrlDelGrupoDeRecursos string[] Lista de direcciones URL del grupo de recursos para los datos de emisiones de carbono. Opcional. Cada dirección URL debe seguir el formato /subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}y debe estar en minúsculas.
listaDeTiposDeRecursos string[] Lista de tipos de recursos para los datos de emisiones de carbono. Opcional. Cada tipo de recurso debe especificarse en minúsculas, siguiendo el formato microsoft.{service}/{resourceType}. Por ejemplo: microsoft.storage/storageaccounts.

FiltroDeConsultaResumenMensualDeElementosPrincipales

Estos son los parámetros de filtro de consulta para configurar TopItemsMonthlySummaryReport las consultas.

Nombre Obligatorio Tipo Descripción
carbonScopeList Cierto EmissionScopeEnum[] Lista de ámbitos de emisión de carbono. Obligatorio. Acepta uno o varios valores de EmissionScopeEnum. Por ejemplo, Scope1, Scope2, Scope3 en forma de lista. La salida incluye las emisiones totales de los ámbitos especificados.
tipoDeCategoría Cierto CategoryTypeEnum Especifica el tipo de categoría que se va a recuperar los elementos emisores superiores, agregados por mes. Vea los tipos admitidos en CategoryTypeEnum.
rango de fechas Cierto DateRange Las fechas de inicio y finalización de los datos de emisiones de carbono. Obligatorio. Para ItemDetailsReport y TopItemsSummaryReport, solo se admite un mes de datos a la vez, por lo que las fechas de inicio y finalización deben ser iguales dentro de DateRange. Por ejemplo, inicio: 2024-06-01 y fin: 2024-06-01.
tipoDeInforme Cierto cuerda:

InformeResumenMensualDeArtículosPrincipales		 ReportType solicitó datos de emisiones de carbono. Obligatorio. Especifica cómo se agregan y muestran los datos en la salida, como se explica en .ReportTypeEnum
lista de suscripciones Cierto string[] Lista de identificadores de suscripción para los que se solicitan los datos de emisiones de carbono. Obligatorio. Cada identificador de suscripción debe estar en minúsculas. La longitud máxima de la lista es 100.
artículos destacados Cierto entero (int32)

mínimo: 1
máximo: 10		 Número de elementos principales que se van a devolver, en función de las emisiones. Debe estar entre 1 y 10.
lista de ubicaciones string[] Lista de localizaciones (nombre de visualización de la región de Azure) para los datos de emisiones de carbono, con cada localización especificada en minúsculas. Por ejemplo: east us. Opcional. Puede usar el comando az account list-locations -o table para buscar nombres visuales de región de Azure.
ListaDeUrlDelGrupoDeRecursos string[] Lista de direcciones URL del grupo de recursos para los datos de emisiones de carbono. Opcional. Cada dirección URL debe seguir el formato /subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}y debe estar en minúsculas.
listaDeTiposDeRecursos string[] Lista de tipos de recursos para los datos de emisiones de carbono. Opcional. Cada tipo de recurso debe especificarse en minúsculas, siguiendo el formato microsoft.{service}/{resourceType}. Por ejemplo: microsoft.storage/storageaccounts.

FiltroDeConsultaDeInformeResumidoDeArtículosPrincipales

Estos son los parámetros de filtro de consulta para configurar TopItemsSummaryReport queries.

Nombre Obligatorio Tipo Descripción
carbonScopeList Cierto EmissionScopeEnum[] Lista de ámbitos de emisión de carbono. Obligatorio. Acepta uno o varios valores de EmissionScopeEnum. Por ejemplo, Scope1, Scope2, Scope3 en forma de lista. La salida incluye las emisiones totales de los ámbitos especificados.
tipoDeCategoría Cierto CategoryTypeEnum Especifica el tipo de categoría para el que se van a recuperar los elementos de emisión superior. Consulte los valores admitidos definidos en CategoryTypeEnum.
rango de fechas Cierto DateRange Las fechas de inicio y finalización de los datos de emisiones de carbono. Obligatorio. Para ItemDetailsReport y TopItemsSummaryReport, solo se admite un mes de datos a la vez, por lo que las fechas de inicio y finalización deben ser iguales dentro de DateRange. Por ejemplo, inicio: 2024-06-01 y fin: 2024-06-01.
tipoDeInforme Cierto cuerda:

Informe de Resumen de Artículos Principales		 ReportType solicitó datos de emisiones de carbono. Obligatorio. Especifica cómo se agregan y muestran los datos en la salida, como se explica en .ReportTypeEnum
lista de suscripciones Cierto string[] Lista de identificadores de suscripción para los que se solicitan los datos de emisiones de carbono. Obligatorio. Cada identificador de suscripción debe estar en minúsculas. La longitud máxima de la lista es 100.
artículos destacados Cierto entero (int32)

mínimo: 1
máximo: 10		 Número de elementos principales que se van a devolver, en función de las emisiones. Este valor debe estar comprendido entre 1 y 10.
lista de ubicaciones string[] Lista de localizaciones (nombre de visualización de la región de Azure) para los datos de emisiones de carbono, con cada localización especificada en minúsculas. Por ejemplo: east us. Opcional. Puede usar el comando az account list-locations -o table para buscar nombres visuales de región de Azure.
ListaDeUrlDelGrupoDeRecursos string[] Lista de direcciones URL del grupo de recursos para los datos de emisiones de carbono. Opcional. Cada dirección URL debe seguir el formato /subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}y debe estar en minúsculas.
listaDeTiposDeRecursos string[] Lista de tipos de recursos para los datos de emisiones de carbono. Opcional. Cada tipo de recurso debe especificarse en minúsculas, siguiendo el formato microsoft.{service}/{resourceType}. Por ejemplo: microsoft.storage/storageaccounts.

Informes de ejemplo

En las secciones siguientes se muestran solicitudes y respuestas de ejemplo para cada tipo de informe.

Todos los informes incluyen la subscriptionAccessDecisionList respuesta. El campo muestra la decisión de acceso para cada suscripción entrante.

InformeResumenGeneral

En el informe se muestran las emisiones totales de todos los ámbitos de suscripciones y el intervalo de fechas especificados en la entrada. Use el informe cuando necesite datos de informe de alto nivel.

Solicitud de ejemplo

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

Respuesta de ejemplo

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

InformeMensualDeResumen

El informe muestra las emisiones de todas las suscripciones y ámbitos de emisión del mes especificado en el intervalo de fechas. Use el informe cuando necesite detalles para un mes especificado.

Solicitud de ejemplo

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

Respuesta de ejemplo

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

Informe de Resumen de Artículos Principales

En el informe se muestran las emisiones de los elementos X principales agregados entre suscripciones, emisiones, ámbito, categoría y intervalo de fechas especificado, desglosados por categoría. Use el informe cuando necesite datos para los elementos principales por categoría.

Solicitud de ejemplo

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
}

Respuesta de ejemplo

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

InformeResumenMensualDeArtículosPrincipales

El informe muestra las emisiones de los elementos X principales agregados entre suscripciones, emisiones, ámbitos y categoría para cada mes especificado en el intervalo de fechas. Las emisiones se desglosan por categoría. Los elementos X principales se basan en las emisiones del mes pasado. Use el informe cuando necesite datos para los elementos principales por categoría y mes.

Solicitud de ejemplo

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
}

Respuesta de ejemplo

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

Informe de Detalles del Artículo

En el informe se muestran las emisiones agregadas en ámbitos seleccionados e identificadores de suscripción para un intervalo de fechas determinado y desglosados por categoría especificada. Use el informe cuando necesite datos de emisiones por categoría y para obtener datos de nivel de recurso y grupo de recursos.

Solicitud de ejemplo

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
}

Respuesta de ejemplo

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

Contenido relacionado

  • Last updated on