通过

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

az iot central device command

  • 参考

注意

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

运行设备命令。

命令

名称 说明 类型 Status
az iot central device command history

获取发送到设备的最新命令请求和响应的详细信息。

 扩展 GA
az iot central device command run

在设备上运行命令并查看关联的响应。 不监视命令可能执行的属性更新。

 扩展 GA

az iot central device command history

获取发送到设备的最新命令请求和响应的详细信息。

列出从 IoT Central 发送到设备的最新命令请求和响应。 由于命令执行，设备对设备属性执行的任何更新都不会包含在响应中。

az iot central device command history --app-id
                                      --cn
                                      --device-id
                                      [--api-version {2022-06-30-preview, 2022-07-31}]
                                      [--central-api-uri]
                                      [--co]
                                      [--interface-id]
                                      [--mn]
                                      [--token]

示例

显示命令响应

az iot central device command history --app-id {appid} --device-id {deviceid} --interface-id {interfaceid} --command-name {commandname}

显示组件命令响应

az iot central device command history --app-id {appid} --device-id {deviceid} --component-name {componentname} --command-name {commandname}

显示模块组件命令响应

az iot central device command history --app-id {appid} --device-id {deviceid} --module-name {modulename} --component-name {componentname} --command-name {commandname}

必需参数

--app-id -n

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

--cn --command-name

设备模板中指定的命令名称。 命令名称可能不同于命令的显示名称。

--device-id -d

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

可选参数

--api-version --av
已放弃

参数“api_version”已弃用，将在将来的版本中删除。

此命令参数已弃用，将被忽略。在未来版本中，我们仅支持最新版本的 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
--co --component-name

设备组件的名称。

--interface-id -i

设备模板中指定的接口/组件的名称。可以通过导航到设备模板并在相应的设备功能下查看接口/组件标识来找到它。

--mn --module-name

设备模块的名称。

--token

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

全局参数
--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 iot central device command run

在设备上运行命令并查看关联的响应。 不监视命令可能执行的属性更新。

--content 可以是内联 json 或文件路径。

az iot central device command run --app-id
                                  --cn
                                  --content
                                  --device-id
                                  [--api-version {2022-06-30-preview, 2022-07-31}]
                                  [--central-api-uri]
                                  [--co]
                                  [--interface-id]
                                  [--mn]
                                  [--token]

示例

使用内联有效负载运行命令。 有效负载应位于 json 字符串中的“request”下

az iot central device command run --app-id {appid} --device-id {deviceid} --interface-id {interfaceid} --command-name {commandname} --content '{"request": {payload}}'

包含 json 有效负载路径的短运行命令。

az iot central device command run -n {appid} -d {deviceid} -i {interfaceid} --cn {commandname} -k {payload_file_path}

运行组件命令。

az iot central device command run -n {appid} -d {deviceid} --co {componentname} --cn {commandname} -k {payload}

运行模块组件命令。

az iot central device command run -n {appid} -d {deviceid} --mn {modulename} --co {componentname} --cn {commandname} -k {payload}

必需参数

--app-id -n

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

--cn --command-name

设备模板中指定的命令名称。 命令名称可能不同于命令的显示名称。

--content -k

请求的配置。 提供 JSON 文件或原始字符串化 JSON 的路径。 [文件路径示例： ./path/to/file.json][字符串化 JSON 示例： {'a'： 'b'}]。

--device-id -d

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

可选参数

--api-version --av
已放弃

参数“api_version”已弃用，将在将来的版本中删除。

此命令参数已弃用，将被忽略。在未来版本中，我们仅支持最新版本的 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
--co --component-name

设备组件的名称。

--interface-id -i

设备模板中指定的接口/组件的名称。可以通过导航到设备模板并在相应的设备功能下查看接口/组件标识来找到它。

--mn --module-name

设备模块的名称。

--token

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

全局参数
--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 获取完整的调试日志。