TopItemsMonthlySummaryReportQueryFilter interface
Параметр фильтра запросов для настройки запросов TopItemsMonthlySummaryReport.
- Extends
Свойства
category |
Указывает тип категории для получения элементов верхнего уровня, агрегированных по месяцам. См. поддерживаемые типы в CategoryTypeEnum. |
report |
Указывает, что тип отчета — это ежемесячный сводный отчет по основным элементам для данных о выбросах углерода. |
top |
Количество основных элементов, возвращаемых на основе выбросов. Должно быть от 1 до 10. |
Унаследованные свойства
carbon |
Список областей выбросов углерода. Обязательное. Принимает одно или несколько значений из ВыбросовScopeEnum (например, Scope1, Scope2, Scope3) в форме списка. Выходные данные будут включать общий объем выбросов для указанных областей. |
date |
Дата начала и окончания данных о выбросах углерода. Обязательное. Для ItemDetailsReport и TopItemsSummaryReport поддерживается только один месяц данных, поэтому даты начала и окончания должны быть равными в DateRange (например, начало: 2024-06-01 и конец: 2024-06-01). |
location |
Список расположений (отображаемое имя региона Azure) для данных о выбросах углерода с каждым расположением, указанным в нижнем регистре (например, "восточная часть сша"). Необязательно. Для поиска отображаемых имен региона Azure можно использовать команду az account list-locations -o table. |
resource |
Список URL-адресов группы ресурсов для данных о выбросах углерода. Необязательно. Каждый URL-адрес должен соответствовать формату "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}" и должен находиться в нижнем регистре. |
resource |
Список типов ресурсов для данных о выбросах углерода. Необязательно. Каждый тип ресурса должен быть указан в нижнем регистре, следуя формату "microsoft". {service}/{resourceType}", например "microsoft.storage/storageaccounts". |
subscription |
Список идентификаторов подписок, для которых запрашиваются данные о выбросах углерода. Обязательное. Каждый идентификатор подписки должен быть в нижнем регистре. Максимальная длина списка составляет 100. |
Сведения о свойстве
categoryType
Указывает тип категории для получения элементов верхнего уровня, агрегированных по месяцам. См. поддерживаемые типы в CategoryTypeEnum.
categoryType: string
Значение свойства
string
reportType
Указывает, что тип отчета — это ежемесячный сводный отчет по основным элементам для данных о выбросах углерода.
reportType: "TopItemsMonthlySummaryReport"
Значение свойства
"TopItemsMonthlySummaryReport"
topItems
Количество основных элементов, возвращаемых на основе выбросов. Должно быть от 1 до 10.
topItems: number
Значение свойства
number
Сведения об унаследованном свойстве
carbonScopeList
Список областей выбросов углерода. Обязательное. Принимает одно или несколько значений из ВыбросовScopeEnum (например, Scope1, Scope2, Scope3) в форме списка. Выходные данные будут включать общий объем выбросов для указанных областей.
carbonScopeList: string[]
Значение свойства
string[]
Наследуется отQueryFilter.carbonScopeList
dateRange
Дата начала и окончания данных о выбросах углерода. Обязательное. Для ItemDetailsReport и TopItemsSummaryReport поддерживается только один месяц данных, поэтому даты начала и окончания должны быть равными в DateRange (например, начало: 2024-06-01 и конец: 2024-06-01).
dateRange: DateRange
Значение свойства
Наследуется отQueryFilter.dateRange
locationList
Список расположений (отображаемое имя региона Azure) для данных о выбросах углерода с каждым расположением, указанным в нижнем регистре (например, "восточная часть сша"). Необязательно. Для поиска отображаемых имен региона Azure можно использовать команду az account list-locations -o table.
locationList?: string[]
Значение свойства
string[]
Наследуется отQueryFilter.locationList
resourceGroupUrlList
Список URL-адресов группы ресурсов для данных о выбросах углерода. Необязательно. Каждый URL-адрес должен соответствовать формату "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}" и должен находиться в нижнем регистре.
resourceGroupUrlList?: string[]
Значение свойства
string[]
Наследуется отQueryFilter.resourceGroupUrlList
resourceTypeList
Список типов ресурсов для данных о выбросах углерода. Необязательно. Каждый тип ресурса должен быть указан в нижнем регистре, следуя формату "microsoft". {service}/{resourceType}", например "microsoft.storage/storageaccounts".
resourceTypeList?: string[]
Значение свойства
string[]
Наследуется отQueryFilter.resourceTypeList
subscriptionList
Список идентификаторов подписок, для которых запрашиваются данные о выбросах углерода. Обязательное. Каждый идентификатор подписки должен быть в нижнем регистре. Максимальная длина списка составляет 100.
subscriptionList: string[]
Значение свойства
string[]
Наследуется отQueryFilter.subscriptionList