Поделиться через


az carbon

Note

This reference is part of the carbon extension for the Azure CLI (version 2.70.0 or higher). The extension will automatically install the first time you run an az carbon command. Learn more about extensions.

Manage Carbon.

Команды

Имя Описание Тип Состояние
az carbon get-emission-data-available-date-range

API для запроса данных о выбросах углерода, доступных для диапазона дат.

Extension GA
az carbon get-emission-report

API для отчетов о выбросах углерода.

Extension GA

az carbon get-emission-data-available-date-range

API для запроса данных о выбросах углерода, доступных для диапазона дат.

az carbon get-emission-data-available-date-range

Примеры

Запрос данных о выбросах углерода, доступный диапазон дат

az carbon get-emission-data-available-date-range
Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Output format.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False

az carbon get-emission-report

API для отчетов о выбросах углерода.

az carbon get-emission-report --carbon-scope-list
                              --date-range
                              --subscription-list
                              [--item-details]
                              [--location-list]
                              [--monthly-summary]
                              [--overall-summary]
                              [--resource-group-urls]
                              [--resource-type-list]
                              [--top-items-monthly]
                              [--top-items-summary]

Примеры

Общий сводный отчет queryCarbonEmission

az carbon get-emission-report --subscription-list "[00000000-0000-0000-0000-000000000000]" --carbon-scope-list "[Scope1,Scope2,Scope3]" --date-range "{start:2024-03-01,end:2025-03-01}" --overall-summary

Ежемесячный сводный отчет queryCarbonEmission

az carbon get-emission-report --subscription-list "[00000000-0000-0000-0000-000000000000]" --carbon-scope-list "[Scope1,Scope2,Scope3]" --date-range "{start:2024-03-01,end:2025-03-01}" --monthly-summary

Отчет сведений об элементе QueryCarbonEmission

az carbon get-emission-report --subscription-list "[00000000-0000-0000-0000-000000000000,00000000-0000-0000-0000-000000000001]" --carbon-scope-list "[Scope1,Scope2,Scope3]" --date-range "{start:2025-03-01,end:2025-03-01}" --item-details "{category-type:ResourceType,order-by:itemName,page-size:10,sort-direction:asc}"

Сводный отчет о верхних элементах QueryCarbonEmission

az carbon get-emission-report --subscription-list "[00000000-0000-0000-0000-000000000000,00000000-0000-0000-0000-000000000001]" --carbon-scope-list "[Scope1,Scope2,Scope3]" --date-range "{start:2025-03-01,end:2025-03-01}" --top-items-summary "{category-type:ResourceType,top-items:5}"

Ежемесячный сводный отчет queryCarbonEmission Top Items

az carbon get-emission-report --subscription-list "[00000000-0000-0000-0000-000000000000]" --carbon-scope-list "[Scope1,Scope2,Scope3]" --date-range "{start:2024-03-01,end:2025-03-01}" --top-items-monthly "{category-type:ResourceType,top-items:5}

Обязательные параметры

--carbon-scope-list

Список областей выбросов углерода. Required. Принимает одно или несколько значений из ВыбросовScopeEnum (например, Scope1, Scope2, Scope3) в форме списка. Выходные данные будут включать общий объем выбросов для указанных областей. Поддержка сокращенного синтаксиса, json-file и yaml-file. Попробуйте "??", чтобы показать больше.

Свойство Значение
Parameter group: QueryParameters Arguments
--date-range

Дата начала и окончания данных о выбросах углерода. Required. Для ItemDetailsReport и TopItemsSummaryReport поддерживается только один месяц данных, поэтому даты начала и окончания должны быть равными в DateRange (например, начало: 2024-06-01 и конец: 2024-06-01). Поддержка сокращенного синтаксиса, json-file и yaml-file. Попробуйте "??", чтобы показать больше.

Свойство Значение
Parameter group: QueryParameters Arguments
--subscription-list

Список идентификаторов подписок, для которых запрашиваются данные о выбросах углерода. Required. Каждый идентификатор подписки должен быть в нижнем регистре. Максимальная длина списка составляет 100. Поддержка сокращенного синтаксиса, json-file и yaml-file. Попробуйте "??", чтобы показать больше.

Свойство Значение
Parameter group: QueryParameters Arguments

Необязательные параметры

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--item-details

Используйте этот параметр, чтобы получить отчет сведений о элементе для поддержки сокращенного синтаксиса, json-file и yaml-file. Попробуйте "??", чтобы показать больше.

Свойство Значение
Parameter group: QueryParameters Arguments
--location-list

Список расположений (отображаемое имя региона Azure) для данных о выбросах углерода с каждым расположением, указанным в нижнем регистре (например, "восточная часть сша"). Optional. Для поиска отображаемых имен региона Azure можно использовать команду az account list-locations -o table. Поддержка сокращенного синтаксиса, json-file и yaml-file. Попробуйте "??", чтобы показать больше.

Свойство Значение
Parameter group: QueryParameters Arguments
--monthly-summary

Используйте этот параметр, чтобы получить ежемесячный сводный отчет о поддержке сокращенного синтаксиса, json-file и yaml-file. Попробуйте "??", чтобы показать больше.

Свойство Значение
Parameter group: QueryParameters Arguments
--overall-summary

Используйте этот параметр, чтобы получить общий сводный отчет о поддержке сокращенного синтаксиса, json-file и yaml-file. Попробуйте "??", чтобы показать больше.

Свойство Значение
Parameter group: QueryParameters Arguments
--resource-group-urls

Список URL-адресов группы ресурсов для данных о выбросах углерода. Optional. Каждый URL-адрес должен соответствовать формату "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}" и должен находиться в нижнем регистре. Поддержка сокращенного синтаксиса, json-file и yaml-file. Попробуйте "??", чтобы показать больше.

Свойство Значение
Parameter group: QueryParameters Arguments
--resource-type-list

Список типов ресурсов для данных о выбросах углерода. Optional. Каждый тип ресурса должен быть указан в нижнем регистре, следуя формату "microsoft". {service}/{resourceType}", например "microsoft.storage/storageaccounts". Поддержка сокращенного синтаксиса, json-file и yaml-file. Попробуйте "??", чтобы показать больше.

Свойство Значение
Parameter group: QueryParameters Arguments
--top-items-monthly

Используйте этот параметр, чтобы получить краткий синтаксис отчета "Основные элементы", json-file и yaml-file. Попробуйте "??", чтобы показать больше.

Свойство Значение
Parameter group: QueryParameters Arguments
--top-items-summary

Используйте этот параметр, чтобы получить краткий синтаксис сводки элементов, json-file и yaml-file. Попробуйте "??", чтобы показать больше.

Свойство Значение
Parameter group: QueryParameters Arguments
Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Output format.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False