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

az monitor action-group

管理操作组。

命令

名称 说明 类型 状态
az monitor action-group create

创建新的操作组。

核心 GA
az monitor action-group delete

删除操作组。

核心 GA
az monitor action-group enable-receiver

在操作组中启用接收方。

核心 GA
az monitor action-group list

列出资源组或当前订阅下的操作组。

核心 GA
az monitor action-group show

显示操作组的详细信息。

核心 GA
az monitor action-group test-notifications

管理操作组测试通知。

核心 GA
az monitor action-group test-notifications create

创建操作组测试通知。

核心 GA
az monitor action-group update

更新操作组。

核心 GA
az monitor action-group wait

将 CLI 置于等待状态。

核心 GA

az monitor action-group create

创建新的操作组。

az monitor action-group create --action-group-name
                               --resource-group
                               [--action]
                               [--group-short-name]
                               [--location]
                               [--tags]

示例

创建新的操作组

az monitor action-group create --action webhook MyActionName https://alerts.contoso.com apiKey={APIKey} type=HighCPU --name MyActionGroup --resource-group MyResourceGroup

必需参数

--action-group-name --name -n

操作组的名称。

--resource-group -g

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

可选参数

--action --actions -a

在创建过程中将接收方添加到操作组。 用法:--action TYPE NAME [ARG ...]电子邮件:格式: --action email NAME EMAIL_ADDRESS [usecommonalertschema] 示例: --action email bob bob@contoso.com SMS: Format: --action sms NAME COUNTRY_CODE PHONE_NUMBER 示例: --action sms charli 1 5551234567 Webhook:格式:--action webhook NAME URI [useaadauth OBJECT_ID IDENTIFIER URI] [usecommonalertschema] 示例: --action webhook alert_hook https://www.contoso.com/alert useaadauth testobj http://identifierusecommonalertschema Arm 角色: 格式: --action armrole NAME ROLE_ID [usecommonalertschema] 示例: --action armole owner_role 8e3af657-a8ff-443c-a75c-2fe8c 4bcb635 Azure 应用 Push: Format: --action azureapppush NAME EMAIL_ADDRESS Example: --action azureapppush test_apppush bob@contoso.com ITSM: Format: --action itsm NAME WORKSPACE_ID CONNECTION_ID TICKET_CONFIGURATION REGION Example: --action itsm test_itsm test_workspace test_conn ticket_blob useast Automationrunbook: Format: --action automationrunbook NAME AUTOMATION_ACCOUNT_ID RUNBOOK_NAME WEBHOOK_RESOURCE_ID 标准版RVICE_URI [isglobalrunbook] [usecommonalertschema] Example: --action automationrunbook test_runbook test_acc test_book test_webhook test_rsrc http://example.com isglobalrunbook usecommonalertschema Voice: Format: --action voice NAME COUNTRY_CODE PHONE_NUMBER Example: --action voice charli 1 4441234567 Logic App: Format: --action logicapp NAME RESOURCE_ID CALLBACK_URL[usecommonalertschema]示例:--action logicapp test_logicapp test_rsrc http://callback Azure Function: Format: --action azurefunction NAME FUNCTION_APP_RESOURCE_ID FUNCTION_NAME HTTP_TRIGGER_URL [usecommonalertschema] 示例: --action azurefunction test_function test_rsrc test_func http://trigger usecommonalertschema 事件中心: 格式: --action eventhub NAME SUBSCRIPTION_ID EVENT_HUB_NAME_SPACE EVENT_HUB_NAME [usecommonalertschema] 示例:--action eventhub test_eventhub 5def922a-3ed4-49c1-b9fd-05ec533819a3可以使用多个--add-action参数指定 eventhubName testEventHubName usecommonalertschema 多个操作。 “useaadauth”、“isglobalrunbook”和“usecommonalertschema”是可选参数,只需将相应的参数设置为 True 即可。 如果传递了“useaadauth”参数,则还需要OBJECT_ID和IDENTIFIER_URI值。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

--group-short-name --short-name

操作组的短名称。 这将在短信中使用。

--location -l

Location。 az account list-locations 中的值。 可以使用 az configure --defaults location=<location> 配置默认位置。 如果未指定,将使用资源组的位置。

默认值: Global
--tags

空格分隔标记:key[=value] [key[=value] ...]。使用“”清除现有标记。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

全局参数
--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 action-group delete

删除操作组。

az monitor action-group delete [--action-group-name]
                               [--ids]
                               [--resource-group]
                               [--subscription]

可选参数

--action-group-name --name -n

操作组的名称。

--ids

