Примечание.
Для доступа к этой странице требуется авторизация. Вы можете попробовать войти или изменить каталоги.
Для доступа к этой странице требуется авторизация. Вы можете попробовать изменить каталоги.
Эта статья поможет вам понять и использовать последний REST API службы углерода для экспорта оптимизации углерода в данные о выбросах Azure. Данные о выбросах доступны за предыдущий месяц по дням 19 текущего месяца.
Чтобы экспортировать данные о выбросах с помощью REST API, необходимо создать и авторизовать служебный аккаунт для доступа к этим данным. Затем можно использовать учетную запись службы для получения токена авторизации, а затем экспортировать данные о выбросах через REST API.
Создание и авторизация субъекта-службы для генерации метрик
Субъект-служба — это приложение, маркеры которого можно использовать для проверки подлинности и предоставления доступа к определенным ресурсам Azure с помощью идентификатора Microsoft Entra. Ресурсы включают пользовательские приложения, службы или средства автоматизации.
- создание приложения Microsoft Entra и субъекта-службы, которые могут получить доступ к ресурсам.
- Сохраните идентификатор арендатора, новый идентификатор клиента и значение секрета клиента для вашего приложения для использования в запросах токенов.
- Приложению необходимо назначить роль
Carbon Optimization Readerдля ресурсов, для которого требуется экспортировать данные о выбросах. Если вы хотите использовать приложение для экспорта данных о выбросах для многих ресурсов, можно назначить роль на уровне подписки. Дополнительные сведения см. в статье "Назначение ролей Azure" с помощью портала Azure и назначение доступа к оптимизации углерода в Azure.
Получите токен авторизации
Отправьте следующий POST запрос в командной строке или с помощью клиента.
Используйте URL-адрес https://management.azure.com ресурса, чтобы получить маркер доступа для API управления ресурсами.
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'
Текст ответа отображается следующим образом:
{
"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"
}
Используйте маркер доступа из ответа для использования в следующих HTTP-запросах.
Экспорт данных о выбросах с помощью REST API
Используйте следующий POST запрос для экспорта данных о выбросах.
POST /providers/Microsoft.Carbon/carbonEmissionReports?api-version=2025-04-01
Host: management.azure.com
Content-Type: application/json
Authorization: Bearer \<token value\>
Пример запроса и ответа
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"
}
}
Пример полученных результатов
{
"subscriptionAccessDecisionList": [
{
"subscriptionId": "00000000-0000-0000-0000-000000000000",
"decision": "Allowed"
}
],
"value": [
{
"dataType": "OverallSummaryData",
"latestMonthEmissions": 0.1,
"previousMonthEmissions": 0.05,
"monthOverMonthEmissionsChangeRatio": 1,
"monthlyEmissionsChangeValue": 0.05
}
]
}
Ниже приведен пример 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
}
'
Пример выходных данных curl:
{
"subscriptionAccessDecisionList": [
{
"subscriptionId": "00000000-0000-0000-0000-000000000000",
"decision": "Allowed"
},
{
"subscriptionId": "00000000-0000-0000-0000-000000000001",
"decision": "Allowed"
},
{
"subscriptionId": "00000000-0000-0000-0000-000000000002",
"decision": "Allowed"
},
{
"subscriptionId": "00000000-0000-0000-0000-000000000003",
"decision": "Allowed"
},
{
"subscriptionId": "00000000-0000-0000-0000-000000000004",
"decision": "Allowed"
},
{
"subscriptionId": "00000000-0000-0000-0000-000000000005",
"decision": "Allowed"
},
{
"subscriptionId": "00000000-0000-0000-0000-000000000006",
"decision": "Denied"
},
{
"subscriptionId": "00000000-0000-0000-0000-000000000007",
"decision": "Denied"
},
{
"subscriptionId": "00000000-0000-0000-0000-000000000008",
"decision": "Denied",
"denialReason": "Carbon Optimization Reader permisison required"
}
],
"value": [
{
"dataType": "ResourceItemDetailsData",
"latestMonthEmissions": 0.1,
"previousMonthEmissions": 0.05,
"monthOverMonthEmissionsChangeRatio": 1,
"monthlyEmissionsChangeValue": 0.05,
"itemName": "rgName1",
"resourceGroup": "rgGroup",
"resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgGroup/providers/microsoft.storage/storageaccounts/rgName1",
"subscriptionId": "00000000-0000-0000-0000-000000000000",
"categoryType": "Resource",
"resourceType": "microsoft.storage/storageaccounts",
"location": "east us"
},
{
"dataType": "ResourceItemDetailsData",
"latestMonthEmissions": 0.1,
"previousMonthEmissions": 0.05,
"monthOverMonthEmissionsChangeRatio": 1,
"monthlyEmissionsChangeValue": 0.05,
"itemName": "rgName2",
"resourceGroup": "rgGroup",
"resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgGroup/providers/microsoft.storage/storageaccounts/rgName2",
"subscriptionId": "00000000-0000-0000-0000-000000000000",
"categoryType": "Resource",
"resourceType": "microsoft.storage/storageaccounts",
"location": "east us"
},
{
"dataType": "ResourceItemDetailsData",
"latestMonthEmissions": 0.1,
"previousMonthEmissions": 0.05,
"monthOverMonthEmissionsChangeRatio": 1,
"monthlyEmissionsChangeValue": 0.05,
"itemName": "rgName3",
"resourceGroup": "rgGroup",
"resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgGroup/providers/microsoft.storage/storageaccounts/rgName3",
"subscriptionId": "00000000-0000-0000-0000-000000000000",
"categoryType": "Resource",
"resourceType": "microsoft.storage/storageaccounts",
"location": "east us"
},
{
"dataType": "ResourceItemDetailsData",
"latestMonthEmissions": 0.1,
"previousMonthEmissions": 0.05,
"monthOverMonthEmissionsChangeRatio": 1,
"monthlyEmissionsChangeValue": 0.05,
"itemName": "rgName4",
"resourceGroup": "rgGroup",
"resourceId": "/subscriptions/00000000-0000-0000-0000-000000000002/resourceGroups/rgGroup/providers/microsoft.storage/storageaccounts/rgName4",
"subscriptionId": "00000000-0000-0000-0000-000000000002",
"categoryType": "Resource",
"resourceType": "microsoft.storage/storageaccounts",
"location": "east us"
},
{
"dataType": "ResourceItemDetailsData",
"latestMonthEmissions": 0.1,
"previousMonthEmissions": 0.05,
"monthOverMonthEmissionsChangeRatio": 1,
"monthlyEmissionsChangeValue": 0.05,
"itemName": "rgName5",
"resourceGroup": "rgGroup",
"resourceId": "/subscriptions/00000000-0000-0000-0000-000000000002/resourceGroups/rgGroup/providers/microsoft.storage/storageaccounts/rgName5",
"subscriptionId": "00000000-0000-0000-0000-000000000002",
"categoryType": "Resource",
"resourceType": "microsoft.storage/storageaccounts",
"location": "east us"
}
],
"skipToken": "dGVzZGZhZGZzZnNkZg=="
}
Типы отчетов
Оптимизация углерода предоставляет различные типы отчетов, помогающие анализировать данные о выбросах. Каждый тип отчета служит для различных целей и используется для конкретных потребностей:
| Тип отчета | Описание | Когда следует использовать |
|---|---|---|
| Отчет об общем совокупном состоянии | Предоставляет общий объем выбросов углерода для указанного диапазона дат и параметров запроса, а также относительные значения для общего обзора. Этот тип отчета принимает различные значения в полях начала и окончания в DateRange. Например, начало: 2024-03-01 и конец: 2024-06-01. | Необходимы данные для отчета высокого уровня |
| Ежемесячный сводный отчет | Предоставляет данные о выбросах углерода по месяцам для указанных параметров запроса. Этот тип отчета принимает различные значения в полях начала и окончания в DateRange. Например, начало: 2024-03-01 и конец: 2024-06-01. | Сведения за указанный месяц |
| Отчет о суммарном обзоре лучших товаров | Предоставляет элементы N с наибольшим уровнем выдачи для указанных фильтров запросов. Этот отчет возвращает данные за один месяц за один месяц, поэтому для него требуются одинаковые значения для полей начала и окончания в DateRange. За раз возвращается максимум N=10 элементов. | Данные для основных элементов по категориям |
| Ежемесячный отчет о лучших товарах | Предоставляет элементы N с наибольшим уровнем выдачи по месяцам для указанного фильтра запросов. Возвращает данные о выбросах для верхних N элементов за месяц в пределах заданного диапазона дат. За раз возвращается максимум N=10 элементов. | Данные для основных элементов по категориям и месяцам |
| ОтчетПоДеталямЭлемента | Подробный список элементов на основе указанного типа CategoryType (включая: Ресурс, ResourceGroup, ResourceType, Location или Subscription) для фильтрации запросов. Можно запросить данные только за один месяц за раз. Для dateRange требуются одинаковые значения для полей начала и окончания. | Данные о выбросах по категориям |
Экспорт параметров API для выбросов
Для каждого из них reportTypeопределяются разные параметры запроса. В следующих разделах приведены подробные сведения о параметрах запроса для каждого из них reportType.
| Имя | Описание |
|---|---|
| ItemDetailsQueryFilter | Параметры запроса для ItemDetailsReport |
| MonthlySummaryReportQueryFilter | Параметры фильтра запросов для настройки MonthlySummaryReport запросов. |
| OverallSummaryReportQueryFilter | Параметры фильтра запросов для настройки OverallSummaryReport запросов. |
| TopItemsMonthlySummaryReportQueryFilter | Параметры фильтра запросов для настройки TopItemsMonthlySummaryReport запросов. |
| TopItemsSummaryReportQueryFilter | Параметры фильтра запросов для настройки TopItemsSummaryReport запросов. |
Дополнительные сведения о отчетах REST API см. в разделе Углеродная служба — список отчетов о выбросах углерода.
ФильтрЗапросаДеталейЭлемента
Ниже приведены параметры запроса для ItemDetailsReport.
| Имя | Обязательный | Тип | Описание |
|---|---|---|---|
| carbonScopeList | Верно | EmissionScopeEnum[] | Список областей выбросов углерода. Обязательное. Принимает одно или несколько значений из EmissionScopeEnum. Например, Scope1, Scope2, Scope3 в форме списка. Выходные данные включают общий объем выбросов для указанных областей. |
| тип категории | Верно | CategoryTypeEnum | Указывает тип категории для подробных данных выбросов, таких как Resource, ResourceGroup, ResourceType, Location или Subscription. См. поддерживаемые типы в CategoryTypeEnum. |
| диапазон дат | Верно | DateRange | Дата начала и окончания данных о выбросах углерода. Обязательное. Для ItemDetailsReport и TopItemsSummaryReport, только один месяц данных поддерживается одновременно, поэтому даты начала и окончания должны быть равными в пределах DateRange. Например, начало: 2024-06-01 и конец: 2024-06-01. |
| упорядочитьПо | Верно | OrderByColumnEnum | Имя столбца, по которым нужно упорядочить результаты. См. поддерживаемые значения в OrderByColumnEnum. |
| размер страницы | Верно | целое число (int32) минимум: 1 максимум: 5000 |
Число элементов, возвращаемых в одном запросе, максимальное значение — 5000. |
| тип отчёта | Верно | струна: ОтчетПоДеталямЭлемента |
ReportType запрашивал данные о выбросах углерода. Обязательное. Указывает, как данные агрегируются и отображаются в выходных данных, как описано в разделе ReportTypeEnum. |
| направление_сортировки | Верно | SortDirectionEnum | Направление сортировки результатов. См. поддерживаемые значения в SortDirectionEnum. |
| список подписок | Верно | строка[] | Список идентификаторов подписок, для которых запрашиваются данные о выбросах углерода. Обязательное. Каждый идентификатор подписки должен быть в нижнем регистре. Максимальная длина списка составляет 100. |
| список местоположений | строка[] | Список регионов (отображаемое имя региона Azure) для данных о выбросах углерода, где каждое название указано в нижнем регистре. Например: east us. Необязательно. Вы можете использовать команду az account list-locations -o table для поиска отображаемых имен региона Azure. |
|
| списокUrlГруппыРесурсов | строка[] | Список URL-адресов группы ресурсов для данных о выбросах углерода. Необязательно. Каждый URL-адрес должен соответствовать формату /subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}и должен находиться во всех строчных регистрах. |
|
| Список типов ресурсов | строка[] | Список типов ресурсов для данных о выбросах углерода. Необязательно. Каждый тип ресурса должен быть указан в нижнем регистре, следуя формату microsoft.{service}/{resourceType}. Например: microsoft.storage/storageaccounts. |
|
| skipToken | струна | Маркер разбиения на страницы для получения следующей страницы данных. Этот маркер имеет значение NULL и возвращается в предыдущем ответе, если доступны другие страницы данных. |
ФильтрЗапросаЕжемесячногоСводногоОтчета
Ниже приведены параметры фильтра запросов для настройки MonthlySummaryReport запросов.
| Имя | Обязательный | Тип | Описание |
|---|---|---|---|
| carbonScopeList | Верно | EmissionScopeEnum[] | Список областей выбросов углерода. Обязательное. Принимает одно или несколько значений из EmissionScopeEnum. Например, Scope1, Scope2, Scope3 в форме списка. Выходные данные включают общий объем выбросов для указанных областей. |
| диапазон дат | Верно | DateRange | Дата начала и окончания данных о выбросах углерода. Обязательное. Для ItemDetailsReport и TopItemsSummaryReport, только один месяц данных поддерживается одновременно, поэтому даты начала и окончания должны быть равными в пределах DateRange. Например, начало: 2024-06-01 и конец: 2024-06-01. |
| тип отчёта | Верно | струна: Ежемесячный сводный отчет |
ReportType запрашивал данные о выбросах углерода. Обязательное. Указывает, как данные агрегируются и отображаются в выходных данных, как описано в разделе ReportTypeEnum. |
| список подписок | Верно | строка[] | Список идентификаторов подписок, для которых запрашиваются данные о выбросах углерода. Обязательное. Каждый идентификатор подписки должен быть в нижнем регистре. Максимальная длина списка составляет 100. |
| список местоположений | строка[] | Список регионов (отображаемое имя региона Azure) для данных о выбросах углерода, где каждое название указано в нижнем регистре. Например: east us. Необязательно. Вы можете использовать команду az account list-locations -o table для поиска отображаемых имен региона Azure. |
|
| списокUrlГруппыРесурсов | строка[] | Список URL-адресов группы ресурсов для данных о выбросах углерода. Необязательно. Каждый URL-адрес должен соответствовать формату /subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}и должен находиться во всех строчных регистрах. |
|
| Список типов ресурсов | строка[] | Список типов ресурсов для данных о выбросах углерода. Необязательно. Каждый тип ресурса должен быть указан в нижнем регистре, следуя формату microsoft.{service}/{resourceType}. Например: microsoft.storage/storageaccounts. |
Фильтр запроса общего отчёта
Ниже приведены параметры фильтра запросов для настройки запросов OverallSummaryReport.
| Имя | Обязательный | Тип | Описание |
|---|---|---|---|
| carbonScopeList | Верно | EmissionScopeEnum[] | Список областей выбросов углерода. Обязательное. Принимает одно или несколько значений из EmissionScopeEnum. Например, Scope1, Scope2, Scope3 в форме списка. Выходные данные включают общий объем выбросов для указанных областей. |
| диапазон дат | Верно | DateRange | Дата начала и окончания данных о выбросах углерода. Обязательное. Для ItemDetailsReport и TopItemsSummaryReport, только один месяц данных поддерживается одновременно, поэтому даты начала и окончания должны быть равными в пределах DateRange. Например, начало: 2024-06-01 и конец: 2024-06-01. |
| тип отчёта | Верно | струна: Отчет об общем совокупном состоянии |
ReportType запрашивал данные о выбросах углерода. Обязательное. Указывает, как данные агрегируются и отображаются в выходных данных, как описано в разделе ReportTypeEnum. |
| список подписок | Верно | строка[] | Список идентификаторов подписок, для которых запрашиваются данные о выбросах углерода. Обязательное. Каждый идентификатор подписки должен быть в нижнем регистре. Максимальная длина списка составляет 100. |
| список местоположений | строка[] | Список регионов (отображаемое имя региона Azure) для данных о выбросах углерода, где каждое название указано в нижнем регистре. Например: east us. Необязательно. Вы можете использовать команду az account list-locations -o table для поиска отображаемых имен региона Azure. |
|
| списокUrlГруппыРесурсов | строка[] | Список URL-адресов группы ресурсов для данных о выбросах углерода. Необязательно. Каждый URL-адрес должен соответствовать формату /subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}и должен находиться во всех строчных регистрах. |
|
| Список типов ресурсов | строка[] | Список типов ресурсов для данных о выбросах углерода. Необязательно. Каждый тип ресурса должен быть указан в нижнем регистре, следуя формату microsoft.{service}/{resourceType}. Например: microsoft.storage/storageaccounts. |
ФильтрЗапросаОтчётаОЕжемесячномСводеТоповыхПредметов
Ниже приведены параметры фильтра запросов для настройки TopItemsMonthlySummaryReport запросов.
| Имя | Обязательный | Тип | Описание |
|---|---|---|---|
| carbonScopeList | Верно | EmissionScopeEnum[] | Список областей выбросов углерода. Обязательное. Принимает одно или несколько значений из EmissionScopeEnum. Например, Scope1, Scope2, Scope3 в форме списка. Выходные данные включают общий объем выбросов для указанных областей. |
| тип категории | Верно | CategoryTypeEnum | Указывает тип категории для получения элементов верхнего уровня, агрегированных по месяцам. См. поддерживаемые типы в CategoryTypeEnum. |
| диапазон дат | Верно | DateRange | Дата начала и окончания данных о выбросах углерода. Обязательное. Для ItemDetailsReport и TopItemsSummaryReport, только один месяц данных поддерживается одновременно, поэтому даты начала и окончания должны быть равными в пределах DateRange. Например, начало: 2024-06-01 и конец: 2024-06-01. |
| тип отчёта | Верно | струна: Ежемесячный отчет о лучших товарах |
ReportType запрашивал данные о выбросах углерода. Обязательное. Указывает, как данные агрегируются и отображаются в выходных данных, как описано в разделе ReportTypeEnum. |
| список подписок | Верно | строка[] | Список идентификаторов подписок, для которых запрашиваются данные о выбросах углерода. Обязательное. Каждый идентификатор подписки должен быть в нижнем регистре. Максимальная длина списка составляет 100. |
| Лучшие товары | Верно | целое число (int32) минимум: 1 максимум: 10 |
Количество основных элементов, возвращаемых на основе выбросов. Должно быть от 1 до 10. |
| список местоположений | строка[] | Список регионов (отображаемое имя региона Azure) для данных о выбросах углерода, где каждое название указано в нижнем регистре. Например: east us. Необязательно. Вы можете использовать команду az account list-locations -o table для поиска отображаемых имен региона Azure. |
|
| списокUrlГруппыРесурсов | строка[] | Список URL-адресов группы ресурсов для данных о выбросах углерода. Необязательно. Каждый URL-адрес должен соответствовать формату /subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}и должен находиться во всех строчных регистрах. |
|
| Список типов ресурсов | строка[] | Список типов ресурсов для данных о выбросах углерода. Необязательно. Каждый тип ресурса должен быть указан в нижнем регистре, следуя формату microsoft.{service}/{resourceType}. Например: microsoft.storage/storageaccounts. |
Фильтр запроса итогового отчета по лучшим элементам
Ниже приведены параметры фильтра запросов для настройки TopItemsSummaryReport queries.
| Имя | Обязательный | Тип | Описание |
|---|---|---|---|
| carbonScopeList | Верно | EmissionScopeEnum[] | Список областей выбросов углерода. Обязательное. Принимает одно или несколько значений из EmissionScopeEnum. Например, Scope1, Scope2, Scope3 в форме списка. Выходные данные включают общий объем выбросов для указанных областей. |
| тип категории | Верно | CategoryTypeEnum | Указывает тип категории, для которого требуется получить элементы верхнего уровня. См. поддерживаемые значения, определенные в CategoryTypeEnum. |
| диапазон дат | Верно | DateRange | Дата начала и окончания данных о выбросах углерода. Обязательное. Для ItemDetailsReport и TopItemsSummaryReport, только один месяц данных поддерживается одновременно, поэтому даты начала и окончания должны быть равными в пределах DateRange. Например, начало: 2024-06-01 и конец: 2024-06-01. |
| тип отчёта | Верно | струна: Отчет о суммарном обзоре лучших товаров |
ReportType запрашивал данные о выбросах углерода. Обязательное. Указывает, как данные агрегируются и отображаются в выходных данных, как описано в разделе ReportTypeEnum. |
| список подписок | Верно | строка[] | Список идентификаторов подписок, для которых запрашиваются данные о выбросах углерода. Обязательное. Каждый идентификатор подписки должен быть в нижнем регистре. Максимальная длина списка составляет 100. |
| Лучшие товары | Верно | целое число (int32) минимум: 1 максимум: 10 |
Количество основных элементов, возвращаемых на основе выбросов. Это значение должно быть от 1 до 10. |
| список местоположений | строка[] | Список регионов (отображаемое имя региона Azure) для данных о выбросах углерода, где каждое название указано в нижнем регистре. Например: east us. Необязательно. Вы можете использовать команду az account list-locations -o table для поиска отображаемых имен региона Azure. |
|
| списокUrlГруппыРесурсов | строка[] | Список URL-адресов группы ресурсов для данных о выбросах углерода. Необязательно. Каждый URL-адрес должен соответствовать формату /subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}и должен находиться во всех строчных регистрах. |
|
| Список типов ресурсов | строка[] | Список типов ресурсов для данных о выбросах углерода. Необязательно. Каждый тип ресурса должен быть указан в нижнем регистре, следуя формату microsoft.{service}/{resourceType}. Например: microsoft.storage/storageaccounts. |
Примеры отчетов
В следующих разделах показаны примеры запросов и ответов для каждого типа отчета.
Все отчеты включают subscriptionAccessDecisionList ответ. В поле отображается решение о доступе для каждой входной подписки.
Отчет об общем совокупном состоянии
В отчете показаны общие выбросы для всех областей подписки и диапазона дат, указанных в входных данных. Используйте отчет, если вам нужны высокоуровневые данные отчета.
Пример запроса
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"
}
}
Пример ответа
{
"subscriptionAccessDecisionList": [
{
"subscriptionId": "00000000-0000-0000-0000-000000000000",
"decision": "Allowed"
}
],
"value": [
{
"dataType": "OverallSummaryData",
"latestMonthEmissions": 0.1,
"previousMonthEmissions": 0.05,
"monthOverMonthEmissionsChangeRatio": 1,
"monthlyEmissionsChangeValue": 0.05
}
]
}
Ежемесячный сводный отчет
В отчете показаны выбросы для всех подписок и областей выбросов за месяц, указанный в диапазоне дат. Используйте отчет, если вам нужны сведения за указанный месяц.
Пример запроса
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"
}
}
Пример ответа
{
"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
}
]
}
Отчет о суммарном обзоре лучших товаров
В докладе показаны выбросы основных элементов X, агрегированных по подпискам, выбросам, области, категории и указанному диапазону дат, разделенным по категориям. Используйте отчет, если вам нужны данные для основных элементов по категориям.
Пример запроса
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
}
Пример ответа
{
"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"
}
]
}
Ежемесячный отчет о лучших товарах
В отчете показаны выбросы основных элементов X, агрегированных по подпискам, выбросам, областям и категориям за каждый месяц, указанный в диапазоне дат. Выбросы разбиваются по категориям. Основные элементы X основаны на выбросах в прошлом месяце. Используйте отчет, если вам нужны данные для основных элементов по категориям и месяцам.
Пример запроса
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
}
Пример ответа
{
"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"
}
]
}
ОтчетПоДеталямЭлемента
В отчете показаны выбросы, агрегированные по выбранным областям и идентификаторам подписок для заданного диапазона дат и разделенные по указанной категории. Используйте отчет, если вам нужны данные о выбросах по категориям и получить данные о группе ресурсов и уровне ресурсов.
Пример запроса
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
}
Пример ответа
{
"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"
}
]
}