DigitalTwinsClient class

Csomag:

@azure/digital-twins-core

Ügyfél az Azure IoT DigitalTwins API-hoz.

Konstruktorok

DigitalTwinsClient(string, TokenCredential, DigitalTwinsClientOptions)

Létrehozza az AzureDigitalTwinsAPI egy példányát. Példahasználat: const { DigitalTwinsClient, ServiceClientCredentials } = require("@azure/digital-twins-core"); const client = new DigitalTwinsClient( "<endpoint>", new DefaultAzureCredential(); );

Metódusok

createModels(any[], OperationOptions)	Egy vagy több létrehozása
decomissionModel(string, OperationOptions)	Modell leszerelése json-javítás használatával. A modellek leszerelésekor az új digitális ikerpéldányok már nem határozhatók meg ezzel a modellel. A meglévő digitális ikerpéldányok azonban továbbra is használhatják ezt a modellt. A modell leszerelése után előfordulhat, hogy a modell nem lesz újracommissioned.
deleteDigitalTwin(string, DigitalTwinsDeleteOptionalParams)	Digitális ikerpéldány törlése
deleteEventRoute(string, OperationOptions)	Eseményútvonal törlése.
deleteModel(string, OperationOptions)	Modell törlése.
deleteRelationship(string, string, DigitalTwinsDeleteRelationshipOptionalParams)	Kapcsolat törlése egy digitális ikerpéldányon.
getComponent(string, string, OperationOptions)	Egy digitális ikerpéldány összetevőjének lekérése.
getDigitalTwin(string, OperationOptions)	Digitális ikerpéldány beszerzése
getEventRoute(string, OperationOptions)	Eseményútvonal lekérése.
getModel(string, boolean, OperationOptions)	Modell lekérése, beleértve a modell metaadatait és a modelldefiníciót.
getRelationship(string, string, OperationOptions)	Kapcsolatot létesíthet egy digitális ikerpéldányon.
listEventRoutes(number, OperationOptions & PageSettings)	Egy digitális ikerpéldány eseményútvonalainak listázása.
listIncomingRelationships(string, OperationOptions & PageSettings)	Egy digitális ikerpéldány összes bejövő kapcsolatának lekérése.
listModels(string[], boolean, number, OperationOptions & PageSettings)	Modellek listájának lekérése
listRelationships(string, OperationOptions & PageSettings)	Digitális ikerpéldány kapcsolatainak lekérése.
publishComponentTelemetry(string, string, string, string, OperationOptions)	Telemetria közzététele egy digitális ikerpéldány összetevőből, amelyet aztán a megadott egy vagy több célvégpont (előfizető) használ fel.
publishTelemetry(string, any, string, OperationOptions)	Telemetria közzététele egy digitális ikerpéldányról, amelyet aztán a megadott egy vagy több célvégpont (előfizető) használ fel.
queryTwins(string, number, OperationOptions & PageSettings)	Digitális ikerpéldányok lekérdezése.
updateComponent(string, string, any[], DigitalTwinsUpdateComponentOptionalParams)	Egy digitális ikerpéldányon lévő összetevő tulajdonságainak frissítése JSON-javítás használatával.
updateDigitalTwin(string, any, DigitalTwinsUpdateOptionalParams)	Digitális ikerpéldány frissítése json-javítás használatával.
updateRelationship(string, string, any[], DigitalTwinsUpdateRelationshipOptionalParams)	Frissítések egy kapcsolat tulajdonságait egy digitális ikerpéldányon egy JSON-javítás használatával.
upsertDigitalTwin(string, string, DigitalTwinsAddOptionalParams)	Digitális ikerpéldány létrehozása vagy frissítése
upsertEventRoute(string, string, string, OperationOptions)	Eseményútvonal létrehozása vagy frissítése.
upsertRelationship(string, string, any, DigitalTwinsAddRelationshipOptionalParams)	Kapcsolat létrehozása vagy frissítése digitális ikerpéldányon.

Konstruktor adatai

DigitalTwinsClient(string, TokenCredential, DigitalTwinsClientOptions)

Létrehozza az AzureDigitalTwinsAPI egy példányát.

Példahasználat:

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

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

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

Paraméterek

endpointUrl

string

A szolgáltatás végponti URL-címe.

credential

TokenCredential

A szolgáltatás felé irányuló kérések hitelesítésére szolgál.

options

DigitalTwinsClientOptions

A szolgáltatásügyfél konfigurálásához használatos.