一个或多个资源 ID(空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。

--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 action-group enable-receiver

在操作组中启用接收方。

这会将接收方的状态从“已禁用”更改为“已启用”。 仅电子邮件或短信接收方支持此操作。

az monitor action-group enable-receiver --name
                                        [--action-group]
                                        [--ids]
                                        [--resource-group]
                                        [--subscription]

必需参数

--name --receiver-name -n

要重新订阅的接收方的名称。

可选参数

--action-group --action-group-name

操作组的名称。

--ids

一个或多个资源 ID(空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。

--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 action-group list

列出资源组或当前订阅下的操作组。

az monitor action-group 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 action-group show

显示操作组的详细信息。

az monitor action-group show [--action-group-name]
                             [--ids]
                             [--resource-group]
                             [--subscription]

示例

显示操作组的详细信息(通常用于 --output 和 --query)。

az monitor action-group show --name MyActionGroup --resource-group MyResourceGroup

可选参数

--action-group-name --name -n

操作组的名称。

--ids

一个或多个资源 ID(空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。

--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 action-group update

更新操作组。

az monitor action-group update [--action-group-name]
                               [--add]
                               [--add-action]
                               [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                               [--group-short-name]
                               [--ids]
                               [--remove]
                               [--remove-action]
                               [--resource-group]
                               [--set]
                               [--subscription]
                               [--tags]

示例

更新操作组

az monitor action-group update --name MyActionGroup --resource-group MyResourceGroup --set retentionPolicy.days=365 --subscription MySubscription

可选参数

--action-group-name --name -n

操作组的名称。

--add

通过指定路径和键值对将对象添加到对象列表。 示例:--add property.listProperty <key=value、string 或 JSON 字符串>。

--add-action --add-actions -a

将接收方添加到操作组。 用法:--add-action TYPE NAME [ARG ...]电子邮件:格式: --add-action 电子邮件 NAME EMAIL_ADDRESS [usecommonalertschema] 示例: --add-action 电子邮件 bob bob@contoso.com SMS: 格式: --add-action sms NAME COUNTRY_CODE PHONE_NUMBER 示例: --add-action sms charli 1 5551234567 Webhook:格式:--add-action webhook NAME URI [useaadauth OBJECT_ID IDENTIFIER URI] [usecommonalertschema] 示例:--add-action https://www.contoso.com/alert useaadauth testobj http://identifierusecommonalertschema Arm 角色: 格式: --add-action armrole NAME ROLE_ID [usecommonalertschema] 示例: --add-action armole owner_role 8e3af657-a8ff-443c-a75c-2fe8c 4bcb635 Azure 应用 Push: Format: --add-action azureapppush NAME EMAIL_ADDRESS Example: --add-action azureapppush test_apppush bob@contoso.com ITSM: Format: --add-action itsm NAME WORKSPACE_ID CONNECTION_ID TICKET_CONFIGURATION REGION Example: --add-action itsm test_itsm test_workspace test_conn ticket_blob useast Automation runbook: Format: --add-action automationrunbook NAME AUTOMATION_ACCOUNT_ID RUNBOOK_NAME WEBHOOK_RESOURCE_ID 标准版RVICE_URI [isglobalrunbook] [usecommonalertschema] Example: --add-action automationrunbook test_runbook test_acc test_book test_webhook test_rsrc http://example.com isglobalrunbook usecommonalertschema Voice: Format: --add-action voice NAME COUNTRY_CODE PHONE_NUMBER Example: --add-action voice charli 1 4441234567 Logic App: Format: --add-actionlogicapp NAME RESOURCE_ID CALLBACK_URL [usecommonalertschema] 示例: --add-action logicapp test_logicapp test_rsrc http://callback Azure Function: Format: --add-action azurefunction NAME FUNCTION_APP_RESOURCE_ID FUNCTION_NAME HTTP_TRIGGER_URL [usecommonalertschema] 示例: --add-action azurefunction test_function test_rsrc test_func http://trigger usecommonalertschema 事件中心: 格式: --action eventhub NAME SUBSCRIPTION_ID EVENT_HUB_NAME_SPACE EVENT_HUB_NAME [usecommonalertschema] 示例: --action eventhub test_eventhub 5def922a-3ed4-49c1-b9fd-05ec533819a3 eventhubNameSpace testEventHubName usecommonalertschema Multiple 操作可以通过使用多个--add-action参数来指定。 “useaadauth”、“isglobalrunbook”和“usecommonalertschema”是可选参数,只需将相应的参数设置为 True 即可。 如果传递了“useaadauth”参数,则还需要OBJECT_ID和IDENTIFIER_URI值。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

--force-string

使用“set”或“add”时,保留字符串文本,而不是尝试转换为 JSON。

接受的值: 0, 1, f, false, n, no, t, true, y, yes
--group-short-name --short-name

操作组的短名称。 这将在短信中使用。

--ids

一个或多个资源 ID(空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。

--remove

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

--remove-action -r

从操作组中删除接收方。 接受以空格分隔的接收方名称列表。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

--resource-group -g

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

--set

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

--subscription

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

--tags

空格分隔标记:key[=value] [key[=value] ...]。使用“”清除现有标记。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

全局参数
--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 action-group wait

将 CLI 置于等待状态。

az monitor action-group wait [--created]
                             [--custom]
                             [--deleted]
                             [--exists]
                             [--ids]
                             [--interval]
                             [--name]
                             [--resource-group]
                             [--subscription]
                             [--timeout]
                             [--updated]

可选参数

--created

等待在“Succeeded”中使用“provisioningState”创建。

默认值: False
--custom

等待条件满足自定义 JMESPath 查询。 例如 provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running']。

--deleted

等到删除为止。

默认值: False
--exists

等待资源存在。

默认值: False
--ids

一个或多个资源 ID(空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。

--interval

轮询间隔(以秒为单位)。

默认值: 30
--name -n

操作组的名称。 必需。

--resource-group -g

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

--subscription

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

--timeout

最大等待(以秒为单位)。

默认值: 3600
--updated

等到 provisioningState 更新为“Succeeded”。

默认值: 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 获取完整的调试日志。