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
要解除委任之模型的識別碼。 屬性可以取代。
- options
- OperationOptions
作業選項
傳回
Promise<RestResponse>
HTTP 回應。
deleteDigitalTwin(string, DigitalTwinsDeleteOptionalParams)
刪除數位對應項
function deleteDigitalTwin(digitalTwinId: string, options?: DigitalTwinsDeleteOptionalParams): Promise<RestResponse>參數
- digitalTwinId
-
string
要刪除之數位對應項的識別碼。
- options
- DigitalTwinsDeleteOptionalParams
擴充作業選項，包括 ifMatch：只有在實體的 etag 符合提供的其中一個 etag 或 * 提供時，才執行作業。
傳回
Promise<RestResponse>
HTTP 回應。
deleteEventRoute(string, OperationOptions)
刪除事件路由。
function deleteEventRoute(eventRouteId: string, options?: OperationOptions): Promise<RestResponse>參數
- eventRouteId
-
string
要刪除之 eventRoute 的識別碼。
- options
- OperationOptions
作業選項
傳回
Promise<RestResponse>
HTTP 回應。
deleteModel(string, OperationOptions)
刪除模型。
function deleteModel(modelId: string, options?: OperationOptions): Promise<RestResponse>參數
- modelId
-
string
要刪除之模型的識別碼。
- options
- OperationOptions
作業選項
傳回
Promise<RestResponse>
HTTP 回應。
deleteRelationship(string, string, DigitalTwinsDeleteRelationshipOptionalParams)
刪除數位對應項上的關聯性。
function deleteRelationship(digitalTwinId: string, relationshipId: string, options?: DigitalTwinsDeleteRelationshipOptionalParams): Promise<RestResponse>參數
- digitalTwinId
-
string
來源數位對應項的識別碼。
- relationshipId
-
string
要刪除之關聯性的識別碼。
ifMatch 的作業選項：只有在實體的 etag 符合提供的其中一個 etag 或 * 時，才執行作業
傳回
Promise<RestResponse>
HTTP 回應。
getComponent(string, string, OperationOptions)
取得數位對應項上的元件。
function getComponent(digitalTwinId: string, componentName: string, options?: OperationOptions): Promise<DigitalTwinsGetComponentResponse>參數
- digitalTwinId
-
string
數位對應項的識別碼。
- componentName
-
string
正在擷取的元件。
- options
- OperationOptions
作業選項
傳回
Promise<DigitalTwinsGetComponentResponse>
對應至所提供 componentName 和 HTTP 回應之元件的 Json 字串表示。
getDigitalTwin(string, OperationOptions)
取得數位對應項
function getDigitalTwin(digitalTwinId: string, options?: OperationOptions): Promise<DigitalTwinsGetByIdResponse>參數
- digitalTwinId
-
string
數位對應項的識別碼。
- options
- OperationOptions
作業選項
傳回
Promise<DigitalTwinsGetByIdResponse>
application/json digital twin 和 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
模型的識別碼。
- includeModelDefinition
-
boolean
- options
- OperationOptions
包含 includeModelDefinition 的擴充作業選項：當為 true 時，模型定義將會傳回為結果的一部分。 預設值：false。
傳回
Promise<DigitalTwinModelsGetByIdResponse>
應用程式/json 模型和 HTTP 回應。
getRelationship(string, string, OperationOptions)
取得數位對應項上的關聯性。
function getRelationship(digitalTwinId: string, relationshipId: string, options?: OperationOptions): Promise<DigitalTwinsGetRelationshipByIdResponse>參數
- digitalTwinId
-
string
來源數位對應項的識別碼。
- relationshipId
-
string
要擷取之關聯性的識別碼。
- 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
數位對應項的識別碼。
- options
傳回
listModels(string[], boolean, number, OperationOptions & PageSettings)
取得模型清單
function listModels(dependeciesFor?: string[], includeModelDefinition?: boolean, resultsPerPage?: number, options?: OperationOptions & PageSettings): PagedAsyncIterableIterator<DigitalTwinsModelData, DigitalTwinModelsListResponse, PageSettings>參數
- dependeciesFor
-
string[]
要擷取相依性的模型識別碼。 如果省略，則會擷取所有模型。
- 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
數位對應項的識別碼。
- options
傳回
publishComponentTelemetry(string, string, string, string, OperationOptions)
從數位對應項的元件發佈遙測，然後由一或多個目的地端點 (定義) 的目的地端點取用。
function publishComponentTelemetry(digitalTwinId: string, componentName: string, payload: string, messageId: string, options?: OperationOptions): Promise<RestResponse>參數
- digitalTwinId
-
string
要刪除的數位對應項識別碼。
- componentName
-
string
DTDL 元件的名稱。
- payload
-
string
要傳送的應用程式/json 遙測承載。
- messageId
-
string
訊息識別碼。
- options
- OperationOptions
作業選項
傳回
Promise<RestResponse>
HTTP 回應。
publishTelemetry(string, any, string, OperationOptions)
從數位對應項發佈遙測，然後由一或多個目的地端點取用， (定義于下方的訂閱者) 。
function publishTelemetry(digitalTwinId: string, payload: any, messageId: string, options?: OperationOptions): Promise<RestResponse>參數
- digitalTwinId
-
string
要刪除的數位對應項識別碼。
- payload
-
any
要傳送的應用程式/json 遙測承載。
- messageId
-
string
訊息識別碼。
- 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
數位對應項的識別碼。
- componentName
-
string
正在更新的元件。
- jsonPatch
-
any[]
要對指定數位對應項元件執行的應用程式/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
數位對應項的識別碼。
- 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
要刪除的數位對應項識別碼。
- relationshipId
-
string
要更新之關聯性的識別碼。
- 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
要建立或更新之數位對應項的識別碼。
- digitalTwinJson
-
string
要建立的應用程式/json 數位對應項。
- options
- DigitalTwinsAddOptionalParams
擴充作業選項，包括 ifNoneMatch：只有在實體不存在時，才執行作業。
傳回
Promise<DigitalTwinsAddResponse>
已建立的應用程式/json 數位對應項和 HTTP 回應。
upsertEventRoute(string, string, string, OperationOptions)
建立或更新事件路由。
function upsertEventRoute(eventRouteId: string, endpointId: string, filter: string, options?: OperationOptions): Promise<RestResponse>參數
- eventRouteId
-
string
要建立或更新之事件路由的識別碼。
- endpointId
-
string
這個事件路由所系結之端點的識別碼。
- 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
來源數位對應項的識別碼。
- relationshipId
-
string
要建立之關聯性的識別碼。
- relationship
-
any
要建立的應用程式/json 關聯性。
擴充作業選項，包括 ifNoneMatch：只有在實體不存在時，才執行作業。
傳回
Promise<DigitalTwinsAddRelationshipResponse>