你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
DigitalTwinsClient class
Azure IoT DigitalTwins API 的客户端。
构造函数
| Digital |
创建 AzureDigitalTwinsAPI 的实例。 用法示例： |
方法
构造函数详细信息
DigitalTwinsClient(string, TokenCredential, DigitalTwinsClientOptions)
创建 AzureDigitalTwinsAPI 的实例。
用法示例：
const { DigitalTwinsClient, ServiceClientCredentials } = require("@azure/digital-twins-core");
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(dtdlModels: any[], options?: OperationOptions): Promise<DigitalTwinModelsAddResponse>参数
- dtdlModels
-
any[]
- options
- OperationOptions
操作选项
返回
Promise<DigitalTwinModelsAddResponse>
创建的应用程序/json 模型和 http 响应。
decomissionModel(string, OperationOptions)
使用 json 修补程序解除模型授权。 解除模型授权后，新的数字孪生体将无法再由此模型定义。 但是，现有数字孪生体可能继续使用此模型。 模型停用后，可能无法重新授权。
function decomissionModel(modelId: string, options?: OperationOptions): Promise<RestResponse>参数
- modelId
-
string
要解除授权的模型的 ID。 属性可以替换。
- options
- OperationOptions
操作选项
返回
Promise<RestResponse>
http 响应。
deleteDigitalTwin(string, DigitalTwinsDeleteOptionalParams)
删除数字孪生体
function deleteDigitalTwin(digitalTwinId: string, options?: DigitalTwinsDeleteOptionalParams): Promise<RestResponse>参数
- digitalTwinId
-
string
要删除的数字孪生体的 ID。
- options
- DigitalTwinsDeleteOptionalParams
扩展的操作选项（包括 ifMatch）：仅当实体的 etag 与提供的 etag 之一匹配或提供 * 时才执行该操作。
返回
Promise<RestResponse>
http 响应。
deleteEventRoute(string, OperationOptions)
删除事件路由。
function deleteEventRoute(eventRouteId: string, options?: OperationOptions): Promise<RestResponse>参数
- eventRouteId
-
string
要删除的 eventRoute 的 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, DigitalTwinsDeleteRelationshipOptionalParams)
删除数字孪生体上的关系。
function deleteRelationship(digitalTwinId: string, relationshipId: string, options?: DigitalTwinsDeleteRelationshipOptionalParams): Promise<RestResponse>参数
- digitalTwinId
-
string
源数字孪生体的 ID。
- relationshipId
-
string
要删除的关系的 ID。
操作选项 ifMatch：仅当实体的 etag 与提供的 etag 之一匹配或 * 为 时才执行操作
返回
Promise<RestResponse>
http 响应。
getComponent(string, string, OperationOptions)
获取数字孪生体的组件。
function getComponent(digitalTwinId: string, componentName: string, options?: OperationOptions): Promise<DigitalTwinsGetComponentResponse>参数
- digitalTwinId
-
string
数字孪生体的 ID。
- componentName
-
string
正在检索的组件。
- options
- OperationOptions
操作选项
返回
Promise<DigitalTwinsGetComponentResponse>
对应于提供的 componentName 和 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
- options
- OperationOptions
扩展的操作选项包括 includeModelDefinition：如果为 true，则模型定义将作为结果的一部分返回。 默认值：false。
返回
Promise<DigitalTwinModelsGetByIdResponse>
application/json 模型和 http 响应。
getRelationship(string, string, OperationOptions)
在数字孪生体上获取关系。
function getRelationship(digitalTwinId: string, relationshipId: string, options?: OperationOptions): Promise<DigitalTwinsGetRelationshipByIdResponse>参数
- digitalTwinId
-
string
源数字孪生体的 ID。
- relationshipId
-
string
要检索的关系的 ID。
- options
- OperationOptions
操作选项
返回
属于指定数字孪生体和 http 响应的应用程序/json 关系的可分页列表。
listEventRoutes(number, OperationOptions & PageSettings)
列出数字孪生实例中的事件路由。
function listEventRoutes(resultsPerPage?: number, options?: OperationOptions & PageSettings): PagedAsyncIterableIterator<EventRoute, EventRoutesListNextResponse, PageSettings>参数
- resultsPerPage
-
number
每个请求要检索的最大项数。 服务器可以选择返回小于请求的最大值。
- options
返回
application/json 事件路由和 http 响应。
listIncomingRelationships(string, OperationOptions & PageSettings)
检索数字孪生体的所有传入关系。
function listIncomingRelationships(digitalTwinId: string, options?: OperationOptions & PageSettings): PagedAsyncIterableIterator<IncomingRelationship, DigitalTwinsListIncomingRelationshipsResponse, PageSettings>参数
- digitalTwinId
-
string
数字孪生体的 ID。
- options
返回
listModels(string[], boolean, number, OperationOptions & PageSettings)
获取模型列表
function listModels(dependeciesFor?: string[], includeModelDefinition?: boolean, resultsPerPage?: number, options?: OperationOptions & PageSettings): PagedAsyncIterableIterator<DigitalTwinsModelData, DigitalTwinModelsListResponse, PageSettings>参数
- dependeciesFor
-
string[]
要检索依赖项的模型 ID。 如果省略，则检索所有模型。
- includeModelDefinition
-
boolean
是否在结果中包含模型定义。 如果为 false，则仅返回模型元数据。
- resultsPerPage
-
number
每个请求要检索的最大项数。 服务器可以选择返回小于请求的最大值。
- options
返回
一组可分页的应用程序/json 模型和 http 响应。
listRelationships(string, OperationOptions & PageSettings)
检索数字孪生体的关系。
function listRelationships(digitalTwinId: string, options?: OperationOptions & PageSettings): PagedAsyncIterableIterator<any, DigitalTwinsListRelationshipsResponse, PageSettings>参数
- digitalTwinId
-
string
数字孪生体的 ID。
- options
返回
publishComponentTelemetry(string, string, string, string, OperationOptions)
发布来自数字孪生组件的遥测数据，然后由一个或多个目标终结点使用， () 定义订阅者。
function publishComponentTelemetry(digitalTwinId: string, componentName: string, payload: string, messageId: string, options?: OperationOptions): Promise<RestResponse>参数
- digitalTwinId
-
string
要删除的数字孪生体的 ID。
- componentName
-
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, number, OperationOptions & PageSettings)
查询数字孪生体。
function queryTwins(query: string, resultsPerPage?: number, options?: OperationOptions & PageSettings): PagedAsyncIterableIterator<any, QueryQueryTwinsResponse, PageSettings>参数
- query
-
string
查询字符串，使用类似于 SQL 的语法。
- resultsPerPage
-
number
每个请求要检索的最大项数。 服务器可以选择返回小于请求的最大值。
- options
返回
查询结果的可分页列表。
updateComponent(string, string, any[], DigitalTwinsUpdateComponentOptionalParams)
使用 JSON 修补程序更新数字孪生体上的组件属性。
function updateComponent(digitalTwinId: string, componentName: string, jsonPatch: any[], options?: DigitalTwinsUpdateComponentOptionalParams): Promise<DigitalTwinsUpdateComponentResponse>参数
- digitalTwinId
-
string
数字孪生体的 ID。
- componentName
-
string
正在更新的组件。
- jsonPatch
-
any[]
要对指定数字孪生体的组件执行的 application/json-patch+json 操作。
扩展的操作选项（包括 ifMatch）：仅当实体的 etag 与提供的 etag 之一匹配或提供 * 时才执行该操作。
返回
Promise<DigitalTwinsUpdateComponentResponse>
http 响应。
updateDigitalTwin(string, any, DigitalTwinsUpdateOptionalParams)
使用 json 修补程序更新数字孪生体。
function updateDigitalTwin(digitalTwinId: string, jsonPatch: any, options?: DigitalTwinsUpdateOptionalParams): Promise<DigitalTwinsUpdateResponse>参数
- digitalTwinId
-
string
数字孪生体的 ID。
- jsonPatch
-
any
JSON 修补程序描述的更新规范。 汇报属性值和$model元素可能发生在同一请求中。 操作仅限于添加、替换和删除。
- options
- DigitalTwinsUpdateOptionalParams
扩展的操作选项（包括 ifMatch）：仅当实体的 etag 与提供的 etag 之一匹配或提供 * 时才执行该操作。
返回
Promise<DigitalTwinsUpdateResponse>
http 响应。
updateRelationship(string, string, any[], DigitalTwinsUpdateRelationshipOptionalParams)
使用 JSON 修补程序汇报数字孪生体上关系的属性。
function updateRelationship(digitalTwinId: string, relationshipId: string, jsonPatch: any[], options?: DigitalTwinsUpdateRelationshipOptionalParams): Promise<DigitalTwinsUpdateRelationshipResponse>参数
- digitalTwinId
-
string
要删除的数字孪生体的 ID。
- relationshipId
-
string
要更新的关系的 ID。
- jsonPatch
-
any[]
要对指定数字孪生体的关系执行的 application/json-patch+json 操作。
扩展的操作选项 ifMatch：仅当实体的 etag 与提供的 etag 之一匹配或提供 * 时才执行操作。
返回
upsertDigitalTwin(string, string, DigitalTwinsAddOptionalParams)
创建或更新数字孪生体
function upsertDigitalTwin(digitalTwinId: string, digitalTwinJson: string, options?: DigitalTwinsAddOptionalParams): Promise<DigitalTwinsAddResponse>参数
- digitalTwinId
-
string
要创建或更新的数字孪生体的 ID。
- digitalTwinJson
-
string
要创建的应用程序/json 数字孪生体。
- options
- DigitalTwinsAddOptionalParams
扩展的操作选项包括 ifNoneMatch：仅当实体尚不存在时才执行该操作。
返回
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, DigitalTwinsAddRelationshipOptionalParams)
在数字孪生体上创建或更新关系。
function upsertRelationship(digitalTwinId: string, relationshipId: string, relationship: any, options?: DigitalTwinsAddRelationshipOptionalParams): Promise<DigitalTwinsAddRelationshipResponse>参数
- digitalTwinId
-
string
源数字孪生体的 ID。
- relationshipId
-
string
要创建的关系的 ID。
- relationship
-
any
要创建的 application/json 关系。
扩展的操作选项包括 ifNoneMatch：仅当实体尚不存在时才执行该操作。
返回
Promise<DigitalTwinsAddRelationshipResponse>