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

az monitor scheduled-query

  • Ссылка

Примечание.

Эта ссылка является частью расширения запланированного запроса для Azure CLI (версия 2.54.0 или более поздней). Расширение автоматически установит при первом запуске команды az monitor scheduled-query . Подробнее о расширениях.

Команды для управления запланированными запросами.

Команды

Имя Описание Тип Состояние
az monitor scheduled-query create

Создайте запланированный запрос.

 Расширение Общедоступная версия
az monitor scheduled-query delete

Удаление запланированного запроса.

 Расширение Общедоступная версия
az monitor scheduled-query list

Список всех запланированных запросов.

 Расширение Общедоступная версия
az monitor scheduled-query show

Отображение сведений о запланированном запросе.

 Расширение Общедоступная версия
az monitor scheduled-query update

Обновите запланированный запрос.

 Расширение Общедоступная версия

az monitor scheduled-query create

Создайте запланированный запрос.

az monitor scheduled-query create --condition
                                  --name
                                  --resource-group
                                  --scopes
                                  [--action-groups]
                                  [--auto-mitigate {false, true}]
                                  [--check-ws-alerts-storage {false, true}]
                                  [--condition-query]
                                  [--custom-properties]
                                  [--description]
                                  [--disabled {false, true}]
                                  [--evaluation-frequency]
                                  [--location]
                                  [--mad]
                                  [--severity]
                                  [--skip-query-validation {false, true}]
                                  [--tags]
                                  [--target-resource-type]
                                  [--window-size]

Примеры

Создайте запланированный запрос для виртуальной машины.

az monitor scheduled-query create -g {rg} -n {name1} --scopes {vm_id} --condition "count 'Placeholder_1' > 360 resource id _ResourceId at least 1 violations out of 5 aggregated points" --condition-query Placeholder_1="union Event, Syslog | where TimeGenerated > ago(1h) | where EventLevelName=='Error' or SeverityLevel=='err'" --description "Test rule"

Создайте запланированный запрос для виртуальных машин в группе ресурсов.

az monitor scheduled-query create -g {rg} -n {name1} --scopes {rg_id} --condition "count 'Placeholder_1' > 360 resource id _ResourceId at least 1 violations out of 5 aggregated points" --condition-query Placeholder_1="union Event, Syslog | where TimeGenerated > ago(1h) | where EventLevelName=='Error' or SeverityLevel=='err'" --description "Test rule"

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

--condition

Условие, которое активирует правило.

Использование: --condition {avg,min,max,total,count} ["METRIC COLUMN" from] "QUERY_PLACEHOLDER" {=,!=,>>=,=<<}ПОРОГ [идентификатор ресурса] [where dimension{includes,excludes} VALUE [or VALUE ...] [и ИЗМЕРЕНИЕ {включает,исключает} ЗНАЧЕНИЕ [или ЗНАЧЕНИЕ ...] ...]] [По крайней мере нарушения MinTimeToFail из агрегированных точек оценки]. Заполнители запросов можно определить в измерениях аргумента --condition-query, добавив ключевое слово "where" и несколько измерений, можно запросить, объединив их с ключевое слово .

--name -n

Имя правила запланированного запроса.

--resource-group -g

Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>.

--scopes

Разделенный пробелами список область применяется к правилу. Ресурсы, указанные в этом параметре, должны иметь одинаковый тип и существовать в том же расположении.

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

--action-groups

Идентификаторы ресурсов группы действий для вызова при срабатывании оповещения.

Использование: --action-groups ACTION_GROUP_NAME_OR_ID [NAME_OR_ID,...].

--auto-mitigate

Флаг, указывающий, следует ли автоматически разрешать оповещение. Значение по умолчанию: true.

Допустимые значения: false, true
Default value: True
--check-ws-alerts-storage --cwas

Флаг, указывающий, следует ли хранить это правило запланированного запроса в хранилище клиента.

Допустимые значения: false, true
Default value: False
--condition-query

Запрос деteils для замены заполнителей в --condition аргументе.

--custom-properties

Свойства полезных данных оповещения.

Использование: --custom-properties ALERT_PAYLOAD_PROPERTIES [KEY=VAL,KEY=VAL ...].

--description

Описание правила в свободном тексте.

--disabled

Отключите запланированный запрос.

Допустимые значения: false, true
Default value: False
--evaluation-frequency

Частота вычисления правила в формате "##h##m##s".

Default value: 5m
--location -l

Location. Значения из az account list-locations. Расположение по умолчанию можно настроить с помощью az configure --defaults location=<location>.

--mad --mute-actions-duration

Отключение действий в течение выбранного периода времени (в формате длительности ISO 8601) после запуска оповещения.

--severity

Серьезность оповещения от 0 (критического) до 4 (подробно).

Default value: 2
--skip-query-validation

Флаг, указывающий, следует ли проверять предоставленный запрос.

Допустимые значения: false, true
Default value: False
--tags

Теги, разделенные пробелами: key[=value] [key[=value] ...]. Используйте "" для очистки существующих тегов.

--target-resource-type --type

Тип ресурса целевого ресурса в область. Это необходимо предоставить, если область является группой ресурсов или подпиской.

--window-size

Время агрегирования метрик в формате ##h##m##s.

Default value: 5m
Глобальные параметры
--debug

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

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

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

