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

DigitalTwinsClient class

包:: @azure/digital-twins

Azure IoT DigitalTwins API 的客户端。

构造函数

DigitalTwinsClient(string, TokenCredential, DigitalTwinsClientOptions)

创建 AzureDigitalTwinsAPI 的实例。

示例用法：

const { DigitalTwinsClient, ServiceClientCredentials } = require("@azure/digital-twins");

const client = new DigitalTwinsClient(
  "<endpoint>",
  new DefaultAzureCredential();
);

方法

createModels(any[], OperationOptions)	创建一个或多个
decomissionModel(string, any[], OperationOptions)	使用 json 修补程序解除模型授权。
deleteDigitalTwin(string, string, OperationOptions)	删除数字孪生体
deleteEventRoute(string, OperationOptions)	删除事件路由。
deleteModel(string, OperationOptions)	删除模型。
deleteRelationship(string, string, string, OperationOptions)	删除数字孪生体上的关系。
getComponent(string, string, OperationOptions)	获取数字孪生体上的组件。
getDigitalTwin(string, OperationOptions)	获取数字孪生体
getEventRoute(string, OperationOptions)	获取事件路由。
getModel(string, boolean, OperationOptions)	获取模型，包括模型元数据和模型定义。
getRelationship(string, string, OperationOptions)	获取数字孪生体上的关系。
listEventRoutes(number)	列出数字孪生实例中的事件路由。
listIncomingRelationships(string, RequestOptionsBase & PageSettings)	检索数字孪生体的所有传入关系。
listModels(string[], boolean, number)	获取模型列表
listRelationships(string, RequestOptionsBase & PageSettings)	检索数字孪生体的关系。
publishComponentTelemetry(string, string, string, string, OperationOptions)	从数字孪生的组件发布遥测数据，然后由定义的一个或多个目标终结点（订阅者）使用。
publishTelemetry(string, any, string, OperationOptions)	从数字孪生体发布遥测数据，然后由定义的一个或多个目标终结点（订阅者）使用。
queryTwins(string)	查询数字孪生体。
updateComponent(string, string, any[], string, OperationOptions)	使用 JSON 修补程序更新数字孪生上的组件的属性。
updateDigitalTwin(string, any, string, OperationOptions)	使用 json 修补程序更新数字孪生体。
updateRelationship(string, string, any[], string, OperationOptions)	使用 JSON 修补程序更新数字孪生体上关系的属性。
upsertDigitalTwin(string, string, OperationOptions)	创建或更新数字孪生体
upsertEventRoute(string, string, string, OperationOptions)	创建或更新事件路由。
upsertRelationship(string, string, any, OperationOptions)	在数字孪生体上创建或更新关系。

构造函数详细信息

DigitalTwinsClient(string, TokenCredential, DigitalTwinsClientOptions)

创建 AzureDigitalTwinsAPI 的实例。

示例用法：

const { DigitalTwinsClient, ServiceClientCredentials } = require("@azure/digital-twins");

const client = new DigitalTwinsClient(
  "<endpoint>",
  new DefaultAzureCredential();
);

new DigitalTwinsClient(endpointUrl: string, credential: TokenCredential, options?: DigitalTwinsClientOptions)

参数

endpointUrl: string

服务的终结点 URL。

credential: TokenCredential

用于对服务的请求进行身份验证。

options: DigitalTwinsClientOptions

用于配置服务客户端。

方法详细信息

createModels(any[], OperationOptions)

创建一个或多个

function createModels(models: any[], options?: OperationOptions): Promise<DigitalTwinModelsAddResponse>

参数

models: any[]

要创建的模型集。每个字符串只对应一个模型。

options: OperationOptions

作选项

Promise<DigitalTwinModelsAddResponse>

创建的应用程序/json 模型和 http 响应。

decomissionModel(string, any[], OperationOptions)

使用 json 修补程序解除模型授权。

