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

az datadog monitor

注意

此参考是 Azure CLI(版本 2.17.0 或更高版本)的 datadog 扩展的一部分。 该扩展将在首次运行 az datadog monitor 命令时自动安装。 详细了解扩展。

使用 datadog 管理监视器。

命令

名称 说明 类型 状态
az datadog monitor create

创建监视器资源。

扩展 GA
az datadog monitor delete

删除监视器资源。

扩展 GA
az datadog monitor get-default-key

获取默认 API 密钥。

分机 GA
az datadog monitor list

列出指定资源组下的所有监视器。 列出指定订阅下的所有监视器。

分机 GA
az datadog monitor list-api-key

列出给定监视资源的 API 密钥。

扩展 GA
az datadog monitor list-host

列出给定监视资源的主机。

分机 GA
az datadog monitor list-linked-resource

列出与目标资源相同的 Datadog 组织关联的所有 Azure 资源。

扩展 GA
az datadog monitor list-monitored-resource

列出 Datadog 监视资源当前正在监视的资源。

分机 GA
az datadog monitor refresh-set-password-link

刷新设置的密码链接并返回最新的密码链接。

分机 GA
az datadog monitor set-default-key

设置默认 API 密钥。

分机 GA
az datadog monitor show

获取特定监视器资源的属性。

分机 GA
az datadog monitor update

更新监视器资源。

分机 GA
az datadog monitor wait

将 CLI 置于等待状态,直到满足 datadog 监视器的条件。

分机 GA

az datadog monitor create

创建监视器资源。

az datadog monitor create --monitor-name
                          --resource-group
                          [--datadog-organization-properties]
                          [--location]
                          [--no-wait]
                          [--sku-name]
                          [--tags]
                          [--type {SystemAssigned, UserAssigned}]
                          [--user-info]

示例

Monitors_Create

az datadog monitor create --name "myMonitor" --resource-group "myResourceGroup" --location "West US 2" --tags Environment="Dev" --user-info name="Alice" email-address="alice@microsoft.com" phone-number="123-456-7890" --type "SystemAssigned" --sku-name "payg_v2_Monthly"

使用链接到 Datadogo 组织来监视创建。

az datadog monitor create --name "myMonitor" --resource-group "myResourceGroup" --location "West US 2" --datadog-organization-properties api-key=XX application-key=XX --tags Environment="Dev" --user-info name="Alice" email-address="alice@microsoft.com" phone-number="123-456-7890" --type "SystemAssigned" --sku-name "Linked"

必需参数

--monitor-name --name -n

监视资源名称。

--resource-group -g

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

可选参数

--datadog-organization-properties

Datadog 组织属性。

用法:--datadog-organization-properties linking-auth-code=XX linking-client-id=XX redirect-uri=XX api-key=XX application-key=XX enterprise-app-id=XX

linking-auth-code:用于链接到现有 datadog 组织的身份验证代码。 linking-client-id:从现有client_id交换用于链接组织的身份验证令牌。 redirect-uri:用于链接的重定向 URI。 api-key:与 Datadog 组织关联的 Api 密钥。 application-key:与 Datadog 组织关联的应用程序密钥。 enterprise-app-id:用于单一登录的企业应用的 ID。

--location -l

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

--no-wait

不等待长时间运行的操作完成。

默认值: False
--sku-name

SKU 的名称。

--tags

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

--type

标识类型。

接受的值: SystemAssigned, UserAssigned
--user-info

用户信息。

用法:--user-info name=XX email-address=XX phone-number=XX

name: user email-address: Datadog 用于联系他们的用户的电子邮件(如果需要)电话号码:Datadog 用于联系他们的用户的电子邮件地址:电话 Datadog 用于联系他们的用户号码( 如果需要)。

全局参数
--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 datadog monitor delete

删除监视器资源。

az datadog monitor delete [--ids]
                          [--monitor-name]
                          [--no-wait]
                          [--resource-group]
                          [--subscription]
                          [--yes]

示例

Monitors_Delete

az datadog monitor delete --name "myMonitor" --resource-group "myResourceGroup"

可选参数

--ids

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

--monitor-name --name -n

监视资源名称。

--no-wait

不等待长时间运行的操作完成。

默认值: False
--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 datadog monitor get-default-key

获取默认 API 密钥。

az datadog monitor get-default-key [--ids]
                                   [--monitor-name]
                                   [--resource-group]
                                   [--subscription]

示例

Monitors_GetDefaultKey

az datadog monitor get-default-key --name "myMonitor" --resource-group "myResourceGroup"