--output -o

Формат вывода.

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

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

--subscription

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

--verbose

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

az monitor scheduled-query delete

Удаление запланированного запроса.

az monitor scheduled-query delete [--ids]
                                  [--name]
                                  [--resource-group]
                                  [--subscription]
                                  [--yes]

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

--ids

Один или несколько идентификаторов ресурсов (через пробелы). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие аргументы Resource Id.

--name -n

Имя правила запланированного запроса.

--resource-group -g

Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>.

--subscription

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

--yes -y

Не запрашивать подтверждение.

Default value: False
Глобальные параметры
--debug

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

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

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

--output -o

Формат вывода.

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

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

--subscription

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

--verbose

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

az monitor scheduled-query list

Список всех запланированных запросов.

az monitor scheduled-query list [--resource-group]

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

--resource-group -g

Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>.

Глобальные параметры
--debug

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

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

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

--output -o

Формат вывода.

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

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

--subscription

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

--verbose

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

az monitor scheduled-query show

Отображение сведений о запланированном запросе.

az monitor scheduled-query show [--ids]
                                [--name]
                                [--resource-group]
                                [--subscription]

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

--ids

Один или несколько идентификаторов ресурсов (через пробелы). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие аргументы Resource Id.

--name -n

Имя правила запланированного запроса.

--resource-group -g

Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>.

--subscription

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

Глобальные параметры
--debug

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

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

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

--output -o

Формат вывода.

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

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

--subscription

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

--verbose

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

az monitor scheduled-query update

Обновите запланированный запрос.

az monitor scheduled-query update [--action-groups]
                                  [--add]
                                  [--auto-mitigate {false, true}]
                                  [--check-ws-alerts-storage {false, true}]
                                  [--condition]
                                  [--condition-query]
                                  [--custom-properties]
                                  [--description]
                                  [--disabled {false, true}]
                                  [--evaluation-frequency]
                                  [--force-string]
                                  [--ids]
                                  [--mad]
                                  [--name]
                                  [--remove]
                                  [--resource-group]
                                  [--set]
                                  [--severity]
                                  [--skip-query-validation {false, true}]
                                  [--subscription]
                                  [--tags]
                                  [--target-resource-type]
                                  [--window-size]

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

--action-groups

Идентификаторы ресурсов группы действий для вызова при срабатывании оповещения.

--add

Добавьте объект в список объектов, указав пары пути и значения ключа. Пример: --add property.listProperty <key=value, string or JSON string>.

Default value: []
--auto-mitigate

Флаг, указывающий, следует ли автоматически разрешать оповещение. Значение по умолчанию: true.

Допустимые значения: false, true
--check-ws-alerts-storage --cwas

Флаг, указывающий, следует ли хранить это правило запланированного запроса в хранилище клиента.

Допустимые значения: false, true
--condition

Условие, которое активирует правило.

Использование: --condition {avg,min,max,total,count} ["METRIC COLUMN" from] "QUERY_PLACEHOLDER" {=,!=,>>=,=<<}ПОРОГ [идентификатор ресурса] [where dimension{includes,excludes} VALUE [or VALUE ...] [и ИЗМЕРЕНИЕ {включает,исключает} ЗНАЧЕНИЕ [или ЗНАЧЕНИЕ ...] ...]] [по крайней мере нарушения MinTimeToFail из агрегированных точек ОценкиPeriod]'

Заполнители запросов можно определить в аргументе --condition-query Dimensions, добавив ключевое слово "where" и несколько измерений, комбинируя их с "и" ключевое слово.

--condition-query

Запрос деteils для замены заполнителей в --condition аргументе.

--custom-properties

Свойства полезных данных оповещения.

Использование: --custom-properties ALERT_PAYLOAD_PROPERTIES [KEY=VAL,KEY=VAL ...].

--description

Описание правила в свободном тексте.

--disabled

Отключите запланированный запрос.

Допустимые значения: false, true
--evaluation-frequency

Частота вычисления правила в формате "##h##m##s".

--force-string

При использовании "set" или "add" сохраняйте строковые литералы вместо попытки преобразовать в JSON.

Default value: False
--ids

Один или несколько идентификаторов ресурсов (через пробелы). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие аргументы Resource Id.

--mad --mute-actions-duration

Отключение действий в течение выбранного периода времени (в формате длительности ISO 8601) после запуска оповещения.

--name -n

Имя правила запланированного запроса.

--remove

Удалите свойство или элемент из списка. Пример: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Default value: []
--resource-group -g

Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>.

--set

Обновите объект, указав путь к свойству и значение для задания. Пример: --set property1.property2=<value>.

Default value: []
--severity

Серьезность оповещения от 0 (критического) до 4 (подробно).

--skip-query-validation

Флаг, указывающий, следует ли проверять предоставленный запрос.

Допустимые значения: false, true
--subscription

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

--tags

Теги, разделенные пробелами: key[=value] [key[=value] ...]. Используйте "" для очистки существующих тегов.

--target-resource-type --type

Тип ресурса целевого ресурса в область. Это необходимо предоставить, если область является группой ресурсов или подпиской.

--window-size

Время агрегирования метрик в формате ##h##m##s.

Глобальные параметры
--debug

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

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

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

--output -o

Формат вывода.

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

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

--subscription

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

--verbose

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