DigitalTwinsClient class

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)

パラメーター

1 つまたは複数を作成する

function createModels(dtdlModels: Record<string, unknown>[], options?: OperationOptions): Promise<DigitalTwinModelsAddResponse>

パラメーター

戻り値

作成された application/json モデル。

json パッチを使用してモデルの使用を停止します。 モデルが使用停止になると、新しいデジタル ツインはこのモデルで定義できなくなります。 ただし、既存のデジタル ツインでは、このモデルを引き続き使用できます。 一度使用を停止したモデルは、再使用を停止することはできません。

function decomissionModel(modelId: string, options?: OperationOptions): Promise<void>

パラメーター

戻り値

デジタル ツインを削除する

function deleteDigitalTwin(digitalTwinId: string, options?: DigitalTwinsDeleteOptionalParams): Promise<void>

パラメーター

戻り値

イベント ルートを削除します。

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

パラメーター

戻り値

モデルを削除します。

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

パラメーター

戻り値

デジタル ツインのリレーションシップを削除します。

function deleteRelationship(digitalTwinId: string, relationshipId: string, options?: DigitalTwinsDeleteRelationshipOptionalParams): Promise<void>

パラメーター

戻り値

デジタル ツインのコンポーネントを取得します。

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

パラメーター

戻り値

指定された componentName に対応するコンポーネントの JSON 文字列表現。

デジタル ツインを取得する

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

パラメーター

戻り値

application/json デジタル ツイン。

イベント ルートを取得します。

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

パラメーター

戻り値

application/json イベントルート。

モデル メタデータとモデル定義を含むモデルを取得します。

function getModel(modelId: string, options?: DigitalTwinModelsGetByIdOptionalParams): Promise<DigitalTwinsModelData>

パラメーター

戻り値

application/json モデル。

デジタル ツインのリレーションシップを取得します。

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

パラメーター

戻り値

指定したデジタル ツインに属する application/json リレーションシップのページング可能なリスト。

デジタル ツイン インスタンス内のイベント ルートを一覧表示します。

function listEventRoutes(options?: EventRoutesListOptionalParams): PagedAsyncIterableIterator<EventRoute, EventRoute[], PageSettings>

パラメーター

戻り値

application/json イベントルート。

デジタル ツインのすべての受信リレーションシップを取得します。

function listIncomingRelationships(digitalTwinId: string, options?: DigitalTwinsListIncomingRelationshipsOptionalParams): PagedAsyncIterableIterator<IncomingRelationship, IncomingRelationship[], PageSettings>

パラメーター

戻り値

モデルの一覧を取得する

function listModels(options?: DigitalTwinModelsListOptionalParams): PagedAsyncIterableIterator<DigitalTwinsModelData, DigitalTwinsModelData[], PageSettings>

パラメーター

戻り値

ページング可能な application/json モデルのセット。

デジタル ツインのリレーションシップを取得します。

function listRelationships(digitalTwinId: string, options?: DigitalTwinsListRelationshipsOptionalParams): PagedAsyncIterableIterator<Record<string, unknown>, Record<string, unknown>[], PageSettings>

パラメーター

戻り値

デジタル ツインのコンポーネントからテレメトリを発行します。これは、次に定義されている 1 つまたは複数の宛先エンドポイント (サブスクライバー) によって使用されます。

function publishComponentTelemetry(digitalTwinId: string, componentName: string, payload: Record<string, unknown>, messageId: string, options?: OperationOptions): Promise<void>

パラメーター

戻り値

デジタル ツインからテレメトリを発行します。このテレメトリは、定義された 1 つまたは複数の宛先エンドポイント (サブスクライバー) によって使用されます。

function publishTelemetry(digitalTwinId: string, payload: Record<string, unknown>, messageId: string, options?: OperationOptions): Promise<void>

パラメーター

戻り値

デジタル ツインのクエリ。

function queryTwins(query: string, options?: QueryQueryTwinsOptionalParams): PagedAsyncIterableIterator<Record<string, unknown>, QueryQueryTwinsResponse, PageSettings>

パラメーター

戻り値

クエリ結果のページング可能な一覧。

JSON パッチを使用して、デジタル ツイン上のコンポーネントのプロパティを更新します。

function updateComponent(digitalTwinId: string, componentName: string, jsonPatch: Record<string, unknown>[], options?: DigitalTwinsUpdateComponentOptionalParams): Promise<DigitalTwinsUpdateComponentHeaders>

パラメーター

戻り値

json パッチを使用してデジタル ツインを更新します。

function updateDigitalTwin(digitalTwinId: string, jsonPatch: Record<string, unknown>[], options?: DigitalTwinsUpdateOptionalParams): Promise<DigitalTwinsUpdateHeaders>

パラメーター

戻り値

JSON パッチを使用して、デジタル ツインのリレーションシップのプロパティを更新します。

function updateRelationship(digitalTwinId: string, relationshipId: string, jsonPatch: Record<string, unknown>[], options?: DigitalTwinsUpdateRelationshipOptionalParams): Promise<DigitalTwinsUpdateRelationshipHeaders>

パラメーター

戻り値

デジタル ツインを作成または更新する

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

パラメーター

戻り値

作成された application/json デジタル ツイン。

イベント ルートを作成または更新します。

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

パラメーター

戻り値

デジタル ツインのリレーションシップを作成または更新します。

function upsertRelationship(digitalTwinId: string, relationshipId: string, relationship: Record<string, unknown>, options?: DigitalTwinsAddRelationshipOptionalParams): Promise<DigitalTwinsAddRelationshipResponse>

パラメーター

戻り値