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

az iot central device twin

参考

注意

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

管理 IoT Central 设备孪生。

命令

名称	说明	类型	Status
az iot central device twin replace	替换设备、设备组件或设备模块或设备模块组件的可写属性值。	扩展	GA
az iot central device twin show	获取设备、设备组件、设备模块或设备模块组件的所有属性值。	扩展	GA
az iot central device twin update	更新设备、设备组件、设备模块或设备模块组件的可写属性值。	扩展	GA

az iot central device twin replace

替换设备、设备组件或设备模块或设备模块组件的可写属性值。

提供 --component-name、--module-name 或两者来替换设备组件属性、设备模块属性或设备模块组件属性。

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

示例

替换设备属性

az iot central device twin replace --app-id {appid} --device-id {deviceid} -k {content}

替换设备组件属性

az iot central device twin replace --app-id {appid} --device-id {deviceid} --co {componentname} -k {content}

替换设备模块组件属性

az iot central device twin replace --app-id {appid} --device-id {deviceid} --mn {modulename} --co {componentname} -k {content}

必需参数

--app-id -n

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

--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

设备组件的名称。

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

获取设备、设备组件、设备模块或设备模块组件的所有属性值。

提供 --component-name、--module-name 或两者以获取设备组件属性、设备模块属性或设备模块组件属性。

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

示例

获取设备属性

az iot central device twin show --app-id {appid} --device-id {deviceid}

获取设备组件属性

az iot central device twin show --app-id {appid} --device-id {deviceid} --co {componentname}

获取设备模块组件属性

az iot central device twin show --app-id {appid} --device-id {deviceid} --mn {modulename} --co {componentname}

必需参数

--app-id -n

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

--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

设备组件的名称。

--mn --module-name

设备模块的名称。

--token

全局参数

--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 twin update

更新设备、设备组件、设备模块或设备模块组件的可写属性值。

提供 --component-name、--module-name 或两者来更新设备组件属性、设备模块属性或设备模块组件属性。

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

示例

更新设备属性

az iot central device twin update --app-id {appid} --device-id {deviceid} -k {content}

更新设备组件属性

az iot central device twin update --app-id {appid} --device-id {deviceid} --co {componentname} -k {content}

更新设备模块组件属性

az iot central device twin update --app-id {appid} --device-id {deviceid} --mn {modulename} --co {componentname} -k {content}

必需参数

--app-id -n

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

--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

设备组件的名称。

--mn --module-name

设备模块的名称。

--token

全局参数

--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 twin

命令

az iot central device twin replace

示例

必需参数

可选参数

az iot central device twin show

示例

必需参数

可选参数

az iot central device twin update

示例

必需参数

可选参数

其他资源