Nota
O acesso a esta página requer autorização. Podes tentar iniciar sessão ou mudar de diretório.
O acesso a esta página requer autorização. Podes tentar mudar de diretório.
Este artigo ajuda você a entender e usar a API REST mais recente do Carbon Service para exportar a otimização de carbono nos dados de emissões do Azure. Os dados relativos às emissões do mês anterior estão disponíveis até ao dia 19 do mês em curso.
Para exportar dados de emissões usando a API REST, você deve criar e autorizar uma entidade de serviço para acessar seus dados de emissões. Pode-se então usar o principal de serviço para obter um token de autorização e exportar dados de emissões usando a API REST.
Criar e autorizar uma entidade de serviço
Uma entidade de serviço é um aplicativo cujas credenciais podem ser usadas para autenticar e conceder acesso a recursos específicos do Azure utilizando o Microsoft Entra ID. Os recursos incluem aplicativos de usuário, serviços ou ferramentas de automação.
- Crie uma aplicação e entidade de serviço Microsoft Entra que possa acessar recursos.
- Salve a ID do locatário, a nova ID do cliente e o valor do segredo do cliente do seu aplicativo para uso em solicitações de token.
- O aplicativo deve receber a função
Carbon Optimization Readerpara os recursos para os quais você deseja exportar dados de emissões. Se quiser usar o aplicativo para exportar dados de emissões para muitos recursos, você pode atribuir a função no nível da assinatura. Para obter mais informações, consulte Atribuir funções do Azure usando o portal do Azure e Atribuir acesso à otimização de carbono no Azure.
Obter um token de autorização
Envie a seguinte POST solicitação no prompt de comando ou usando um cliente.
Use a URL https://management.azure.com do recurso para obter um token de acesso para a API de gerenciamento 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'
O corpo da resposta aparece da seguinte forma:
{
"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 o token de acesso da resposta para uso nas seguintes solicitações HTTP.
Exportar dados de emissões usando a API REST
Use a solicitação a seguir POST para exportar dados de emissões.
POST /providers/Microsoft.Carbon/carbonEmissionReports?api-version=2025-04-01
Host: management.azure.com
Content-Type: application/json
Authorization: Bearer \<token value\>
Exemplo de pedido e resposta
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"
}
}
Saída da amostra
{
"subscriptionAccessDecisionList": [
{
"subscriptionId": "00000000-0000-0000-0000-000000000000",
"decision": "Allowed"
}
],
"value": [
{
"dataType": "OverallSummaryData",
"latestMonthEmissions": 0.1,
"previousMonthEmissions": 0.05,
"monthOverMonthEmissionsChangeRatio": 1,
"monthlyEmissionsChangeValue": 0.05
}
]
}
Aqui está um exemplo 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
}
'
Saída de ondulação de amostra:
{
"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 relatório
A otimização de carbono fornece vários tipos de relatório para ajudá-lo a analisar seus dados de emissões. Cada tipo de relatório serve uma finalidade diferente e é usado para suas necessidades específicas:
| Tipo de relatório | Descrição | Quando utilizar |
|---|---|---|
| RelatórioResumoGeral | Fornece emissões totais de carbono para o intervalo de datas especificado e parâmetros de consulta, e valores comparativos para uma visão geral de alto nível. Este tipo de relatório aceita valores diferentes nos campos inicial e final dentro de DateRange. Por exemplo, início: 2024-03-01 e fim: 2024-06-01. | Dados de relatório de alto nível necessários |
| RelatórioResumoMensal | Fornece dados de emissões de carbono por mês para os parâmetros de consulta especificados. Este tipo de relatório aceita valores diferentes nos campos inicial e final dentro de DateRange. Por exemplo, início: 2024-03-01 e fim: 2024-06-01. | Detalhes para um mês especificado |
| Relatório de Resumo dos Principais Itens | Fornece os N itens de maior emissão para os filtros de consulta especificados. Esse relatório retorna dados de um único mês de cada vez, portanto, requer os mesmos valores para os campos inicial e final em DateRange. Um máximo de N = 10 itens são devolvidos de cada vez. | Dados para os principais itens por categoria |
| Relatório de Resumo Mensal de Itens Principais | Fornece os N itens de maior emissão por mês para o filtro de consulta especificado. Devolve dados de emissões para os principais itens N por mês dentro do intervalo de datas determinado. Um máximo de N = 10 itens são devolvidos de cada vez. | Dados para os principais itens por categoria e mês |
| Relatório de Detalhes do Item | Uma lista granular de itens com base no CategoryType especificado (incluindo: Resource, ResourceGroup, ResourceType, Location ou Subscription) para o filtro de consulta. Você pode consultar apenas um mês de cada vez. O DateRange requer os mesmos valores para os campos inicial e final. | Dados relativos às emissões por categoria |
Exportar parâmetros API de emissões
Para cada reportType, diferentes parâmetros de consulta são definidos. As seções a seguir fornecem informações detalhadas sobre os parâmetros de consulta para cada reportType.
| Nome | Descrição |
|---|---|
| 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. |
| FiltroDeConsultaDeRelatórioDeResumoMensalDePrincipaisItens | Parâmetros de filtro de consulta para configurar TopItemsMonthlySummaryReport consultas. |
| RelatórioDeResumoDeItensPrincipaisConsultaFiltro | Parâmetros de filtro de consulta para configurar TopItemsSummaryReport consultas. |
Para obter mais informações sobre os relatórios da API REST, consulte Carbon Service - List Carbon Emission Reports.
FiltroDeConsultaDeDetalhesDoItem
Aqui estão os parâmetros de consulta para ItemDetailsReport.
| Nome | Necessário | Tipo | Descrição |
|---|---|---|---|
| carbonScopeList | Verdade | EmissionScopeEnum[] | Lista de escopos de emissão de carbono. Obrigatório Aceita um ou mais valores de EmissionScopeEnum. Por exemplo, Scope1, Scope2, Scope3 em forma de lista. A saída inclui o total de emissões para os escopos especificados. |
| tipoDeCategoria | Verdade | CategoriaTipoEnum | Especifica o tipo de categoria para dados de emissões detalhados, como Resource, ResourceGroup, ResourceType, Location ou Subscription. Consulte os tipos suportados em CategoryTypeEnum. |
| intervalo de datas | Verdade | Intervalo de datas | As datas de início e fim dos dados de emissões de carbono. Obrigatório Para ItemDetailsReport e TopItemsSummaryReport, apenas um mês de dados é permitido de cada vez, portanto, as datas de início e término devem ser iguais dentro de DateRange. Por exemplo, início: 2024-06-01 e fim: 2024-06-01. |
| ordenarPor | Verdade | OrderByColumnEnum | O nome da coluna pela qual ordenar os resultados. Consulte os valores suportados em OrderByColumnEnum. |
| tamanho da página | Verdade | inteiro (int32) mínimo: 1 Máximo: 5000 |
Número de itens a devolver num pedido, o valor máximo é 5000. |
| tipo de relatório | Verdade | string: Relatório de Detalhes do Item |
O ReportType solicitou dados de emissões de carbono. Obrigatório Especifica como os dados são agregados e exibidos na saída, conforme explicado no ReportTypeEnum. |
| sortDirection | Verdade | SortDirectionEnum | Direção para classificar resultados. Consulte os valores suportados em SortDirectionEnum. |
| lista de assinaturas | Verdade | string[] | Lista de IDs de assinatura para os quais os dados de emissões de carbono são solicitados. Obrigatório Cada ID de assinatura deve estar em formato minúsculo. O comprimento máximo da lista é 100. |
| listaDeLocalizações | string[] | Lista de locais (nome de exibição da Região do Azure) para dados de emissões de carbono, com cada local especificado em minúsculas. Por exemplo, east us. Opcional. Você pode usar o comando az account list-locations -o table para localizar nomes de exibição da Região do Azure. |
|
| listaDeUrlsDoGrupoDeRecursos | string[] | Lista de URLs de grupos de recursos para dados de emissões de carbono. Opcional. Cada URL deve seguir o formato /subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}e deve estar em minúsculas. |
|
| listaDeTiposDeRecursos | string[] | Lista de tipos de recursos para dados de emissões de carbono. Opcional. Cada tipo de recurso deve ser especificado em minúsculas, seguindo o formato microsoft.{service}/{resourceType}. Por exemplo, microsoft.storage/storageaccounts. |
|
| skipToken | cadeia (de caracteres) | Token de paginação para buscar a próxima página de dados. Esse token é anulável e é retornado na resposta anterior se outras páginas de dados estiverem disponíveis. |
FiltroDeConsultaRelatórioResumoMensal
Aqui estão os parâmetros do filtro para configurar consultas MonthlySummaryReport.
| Nome | Necessário | Tipo | Descrição |
|---|---|---|---|
| carbonScopeList | Verdade | EmissionScopeEnum[] | Lista de escopos de emissão de carbono. Obrigatório Aceita um ou mais valores de EmissionScopeEnum. Por exemplo, Scope1, Scope2, Scope3 em forma de lista. A saída inclui o total de emissões para os escopos especificados. |
| intervalo de datas | Verdade | Intervalo de datas | As datas de início e fim dos dados de emissões de carbono. Obrigatório Para ItemDetailsReport e TopItemsSummaryReport, apenas um mês de dados é permitido de cada vez, portanto, as datas de início e término devem ser iguais dentro de DateRange. Por exemplo, início: 2024-06-01 e fim: 2024-06-01. |
| tipo de relatório | Verdade | string: RelatórioResumoMensal |
O ReportType solicitou dados de emissões de carbono. Obrigatório Especifica como os dados são agregados e exibidos na saída, conforme explicado no ReportTypeEnum. |
| lista de assinaturas | Verdade | string[] | Lista de IDs de assinatura para os quais os dados de emissões de carbono são solicitados. Obrigatório Cada ID de assinatura deve estar em formato minúsculo. O comprimento máximo da lista é 100. |
| listaDeLocalizações | string[] | Lista de locais (nome de exibição da Região do Azure) para dados de emissões de carbono, com cada local especificado em minúsculas. Por exemplo, east us. Opcional. Você pode usar o comando az account list-locations -o table para localizar nomes de exibição da Região do Azure. |
|
| listaDeUrlsDoGrupoDeRecursos | string[] | Lista de URLs de grupos de recursos para dados de emissões de carbono. Opcional. Cada URL deve seguir o formato /subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}e deve estar em minúsculas. |
|
| listaDeTiposDeRecursos | string[] | Lista de tipos de recursos para dados de emissões de carbono. Opcional. Cada tipo de recurso deve ser especificado em minúsculas, seguindo o formato microsoft.{service}/{resourceType}. Por exemplo, microsoft.storage/storageaccounts. |
FiltroConsultaRelatórioResumoGeral
Aqui estão os parâmetros do filtro de consulta para configurar consultas OverallSummaryReport.
| Nome | Necessário | Tipo | Descrição |
|---|---|---|---|
| carbonScopeList | Verdade | EmissionScopeEnum[] | Lista de escopos de emissão de carbono. Obrigatório Aceita um ou mais valores de EmissionScopeEnum. Por exemplo, Scope1, Scope2, Scope3 em forma de lista. A saída inclui o total de emissões para os escopos especificados. |
| intervalo de datas | Verdade | Intervalo de datas | As datas de início e fim dos dados de emissões de carbono. Obrigatório Para ItemDetailsReport e TopItemsSummaryReport, apenas um mês de dados é permitido de cada vez, portanto, as datas de início e término devem ser iguais dentro de DateRange. Por exemplo, início: 2024-06-01 e fim: 2024-06-01. |
| tipo de relatório | Verdade | string: RelatórioResumoGeral |
O ReportType solicitou dados de emissões de carbono. Obrigatório Especifica como os dados são agregados e exibidos na saída, conforme explicado no ReportTypeEnum. |
| lista de assinaturas | Verdade | string[] | Lista de IDs de assinatura para os quais os dados de emissões de carbono são solicitados. Obrigatório Cada ID de assinatura deve estar em formato minúsculo. O comprimento máximo da lista é 100. |
| listaDeLocalizações | string[] | Lista de locais (nome de exibição da Região do Azure) para dados de emissões de carbono, com cada local especificado em minúsculas. Por exemplo, east us. Opcional. Você pode usar o comando az account list-locations -o table para localizar nomes de exibição da Região do Azure. |
|
| listaDeUrlsDoGrupoDeRecursos | string[] | Lista de URLs de grupos de recursos para dados de emissões de carbono. Opcional. Cada URL deve seguir o formato /subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}e deve estar em minúsculas. |
|
| listaDeTiposDeRecursos | string[] | Lista de tipos de recursos para dados de emissões de carbono. Opcional. Cada tipo de recurso deve ser especificado em minúsculas, seguindo o formato microsoft.{service}/{resourceType}. Por exemplo, microsoft.storage/storageaccounts. |
FiltroDeConsultaDeRelatórioDeResumoMensalDosPrincipaisItens
Aqui estão os parâmetros do filtro para configurar consultas TopItemsMonthlySummaryReport.
| Nome | Necessário | Tipo | Descrição |
|---|---|---|---|
| carbonScopeList | Verdade | EmissionScopeEnum[] | Lista de escopos de emissão de carbono. Obrigatório Aceita um ou mais valores de EmissionScopeEnum. Por exemplo, Scope1, Scope2, Scope3 em forma de lista. A saída inclui o total de emissões para os escopos especificados. |
| tipoDeCategoria | Verdade | CategoriaTipoEnum | Especifica o tipo de categoria para recuperar itens de maior emissão, agregados por mês. Consulte os tipos suportados em CategoryTypeEnum. |
| intervalo de datas | Verdade | Intervalo de datas | As datas de início e fim dos dados de emissões de carbono. Obrigatório Para ItemDetailsReport e TopItemsSummaryReport, apenas um mês de dados é permitido de cada vez, portanto, as datas de início e término devem ser iguais dentro de DateRange. Por exemplo, início: 2024-06-01 e fim: 2024-06-01. |
| tipo de relatório | Verdade | string: Relatório de Resumo Mensal de Itens Principais |
O ReportType solicitou dados de emissões de carbono. Obrigatório Especifica como os dados são agregados e exibidos na saída, conforme explicado no ReportTypeEnum. |
| lista de assinaturas | Verdade | string[] | Lista de IDs de assinatura para os quais os dados de emissões de carbono são solicitados. Obrigatório Cada ID de assinatura deve estar em formato minúsculo. O comprimento máximo da lista é 100. |
| top-Itens | Verdade | inteiro (int32) mínimo: 1 Máximo: 10 |
O número de itens principais a devolver, com base nas emissões. Deve ter entre 1 e 10. |
| listaDeLocalizações | string[] | Lista de locais (nome de exibição da Região do Azure) para dados de emissões de carbono, com cada local especificado em minúsculas. Por exemplo, east us. Opcional. Você pode usar o comando az account list-locations -o table para localizar nomes de exibição da Região do Azure. |
|
| listaDeUrlsDoGrupoDeRecursos | string[] | Lista de URLs de grupos de recursos para dados de emissões de carbono. Opcional. Cada URL deve seguir o formato /subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}e deve estar em minúsculas. |
|
| listaDeTiposDeRecursos | string[] | Lista de tipos de recursos para dados de emissões de carbono. Opcional. Cada tipo de recurso deve ser especificado em minúsculas, seguindo o formato microsoft.{service}/{resourceType}. Por exemplo, microsoft.storage/storageaccounts. |
ConsultaResumoRelatórioItensPrincipais
Aqui estão os parâmetros do filtro de consulta para configurar TopItemsSummaryReport queries.
| Nome | Necessário | Tipo | Descrição |
|---|---|---|---|
| carbonScopeList | Verdade | EmissionScopeEnum[] | Lista de escopos de emissão de carbono. Obrigatório Aceita um ou mais valores de EmissionScopeEnum. Por exemplo, Scope1, Scope2, Scope3 em forma de lista. A saída inclui o total de emissões para os escopos especificados. |
| tipoDeCategoria | Verdade | CategoriaTipoEnum | Especifica o tipo de categoria para o qual recuperar itens de emissão superior. Consulte os valores suportados definidos em CategoryTypeEnum. |
| intervalo de datas | Verdade | Intervalo de datas | As datas de início e fim dos dados de emissões de carbono. Obrigatório Para ItemDetailsReport e TopItemsSummaryReport, apenas um mês de dados é permitido de cada vez, portanto, as datas de início e término devem ser iguais dentro de DateRange. Por exemplo, início: 2024-06-01 e fim: 2024-06-01. |
| tipo de relatório | Verdade | string: Relatório de Resumo dos Principais Itens |
O ReportType solicitou dados de emissões de carbono. Obrigatório Especifica como os dados são agregados e exibidos na saída, conforme explicado no ReportTypeEnum. |
| lista de assinaturas | Verdade | string[] | Lista de IDs de assinatura para os quais os dados de emissões de carbono são solicitados. Obrigatório Cada ID de assinatura deve estar em formato minúsculo. O comprimento máximo da lista é 100. |
| top-Itens | Verdade | inteiro (int32) mínimo: 1 Máximo: 10 |
O número de itens principais a devolver, com base nas emissões. Esse valor deve estar entre 1 e 10. |
| listaDeLocalizações | string[] | Lista de locais (nome de exibição da Região do Azure) para dados de emissões de carbono, com cada local especificado em minúsculas. Por exemplo, east us. Opcional. Você pode usar o comando az account list-locations -o table para localizar nomes de exibição da Região do Azure. |
|
| listaDeUrlsDoGrupoDeRecursos | string[] | Lista de URLs de grupos de recursos para dados de emissões de carbono. Opcional. Cada URL deve seguir o formato /subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}e deve estar em minúsculas. |
|
| listaDeTiposDeRecursos | string[] | Lista de tipos de recursos para dados de emissões de carbono. Opcional. Cada tipo de recurso deve ser especificado em minúsculas, seguindo o formato microsoft.{service}/{resourceType}. Por exemplo, microsoft.storage/storageaccounts. |
Relatórios de exemplo
As seções a seguir mostram exemplos de solicitações e respostas para cada tipo de relatório.
Todos os relatórios incluem a subscriptionAccessDecisionList resposta. O campo mostra a decisão de acesso para cada assinatura de entrada.
RelatórioResumoGeral
O relatório mostra as emissões totais de todas as assinaturas, escopos e intervalo de datas especificados na entrada. Use o relatório quando precisar de dados de relatório de alto nível.
Pedido de amostra
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"
}
}
Resposta da amostra
{
"subscriptionAccessDecisionList": [
{
"subscriptionId": "00000000-0000-0000-0000-000000000000",
"decision": "Allowed"
}
],
"value": [
{
"dataType": "OverallSummaryData",
"latestMonthEmissions": 0.1,
"previousMonthEmissions": 0.05,
"monthOverMonthEmissionsChangeRatio": 1,
"monthlyEmissionsChangeValue": 0.05
}
]
}
RelatórioResumoMensal
O relatório mostra as emissões para todas as assinaturas e escopos de emissões para o mês especificado no intervalo de datas. Use o relatório quando precisar de detalhes de um mês especificado.
Pedido de amostra
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"
}
}
Resposta da amostra
{
"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
}
]
}
Relatório de Resumo dos Principais Itens
O relatório mostra as emissões dos principais itens X agregadas em assinaturas, emissões, escopo, categoria e intervalo de datas especificado, discriminadas por categoria. Use o relatório quando precisar de dados para os principais itens por categoria.
Pedido de amostra
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
}
Resposta da amostra
{
"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"
}
]
}
Relatório de Resumo Mensal de Itens Principais
O relatório mostra as emissões dos principais itens X agregados em assinaturas, emissões, escopos e categoria para cada mês especificado no intervalo de datas. As emissões são discriminadas por categoria. Os principais itens X são baseados nas emissões do mês passado. Use o relatório quando precisar de dados para os principais itens por categoria e mês.
Pedido de amostra
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
}
Resposta da amostra
{
"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"
}
]
}
Relatório de Detalhes do Item
O relatório mostra as emissões agregadas em escopos selecionados e IDs de assinatura para um determinado intervalo de datas e discriminadas por categoria especificada. Use o relatório quando precisar de dados de emissões por categoria e para obter dados de grupo de recursos e de nível de recurso.
Pedido de amostra
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
}
Resposta da amostra
{
"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"
}
]
}