function decomissionModel(modelId: string, updateModel: any[], options?: OperationOptions): Promise<RestResponse>

参数

modelId: string

要解除授权的模型的 ID。

updateModel: any[]

JSON 修补程序描述的更新规范。只能更换退役的财产。

options: OperationOptions

作选项

Promise<RestResponse>

http 响应。

deleteDigitalTwin(string, string, OperationOptions)

删除数字孪生体

function deleteDigitalTwin(digitalTwinId: string, etag?: string, options?: OperationOptions): Promise<RestResponse>

参数

digitalTwinId: string

要删除的数字孪生体的 ID。

etag: string

仅当实体的 etag 与提供的 etag 之一匹配或提供 * 时才执行作

options: OperationOptions

作选项

Promise<RestResponse>

http 响应。

deleteEventRoute(string, OperationOptions)

删除事件路由。

function deleteEventRoute(eventRouteId: string, options?: OperationOptions): Promise<RestResponse>

参数

eventRouteId: string

要删除的模型的 ID。

options: OperationOptions

作选项

Promise<RestResponse>

http 响应。

deleteModel(string, OperationOptions)

删除模型。

function deleteModel(modelId: string, options?: OperationOptions): Promise<RestResponse>

参数

modelId: string

要删除的模型的 ID。

options: OperationOptions

作选项

Promise<RestResponse>

http 响应。

deleteRelationship(string, string, string, OperationOptions)

删除数字孪生体上的关系。

function deleteRelationship(digitalTwinId: string, relationshipId: string, etag?: string, options?: OperationOptions): Promise<RestResponse>

参数

digitalTwinId: string

源数字孪生体的 ID。

relationshipId: string

要删除的关系的 ID。

etag: string

仅当实体的 etag 与提供的 etag 之一匹配或 * 是

options: OperationOptions

作选项

Promise<RestResponse>

http 响应。

getComponent(string, string, OperationOptions)

获取数字孪生体上的组件。

function getComponent(digitalTwinId: string, componentPath: string, options?: OperationOptions): Promise<DigitalTwinsGetComponentResponse>

参数

digitalTwinId: string

数字孪生体的 ID。

componentPath: string

正在检索的组件。

options: OperationOptions

作选项

Promise<DigitalTwinsGetComponentResponse>

与提供的 componentPath 和 HTTP 响应相对应的组件的 json 字符串表示形式。

getDigitalTwin(string, OperationOptions)

获取数字孪生体

function getDigitalTwin(digitalTwinId: string, options?: OperationOptions): Promise<DigitalTwinsGetByIdResponse>

参数

digitalTwinId: string

数字孪生体的 ID。

options: OperationOptions

作选项

Promise<DigitalTwinsGetByIdResponse>

application/json 数字孪生体和 http 响应。

getEventRoute(string, OperationOptions)

获取事件路由。

function getEventRoute(eventRouteId: string, options?: OperationOptions): Promise<EventRoutesGetByIdResponse>

参数

eventRouteId: string

options: OperationOptions

作选项

Promise<EventRoutesGetByIdResponse>

application/json 事件路由和 http 响应。

getModel(string, boolean, OperationOptions)

获取模型，包括模型元数据和模型定义。

function getModel(modelId: string, includeModelDefinition?: boolean, options?: OperationOptions): Promise<DigitalTwinModelsGetByIdResponse>

参数

modelId: string

模型的 ID。

includeModelDefinition: boolean

如果为 true，则模型定义将作为结果的一部分返回。默认值：false。

options: OperationOptions

作选项

Promise<DigitalTwinModelsGetByIdResponse>

application/json 模型和 http 响应。

getRelationship(string, string, OperationOptions)

获取数字孪生体上的关系。

function getRelationship(digitalTwinId: string, relationshipId: string, options?: OperationOptions): Promise<DigitalTwinsGetByIdResponse>

参数

digitalTwinId: string

源数字孪生体的 ID。

relationshipId: string

