DigitalTwinsClient class
Azure IoT DigitalTwins API 的客户端。
构造函数
| Digital |
创建 AzureDigitalTwinsAPI 的实例。 示例用法： |
方法
构造函数详细信息
DigitalTwinsClient(string, TokenCredential, DigitalTwinsClientOptions)
创建 AzureDigitalTwinsAPI 的实例。
示例用法：
import { DefaultAzureCredential } from "@azure/identity";
import { DigitalTwinsClient } from "@azure/digital-twins-core";
const url = "<URL to Azure Digital Twins instance>";
const credential = new DefaultAzureCredential();
const serviceClient = new DigitalTwinsClient(url, credential);
new DigitalTwinsClient(endpointUrl: string, credential: TokenCredential, options?: DigitalTwinsClientOptions)参数
- endpointUrl
-
string
服务的终结点 URL。
- credential
- TokenCredential
用于对服务的请求进行身份验证。
- options
- DigitalTwinsClientOptions
用于配置服务客户端。
方法详细信息
createModels(Record<string, unknown>[], OperationOptions)
创建一个或多个
function createModels(dtdlModels: Record<string, unknown>[], options?: OperationOptions): Promise<DigitalTwinModelsAddResponse>参数
- dtdlModels
-
Record<string, unknown>[]
要创建的模型集。 每个字符串只对应一个模型。
- options
- OperationOptions
作选项
返回
Promise<DigitalTwinModelsAddResponse>
创建的 application/json 模型。
decomissionModel(string, OperationOptions)
使用 json 修补程序解除模型授权。 当模型停用时，新的数字孪生体将无法再由此模型定义。 但是，现有的数字孪生体可能继续使用此模型。 解除模型授权后，它可能不会重新授权。
function decomissionModel(modelId: string, options?: OperationOptions): Promise<void>参数
- modelId
-
string
要解除授权的模型的 ID。 可以替换属性。
- options
- OperationOptions
作选项
返回
Promise<void>
deleteDigitalTwin(string, DigitalTwinsDeleteOptionalParams)
删除数字孪生体
function deleteDigitalTwin(digitalTwinId: string, options?: DigitalTwinsDeleteOptionalParams): Promise<void>参数
- digitalTwinId
-
string
要删除的数字孪生体的 ID。
- options
- DigitalTwinsDeleteOptionalParams
扩展作选项（包括 ifMatch：仅当实体的 etag 与提供或 * 之一匹配时执行该作）。
返回
Promise<void>
deleteEventRoute(string, OperationOptions)
删除事件路由。
function deleteEventRoute(eventRouteId: string, options?: OperationOptions): Promise<void>参数
- eventRouteId
-
string
要删除的事件路由的 ID。
- options
- OperationOptions
作选项
返回
Promise<void>
deleteModel(string, OperationOptions)
删除模型。
function deleteModel(modelId: string, options?: OperationOptions): Promise<void>参数
- modelId
-
string
要删除的模型的 ID。
- options
- OperationOptions
作选项
返回
Promise<void>
deleteRelationship(string, string, DigitalTwinsDeleteRelationshipOptionalParams)
删除数字孪生体上的关系。
function deleteRelationship(digitalTwinId: string, relationshipId: string, options?: DigitalTwinsDeleteRelationshipOptionalParams): Promise<void>参数
- digitalTwinId
-
string
源数字孪生体的 ID。
- relationshipId
-
string
要删除的关系的 ID。
ifMatch 的作选项：仅当实体的 etag 与提供的 etag 之一匹配或 * 为
返回
Promise<void>
getComponent(string, string, OperationOptions)
获取数字孪生体上的组件。
function getComponent(digitalTwinId: string, componentName: string, options?: OperationOptions): Promise<DigitalTwinsGetComponentResponse>参数
- digitalTwinId
-
string
数字孪生体的 ID。
- componentName
-
string
正在检索的组件。
- options
- OperationOptions
作选项
返回
Promise<DigitalTwinsGetComponentResponse>
与提供的 componentName 对应的组件的 Json 字符串表示形式。
getDigitalTwin(string, OperationOptions)
获取数字孪生体
function getDigitalTwin(digitalTwinId: string, options?: OperationOptions): Promise<DigitalTwinsGetByIdResponse>参数
- digitalTwinId
-
string
数字孪生体的 ID。
- options
- OperationOptions
作选项
返回
Promise<DigitalTwinsGetByIdResponse>
application/json 数字孪生体。
getEventRoute(string, OperationOptions)
获取事件路由。
function getEventRoute(eventRouteId: string, options?: OperationOptions): Promise<EventRoute>参数
- eventRouteId
-
string
- options
- OperationOptions
作选项
返回
Promise<EventRoute>
application/json 事件路由。
getModel(string, DigitalTwinModelsGetByIdOptionalParams)
获取模型，包括模型元数据和模型定义。
function getModel(modelId: string, options?: DigitalTwinModelsGetByIdOptionalParams): Promise<DigitalTwinsModelData>参数
- modelId
-
string
模型的 ID。
- options
- GetModelOptions
此作的选项
返回
Promise<DigitalTwinsModelData>
application/json 模型。
getRelationship(string, string, OperationOptions)
获取数字孪生体上的关系。
function getRelationship(digitalTwinId: string, relationshipId: string, options?: OperationOptions): Promise<DigitalTwinsGetRelationshipByIdResponse>参数
- digitalTwinId
-
string
源数字孪生体的 ID。
- relationshipId
-
string
要检索的关系的 ID。
- options
- OperationOptions
作选项
返回
属于指定数字孪生体的 application/json 关系的可分页列表。
listEventRoutes(EventRoutesListOptionalParams)
列出数字孪生实例中的事件路由。
function listEventRoutes(options?: EventRoutesListOptionalParams): PagedAsyncIterableIterator<EventRoute, EventRoute[], PageSettings>参数
- options
- ListEventRoutesOptions
listEventRoutes 的选项。
返回
application/json 事件路由。
listIncomingRelationships(string, DigitalTwinsListIncomingRelationshipsOptionalParams)
检索数字孪生体的所有传入关系。
function listIncomingRelationships(digitalTwinId: string, options?: DigitalTwinsListIncomingRelationshipsOptionalParams): PagedAsyncIterableIterator<IncomingRelationship, IncomingRelationship[], PageSettings>参数
- digitalTwinId
-
string
数字孪生体的 ID。
- options
- ListIncomingRelationshipsOptions
返回
listModels(DigitalTwinModelsListOptionalParams)
获取模型列表
function listModels(options?: DigitalTwinModelsListOptionalParams): PagedAsyncIterableIterator<DigitalTwinsModelData, DigitalTwinsModelData[], PageSettings>参数
- options
- ListModelsOptions
用于列出模型的选项。
返回
一组可分页的 application/json 模型。
listRelationships(string, DigitalTwinsListRelationshipsOptionalParams)
检索数字孪生体的关系。
function listRelationships(digitalTwinId: string, options?: DigitalTwinsListRelationshipsOptionalParams): PagedAsyncIterableIterator<Record<string, unknown>, Record<string, unknown>[], PageSettings>参数
- digitalTwinId
-
string
数字孪生体的 ID。
- options
- ListRelationshipsOptions
返回
PagedAsyncIterableIterator<Record<string, unknown>, Record<string, unknown>[], PageSettings>
publishComponentTelemetry(string, string, Record<string, unknown>, string, OperationOptions)
从数字孪生的组件发布遥测数据，然后由定义的一个或多个目标终结点（订阅者）使用。
function publishComponentTelemetry(digitalTwinId: string, componentName: string, payload: Record<string, unknown>, messageId: string, options?: OperationOptions): Promise<void>参数
- digitalTwinId
-
string
要删除的数字孪生体的 ID。
- componentName
-
string
DTDL 组件的名称。
- payload
-
Record<string, unknown>
要发送的应用程序/json 遥测有效负载。
- messageId
-
string
消息 ID。
- options
- OperationOptions
作选项
返回
Promise<void>
publishTelemetry(string, Record<string, unknown>, string, OperationOptions)
从数字孪生体发布遥测数据，然后由定义的一个或多个目标终结点（订阅者）使用。
function publishTelemetry(digitalTwinId: string, payload: Record<string, unknown>, messageId: string, options?: OperationOptions): Promise<void>参数
- digitalTwinId
-
string
要删除的数字孪生体的 ID。
- payload
-
Record<string, unknown>
要发送的应用程序/json 遥测有效负载。
- messageId
-
string
消息 ID。
- options
- OperationOptions
作选项
返回
Promise<void>
queryTwins(string, QueryQueryTwinsOptionalParams)
查询数字孪生体。
function queryTwins(query: string, options?: QueryQueryTwinsOptionalParams): PagedAsyncIterableIterator<Record<string, unknown>, QueryQueryTwinsResponse, PageSettings>参数
- query
-
string
类似于 SQL 的语法中的查询字符串。
- options
- QueryTwinsOptions
查询作的选项。
返回
PagedAsyncIterableIterator<Record<string, unknown>, QueryQueryTwinsResponse, PageSettings>
查询结果的可分页列表。
updateComponent(string, string, Record<string, unknown>[], DigitalTwinsUpdateComponentOptionalParams)
使用 JSON 修补程序更新数字孪生上的组件的属性。
function updateComponent(digitalTwinId: string, componentName: string, jsonPatch: Record<string, unknown>[], options?: DigitalTwinsUpdateComponentOptionalParams): Promise<DigitalTwinsUpdateComponentHeaders>参数
- digitalTwinId
-
string
数字孪生体的 ID。
- componentName
-
string
正在更新的组件。
- jsonPatch
-
Record<string, unknown>[]
要在指定的数字孪生组件上执行的 application/json-patch+json作。
扩展作选项（包括 ifMatch：仅当实体的 etag 与提供或 * 之一匹配时执行该作）。
返回
Promise<DigitalTwinsUpdateComponentHeaders>
updateDigitalTwin(string, Record<string, unknown>[], DigitalTwinsUpdateOptionalParams)
使用 json 修补程序更新数字孪生体。
function updateDigitalTwin(digitalTwinId: string, jsonPatch: Record<string, unknown>[], options?: DigitalTwinsUpdateOptionalParams): Promise<DigitalTwinsUpdateHeaders>参数
- digitalTwinId
-
string
数字孪生体的 ID。
- jsonPatch
-
Record<string, unknown>[]
JSON 修补程序描述的更新规范。 对属性值和$model元素的更新可能在同一请求中发生。 作仅限于添加、替换和删除。
- options
- DigitalTwinsUpdateOptionalParams
扩展作选项（包括 ifMatch：仅当实体的 etag 与提供或 * 之一匹配时执行该作）。
返回
Promise<DigitalTwinsUpdateHeaders>
updateRelationship(string, string, Record<string, unknown>[], DigitalTwinsUpdateRelationshipOptionalParams)
使用 JSON 修补程序更新数字孪生体上关系的属性。
function updateRelationship(digitalTwinId: string, relationshipId: string, jsonPatch: Record<string, unknown>[], options?: DigitalTwinsUpdateRelationshipOptionalParams): Promise<DigitalTwinsUpdateRelationshipHeaders>参数
- digitalTwinId
-
string
要删除的数字孪生体的 ID。
- relationshipId
-
string
要更新的关系的 ID。
- jsonPatch
-
Record<string, unknown>[]
要对指定的数字孪生关系执行的 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 数字孪生体。
upsertEventRoute(string, string, string, OperationOptions)
创建或更新事件路由。
function upsertEventRoute(eventRouteId: string, endpointId: string, filter: string, options?: OperationOptions): Promise<void>参数
- eventRouteId
-
string
要创建或更新的事件路由的 ID。
- endpointId
-
string
此事件路由绑定到的终结点的 ID。
- filter
-
string
一个表达式，描述路由到终结点的事件。
- options
- OperationOptions
作选项
返回
Promise<void>
upsertRelationship(string, string, Record<string, unknown>, DigitalTwinsAddRelationshipOptionalParams)
在数字孪生体上创建或更新关系。
function upsertRelationship(digitalTwinId: string, relationshipId: string, relationship: Record<string, unknown>, options?: DigitalTwinsAddRelationshipOptionalParams): Promise<DigitalTwinsAddRelationshipResponse>参数
- digitalTwinId
-
string
源数字孪生体的 ID。
- relationshipId
-
string
要创建的关系的 ID。
- relationship
-
Record<string, unknown>
要创建的应用程序/json 关系。
扩展作选项，包括 ifNoneMatch：仅当实体尚不存在时执行该作。
返回
Promise<DigitalTwinsAddRelationshipResponse>