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
要解除委任之模型的標識碼。 屬性可以取代。
- options
- OperationOptions
作業選項
傳回
Promise<void>
deleteDigitalTwin(string, DigitalTwinsDeleteOptionalParams)
刪除數字對應項
function deleteDigitalTwin(digitalTwinId: string, options?: DigitalTwinsDeleteOptionalParams): Promise<void>參數
- digitalTwinId
-
string
要刪除的數字對應項識別碼。
- options
- DigitalTwinsDeleteOptionalParams
擴充作業選項，包括 ifMatch：只有在實體的 etag 符合提供的其中一個 etag 或 * 時，才執行作業。
傳回
Promise<void>
deleteEventRoute(string, OperationOptions)
刪除事件路由。
function deleteEventRoute(eventRouteId: string, options?: OperationOptions): Promise<void>參數
- eventRouteId
-
string
要刪除之 eventRoute 的標識碼。
- options
- OperationOptions
作業選項
傳回
Promise<void>
deleteModel(string, OperationOptions)
刪除模型。
function deleteModel(modelId: string, options?: OperationOptions): Promise<void>參數
- modelId
-
string
要刪除之模型的標識碼。
- options
- OperationOptions
作業選項
傳回
Promise<void>
deleteRelationship(string, string, DigitalTwinsDeleteRelationshipOptionalParams)
刪除數字對應項上的關聯性。
function deleteRelationship(digitalTwinId: string, relationshipId: string, options?: DigitalTwinsDeleteRelationshipOptionalParams): Promise<void>參數
- digitalTwinId
-
string
來源數字對應項的標識碼。
- relationshipId
-
string
要刪除之關聯性的標識碼。
ifMatch 的作業選項：只有在實體的 etag 符合提供的其中一個 etag 或 * 時，才執行作業
傳回
Promise<void>
getComponent(string, string, OperationOptions)
取得數字對應項上的元件。
function getComponent(digitalTwinId: string, componentName: string, options?: OperationOptions): Promise<DigitalTwinsGetComponentResponse>參數
- digitalTwinId
-
string
數字對應項的標識碼。
- componentName
-
string
正在擷取的元件。
- options
- OperationOptions
作業選項
傳回
Promise<DigitalTwinsGetComponentResponse>
與提供的 componentName 對應的元件的 Json 字串表示形式。
getDigitalTwin(string, OperationOptions)
取得數字對應項
function getDigitalTwin(digitalTwinId: string, options?: OperationOptions): Promise<DigitalTwinsGetByIdResponse>參數
- digitalTwinId
-
string
數字對應項的標識碼。
- 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
模型的標識碼。
- options
- GetModelOptions
此作的選項
傳回
Promise<DigitalTwinsModelData>
application/json 模型。
getRelationship(string, string, OperationOptions)
取得數字對應項的關聯性。
function getRelationship(digitalTwinId: string, relationshipId: string, options?: OperationOptions): Promise<DigitalTwinsGetRelationshipByIdResponse>參數
- digitalTwinId
-
string
來源數字對應項的標識碼。
- relationshipId
-
string
要擷取之關聯性的標識碼。
- 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
數字對應項的標識碼。
- 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
數字對應項的標識碼。
- 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
要刪除的數字對應項識別碼。
- componentName
-
string
DTDL 元件的名稱。
- payload
-
Record<string, unknown>
要傳送的應用程式/json 遙測承載。
- messageId
-
string
訊息標識碼。
- 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
要刪除的數字對應項識別碼。
- payload
-
Record<string, unknown>
要傳送的應用程式/json 遙測承載。
- messageId
-
string
訊息標識碼。
- 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
數字對應項的標識碼。
- componentName
-
string
正在更新的元件。
- jsonPatch
-
Record<string, unknown>[]
要對指定數字對應項元件執行的應用程式/json-patch+json 作業。
擴充作業選項，包括 ifMatch：只有在實體的 etag 符合提供的其中一個 etag 或 * 時，才執行作業。
傳回
Promise<DigitalTwinsUpdateComponentHeaders>
updateDigitalTwin(string, Record<string, unknown>[], DigitalTwinsUpdateOptionalParams)
使用 json 修補程式更新數字對應項。
function updateDigitalTwin(digitalTwinId: string, jsonPatch: Record<string, unknown>[], options?: DigitalTwinsUpdateOptionalParams): Promise<DigitalTwinsUpdateHeaders>參數
- digitalTwinId
-
string
數字對應項的標識碼。
- jsonPatch
-
Record<string, unknown>[]
JSON Patch 所描述的更新規格。 屬性值和$model元素的更新可能會在相同的要求中發生。 作業僅限於新增、取代和移除。
- options
- DigitalTwinsUpdateOptionalParams
擴充作業選項，包括 ifMatch：只有在實體的 etag 符合提供的其中一個 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
要刪除的數字對應項識別碼。
- relationshipId
-
string
要更新之關聯性的標識碼。
- jsonPatch
-
Record<string, unknown>[]
要對指定數字對應項關聯性執行的應用程式/json-patch+json 作業。
ifMatch 的擴充作業選項：只有在實體的 etag 符合提供的其中一個 etag 或 * 時，才執行作業。
傳回
upsertDigitalTwin(string, string, DigitalTwinsAddOptionalParams)
建立或更新數字對應項
function upsertDigitalTwin(digitalTwinId: string, digitalTwinJson: string, options?: DigitalTwinsAddOptionalParams): Promise<DigitalTwinsAddResponse>參數
- digitalTwinId
-
string
要建立或更新的數字對應項標識碼。
- 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
要建立或更新的事件路由標識碼。
- endpointId
-
string
這個事件路由所系結的端點標識碼。
- 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
來源數字對應項的標識碼。
- relationshipId
-
string
要建立之關聯性的標識碼。
- relationship
-
Record<string, unknown>
要建立的應用程式/json 關聯性。
擴充作業選項，包括 ifNoneMatch：只有在實體不存在時，才執行作業。
傳回
Promise<DigitalTwinsAddRelationshipResponse>