DigitalTwinsClient class

AzureDigitalTwinsAPI のインスタンスを作成します。

使用例:

const { DigitalTwinsClient, ServiceClientCredentials } = require("@azure/digital-twins-core");

const client = new DigitalTwinsClient(
  "<endpoint>",
  new DefaultAzureCredential();
);

new DigitalTwinsClient(endpointUrl: string, credential: TokenCredential, options?: DigitalTwinsClientOptions)

パラメーター

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

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

パラメーター

戻り値

作成されたアプリケーション/json モデルと http 応答。

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

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

パラメーター

戻り値

http 応答。

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

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

パラメーター

戻り値

http 応答。

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

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

パラメーター

戻り値

http 応答。

モデルを削除します。

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

パラメーター

戻り値

http 応答。

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

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

パラメーター

戻り値

http 応答。

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

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

パラメーター

戻り値

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

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

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

パラメーター

戻り値

アプリケーション/json デジタル ツインと http 応答。

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

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

パラメーター

戻り値

application/json イベント ルートと http 応答。

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

function getModel(modelId: string, includeModelDefinition?: boolean, options?: OperationOptions): Promise<DigitalTwinModelsGetByIdResponse>

パラメーター

戻り値

アプリケーション/json モデルと http 応答。

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

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

パラメーター

戻り値

指定されたデジタル ツインと http 応答に属するアプリケーション/json リレーションシップのページング可能な一覧。

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

function listEventRoutes(resultsPerPage?: number, options?: OperationOptions & PageSettings): PagedAsyncIterableIterator<EventRoute, EventRoutesListNextResponse, PageSettings>

パラメーター

戻り値

application/json イベント ルートと http 応答。

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

function listIncomingRelationships(digitalTwinId: string, options?: OperationOptions & PageSettings): PagedAsyncIterableIterator<IncomingRelationship, DigitalTwinsListIncomingRelationshipsResponse, PageSettings>

パラメーター

戻り値

モデルの一覧を取得する

function listModels(dependeciesFor?: string[], includeModelDefinition?: boolean, resultsPerPage?: number, options?: OperationOptions & PageSettings): PagedAsyncIterableIterator<DigitalTwinsModelData, DigitalTwinModelsListResponse, PageSettings>

パラメーター

戻り値

アプリケーション/json モデルのページング可能なセットと http 応答。

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

function listRelationships(digitalTwinId: string, options?: OperationOptions & PageSettings): PagedAsyncIterableIterator<any, DigitalTwinsListRelationshipsResponse, PageSettings>

パラメーター

戻り値

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

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

パラメーター

戻り値

http 応答。

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

function publishTelemetry(digitalTwinId: string, payload: any, messageId: string, options?: OperationOptions): Promise<RestResponse>

パラメーター

戻り値

http 応答。

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

function queryTwins(query: string, resultsPerPage?: number, options?: OperationOptions & PageSettings): PagedAsyncIterableIterator<any, QueryQueryTwinsResponse, PageSettings>

パラメーター

戻り値

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

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

function updateComponent(digitalTwinId: string, componentName: string, jsonPatch: any[], options?: DigitalTwinsUpdateComponentOptionalParams): Promise<DigitalTwinsUpdateComponentResponse>

パラメーター

戻り値

http 応答。

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

function updateDigitalTwin(digitalTwinId: string, jsonPatch: any, options?: DigitalTwinsUpdateOptionalParams): Promise<DigitalTwinsUpdateResponse>

パラメーター

戻り値

http 応答。

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

function updateRelationship(digitalTwinId: string, relationshipId: string, jsonPatch: any[], options?: DigitalTwinsUpdateRelationshipOptionalParams): Promise<DigitalTwinsUpdateRelationshipResponse>

パラメーター

戻り値

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

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

パラメーター

戻り値

作成されたアプリケーション/json デジタル ツインと http 応答。

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

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

パラメーター

戻り値

http 応答。

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

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

パラメーター

戻り値