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

az iot central diagnostics

注意

此参考是 Azure CLI (2.30.0 或更高版本) 的 azure-iot 扩展的一部分。 首次运行 az iot central diagnostics 命令时,该扩展将自动安装。 详细了解扩展。

执行应用程序和设备级诊断。

命令

az iot central diagnostics monitor-events

查看发送到 IoT Central 应用的设备遥测消息。

az iot central diagnostics monitor-properties

查看发送到/从 IoT Central 应用发送的所需属性和报告属性。

az iot central diagnostics registration-summary

查看应用中所有设备的注册摘要。

az iot central diagnostics validate-messages

验证发送到 IoT Central 应用的IoT 中心的消息。

az iot central diagnostics validate-properties

验证发送到 IoT Central 应用程序的报告属性。

az iot central diagnostics monitor-events

查看发送到 IoT Central 应用的设备遥测消息。

显示发送到 IoT Central 应用程序的遥测数据。 默认情况下,它显示所有设备发送的所有数据。 使用 --device-id 参数筛选到特定设备。

az iot central diagnostics monitor-events --app-id
                                          [--central-api-uri]
                                          [--cg]
                                          [--device-id]
                                          [--enqueued-time]
                                          [--module-id]
                                          [--properties {all, anno, app, sys}]
                                          [--repair {false, true}]
                                          [--timeout]
                                          [--token]
                                          [--yes {false, true}]

示例

基本用法

az iot central diagnostics monitor-events --app-id {app_id}

在目标设备上筛选时的基本用法

az iot central diagnostics monitor-events --app-id {app_id} -d {device_id}

在 ID 中使用通配符筛选目标设备时的基本用法

az iot central diagnostics monitor-events --app-id {app_id} -d Device*d

在模块上筛选时的基本用法。

az iot central diagnostics monitor-events --app-id {app_id} -m {module_id}

在 ID 中使用通配符筛选目标模块时的基本用法

az iot central diagnostics monitor-events --app-id {app_id} -m Module*

筛选设备并指定要绑定到的事件中心使用者组。

az iot central diagnostics monitor-events --app-id {app_id} -d {device_id} --cg {consumer_group_name}

(消息标头) 接收消息注释

az iot central diagnostics monitor-events --app-id {app_id} -d {device_id} --properties anno

接收消息注释 + 系统属性。 从不超时。

az iot central diagnostics monitor-events --app-id {app_id} -d {device_id} --properties anno sys --timeout 0

从所有设备消息接收所有消息属性

az iot central diagnostics monitor-events --app-id {app_id} --props all

接收所有消息并分析消息有效负载作为 JSON

az iot central diagnostics monitor-events --app-id {app_id} --output json

必需参数

--app-id -n

要管理的 IoT Central 应用的应用 ID。 可以在“关于”页中找到应用程序的“关于”页中的“帮助”菜单。

可选参数

--central-api-uri --central-dns-suffix

与应用程序关联的 IoT Central DNS 后缀。

默认值: azureiotcentral.com
--cg --consumer-group -c

指定连接到事件中心终结点时要使用的使用者组。

默认值: $Default
--device-id -d

目标设备的设备 ID。可以通过单击“设备详细信息”页上的“连接”按钮来查找设备 ID。

--enqueued-time --et -e

指示应用作从分区读取消息的起点的时间。 单位是自 unix 纪元以来的毫秒数。 如果未指示“立即”使用任何时间。

--module-id -m

如果设备类型IoT Edge,则IoT Edge模块 ID。

--properties --props -p

指示要输出的关键消息属性。 sys = 系统属性,应用 = 应用程序属性,anno = 批注。

接受的值: all, anno, app, sys
--repair -r

重新安装与扩展版本兼容的 uamqp 依赖项。 默认值:false。

接受的值: false, true
--timeout --to -t

在未收到消息的情况下维护连接的最大秒数。 将 0 用于无穷大。

默认值: 300
--token