要检索的关系的 ID。

options: OperationOptions

作选项

Promise<DigitalTwinsGetByIdResponse>

属于指定数字孪生体和 http 响应的应用程序/json 关系的可分页列表。

listEventRoutes(number)

列出数字孪生实例中的事件路由。

function listEventRoutes(maxItemCount?: number): PagedAsyncIterableIterator<EventRoute, EventRoutesListNextResponse, PageSettings>

参数

maxItemCount: number

每个请求检索的最大项数。服务器可以选择返回小于所请求的最大值。默认值：-1。

PagedAsyncIterableIterator<EventRoute, EventRoutesListNextResponse, PageSettings>

application/json 事件路由和 http 响应。

listIncomingRelationships(string, RequestOptionsBase & PageSettings)

检索数字孪生体的所有传入关系。

function listIncomingRelationships(digitalTwinId: string, options?: RequestOptionsBase & PageSettings): PagedAsyncIterableIterator<IncomingRelationship, DigitalTwinsListIncomingRelationshipsResponse, PageSettings>

参数

digitalTwinId: string

数字孪生体的 ID。

options: RequestOptionsBase & PageSettings

PagedAsyncIterableIterator<IncomingRelationship, DigitalTwinsListIncomingRelationshipsResponse, PageSettings>

listModels(string[], boolean, number)

获取模型列表

function listModels(dependeciesFor?: string[], includeModelDefinition?: boolean, maxItemCount?: number): PagedAsyncIterableIterator<ModelData, DigitalTwinModelsListResponse, PageSettings>

参数

dependeciesFor: string[]

要检索依赖项的模型 ID。如果省略，将检索所有模型。

includeModelDefinition: boolean

是否在结果中包含模型定义。如果为 false，则仅返回模型元数据。

maxItemCount: number

每个请求检索的最大项数。服务器可以选择返回小于所请求的最大值。默认值：-1。

PagedAsyncIterableIterator<ModelData, DigitalTwinModelsListResponse, PageSettings>

一组可分页的应用程序/json 模型和 http 响应。

listRelationships(string, RequestOptionsBase & PageSettings)

检索数字孪生体的关系。

function listRelationships(digitalTwinId: string, options?: RequestOptionsBase & PageSettings): PagedAsyncIterableIterator<any, DigitalTwinsListRelationshipsResponse, PageSettings>

参数

digitalTwinId: string

数字孪生体的 ID。

options: RequestOptionsBase & PageSettings

PagedAsyncIterableIterator<any, DigitalTwinsListRelationshipsResponse, PageSettings>

publishComponentTelemetry(string, string, string, string, OperationOptions)

从数字孪生的组件发布遥测数据，然后由定义的一个或多个目标终结点（订阅者）使用。

function publishComponentTelemetry(digitalTwinId: string, componentPath: string, payload: string, messageId?: string, options?: OperationOptions): Promise<RestResponse>

参数

digitalTwinId: string

要删除的数字孪生体的 ID。

componentPath: string

DTDL 组件的名称。

payload: string

要发送的应用程序/json 遥测有效负载。

messageId: string

消息 ID。

options: OperationOptions

作选项

Promise<RestResponse>

http 响应。

publishTelemetry(string, any, string, OperationOptions)

从数字孪生体发布遥测数据，然后由定义的一个或多个目标终结点（订阅者）使用。

function publishTelemetry(digitalTwinId: string, payload: any, messageId?: string, options?: OperationOptions): Promise<RestResponse>

参数

digitalTwinId: string

要删除的数字孪生体的 ID。

payload: any

要发送的应用程序/json 遥测有效负载。

messageId: string

消息 ID。

options: OperationOptions

作选项

Promise<RestResponse>

http 响应。

queryTwins(string)

查询数字孪生体。

function queryTwins(query?: string): PagedAsyncIterableIterator<any, QueryQueryTwinsResponse, PageSettings>

参数

query: string