Metódus adatai

createModels(any[], OperationOptions)

Egy vagy több létrehozása

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

Paraméterek

dtdlModels

any[]

options

OperationOptions

A művelet beállításai

Válaszok

Promise<DigitalTwinModelsAddResponse>

A létrehozott alkalmazás-/json-modellek és a HTTP-válasz.

decomissionModel(string, OperationOptions)

Modell leszerelése json-javítás használatával. A modellek leszerelésekor az új digitális ikerpéldányok már nem határozhatók meg ezzel a modellel. A meglévő digitális ikerpéldányok azonban továbbra is használhatják ezt a modellt. A modell leszerelése után előfordulhat, hogy a modell nem lesz újracommissioned.

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

Paraméterek

modelId

string

A leszerelendő modell azonosítója. tulajdonság lecserélhető.

options

OperationOptions

A művelet beállításai

Válaszok

Promise<RestResponse>

A HTTP-válasz.

deleteDigitalTwin(string, DigitalTwinsDeleteOptionalParams)

Digitális ikerpéldány törlése

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

Paraméterek

digitalTwinId

string

A törölni kívánt digitális ikerpéldány azonosítója.

options

DigitalTwinsDeleteOptionalParams

Kiterjesztett műveleti lehetőségek, beleértve az ifMatch műveletet: Csak akkor hajtsa végre a műveletet, ha az entitás etagje megegyezik a megadott etagek egyikével, vagy * meg van adva.

Válaszok

Promise<RestResponse>

A HTTP-válasz.

deleteEventRoute(string, OperationOptions)

Eseményútvonal törlése.

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

Paraméterek

eventRouteId

string

A törölni kívánt eventRoute azonosítója.

options

OperationOptions

A művelet beállításai

Válaszok

Promise<RestResponse>

A HTTP-válasz.

deleteModel(string, OperationOptions)

Modell törlése.

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

Paraméterek

modelId

string

A törölni kívánt modell azonosítója.

options

OperationOptions

A művelet beállításai

Válaszok

Promise<RestResponse>

A HTTP-válasz.

deleteRelationship(string, string, DigitalTwinsDeleteRelationshipOptionalParams)

Kapcsolat törlése egy digitális ikerpéldányon.

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

Paraméterek

digitalTwinId

string

A forrás digitális ikerpéldány azonosítója.

relationshipId

string

A törölni kívánt kapcsolat azonosítója.

options

DigitalTwinsDeleteRelationshipOptionalParams

Az ifMatch művelet beállításai: Csak akkor hajtsa végre a műveletet, ha az entitás etagje megegyezik a megadott etagek egyikével, vagy *

Válaszok

Promise<RestResponse>

A HTTP-válasz.

getComponent(string, string, OperationOptions)

Egy digitális ikerpéldány összetevőjének lekérése.

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

Paraméterek

digitalTwinId

string

A digitális ikerpéldány azonosítója.

componentName

string

A lekért összetevő.

options

OperationOptions

A művelet beállításai

Válaszok

Promise<DigitalTwinsGetComponentResponse>

A megadott componentName és a HTTP-válasznak megfelelő összetevő JSON-sztringje.

getDigitalTwin(string, OperationOptions)

Digitális ikerpéldány beszerzése

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

Paraméterek

digitalTwinId

string

A digitális ikerpéldány azonosítója.

options

OperationOptions

A művelet beállításai

Válaszok

Promise<DigitalTwinsGetByIdResponse>

Az alkalmazás/json digitális ikerpéldány és a HTTP-válasz.

getEventRoute(string, OperationOptions)

Eseményútvonal lekérése.

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

Paraméterek

eventRouteId

string

options

OperationOptions

A művelet beállításai

Válaszok

Promise<EventRoutesGetByIdResponse>

Az application/json eseményútvonal és a HTTP-válasz.

getModel(string, boolean, OperationOptions)

Modell lekérése, beleértve a modell metaadatait és a modelldefiníciót.

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

Paraméterek

modelId

string

A modell azonosítója.

includeModelDefinition

boolean

options

OperationOptions

Kiterjesztett műveleti lehetőségek, beleértve a következőt:ModelDefinition: Ha igaz, a rendszer visszaadja a modelldefiníciót az eredmény részeként. Alapértelmezett érték: hamis.

Válaszok

Promise<DigitalTwinModelsGetByIdResponse>

Az alkalmazás/json modell és a HTTP-válasz.