如果希望提交请求而不对 Azure CLI 进行身份验证,可以指定有效的用户令牌来对请求进行身份验证。 必须将密钥类型指定为请求的一部分。 更多信息请访问 https://aka.ms/iotcentraldocsapi

--yes -y

跳过用户提示。 指示接受操作。 主要用于自动化方案。 默认值:false。

接受的值: false, true

az iot central diagnostics monitor-properties

查看发送到/从 IoT Central 应用发送的所需属性和报告属性。

从中心轮询设备孪生,并将其与最后一个设备孪生分析设备孪生中的属性进行比较,并检测是否已更改在轮询间隔内更改的属性子集。

az iot central diagnostics monitor-properties --app-id
                                              --device-id
                                              [--central-api-uri]
                                              [--token]

示例

基本用法

az iot central diagnostics monitor-properties --app-id {app_id} -d {device_id}

必需参数

--app-id -n

要管理的 IoT Central 应用的应用 ID。 可以在“关于”页中找到应用程序的“关于”页中的“帮助”菜单。

--device-id -d

目标设备的设备 ID。可以通过单击“设备详细信息”页上的“连接”按钮来查找设备 ID。

可选参数

--central-api-uri --central-dns-suffix

与应用程序关联的 IoT Central DNS 后缀。

默认值: azureiotcentral.com
--token

如果希望提交请求而不对 Azure CLI 进行身份验证,可以指定有效的用户令牌来对请求进行身份验证。 必须将密钥类型指定为请求的一部分。 更多信息请访问 https://aka.ms/iotcentraldocsapi

az iot central diagnostics registration-summary

查看应用中所有设备的注册摘要。

注意:如果应用包含大量设备,此命令可能需要大量时间才能返回。

az iot central diagnostics registration-summary --app-id
                                                [--api-version {2022-06-30-preview, 2022-07-31}]
                                                [--central-api-uri]
                                                [--token]

示例

注册摘要

az iot central diagnostics registration-summary --app-id {appid}

必需参数

--app-id -n

要管理的 IoT Central 应用的应用 ID。 可以在“关于”页中找到应用程序的“关于”页中的“帮助”菜单。

可选参数

--api-version --av

此命令参数已被弃用,将被忽略。在将来的版本中,我们将仅支持最新版本的 IoT Central API。如果任何 API 尚未正式发布,我们将调用最新的预览版。

接受的值: 2022-06-30-preview, 2022-07-31
默认值: 2022-07-31
--central-api-uri --central-dns-suffix

与应用程序关联的 IoT Central DNS 后缀。

默认值: azureiotcentral.com
--token

如果希望提交请求而不对 Azure CLI 进行身份验证,可以指定有效的用户令牌来对请求进行身份验证。 必须将密钥类型指定为请求的一部分。 更多信息请访问 https://aka.ms/iotcentraldocsapi

az iot central diagnostics validate-messages

验证发送到 IoT Central 应用的IoT 中心的消息。

对遥测消息执行验证,并报告未在设备模板中建模的数据或数据类型与设备模板中定义的数据不匹配的数据。

az iot central diagnostics validate-messages --app-id
                                             [--central-api-uri]
                                             [--cg]
                                             [--device-id]
                                             [--dr]
                                             [--enqueued-time]
                                             [--max-messages]
                                             [--minimum-severity {error, info, warning}]
                                             [--module-id]
                                             [--properties {all, anno, app, sys}]
                                             [--repair {false, true}]
                                             [--style {csv, json, scroll}]
                                             [--timeout]
                                             [--token]
                                             [--yes {false, true}]

示例

基本用法

az iot central diagnostics validate-messages --app-id {app_id}

检测到错误时输出错误

az iot central diagnostics validate-messages --app-id {app_id} --style scroll

在目标设备上筛选时的基本用法

az iot central diagnostics validate-messages --app-id {app_id} -d {device_id}

在 ID 中使用通配符筛选目标设备时的基本用法

az iot central diagnostics validate-messages --app-id {app_id} -d Device*

