通过

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

DigitalTwinClient class

  • 参考
包:
azure-iothub

构造函数

DigitalTwinClient(IoTHubTokenCredentials)

构造函数，该构造函数还创建 DigitalTwinClient 使用的协议层客户端的实例。

方法

getDigitalTwin(string)

检索给定设备的数字孪生。
getDigitalTwin(string, TripleValueCallback<DigitalTwin, HttpOperationResponse>)
invokeCommand(string, string, any, DigitalTwinInvokeRootLevelCommandOptionalParams)

在特定设备的组件上调用命令并获取其结果。
invokeComponentCommand(string, string, string, any, DigitalTwinInvokeComponentCommandOptionalParams)

在特定设备的组件上调用命令并获取其结果。
updateDigitalTwin(string, any[], string | TripleValueCallback<void, HttpOperationResponse>, TripleValueCallback<void, HttpOperationResponse>)
updateDigitalTwin(string, any[], string)

使用修补程序对象更新给定设备的数字孪生。

构造函数详细信息

DigitalTwinClient(IoTHubTokenCredentials)

构造函数，该构造函数还创建 DigitalTwinClient 使用的协议层客户端的实例。

new DigitalTwinClient(creds: IoTHubTokenCredentials)

参数

creds
IoTHubTokenCredentials

用于创建协议层客户端的 IoTHub 令牌凭据。

方法详细信息

getDigitalTwin(string)

检索给定设备的数字孪生。

function getDigitalTwin(digitalTwinId: string): Promise<DigitalTwinResponse>

参数

digitalTwinId

string

给定设备或模块的数字孪生 ID。 digitalTwinId 的格式为 DeviceId[~ModuleId]。 ModuleId 是可选的。

返回

Promise<DigitalTwinResponse>

DigitalTwinResponse 包含数字孪生和 HttpResponse 的返回对象。

getDigitalTwin(string, TripleValueCallback<DigitalTwin, HttpOperationResponse>) 

function getDigitalTwin(digitalTwinId: string, callback: TripleValueCallback<DigitalTwin, HttpOperationResponse>)

参数

digitalTwinId

string

callback

TripleValueCallback<DigitalTwin, HttpOperationResponse>

invokeCommand(string, string, any, DigitalTwinInvokeRootLevelCommandOptionalParams)

在特定设备的组件上调用命令并获取其结果。

function invokeCommand(digitalTwinId: string, commandName: string, argument: any, options?: DigitalTwinInvokeRootLevelCommandOptionalParams): Promise<DigitalTwinInvokeRootLevelCommandResponse>

参数

digitalTwinId

string

给定设备的数字孪生 ID。

commandName

string

argument

any

命令的参数。

options

DigitalTwinInvokeRootLevelCommandOptionalParams

用于设置选项的可选参数，包括 connectionTimeoutInSeconds 和 responseTimeoutInSeconds。 responseTimeoutInSeconds 必须位于 [5; 300] 内

返回

Promise<DigitalTwinInvokeRootLevelCommandResponse>

DigitalTwinInvokeRootLevelCommandResponse 已调用的命令的结果，其中包含结果、状态代码、请求 ID 和已分析的 HttpResponse。

invokeComponentCommand(string, string, string, any, DigitalTwinInvokeComponentCommandOptionalParams)

在特定设备的组件上调用命令并获取其结果。

function invokeComponentCommand(digitalTwinId: string, componentName: string, commandName: string, argument: any, options?: DigitalTwinInvokeComponentCommandOptionalParams): Promise<DigitalTwinInvokeComponentCommandResponse>

参数

digitalTwinId

string

给定设备的数字孪生 ID。

componentName

string

组件的名称。

commandName

string

命令的名称。

argument

any

命令的参数。

options

DigitalTwinInvokeComponentCommandOptionalParams

用于设置选项的可选参数，包括 connectionTimeoutInSeconds 和 responseTimeoutInSeconds。 responseTimeoutInSeconds 必须位于 [5; 300] 内

返回

Promise<DigitalTwinInvokeComponentCommandResponse>

DigitalTwinInvokeComponentCommandResponse 包含结果、状态代码、请求 ID 和已分析的 HttpResponse 的已调用命令的结果。

updateDigitalTwin(string, any[], string | TripleValueCallback<void, HttpOperationResponse>, TripleValueCallback<void, HttpOperationResponse>) 

function updateDigitalTwin(digitalTwinId: string, patch: any[], eTagOrCallback?: string | TripleValueCallback<void, HttpOperationResponse>, callback?: TripleValueCallback<void, HttpOperationResponse>)

参数

digitalTwinId

string

patch

any[]

eTagOrCallback

string | TripleValueCallback<void, HttpOperationResponse>

callback

TripleValueCallback<void, HttpOperationResponse>

updateDigitalTwin(string, any[], string)

使用修补程序对象更新给定设备的数字孪生。

function updateDigitalTwin(digitalTwinId: string, patch: any[], eTag?: string): Promise<DigitalTwinUpdateResponse>

参数

digitalTwinId

string

给定设备的数字孪生 ID。

patch

any[]

修补程序 objet 包含数字孪生的更新部分。

eTag

string

用于标识修补程序的 eTag。

返回

Promise<DigitalTwinUpdateResponse>

DigitalTwinUpdateResponse The HTTPesponse.