getRelationship(string, string, OperationOptions)

Kapcsolatot létesíthet egy digitális ikerpéldányon.

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

Paraméterek

digitalTwinId

string

A forrás digitális ikerpéldány azonosítója.

relationshipId

string

A lekérendő kapcsolat azonosítója.

options

OperationOptions

A művelet beállításai

Válaszok

Promise<DigitalTwinsGetRelationshipByIdResponse>

A megadott digitális ikerpéldányhoz tartozó alkalmazás-json kapcsolatok lapozható listája és a HTTP-válasz.

listEventRoutes(number, OperationOptions & PageSettings)

Egy digitális ikerpéldány eseményútvonalainak listázása.

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

Paraméterek

resultsPerPage

number

Kérésenként lekérhető elemek maximális száma. A kiszolgáló dönthet úgy, hogy a kért maximálisnál kevesebbet ad vissza.

options

OperationOptions & PageSettings

Válaszok

PagedAsyncIterableIterator<EventRoute, EventRoutesListNextResponse, PageSettings>

Az application/json eseményútvonal és a HTTP-válasz.

listIncomingRelationships(string, OperationOptions & PageSettings)

Egy digitális ikerpéldány összes bejövő kapcsolatának lekérése.

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

Paraméterek

digitalTwinId

string

A digitális ikerpéldány azonosítója.

options

OperationOptions & PageSettings

Válaszok

PagedAsyncIterableIterator<IncomingRelationship, DigitalTwinsListIncomingRelationshipsResponse, PageSettings>

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

Modellek listájának lekérése

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

Paraméterek

dependeciesFor

string[]

A modellazonosítók a függőségek lekéréséhez. Ha nincs megadva, a rendszer lekéri az összes modellt.

includeModelDefinition

boolean

A modelldefiníció belefoglalása az eredménybe. Ha hamis, a rendszer csak a modell metaadatait adja vissza.

resultsPerPage

number

Kérésenként lekérhető elemek maximális száma. A kiszolgáló dönthet úgy, hogy a kért maximálisnál kevesebbet ad vissza.

options

OperationOptions & PageSettings

Válaszok

PagedAsyncIterableIterator<DigitalTwinsModelData, DigitalTwinModelsListResponse, PageSettings>

Az alkalmazás-/json-modellek lapozható készlete és a HTTP-válasz.

listRelationships(string, OperationOptions & PageSettings)

Digitális ikerpéldány kapcsolatainak lekérése.

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

Paraméterek

digitalTwinId

string

A digitális ikerpéldány azonosítója.

options

OperationOptions & PageSettings

Válaszok

PagedAsyncIterableIterator<any, DigitalTwinsListRelationshipsResponse, PageSettings>

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

Telemetria közzététele egy digitális ikerpéldány összetevőből, amelyet aztán a megadott egy vagy több célvégpont (előfizető) használ fel.

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

Paraméterek

digitalTwinId

string

A törölni kívánt digitális ikerpéldány azonosítója.

componentName

string

A DTDL-összetevő neve.

payload

string

Az elküldendő alkalmazás-/json-telemetriai hasznos adatok.

messageId

string

Az üzenet azonosítója.

options

OperationOptions

A művelet beállításai

Válaszok

Promise<RestResponse>

A http-válasz.

publishTelemetry(string, any, string, OperationOptions)

Telemetria közzététele egy digitális ikerpéldányról, amelyet aztán a megadott egy vagy több célvégpont (előfizető) használ fel.

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

Paraméterek

digitalTwinId

string

A törölni kívánt digitális ikerpéldány azonosítója.

payload

any

Az elküldendő alkalmazás-/json-telemetriai hasznos adatok.

messageId

string

Az üzenet azonosítója.

options

OperationOptions

A művelet beállításai

Válaszok

Promise<RestResponse>

A http-válasz.

queryTwins(string, number, OperationOptions & PageSettings)

Digitális ikerpéldányok lekérdezése.

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

Paraméterek

query

string

A lekérdezési sztring SQL-szerű szintaxisban.

resultsPerPage

number

Kérésenként lekérhető elemek maximális száma. A kiszolgáló dönthet úgy, hogy a kért maximálisnál kevesebbet ad vissza.

options

OperationOptions & PageSettings

Válaszok

PagedAsyncIterableIterator<any, QueryQueryTwinsResponse, PageSettings>

A lekérdezés eredményeinek lapozható listája.

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

Egy digitális ikerpéldányon lévő összetevő tulajdonságainak frissítése JSON-javítás használatával.

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

