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

az iot hub digital-twin

参考

注意

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

操作IoT 中心设备的数字孪生并与之交互。

命令

名称	说明	类型	Status
az iot hub digital-twin invoke-command	调用数字孪生设备的根或组件级命令。	扩展	GA
az iot hub digital-twin show	显示IoT 中心设备的数字孪生体。	扩展	GA
az iot hub digital-twin update	通过 JSON 修补程序规范更新数字孪生设备的读写属性。	扩展	GA

az iot hub digital-twin invoke-command

调用数字孪生设备的根或组件级命令。

az iot hub digital-twin invoke-command --cn
                                       --device-id
                                       [--component-path]
                                       [--connect-timeout]
                                       [--hub-name]
                                       [--login]
                                       [--payload]
                                       [--resource-group]
                                       [--response-timeout]

示例

一般情况下，调用命令使用内联 JSON 获取包含特定属性的有效负载。

az iot hub digital-twin invoke-command --command-name {command_name} -n {iothub_name} -d {device_id} --payload '{"property_name": "property_value"}'

调用根级别命令“重新启动”，该命令采用符合 DTDL 模型的名为“delay”的有效负载 https://github.com/Azure/opendigitaltwins-dtdl/blob/master/DTDL/v2/samples/TemperatureController.json.

az iot hub digital-twin invoke-command --command-name reboot -n {iothub_name} -d {device_id} --payload 5

对不带输入的组件“thermostat1”调用命令“getMaxMinReport”。

az iot hub digital-twin invoke-command --cn getMaxMinReport -n {iothub_name} -d {device_id} --component-path thermostat1

必需参数

--cn --command-name

数字孪生命令名称。

--device-id -d

目标设备 ID。

可选参数

--component-path

数字孪生组件路径。例如：恒温器 1。

--connect-timeout --cto

IoT 中心尝试连接到设备的最大时间间隔（以秒为单位）。

--hub-name -n

IoT 中心名称或主机名。如果未提供 --login，则为必需。

--login -l

此命令支持具有执行操作权限的实体连接字符串。用于避免通过“az login”进行会话登录。如果同时提供实体连接字符串和名称，则连接字符串优先。如果未提供 --hub-name，则为必需。

--payload

命令的 JSON 有效负载输入。提供文件路径或内联 JSON。

默认值: {}

--resource-group -g

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

--response-timeout --rto

数字孪生命令等待结果的最大时间间隔（以秒为单位）。

全局参数

--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 hub digital-twin show

显示IoT 中心设备的数字孪生体。

az iot hub digital-twin show --device-id
                             [--hub-name]
                             [--login]
                             [--resource-group]

示例

显示目标设备数字孪生体。

az iot hub digital-twin show -n {iothub_name} -d {device_id}

必需参数

--device-id -d

目标设备 ID。

可选参数

--hub-name -n

IoT 中心名称或主机名。如果未提供 --login，则为必需。

--login -l

--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 iot hub digital-twin update

通过 JSON 修补程序规范更新数字孪生设备的读写属性。

当前操作仅限于添加、替换和删除。

az iot hub digital-twin update --device-id
                               --json-patch
                               [--etag]
                               [--hub-name]
                               [--login]
                               [--resource-group]

示例

通过 JSON 修补程序规范更新数字孪生体。

az iot hub digital-twin update --hub-name {iothub_name} --device-id {device_id} --json-patch '{"op":"add", "path":"/thermostat1/targetTemperature", "value": 54}'

通过 JSON 修补程序规范更新数字孪生体。

az iot hub digital-twin update -n {iothub_name} -d {device_id} --json-patch '[
  {"op":"remove", "path":"/thermostat1/targetTemperature"},
  {"op":"add", "path":"/thermostat2/targetTemperature", "value": 22}
]'

通过文件中定义的 JSON 修补程序规范更新数字孪生属性。

az iot hub digital-twin update -n {iothub_name} -d {device_id} --json-patch ./my/patch/document.json

必需参数

--device-id -d

目标设备 ID。

--json-patch --patch

JSON 修补程序描述的更新规范。操作仅限于添加、替换和删除。提供文件路径或内联 JSON。

可选参数

--etag -e

对应于资源最后状态的 Etag 或实体标记。如果未提供 etag，则使用值“*”。

--hub-name -n

IoT 中心名称或主机名。如果未提供 --login，则为必需。

--login -l

--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 iot hub digital-twin

命令

az iot hub digital-twin invoke-command

示例

必需参数

可选参数

az iot hub digital-twin show

示例

必需参数

可选参数

az iot hub digital-twin update

示例

必需参数

可选参数

其他资源