在模块上筛选时的基本用法。

az iot central diagnostics validate-messages --app-id {app_id} -m {module_id}

在 ID 中使用通配符筛选目标模块时的基本用法

az iot central diagnostics validate-messages --app-id {app_id} -m Module*

筛选设备并指定要绑定到的事件中心使用者组。

az iot central diagnostics validate-messages --app-id {app_id} -d {device_id} --cg {consumer_group_name}

必需参数

--app-id -n

要管理的 IoT Central 应用的应用 ID。 可以在“关于”页中找到应用程序在帮助菜单中的应用 ID。

可选参数

--central-api-uri --central-dns-suffix

与应用程序关联的 IoT Central DNS 后缀。

默认值: azureiotcentral.com
--cg --consumer-group -c

指定连接到事件中心终结点时要使用的使用者组。

默认值: $Default
--device-id -d

目标设备的设备 ID。可以通过单击“设备详细信息”页上的“连接”按钮来查找设备 ID。

--dr --duration

终止连接之前从目标设备接收消息的最大持续时间。将 0 用于无穷大。

默认值: 300
--enqueued-time --et -e

指示应用作从分区读取消息的起点的时间。 单位是 unix 纪元以来的毫秒数。 如果未使用任何时间,则表示“立即”。

--max-messages --mm

在终止连接之前,要从目标设备接收的最大消息数。将 0 用于无穷大。

默认值: 10
--minimum-severity

报告所需的问题的最低严重性。

接受的值: error, info, warning
默认值: warning
--module-id -m

如果设备类型IoT Edge,则IoT Edge模块 ID。

--properties --props -p

指示要输出的关键消息属性。 sys = 系统属性,应用 = 应用程序属性,anno = 批注。

接受的值: all, anno, app, sys
--repair -r

重新安装与扩展版本兼容的 uamqp 依赖项。 默认值:false。

接受的值: false, true
--style

指示输出 stylescroll = 在到达时传递错误,json = 将结果汇总为 json,csv = 将结果汇总为 csv。

接受的值: csv, json, scroll
默认值: scroll
--timeout --to -t

在未收到消息的情况下维护连接的最大秒数。 将 0 用于无穷大。

默认值: 300
--token

如果想要提交请求而不针对 Azure CLI 进行身份验证,可以指定有效的用户令牌来对请求进行身份验证。 必须将密钥类型指定为请求的一部分。 更多信息请访问 https://aka.ms/iotcentraldocsapi

--yes -y

跳过用户提示。 指示接受操作。 主要用于自动化方案。 默认值:false。

接受的值: false, true

az iot central diagnostics validate-properties

验证发送到 IoT Central 应用程序的报告属性。

对报告的属性更新执行验证:

  1. 警告 - 未在中央建模的设备发送的属性。
  2. 警告 - 在多个接口中声明具有相同名称的属性应包含接口名称作为属性更新的一部分。
az iot central diagnostics validate-properties --app-id
                                               --device-id
                                               [--central-api-uri]
                                               [--minimum-severity {error, info, warning}]
                                               [--token]

示例

基本用法

az iot central diagnostics validate-properties --app-id {app_id} -d {device_id}

必需参数

--app-id -n

要管理的 IoT Central 应用的应用 ID。 可以在“关于”页中找到应用程序在帮助菜单中的应用 ID。

--device-id -d

目标设备的设备 ID。可以通过单击“设备详细信息”页上的“连接”按钮来查找设备 ID。

可选参数

--central-api-uri --central-dns-suffix

与应用程序关联的 IoT Central DNS 后缀。

默认值: azureiotcentral.com
--minimum-severity

报告所需的问题的最低严重性。

接受的值: error, info, warning
默认值: warning
--token

如果想要提交请求而不针对 Azure CLI 进行身份验证,可以指定有效的用户令牌来对请求进行身份验证。 必须将密钥类型指定为请求的一部分。 更多信息请访问 https://aka.ms/iotcentraldocsapi