可选参数

--ids

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

--monitor-name --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 datadog monitor list

列出指定资源组下的所有监视器。 列出指定订阅下的所有监视器。

az datadog monitor list [--resource-group]

示例

Monitors_ListByResourceGroup

az datadog monitor list --resource-group "myResourceGroup"

Monitors_List

az datadog monitor list

可选参数

--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 datadog monitor list-api-key

列出给定监视资源的 API 密钥。

az datadog monitor list-api-key --monitor-name
                                --resource-group

示例

Monitors_ListApiKeys

az datadog monitor list-api-key --name "myMonitor" --resource-group "myResourceGroup"

必需参数

--monitor-name --name -n

监视资源名称。

--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 datadog monitor list-host

列出给定监视资源的主机。

az datadog monitor list-host --monitor-name
                             --resource-group

示例

Monitors_ListHosts

az datadog monitor list-host --name "myMonitor" --resource-group "myResourceGroup"

必需参数

--monitor-name --name -n

监视资源名称。

--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 datadog monitor list-linked-resource

列出与目标资源相同的 Datadog 组织关联的所有 Azure 资源。

az datadog monitor list-linked-resource --monitor-name
                                        --resource-group

示例

Monitors_ListLinkedResources

az datadog monitor list-linked-resource --name "myMonitor" --resource-group "myResourceGroup"

必需参数

--monitor-name --name -n

监视资源名称。

--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 datadog monitor list-monitored-resource

列出 Datadog 监视资源当前正在监视的资源。

az datadog monitor list-monitored-resource --monitor-name
                                           --resource-group

示例

Monitors_ListMonitoredResources

az datadog monitor list-monitored-resource --name "myMonitor" --resource-group "myResourceGroup"

必需参数

--monitor-name --name -n

监视资源名称。

--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 datadog monitor refresh-set-password-link [--ids]
                                             [--monitor-name]
                                             [--resource-group]
                                             [--subscription]

Monitors_RefreshSetPasswordLink

az datadog monitor refresh-set-password-link --name "myMonitor" --resource-group "myResourceGroup"
--ids

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

--monitor-name --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 datadog monitor set-default-key

设置默认 API 密钥。

az datadog monitor set-default-key [--created]
                                   [--created-by]
                                   [--ids]
                                   [--key]
                                   [--monitor-name]
                                   [--name]
                                   [--resource-group]
                                   [--subscription]

示例

Monitors_SetDefaultKey

az datadog monitor set-default-key --monitor-name "myMonitor" --key "1111111111111111aaaaaaaaaaaaaaaa" --resource-group "myResourceGroup"

可选参数

--created

创建 API 密钥的时间。

--created-by

创建 API 密钥的用户。

--ids

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

--key

API 密钥的值。

--monitor-name

监视资源名称。

--name

API 密钥的名称。

--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 datadog monitor show

获取特定监视器资源的属性。

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

示例

Monitors_Get

az datadog monitor show --name "myMonitor" --resource-group "myResourceGroup"

可选参数

--ids

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

--monitor-name --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 datadog monitor update

更新监视器资源。

az datadog monitor update [--ids]
                          [--monitor-name]
                          [--monitoring-status]
                          [--no-wait]
                          [--resource-group]
                          [--sku-name]
                          [--subscription]
                          [--tags]

示例

Monitors_Update

az datadog monitor update --name "myMonitor" --tags Environment="Dev" --monitoring-status "Disabled" --resource-group "myResourceGroup"

可选参数

--ids

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

--monitor-name --name -n

监视资源名称。

--monitoring-status

指定是否启用或禁用资源监视的标志。 允许的值:“Enabled”、“Disabled”。

--no-wait

不等待长时间运行的操作完成。

默认值: False
--resource-group -g

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

--sku-name

SKU 的名称。

--subscription

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

--tags

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

全局参数
--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 datadog monitor wait

将 CLI 置于等待状态,直到满足 datadog 监视器的条件。

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

示例

暂停执行下一行 CLI 脚本,直到成功创建 datadog 监视器。

az datadog monitor wait --name "myMonitor" --resource-group "myResourceGroup" --created

暂停执行下一行 CLI 脚本,直到 datadog 监视器成功更新。

az datadog monitor wait --name "myMonitor" --resource-group "myResourceGroup" --updated

暂停执行下一行 CLI 脚本,直到成功删除 datadog 监视器。

az datadog monitor wait --name "myMonitor" --resource-group "myResourceGroup" --deleted

可选参数

--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
--monitor-name --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 获取完整的调试日志。