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

DigitalTwinClient 类

一个类，用于基于自动生成的 IotHub REST API 为 DigitalTwin 操作提供方便的 API

DigitalTwinClient 的初始值设定项。

成功创建后，该类已通过 IoTHub 进行身份验证，并已准备好调用成员 API 以与 IoTHub 通信。

继承

builtins.object

DigitalTwinClient

构造函数

DigitalTwinClient(connection_string=None, host=None, auth=None)

参数

名称	说明
connection_string	str 如果使用connection_str身份验证，则用于对与 IoTHub 的连接进行身份验证的 IoTHub 连接字符串。 默认值： 无 默认值: None
host	str 如果使用的是令牌凭据身份验证，则为 Azure 服务 URL。 默认值： 无 默认值: None
auth	str 如果使用的是令牌凭据身份验证，则为 Azure 身份验证对象。 默认值： 无 默认值: None

方法

from_connection_string	DigitalTwinClient 服务客户端的类方法初始值设定项。 从连接字符串创建 DigitalTwinClient 类。 成功创建后，该类已通过 IoTHub 进行身份验证，并已准备好调用成员 API 以与 IoTHub 通信。
from_token_credential	DigitalTwinClient 服务客户端的类方法初始值设定项。 从主机名 URL 和 Azure 令牌凭据创建 DigitalTwinClient 类。 成功创建后，该类已通过 IoTHub 进行身份验证，并已准备好调用成员 API 以与 IoTHub 通信。
get_digital_twin	检索给定设备的数字孪生。 :p aram str digital_twin__id：给定设备的数字孪生 ID。
invoke_command	在特定设备上调用命令并获取其结果。 :p aram str digital_twin__id：给定设备的数字孪生 ID。 :p aram str command_name：命令的名称。 :p aram str 有效负载：命令的参数。 :p aram int connect_timeout_in_seconds：数字孪生命令等待答案的最大时间间隔（以秒为单位）。 :p aram int response_timeout_in_seconds：数字孪生命令等待响应的最大时间间隔（以秒为单位）。 该值必须位于 5-300 范围内。
invoke_component_command	在特定设备的组件上调用命令并获取其结果。 :p aram str digital_twin__id：给定设备的数字孪生 ID。 :p aram str component_path：组件的名称。 :p aram str command_name：命令的名称。 :p aram str 有效负载：命令的参数。 :p aram int connect_timeout_in_seconds：数字孪生命令等待答案的最大时间间隔（以秒为单位）。 :p aram int response_timeout_in_seconds：数字孪生命令等待响应的最大时间间隔（以秒为单位）。 该值必须位于 5-300 范围内。 ：type response_timeout_in_seconds： int
update_digital_twin	使用修补程序对象更新给定设备的数字孪生组件。 :p aram str digital_twin__id：给定设备的数字孪生 ID。 :p aram list[object]：用于更新数字孪生的 json 补丁对象。 :p aram str etag：用于更新操作的 etag (if_match) 值。

from_connection_string

DigitalTwinClient 服务客户端的类方法初始值设定项。 从连接字符串创建 DigitalTwinClient 类。

成功创建后，该类已通过 IoTHub 进行身份验证，并已准备好调用成员 API 以与 IoTHub 通信。

from_connection_string(connection_string)

参数

名称	说明
connection_string 必需	str 用于对 IoTHub 的连接进行身份验证的 IoTHub 连接字符串。

返回

类型	说明
DigitalTwinClient

from_token_credential

DigitalTwinClient 服务客户端的类方法初始值设定项。 从主机名 URL 和 Azure 令牌凭据创建 DigitalTwinClient 类。

成功创建后，该类已通过 IoTHub 进行身份验证，并已准备好调用成员 API 以与 IoTHub 通信。

from_token_credential(url, token_credential)

参数

名称	说明
url 必需	str azure 服务 URL (主机名) 。
token_credential 必需	<xref:azure.core.TokenCredential> Azure 令牌凭据对象

返回

类型	说明
DigitalTwinClient

get_digital_twin

检索给定设备的数字孪生。 :p aram str digital_twin__id：给定设备的数字孪生 ID。

get_digital_twin(digital_twin_id)

参数

名称	说明
digital_twin_id 必需

返回

类型	说明
	包含数字孪生的返回对象。

例外

类型	说明
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

invoke_command

在特定设备上调用命令并获取其结果。 :p aram str digital_twin__id：给定设备的数字孪生 ID。 :p aram str command_name：命令的名称。 :p aram str 有效负载：命令的参数。 :p aram int connect_timeout_in_seconds：数字孪生命令等待答案的最大时间间隔（以秒为单位）。 :p aram int response_timeout_in_seconds：数字孪生命令等待响应的最大时间间隔（以秒为单位）。 该值必须位于 5-300 范围内。

invoke_command(digital_twin_id, command_name, payload, connect_timeout_in_seconds=None, response_timeout_in_seconds=None)

参数

名称	说明
digital_twin_id 必需
command_name 必需
payload 必需
connect_timeout_in_seconds	默认值: None
response_timeout_in_seconds	默认值: None

返回

类型	说明
	调用的命令的结果。

例外

类型	说明
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

invoke_component_command

在特定设备的组件上调用命令并获取其结果。 :p aram str digital_twin__id：给定设备的数字孪生 ID。 :p aram str component_path：组件的名称。 :p aram str command_name：命令的名称。 :p aram str 有效负载：命令的参数。 :p aram int connect_timeout_in_seconds：数字孪生命令等待答案的最大时间间隔（以秒为单位）。 :p aram int response_timeout_in_seconds：数字孪生命令等待响应的最大时间间隔（以秒为单位）。 该值必须位于 5-300 范围内。 ：type response_timeout_in_seconds： int

invoke_component_command(digital_twin_id, component_path, command_name, payload, connect_timeout_in_seconds=None, response_timeout_in_seconds=None)

参数

名称	说明
digital_twin_id 必需
component_path 必需
command_name 必需
payload 必需
connect_timeout_in_seconds	默认值: None
response_timeout_in_seconds	默认值: None

返回

类型	说明
	调用的命令的结果。

例外

类型	说明
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

update_digital_twin

使用修补程序对象更新给定设备的数字孪生组件。 :p aram str digital_twin__id：给定设备的数字孪生 ID。 :p aram list[object]：用于更新数字孪生的 json 补丁对象。 :p aram str etag：用于更新操作的 etag (if_match) 值。

update_digital_twin(digital_twin_id, digital_twin_patch, etag=None)

参数

名称	说明
digital_twin_id 必需
digital_twin_patch 必需
etag	默认值: None

返回

类型	说明
	包含更新的数字孪生的返回对象。

例外

类型	说明
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>