Observação
O acesso a essa página exige autorização. Você pode tentar entrar ou alterar diretórios.
O acesso a essa página exige autorização. Você pode tentar alterar os diretórios.
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 de emissões estão disponíveis para o mês anterior até o dia 19 do mês atual.
Para exportar dados de emissões usando a API REST, você deve criar e autorizar uma entidade de serviço a acessar seus dados de emissões. Em seguida, você pode 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 cujos tokens podem ser usados para autenticar e conceder acesso a recursos específicos do Azure por meio do Microsoft Entra ID. Os recursos incluem aplicativos de usuário, serviços ou ferramentas de automação.
- Criar um aplicativo do Microsoft Entra e uma entidade de serviço que possa acessar recursos.
- Salve a ID do locatário, a nova ID do cliente e o valor do segredo do cliente para 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 você quiser usar o aplicativo para exportar dados de emissões para muitos recursos, poderá 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 solicitação a seguir POST 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 maneira:
{
"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 solicitações HTTP a seguir.
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 solicitação 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 de exemplo
{
"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 curl de exemplo:
{
"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 a uma finalidade diferente e é usado para suas necessidades específicas:
| Tipo de relatório | Descrição | Quando usar |
|---|---|---|
| RelatórioResumoGeral | Fornece emissões totais de carbono para o intervalo de datas e parâmetros de consulta especificados e valores comparativos para uma visão geral de alto nível. Esse tipo de relatório aceita valores diferentes nos campos inicial e final no DateRange. Por exemplo, comece: 2024-03-01 e final: 2024-06-01. | Dados de relatório de alto nível necessários |
| RelatórioMensalResumo | Fornece dados de emissões de carbono por mês para os parâmetros de consulta especificados. Esse tipo de relatório aceita valores diferentes nos campos inicial e final no DateRange. Por exemplo, comece: 2024-03-01 e final: 2024-06-01. | Detalhes de 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. Este relatório retorna dados para um único mês de cada vez, portanto, ele requer os mesmos valores para os campos de início e término no DateRange. Um máximo de N=10 itens são retornados por vez. | Dados para os principais itens por categoria |
| Relatório de Resumo Mensal dos Principais Itens | Fornece os N itens de maior emissão por mês para o filtro de consulta especificado. Retorna dados de emissões para os N itens principais por mês dentro do intervalo de datas especificado. Um máximo de N=10 itens são retornados por 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 por apenas um mês de cada vez. O DateRange requer os mesmos valores para os campos inicial e final. | Dados de emissões por categoria |
Exportar parâmetros de 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. |
| TopItemsMonthlySummaryReportQueryFilter | Parâmetros de filtro de consulta para configurar TopItemsMonthlySummaryReport consultas. |
| FiltroDeConsultaDoRelatórioResumoDePrincipaisItens | 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 | Obrigató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 das emissões para os escopos especificados. |
| tipoDeCategoria | Verdade | CategoryTypeEnum | Especifica o tipo de categoria para dados detalhados de emissões, como Resource, ResourceGroup, ResourceType, Location ou Subscription. Consulte os tipos com suporte em CategoryTypeEnum. |
| intervalo de datas | Verdade | DateRange | As datas de início e término dos dados de emissões de carbono. Obrigatório
ItemDetailsReport e TopItemsSummaryReport têm suporte para apenas um mês de dados por vez, portanto, as datas de início e término devem ser iguais dentro de DateRange. Por exemplo, comece: 2024-06-01 e final: 2024-06-01. |
| ordenarPor | Verdade | OrderByColumnEnum | O nome da coluna pelo qual ordenar os resultados. Veja os valores com suporte em OrderByColumnEnum. |
| Tamanho da página | Verdade | inteiro (int32) mínimo: 1 máximo: 5000 |
Número de itens a serem retornados em uma solicitação, o valor máximo é 5000. |
| tipoDeRelatório | Verdade | corda: 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 classificação de resultados. Veja os valores com suporte em SortDirectionEnum. |
| lista de assinaturas | Verdade | cadeia de caracteres[] | Lista de IDs de assinatura para as 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 | cadeia de caracteres[] | Lista de locais (nome de exibição da Região do Azure) para dados de emissões de carbono, com cada local especificado em letras 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 | cadeia de caracteres[] | Lista de URLs do grupo de recursos para dados de emissões de carbono. Opcional. Cada URL deve seguir o formato /subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}e deve estar em letras minúsculas. |
|
| listaDeTiposDeRecursos | cadeia de caracteres[] | Lista de tipos de recursos para dados de emissões de carbono. Opcional. Cada tipo de recurso deve ser especificado em letras minúsculas, seguindo o formato microsoft.{service}/{resourceType}. Por exemplo, microsoft.storage/storageaccounts. |
|
| skipToken | cadeia | 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. |
FiltroConsultaRelatórioResumoMensal
Aqui estão os parâmetros de filtro de consulta para configurar consultas MonthlySummaryReport.
| Nome | Obrigató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 das emissões para os escopos especificados. |
| intervalo de datas | Verdade | DateRange | As datas de início e término dos dados de emissões de carbono. Obrigatório
ItemDetailsReport e TopItemsSummaryReport têm suporte para apenas um mês de dados por vez, portanto, as datas de início e término devem ser iguais dentro de DateRange. Por exemplo, comece: 2024-06-01 e final: 2024-06-01. |
| tipoDeRelatório | Verdade | corda: RelatórioMensalResumo |
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 | cadeia de caracteres[] | Lista de IDs de assinatura para as 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 | cadeia de caracteres[] | Lista de locais (nome de exibição da Região do Azure) para dados de emissões de carbono, com cada local especificado em letras 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 | cadeia de caracteres[] | Lista de URLs do grupo de recursos para dados de emissões de carbono. Opcional. Cada URL deve seguir o formato /subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}e deve estar em letras minúsculas. |
|
| listaDeTiposDeRecursos | cadeia de caracteres[] | Lista de tipos de recursos para dados de emissões de carbono. Opcional. Cada tipo de recurso deve ser especificado em letras minúsculas, seguindo o formato microsoft.{service}/{resourceType}. Por exemplo, microsoft.storage/storageaccounts. |
FiltroDeConsultaDeRelatórioDeResumoGeral
Aqui estão os parâmetros de filtro de consulta para configurar consultas OverallSummaryReport.
| Nome | Obrigató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 das emissões para os escopos especificados. |
| intervalo de datas | Verdade | DateRange | As datas de início e término dos dados de emissões de carbono. Obrigatório
ItemDetailsReport e TopItemsSummaryReport têm suporte para apenas um mês de dados por vez, portanto, as datas de início e término devem ser iguais dentro de DateRange. Por exemplo, comece: 2024-06-01 e final: 2024-06-01. |
| tipoDeRelatório | Verdade | corda: 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 | cadeia de caracteres[] | Lista de IDs de assinatura para as 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 | cadeia de caracteres[] | Lista de locais (nome de exibição da Região do Azure) para dados de emissões de carbono, com cada local especificado em letras 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 | cadeia de caracteres[] | Lista de URLs do grupo de recursos para dados de emissões de carbono. Opcional. Cada URL deve seguir o formato /subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}e deve estar em letras minúsculas. |
|
| listaDeTiposDeRecursos | cadeia de caracteres[] | Lista de tipos de recursos para dados de emissões de carbono. Opcional. Cada tipo de recurso deve ser especificado em letras minúsculas, seguindo o formato microsoft.{service}/{resourceType}. Por exemplo, microsoft.storage/storageaccounts. |
Filtro de Consulta de Relatório do Resumo Mensal dos Principais Itens
Aqui estão os parâmetros de filtro de consulta para configurar consultas TopItemsMonthlySummaryReport.
| Nome | Obrigató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 das emissões para os escopos especificados. |
| tipoDeCategoria | Verdade | CategoryTypeEnum | Especifica o tipo de categoria para recuperar itens de emissão superior, agregados por mês. Consulte os tipos com suporte em CategoryTypeEnum. |
| intervalo de datas | Verdade | DateRange | As datas de início e término dos dados de emissões de carbono. Obrigatório
ItemDetailsReport e TopItemsSummaryReport têm suporte para apenas um mês de dados por vez, portanto, as datas de início e término devem ser iguais dentro de DateRange. Por exemplo, comece: 2024-06-01 e final: 2024-06-01. |
| tipoDeRelatório | Verdade | corda: Relatório de Resumo Mensal 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 | cadeia de caracteres[] | Lista de IDs de assinatura para as 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. |
| itens principais | Verdade | inteiro (int32) mínimo: 1 máximo: 10 |
O número de itens principais a serem retornados, com base nas emissões. Deve estar entre 1 e 10. |
| listaDeLocalizações | cadeia de caracteres[] | Lista de locais (nome de exibição da Região do Azure) para dados de emissões de carbono, com cada local especificado em letras 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 | cadeia de caracteres[] | Lista de URLs do grupo de recursos para dados de emissões de carbono. Opcional. Cada URL deve seguir o formato /subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}e deve estar em letras minúsculas. |
|
| listaDeTiposDeRecursos | cadeia de caracteres[] | Lista de tipos de recursos para dados de emissões de carbono. Opcional. Cada tipo de recurso deve ser especificado em letras minúsculas, seguindo o formato microsoft.{service}/{resourceType}. Por exemplo, microsoft.storage/storageaccounts. |
FiltroConsultaRelatórioResumoPrincipaisItens
Aqui estão os parâmetros de filtro de consulta para configurar TopItemsSummaryReport queries.
| Nome | Obrigató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 das emissões para os escopos especificados. |
| tipoDeCategoria | Verdade | CategoryTypeEnum | Especifica o tipo de categoria para o qual recuperar itens de emissão superior. Veja os valores com suporte definidos em CategoryTypeEnum. |
| intervalo de datas | Verdade | DateRange | As datas de início e término dos dados de emissões de carbono. Obrigatório
ItemDetailsReport e TopItemsSummaryReport têm suporte para apenas um mês de dados por vez, portanto, as datas de início e término devem ser iguais dentro de DateRange. Por exemplo, comece: 2024-06-01 e final: 2024-06-01. |
| tipoDeRelatório | Verdade | corda: 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 | cadeia de caracteres[] | Lista de IDs de assinatura para as 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. |
| itens principais | Verdade | inteiro (int32) mínimo: 1 máximo: 10 |
O número de itens principais a serem retornados, com base nas emissões. Esse valor deve estar entre 1 e 10. |
| listaDeLocalizações | cadeia de caracteres[] | Lista de locais (nome de exibição da Região do Azure) para dados de emissões de carbono, com cada local especificado em letras 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 | cadeia de caracteres[] | Lista de URLs do grupo de recursos para dados de emissões de carbono. Opcional. Cada URL deve seguir o formato /subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}e deve estar em letras minúsculas. |
|
| listaDeTiposDeRecursos | cadeia de caracteres[] | Lista de tipos de recursos para dados de emissões de carbono. Opcional. Cada tipo de recurso deve ser especificado em letras minúsculas, seguindo o formato microsoft.{service}/{resourceType}. Por exemplo, microsoft.storage/storageaccounts. |
Relatórios de exemplo
As seções a seguir mostram solicitações de exemplo e respostas para cada tipo de relatório.
A resposta subscriptionAccessDecisionList está inclusa em todos os relatórios. O campo mostra a decisão de acesso para cada assinatura de entrada.
RelatórioResumoGeral
O relatório mostra as emissões totais para todos os escopos de assinaturas e o intervalo de datas especificado na entrada. Use o relatório quando precisar de dados de relatório de alto nível.
Solicitação de exemplo
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 de exemplo
{
"subscriptionAccessDecisionList": [
{
"subscriptionId": "00000000-0000-0000-0000-000000000000",
"decision": "Allowed"
}
],
"value": [
{
"dataType": "OverallSummaryData",
"latestMonthEmissions": 0.1,
"previousMonthEmissions": 0.05,
"monthOverMonthEmissionsChangeRatio": 1,
"monthlyEmissionsChangeValue": 0.05
}
]
}
RelatórioMensalResumo
O relatório mostra as emissões para todas as assinaturas e os escopos de emissão referentes ao mês especificado no intervalo de datas. Use o relatório quando precisar de detalhes para um mês especificado.
Solicitação de exemplo
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 de exemplo
{
"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 agregados entre assinaturas, emissões, escopo, categoria e intervalo de datas especificado, divididos por categoria. Use o relatório quando precisar de dados para os principais itens por categoria.
Solicitação de exemplo
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 de exemplo
{
"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 dos Principais Itens
O relatório mostra as emissões dos principais itens X agregados entre assinaturas, emissões, escopos e categoria para cada mês especificado no intervalo de datas. As emissões são divididas 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.
Solicitação de exemplo
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 de exemplo
{
"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 entre escopos selecionados e IDs de assinatura para um determinado intervalo de datas e divididas 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.
Solicitação de exemplo
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 de exemplo
{
"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"
}
]
}