你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

az monitor scheduled-query

注意

此参考是 Azure CLI 的计划查询扩展（版本 2.54.0 或更高版本）的一部分。 该扩展将在首次运行 az monitor scheduled-query 命令时自动安装。 详细了解扩展。

用于管理计划查询的命令。

命令

名称	说明	类型	状态
az monitor scheduled-query create	创建计划查询。	扩展	GA
az monitor scheduled-query delete	删除计划的查询。	扩展	GA
az monitor scheduled-query list	列出所有计划查询。	扩展	GA
az monitor scheduled-query show	显示计划查询的详细信息。	扩展	GA
az monitor scheduled-query update	更新计划查询。	扩展	GA

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]

示例

为 VM 创建计划查询。

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"

为资源组中的 VM 创建计划查询。

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” {=，！=，>=，>=，<<=} THRESHOLD [resource id RESOURCEID] [where DIMENSION {includes，excludes} VALUE [or VALUE ...][和 DIMENSION {includes，excludes} VALUE [or VALUE ...] ][至少 MinTimeToFail 冲突与 EvaluationPeriod 聚合点冲突]“查询占位符可以在 --condition-query 参数维度中定义，方法是添加”where“关键字 (keyword)，并通过将它们与”and“关键字 (keyword)组合来查询多个维度。

--name -n

计划查询规则的名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--scopes

规则适用的范围的空间分隔列表。 此参数中指定的资源的类型必须相同，并且位于同一位置。

可选参数

--action-groups

触发警报时要调用的操作组资源 ID。

用法：--action-groups ACTION_GROUP_NAME_OR_ID [NAME_OR_ID,...]。

--auto-mitigate

指示是否应自动解决警报的标志。 默认值为 true。

接受的值: false, true

默认值: True

--check-ws-alerts-storage --cwas

指示此计划查询规则是否应存储在客户的存储中的标志。

接受的值: false, true

默认值: False

--condition-query

查询删除以替换参数中的 --condition 占位符。

--custom-properties

警报有效负载的属性。

用法：--custom-properties ALERT_PAYLOAD_PROPERTIES [KEY=VAL，KEY=VAL ...]。

--description

规则的自由文本说明。

--disabled

禁用计划的查询。

接受的值: false, true

默认值: False

--evaluation-frequency

以“##h##m##s”格式计算规则的频率。

默认值: 5m

--location -l

位置。 az account list-locations 中的值。 可以使用 az configure --defaults location=<location> 配置默认位置。

--mad --mute-actions-duration

触发警报后，在所选时间段（采用 ISO 8601 持续时间格式）将操作静音。

--severity

警报的严重性从 0（严重）到 4（详细）。

默认值: 2

--skip-query-validation

指示是否应验证提供的查询的标志。

接受的值: false, true

默认值: False

--tags

空格分隔标记：key[=value] [key[=value] ...]。使用“”清除现有标记。

--target-resource-type --type

范围中目标资源的资源类型。 当范围是资源组或订阅时，必须提供此项。

--window-size

聚合采用“##h##m##s”格式的指标的时间。

默认值: 5m

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 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

一个或多个资源 ID（以空格分隔）。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。

--name -n

计划查询规则的名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--yes -y

不提示确认。

默认值: False

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 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

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 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

一个或多个资源 ID（以空格分隔）。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。

--name -n

计划查询规则的名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 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

触发警报时要调用的操作组资源 ID。

--add

通过指定路径和键值对将对象添加到对象列表。 示例：--add property.listProperty <key=value, string or JSON string>。

默认值: []

--auto-mitigate

指示是否应自动解决警报的标志。 默认值为 true。

接受的值: false, true

--check-ws-alerts-storage --cwas

指示此计划查询规则是否应存储在客户的存储中的标志。

接受的值: false, true

--condition

触发规则的条件。

用法：--condition {avg，min，max，total，count} [“METRIC COLUMN” from] “QUERY_PLACEHOLDER” {=，！=，>=，>=，<<=} THRESHOLD [resource id RESOURCEID] [where DIMENSION {includes，excludes} VALUE [or VALUE ...][和 DIMENSION {includes，excludes} VALUE [or VALUE ...] ][至少 MinTimeToFail 违反 EvaluationPeriod 聚合点]'

可以在 --condition-query 参数维度中定义查询占位符，方法是添加“where”关键字 (keyword)，并通过将它们与“and”关键字 (keyword)相结合来查询多个维度。

--condition-query

查询删除以替换参数中的 --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。

默认值: False

--ids

一个或多个资源 ID（以空格分隔）。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。

--mad --mute-actions-duration

触发警报后，在所选时间段（采用 ISO 8601 持续时间格式）将操作静音。

--name -n

计划查询规则的名称。

--remove

从列表中删除属性或元素。 示例： --remove property.list <indexToRemove> OR --remove propertyToRemove.

默认值: []

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--set

通过指定要设置的属性路径和值来更新对象。 示例：--set property1.property2=<value>。

默认值: []

--severity

警报的严重性从 0（严重）到 4（详细）。

--skip-query-validation

指示是否应验证提供的查询的标志。

接受的值: false, true

--subscription

订阅的名称或 ID。 可以使用 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

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。