DigitalTwinsClient class

パッケージ:

@azure/digital-twins-core

Azure IoT DigitalTwins API 用のクライアント。

コンストラクター

DigitalTwinsClient(string, TokenCredential, DigitalTwinsClientOptions)

AzureDigitalTwinsAPI のインスタンスを作成します。 使用例: const { DigitalTwinsClient, ServiceClientCredentials } = require("@azure/digital-twins-core"); const client = new DigitalTwinsClient( "<endpoint>", new DefaultAzureCredential(); );

メソッド

createModels(any[], OperationOptions)	1 つまたは複数を作成する
decomissionModel(string, OperationOptions)	json パッチを使用してモデルの使用を停止します。 モデルが使用停止になると、新しいデジタル ツインは、このモデルで定義できなくなります。 ただし、既存のデジタル ツインでは、このモデルを引き続き使用できます。 一度使用を停止すると、モデルは使用停止にならない可能性があります。
deleteDigitalTwin(string, DigitalTwinsDeleteOptionalParams)	デジタル ツインを削除する
deleteEventRoute(string, OperationOptions)	イベント ルートを削除します。
deleteModel(string, OperationOptions)	モデルを削除します。
deleteRelationship(string, string, DigitalTwinsDeleteRelationshipOptionalParams)	デジタル ツインのリレーションシップを削除します。
getComponent(string, string, OperationOptions)	デジタル ツインのコンポーネントを取得します。
getDigitalTwin(string, OperationOptions)	デジタル ツインを取得する
getEventRoute(string, OperationOptions)	イベント ルートを取得します。
getModel(string, boolean, OperationOptions)	モデルメタデータとモデル定義を含むモデルを取得します。
getRelationship(string, string, OperationOptions)	デジタル ツインのリレーションシップを取得します。
listEventRoutes(number, OperationOptions & PageSettings)	デジタル ツイン インスタンスのイベント ルートを一覧表示します。
listIncomingRelationships(string, OperationOptions & PageSettings)	デジタル ツインのすべての受信リレーションシップを取得します。
listModels(string[], boolean, number, OperationOptions & PageSettings)	モデルの一覧を取得する
listRelationships(string, OperationOptions & PageSettings)	デジタル ツインのリレーションシップを取得します。
publishComponentTelemetry(string, string, string, string, OperationOptions)	デジタル ツインのコンポーネントからテレメトリを発行します。このコンポーネントは、 で定義されている 1 つまたは複数の宛先エンドポイント (サブスクライバー) によって使用されます。
publishTelemetry(string, any, string, OperationOptions)	デジタル ツインからテレメトリを発行します。このテレメトリは、 で定義されている 1 つまたは複数の宛先エンドポイント (サブスクライバー) によって使用されます。
queryTwins(string, number, OperationOptions & PageSettings)	デジタル ツインのクエリ。
updateComponent(string, string, any[], DigitalTwinsUpdateComponentOptionalParams)	JSON パッチを使用して、デジタル ツイン上のコンポーネントのプロパティを更新します。
updateDigitalTwin(string, any, DigitalTwinsUpdateOptionalParams)	json パッチを使用してデジタル ツインを更新します。
updateRelationship(string, string, any[], DigitalTwinsUpdateRelationshipOptionalParams)	JSON パッチを使用して、デジタル ツイン上のリレーションシップのプロパティを更新します。
upsertDigitalTwin(string, string, DigitalTwinsAddOptionalParams)	デジタル ツインを作成または更新する
upsertEventRoute(string, string, string, OperationOptions)	イベント ルートを作成または更新します。
upsertRelationship(string, string, any, DigitalTwinsAddRelationshipOptionalParams)	デジタル ツインでリレーションシップを作成または更新します。

コンストラクターの詳細

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)

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

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

使用を停止するモデルの ID。 プロパティは置き換えることができます。

options

OperationOptions

操作オプション

戻り値

Promise<RestResponse>

http 応答。

deleteDigitalTwin(string, DigitalTwinsDeleteOptionalParams)

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

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

パラメーター

digitalTwinId

string

削除するデジタル ツインの ID。

options

DigitalTwinsDeleteOptionalParams

ifMatch を含む拡張操作オプション: エンティティの etag が指定された etag または * のいずれかが指定されている場合にのみ、操作を実行します。

戻り値

Promise<RestResponse>

http 応答。

deleteEventRoute(string, OperationOptions)

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

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

パラメーター

eventRouteId

string

削除する eventRoute の ID。

options

OperationOptions

操作オプション

戻り値

Promise<RestResponse>

http 応答。

deleteModel(string, OperationOptions)

モデルを削除します。

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

パラメーター

modelId

string

削除するモデルの ID。

options

OperationOptions

操作オプション

戻り値

Promise<RestResponse>

http 応答。

deleteRelationship(string, string, DigitalTwinsDeleteRelationshipOptionalParams)

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

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

パラメーター

digitalTwinId

string

ソース デジタル ツインの ID。

relationshipId

string

削除するリレーションシップの ID。

options

DigitalTwinsDeleteRelationshipOptionalParams

操作オプション ifMatch: エンティティの etag が指定された etag のいずれかに一致する場合にのみ、操作を実行します。

戻り値

Promise<RestResponse>

http 応答。

getComponent(string, string, OperationOptions)

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

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