类似于 SQL 的语法中的查询字符串。

PagedAsyncIterableIterator<any, QueryQueryTwinsResponse, PageSettings>

查询结果的可分页列表。

updateComponent(string, string, any[], string, OperationOptions)

使用 JSON 修补程序更新数字孪生上的组件的属性。

function updateComponent(digitalTwinId: string, componentPath: string, componentPatch?: any[], etag?: string, options?: OperationOptions): Promise<DigitalTwinsUpdateComponentResponse>

参数

digitalTwinId: string

数字孪生体的 ID。

componentPath: string

正在更新的组件。

componentPatch: any[]

要在指定的数字孪生组件上执行的 application/json-patch+json作。

etag: string

要更新的组件的 etag。仅当实体的 etag 与提供或 * 之一匹配时，才执行该作。

options: OperationOptions

作选项

Promise<DigitalTwinsUpdateComponentResponse>

http 响应。

updateDigitalTwin(string, any, string, OperationOptions)

使用 json 修补程序更新数字孪生体。

function updateDigitalTwin(digitalTwinId: string, twinPatch: any, etag?: string, options?: OperationOptions): Promise<DigitalTwinsUpdateResponse>

参数

digitalTwinId: string

数字孪生体的 ID。

twinPatch: any

JSON 修补程序描述的更新规范。对属性值和$model元素的更新可能在同一请求中发生。作仅限于添加、替换和删除。

etag: string

仅当实体的 etag 与提供的 etag 之一匹配或提供 * 时才执行作

options: OperationOptions

作选项

Promise<DigitalTwinsUpdateResponse>

http 响应。

updateRelationship(string, string, any[], string, OperationOptions)

使用 JSON 修补程序更新数字孪生体上关系的属性。

function updateRelationship(digitalTwinId: string, relationshipId: string, relationshipPatch: any[], etag?: string, options?: OperationOptions): Promise<DigitalTwinsUpdateRelationshipResponse>

参数

digitalTwinId: string

要删除的数字孪生体的 ID。

relationshipId: string

要更新的关系的 ID。

relationshipPatch: any[]

要对指定的数字孪生关系执行的 application/json-patch+json作。

etag: string

仅当实体的 etag 与提供的 etag 之一匹配或 * 是

options: OperationOptions

提供的作选项

Promise<DigitalTwinsUpdateRelationshipResponse>

upsertDigitalTwin(string, string, OperationOptions)

创建或更新数字孪生体

function upsertDigitalTwin(digitalTwinId: string, digitalTwinJson: string, options?: OperationOptions): Promise<DigitalTwinsAddResponse>

参数

digitalTwinId: string

要创建或更新的数字孪生体的 ID。

digitalTwinJson: string

要创建的应用程序/json 数字孪生体。

options: OperationOptions

作选项

Promise<DigitalTwinsAddResponse>

创建的 application/json 数字孪生体和 http 响应。

upsertEventRoute(string, string, string, OperationOptions)

创建或更新事件路由。

function upsertEventRoute(eventRouteId: string, endpointId: string, filter?: string, options?: OperationOptions): Promise<RestResponse>

参数

eventRouteId: string

要创建或更新的事件路由的 ID。

endpointId: string

此事件路由绑定到的终结点的 ID。

filter: string

一个表达式，描述路由到终结点的事件。

options: OperationOptions

作选项

Promise<RestResponse>

http 响应。

upsertRelationship(string, string, any, OperationOptions)

在数字孪生体上创建或更新关系。

function upsertRelationship(digitalTwinId: string, relationshipId: string, relationship: any, options?: OperationOptions): Promise<DigitalTwinsAddRelationshipResponse>

参数

digitalTwinId: string

源数字孪生体的 ID。

relationshipId: string

要创建的关系的 ID。

relationship: any

options: OperationOptions

作选项

Promise<DigitalTwinsAddRelationshipResponse>

反馈

此页面是否有帮助？