Paraméterek

digitalTwinId

string

A digitális ikerpéldány azonosítója.

componentName

string

A frissítés alatt álló összetevő.

jsonPatch

any[]

A megadott digitális ikerpéldányon végrehajtandó alkalmazás-/json-patch+json műveletek.

options

DigitalTwinsUpdateComponentOptionalParams

Kiterjesztett műveletbeállítások, beleértve az ifMatch-et is: Csak akkor hajtsa végre a műveletet, ha az entitás etagje megegyezik a megadott etagek egyikével, vagy * meg van adva.

Válaszok

Promise<DigitalTwinsUpdateComponentResponse>

A http-válasz.

updateDigitalTwin(string, any, DigitalTwinsUpdateOptionalParams)

Digitális ikerpéldány frissítése json-javítás használatával.

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

Paraméterek

digitalTwinId

string

A digitális ikerpéldány azonosítója.

jsonPatch

any

A JSON-javítás által leírt frissítési specifikáció. Frissítések tulajdonságértékek és $model elemek ugyanabban a kérésben fordulhatnak elő. A műveletek hozzáadására, cseréjére és eltávolítására korlátozódnak.

options

DigitalTwinsUpdateOptionalParams

Kiterjesztett műveletbeállítások, beleértve az ifMatch-et is: Csak akkor hajtsa végre a műveletet, ha az entitás etagje megegyezik a megadott etagek egyikével, vagy * meg van adva.

Válaszok

Promise<DigitalTwinsUpdateResponse>

A http-válasz.

updateRelationship(string, string, any[], DigitalTwinsUpdateRelationshipOptionalParams)

Frissítések egy kapcsolat tulajdonságait egy digitális ikerpéldányon egy JSON-javítás használatával.

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

Paraméterek

digitalTwinId

string

A törölni kívánt digitális ikerpéldány azonosítója.

relationshipId

string

A frissíteni kívánt kapcsolat azonosítója.

jsonPatch

any[]

A megadott digitális ikerpéldány kapcsolatán végrehajtandó alkalmazás-/json-patch+json műveletek.

options

DigitalTwinsUpdateRelationshipOptionalParams

Bővített műveleti beállítások ifMatch: Csak akkor hajtsa végre a műveletet, ha az entitás etagje megegyezik a megadott etagek egyikével, vagy * meg van adva.

Válaszok

Promise<DigitalTwinsUpdateRelationshipResponse>

upsertDigitalTwin(string, string, DigitalTwinsAddOptionalParams)

Digitális ikerpéldány létrehozása vagy frissítése

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

Paraméterek

digitalTwinId

string

A létrehozandó vagy frissíteni kívánt digitális ikerpéldány azonosítója.

digitalTwinJson

string

A létrehozandó alkalmazás/json digitális ikerpéldány.

options

DigitalTwinsAddOptionalParams

Bővített műveletbeállítások, beleértve az ifNoneMatch-t is: Csak akkor hajtsa végre a műveletet, ha az entitás még nem létezik.

Válaszok

Promise<DigitalTwinsAddResponse>

A létrehozott alkalmazás/json digitális ikerpéldány és a HTTP-válasz.

upsertEventRoute(string, string, string, OperationOptions)

Eseményútvonal létrehozása vagy frissítése.

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

Paraméterek

eventRouteId

string

A létrehozandó vagy frissíteni kívánt eseményútvonal azonosítója.

endpointId

string

Annak a végpontnak az azonosítója, amelyhez az eseményútvonal hozzá van kötve.

filter

string

A végpontra irányított eseményeket leíró kifejezés.

options

OperationOptions

A művelet beállításai

Válaszok

Promise<RestResponse>

A http-válasz.

upsertRelationship(string, string, any, DigitalTwinsAddRelationshipOptionalParams)

Kapcsolat létrehozása vagy frissítése digitális ikerpéldányon.

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

Paraméterek

digitalTwinId

string

A forrás digitális ikerpéldány azonosítója.

relationshipId

string

A létrehozandó kapcsolat azonosítója.

relationship

any

A létrehozandó alkalmazás-json kapcsolat.

options

DigitalTwinsAddRelationshipOptionalParams

Bővített műveletbeállítások, beleértve az ifNoneMatch-t is: Csak akkor hajtsa végre a műveletet, ha az entitás még nem létezik.

Válaszok

Promise<DigitalTwinsAddRelationshipResponse>