パラメーター

digitalTwinId

string

デジタル ツインの ID。

componentName

string

取得するコンポーネント。

options

OperationOptions

操作オプション

戻り値

Promise<DigitalTwinsGetComponentResponse>

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

getDigitalTwin(string, OperationOptions)

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

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

パラメーター

digitalTwinId

string

デジタル ツインの ID。

options

OperationOptions

操作オプション

戻り値

Promise<DigitalTwinsGetByIdResponse>

アプリケーション/json デジタル ツインと 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

モデルの ID。

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

ソース デジタル ツインの ID。

relationshipId

string

取得するリレーションシップの ID。

options

OperationOptions

操作オプション

戻り値

Promise<DigitalTwinsGetRelationshipByIdResponse>

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

listEventRoutes(number, OperationOptions & PageSettings)

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

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

パラメーター

resultsPerPage

number

要求ごとに取得するアイテムの最大数。 サーバーは、要求された最大値より小さい値を返すように選択できます。

options

OperationOptions & PageSettings

戻り値

PagedAsyncIterableIterator<EventRoute, EventRoutesListNextResponse, PageSettings>

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

listIncomingRelationships(string, OperationOptions & PageSettings)

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

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

パラメーター

digitalTwinId

string

デジタル ツインの ID。

options

OperationOptions & PageSettings

戻り値

PagedAsyncIterableIterator<IncomingRelationship, DigitalTwinsListIncomingRelationshipsResponse, PageSettings>

listModels(string[], boolean, number, OperationOptions & PageSettings)

モデルの一覧を取得する

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

パラメーター

dependeciesFor

string[]

依存関係を取得するモデル ID。 省略すると、すべてのモデルが取得されます。

includeModelDefinition

boolean

モデル定義を結果に含めるかどうか。 false の場合は、モデル メタデータのみが返されます。

resultsPerPage

number

要求ごとに取得するアイテムの最大数。 サーバーは、要求された最大値より小さい値を返すように選択できます。

options

OperationOptions & PageSettings

戻り値

PagedAsyncIterableIterator<DigitalTwinsModelData, DigitalTwinModelsListResponse, PageSettings>

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

listRelationships(string, OperationOptions & PageSettings)

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

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

パラメーター

digitalTwinId

string

デジタル ツインの ID。

options

OperationOptions & PageSettings

戻り値

PagedAsyncIterableIterator<any, DigitalTwinsListRelationshipsResponse, PageSettings>

publishComponentTelemetry(string, string, string, string, OperationOptions)

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

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

パラメーター

digitalTwinId

string

削除するデジタル ツインの ID。

componentName

string

DTDL コンポーネントの名前。

payload

string

送信されるアプリケーション/json テレメトリ ペイロード。

messageId

string

メッセージ ID。

options

OperationOptions

操作オプション

戻り値

Promise<RestResponse>

http 応答。

publishTelemetry(string, any, string, OperationOptions)

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

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

パラメーター

digitalTwinId

string

削除するデジタル ツインの ID。

payload

any

送信されるアプリケーション/json テレメトリ ペイロード。

messageId

string

メッセージ ID。

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

OperationOptions & PageSettings

戻り値

PagedAsyncIterableIterator<any, QueryQueryTwinsResponse, PageSettings>

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

updateComponent(string, string, any[], DigitalTwinsUpdateComponentOptionalParams)

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

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

パラメーター

digitalTwinId

string

デジタル ツインの ID。

componentName

string

更新されるコンポーネント。

jsonPatch

any[]

指定したデジタル ツインのコンポーネントに対して実行される application/json-patch+json 操作。

options

DigitalTwinsUpdateComponentOptionalParams

ifMatch を含む拡張操作オプション: エンティティの etag が指定された etag または * のいずれかが指定されている場合にのみ、操作を実行します。

戻り値

Promise<DigitalTwinsUpdateComponentResponse>

http 応答。

updateDigitalTwin(string, any, DigitalTwinsUpdateOptionalParams)

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

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

パラメーター

digitalTwinId

string

デジタル ツインの ID。

jsonPatch

any

JSON Patch で説明されている更新プログラムの仕様。 プロパティ値と$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

削除するデジタル ツインの ID。

relationshipId

string

更新するリレーションシップの ID。

jsonPatch

any[]

指定されたデジタル ツインのリレーションシップに対して実行される application/json-patch+json 操作。

options

DigitalTwinsUpdateRelationshipOptionalParams

拡張操作オプション ifMatch: エンティティの etag が指定された etag のいずれかまたは * が指定されている場合にのみ、操作を実行します。

戻り値

Promise<DigitalTwinsUpdateRelationshipResponse>

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>

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

upsertEventRoute(string, string, string, OperationOptions)

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

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

パラメーター

eventRouteId

string

作成または更新するイベント ルートの ID。

endpointId

string

このイベント ルートがバインドされているエンドポイントの ID。

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

ソース デジタル ツインの ID。

relationshipId

string

作成するリレーションシップの ID。

relationship

any

作成するアプリケーション/json リレーションシップ。

options

DigitalTwinsAddRelationshipOptionalParams

ifNoneMatch を含む拡張操作オプション: エンティティがまだ存在しない場合にのみ操作を実行します。

戻り値

Promise<DigitalTwinsAddRelationshipResponse>