DigitalTwinsClient class
Client für Azure IoT DigitalTwins-API.
Konstruktoren
| Digital |
Erstellt eine Instanz von AzureDigitalTwinsAPI. Beispielverwendung: |
Methoden
| create |
Erstellen einer oder mehrerer |
| decomission |
Außerbetriebnahme eines Modells mithilfe eines JSON-Patches. Wenn ein Modell außer Betrieb genommen wird, können neue digitale Zwillinge nicht mehr durch dieses Modell definiert werden. Bestehende digitale Zwillinge können dieses Modell jedoch weiterhin verwenden. Sobald ein Modell außer Betrieb genommen wurde, wird es möglicherweise nicht erneut in Betrieb genommen. |
| delete |
Löschen eines digitalen Zwillings |
| delete |
Löschen sie eine Ereignisroute. |
| delete |
Löschen sie ein Modell. |
| delete |
Löschen Sie eine Beziehung zu einem digitalen Zwilling. |
| get |
Rufen Sie eine Komponente auf einem digitalen Zwilling ab. |
| get |
Abrufen eines digitalen Zwillings |
| get |
Rufen Sie eine Ereignisroute ab. |
| get |
Rufen Sie ein Modell ab, einschließlich der Modellmetadaten und der Modelldefinition. |
| get |
Erhalten Sie eine Beziehung zu einem digitalen Zwilling. |
| list |
Listen Sie die Ereignisrouten in einer digitalen Twins-Instanz auf. |
| list |
Rufen Sie alle eingehenden Beziehungen für einen digitalen Zwilling ab. |
| list |
Abrufen der Liste der Modelle |
| list |
Dient zum Abrufen von Beziehungen für einen digitalen Zwilling. |
| publish |
Veröffentlichen Sie Telemetrie aus der Komponente eines digitalen Zwillings, die dann von einem oder mehreren Zielendpunkten (Abonnenten) genutzt wird, die unter definiert sind. |
| publish |
Veröffentlichen Sie Telemetrie von einem digitalen Zwilling, der dann von einem oder mehreren Zielendpunkten (Abonnenten) genutzt wird, die unter definiert sind. |
| query |
Abfrage nach digitalen Zwillingen. |
| update |
Aktualisieren Sie die Eigenschaften einer Komponente auf einem digitalen Zwilling mithilfe eines JSON-Patches. |
| update |
Aktualisieren Sie einen digitalen Zwilling mithilfe eines JSON-Patches. |
| update |
Aktualisiert die Eigenschaften einer Beziehung auf einem digitalen Zwilling mithilfe eines JSON-Patches. |
| upsert |
Erstellen oder Aktualisieren eines digitalen Zwillings |
| upsert |
Erstellen oder Aktualisieren einer Ereignisroute. |
| upsert |
Erstellen oder Aktualisieren einer Beziehung zu einem digitalen Zwilling. |
Details zum Konstruktor
DigitalTwinsClient(string, TokenCredential, DigitalTwinsClientOptions)
Erstellt eine Instanz von AzureDigitalTwinsAPI.
Beispielverwendung:
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)Parameter
- endpointUrl
-
string
Die Endpunkt-URL des Diensts.
- credential
- TokenCredential
Wird verwendet, um Anforderungen an den Dienst zu authentifizieren.
- options
- DigitalTwinsClientOptions
Wird zum Konfigurieren des Dienstclients verwendet.
Details zur Methode
createModels(Record<string, unknown>[], OperationOptions)
Erstellen einer oder mehrerer
function createModels(dtdlModels: Record<string, unknown>[], options?: OperationOptions): Promise<DigitalTwinModelsAddResponse>Parameter
- dtdlModels
-
Record<string, unknown>[]
Der Satz von Modellen, die erstellt werden sollen. Jeder String entspricht genau einem Modell.
- options
- OperationOptions
Die Vorgangsoptionen
Gibt zurück
Promise<DigitalTwinModelsAddResponse>
Die erstellten application/json-Modelle.
decomissionModel(string, OperationOptions)
Außerbetriebnahme eines Modells mithilfe eines JSON-Patches. Wenn ein Modell außer Betrieb genommen wird, können neue digitale Zwillinge nicht mehr durch dieses Modell definiert werden. Bestehende digitale Zwillinge können dieses Modell jedoch weiterhin verwenden. Sobald ein Modell außer Betrieb genommen wurde, wird es möglicherweise nicht erneut in Betrieb genommen.
function decomissionModel(modelId: string, options?: OperationOptions): Promise<void>Parameter
- modelId
-
string
Die ID des Modells, das außer Betrieb genommen werden soll. -Eigenschaft kann ersetzt werden.
- options
- OperationOptions
Die Vorgangsoptionen
Gibt zurück
Promise<void>
deleteDigitalTwin(string, DigitalTwinsDeleteOptionalParams)
Löschen eines digitalen Zwillings
function deleteDigitalTwin(digitalTwinId: string, options?: DigitalTwinsDeleteOptionalParams): Promise<void>Parameter
- digitalTwinId
-
string
Die ID des zu löschenden digitalen Zwillings.
- options
- DigitalTwinsDeleteOptionalParams
Erweiterte Vorgangsoptionen, einschließlich ifMatch: Führen Sie den Vorgang nur aus, wenn das etag der Entität mit einem der bereitgestellten etags übereinstimmt oder * bereitgestellt wird.
Gibt zurück
Promise<void>
deleteEventRoute(string, OperationOptions)
Löschen sie eine Ereignisroute.
function deleteEventRoute(eventRouteId: string, options?: OperationOptions): Promise<void>Parameter
- eventRouteId
-
string
Die ID der zu löschenden eventRoute.
- options
- OperationOptions
Die Vorgangsoptionen
Gibt zurück
Promise<void>
deleteModel(string, OperationOptions)
Löschen sie ein Modell.
function deleteModel(modelId: string, options?: OperationOptions): Promise<void>Parameter
- modelId
-
string
Die ID des zu löschenden Modells.
- options
- OperationOptions
Die Vorgangsoptionen
Gibt zurück
Promise<void>
deleteRelationship(string, string, DigitalTwinsDeleteRelationshipOptionalParams)
Löschen Sie eine Beziehung zu einem digitalen Zwilling.
function deleteRelationship(digitalTwinId: string, relationshipId: string, options?: DigitalTwinsDeleteRelationshipOptionalParams): Promise<void>Parameter
- digitalTwinId
-
string
Die ID des digitalen Zwillings der Quelle.
- relationshipId
-
string
Die ID der zu löschenden Beziehung.
Die Vorgangsoptionen ifMatch: Führen Sie den Vorgang nur aus, wenn das Etag der Entität mit einem der bereitgestellten etags übereinstimmt oder * ist.
Gibt zurück
Promise<void>
getComponent(string, string, OperationOptions)
Rufen Sie eine Komponente auf einem digitalen Zwilling ab.
function getComponent(digitalTwinId: string, componentName: string, options?: OperationOptions): Promise<DigitalTwinsGetComponentResponse>Parameter
- digitalTwinId
-
string
Die ID des digitalen Zwillings.
- componentName
-
string
Die abzurufende Komponente.
- options
- OperationOptions
Die Vorgangsoptionen
Gibt zurück
Promise<DigitalTwinsGetComponentResponse>
Json-Zeichenfolgendarstellung der Komponente, die dem angegebenen componentName entspricht.
getDigitalTwin(string, OperationOptions)
Abrufen eines digitalen Zwillings
function getDigitalTwin(digitalTwinId: string, options?: OperationOptions): Promise<DigitalTwinsGetByIdResponse>Parameter
- digitalTwinId
-
string
Die ID des digitalen Zwillings.
- options
- OperationOptions
Die Vorgangsoptionen
Gibt zurück
Promise<DigitalTwinsGetByIdResponse>
Der digitale Zwilling application/json.
getEventRoute(string, OperationOptions)
Rufen Sie eine Ereignisroute ab.
function getEventRoute(eventRouteId: string, options?: OperationOptions): Promise<EventRoute>Parameter
- eventRouteId
-
string
- options
- OperationOptions
Die Vorgangsoptionen
Gibt zurück
Promise<EventRoute>
Die application/json-Ereignisroute.
getModel(string, DigitalTwinModelsGetByIdOptionalParams)
Rufen Sie ein Modell ab, einschließlich der Modellmetadaten und der Modelldefinition.
function getModel(modelId: string, options?: DigitalTwinModelsGetByIdOptionalParams): Promise<DigitalTwinsModelData>Parameter
- modelId
-
string
Die ID des Modells.
- options
- GetModelOptions
Optionen für diesen Vorgang
Gibt zurück
Promise<DigitalTwinsModelData>
Das application/json-Modell.
getRelationship(string, string, OperationOptions)
Erhalten Sie eine Beziehung zu einem digitalen Zwilling.
function getRelationship(digitalTwinId: string, relationshipId: string, options?: OperationOptions): Promise<DigitalTwinsGetRelationshipByIdResponse>Parameter
- digitalTwinId
-
string
Die ID des digitalen Zwillings der Quelle.
- relationshipId
-
string
Die ID der abzurufenden Beziehung.
- options
- OperationOptions
Die Vorgangsoptionen
Gibt zurück
Die auslagerungsfähige Liste der Anwendungs-/JSON-Beziehungen, die zum angegebenen digitalen Zwilling gehören.
listEventRoutes(EventRoutesListOptionalParams)
Listen Sie die Ereignisrouten in einer digitalen Twins-Instanz auf.
function listEventRoutes(options?: EventRoutesListOptionalParams): PagedAsyncIterableIterator<EventRoute, EventRoute[], PageSettings>Parameter
- options
- ListEventRoutesOptions
Optionen für listEventRoutes.
Gibt zurück
Die application/json-Ereignisroute.
listIncomingRelationships(string, DigitalTwinsListIncomingRelationshipsOptionalParams)
Rufen Sie alle eingehenden Beziehungen für einen digitalen Zwilling ab.
function listIncomingRelationships(digitalTwinId: string, options?: DigitalTwinsListIncomingRelationshipsOptionalParams): PagedAsyncIterableIterator<IncomingRelationship, IncomingRelationship[], PageSettings>Parameter
- digitalTwinId
-
string
Die ID des digitalen Zwillings.
- options
- ListIncomingRelationshipsOptions
Gibt zurück
listModels(DigitalTwinModelsListOptionalParams)
Abrufen der Liste der Modelle
function listModels(options?: DigitalTwinModelsListOptionalParams): PagedAsyncIterableIterator<DigitalTwinsModelData, DigitalTwinsModelData[], PageSettings>Parameter
- options
- ListModelsOptions
Optionen für Auflistungsmodelle.
Gibt zurück
Ein auslagerungsfähiger Satz von Anwendungs-/JSON-Modellen.
listRelationships(string, DigitalTwinsListRelationshipsOptionalParams)
Dient zum Abrufen von Beziehungen für einen digitalen Zwilling.
function listRelationships(digitalTwinId: string, options?: DigitalTwinsListRelationshipsOptionalParams): PagedAsyncIterableIterator<Record<string, unknown>, Record<string, unknown>[], PageSettings>Parameter
- digitalTwinId
-
string
Die ID des digitalen Zwillings.
- options
- ListRelationshipsOptions
Gibt zurück
PagedAsyncIterableIterator<Record<string, unknown>, Record<string, unknown>[], PageSettings>
publishComponentTelemetry(string, string, Record<string, unknown>, string, OperationOptions)
Veröffentlichen Sie Telemetrie aus der Komponente eines digitalen Zwillings, die dann von einem oder mehreren Zielendpunkten (Abonnenten) genutzt wird, die unter definiert sind.
function publishComponentTelemetry(digitalTwinId: string, componentName: string, payload: Record<string, unknown>, messageId: string, options?: OperationOptions): Promise<void>Parameter
- digitalTwinId
-
string
Die ID des zu löschenden digitalen Zwillings.
- componentName
-
string
Der Name der DTDL-Komponente.
- payload
-
Record<string, unknown>
Die zu sendende Anwendungs-/JSON-Telemetrienutzlast.
- messageId
-
string
Die Nachrichten-ID.
- options
- OperationOptions
Die Vorgangsoptionen
Gibt zurück
Promise<void>
publishTelemetry(string, Record<string, unknown>, string, OperationOptions)
Veröffentlichen Sie Telemetrie von einem digitalen Zwilling, der dann von einem oder mehreren Zielendpunkten (Abonnenten) genutzt wird, die unter definiert sind.
function publishTelemetry(digitalTwinId: string, payload: Record<string, unknown>, messageId: string, options?: OperationOptions): Promise<void>Parameter
- digitalTwinId
-
string
Die ID des zu löschenden digitalen Zwillings.
- payload
-
Record<string, unknown>
Die zu sendende Anwendungs-/JSON-Telemetrienutzlast.
- messageId
-
string
Die Nachrichten-ID.
- options
- OperationOptions
Die Vorgangsoptionen
Gibt zurück
Promise<void>
queryTwins(string, QueryQueryTwinsOptionalParams)
Abfrage nach digitalen Zwillingen.
function queryTwins(query: string, options?: QueryQueryTwinsOptionalParams): PagedAsyncIterableIterator<Record<string, unknown>, QueryQueryTwinsResponse, PageSettings>Parameter
- query
-
string
Die Abfragezeichenfolge in SQL-ähnliche Syntax.
- options
- QueryTwinsOptions
Optionen für den Abfragevorgang.
Gibt zurück
PagedAsyncIterableIterator<Record<string, unknown>, QueryQueryTwinsResponse, PageSettings>
Die seitenfähige Liste der Abfrageergebnisse.
updateComponent(string, string, Record<string, unknown>[], DigitalTwinsUpdateComponentOptionalParams)
Aktualisieren Sie die Eigenschaften einer Komponente auf einem digitalen Zwilling mithilfe eines JSON-Patches.
function updateComponent(digitalTwinId: string, componentName: string, jsonPatch: Record<string, unknown>[], options?: DigitalTwinsUpdateComponentOptionalParams): Promise<DigitalTwinsUpdateComponentHeaders>Parameter
- digitalTwinId
-
string
Die ID des digitalen Zwillings.
- componentName
-
string
Die Komponente, die aktualisiert wird.
- jsonPatch
-
Record<string, unknown>[]
Die application/json-patch+json-Vorgänge, die für die Komponente des angegebenen digitalen Zwillings ausgeführt werden sollen.
Erweiterte Vorgangsoptionen, einschließlich ifMatch: Führen Sie den Vorgang nur aus, wenn das etag der Entität mit einem der bereitgestellten etags übereinstimmt oder * bereitgestellt wird.
Gibt zurück
Promise<DigitalTwinsUpdateComponentHeaders>
updateDigitalTwin(string, Record<string, unknown>[], DigitalTwinsUpdateOptionalParams)
Aktualisieren Sie einen digitalen Zwilling mithilfe eines JSON-Patches.
function updateDigitalTwin(digitalTwinId: string, jsonPatch: Record<string, unknown>[], options?: DigitalTwinsUpdateOptionalParams): Promise<DigitalTwinsUpdateHeaders>Parameter
- digitalTwinId
-
string
Die ID des digitalen Zwillings.
- jsonPatch
-
Record<string, unknown>[]
Eine vom JSON-Patch beschriebene Updatespezifikation. Aktualisierungen von Eigenschaftswerten und $model Elementen können in derselben Anforderung auftreten. Vorgänge sind auf das Hinzufügen, Ersetzen und Entfernen beschränkt.
- options
- DigitalTwinsUpdateOptionalParams
Erweiterte Vorgangsoptionen, einschließlich ifMatch: Führen Sie den Vorgang nur aus, wenn das etag der Entität mit einem der bereitgestellten etags übereinstimmt oder * bereitgestellt wird.
Gibt zurück
Promise<DigitalTwinsUpdateHeaders>
updateRelationship(string, string, Record<string, unknown>[], DigitalTwinsUpdateRelationshipOptionalParams)
Aktualisiert die Eigenschaften einer Beziehung auf einem digitalen Zwilling mithilfe eines JSON-Patches.
function updateRelationship(digitalTwinId: string, relationshipId: string, jsonPatch: Record<string, unknown>[], options?: DigitalTwinsUpdateRelationshipOptionalParams): Promise<DigitalTwinsUpdateRelationshipHeaders>Parameter
- digitalTwinId
-
string
Die ID des zu löschenden digitalen Zwillings.
- relationshipId
-
string
Die ID der zu aktualisierenden Beziehung.
- jsonPatch
-
Record<string, unknown>[]
Die application/json-patch+json-Vorgänge, die für die Beziehung des angegebenen digitalen Zwillings ausgeführt werden sollen.
Erweiterte Vorgangsoptionen ifMatch: Führen Sie den Vorgang nur aus, wenn das Etag der Entität mit einem der bereitgestellten etags übereinstimmt oder * bereitgestellt wird.
Gibt zurück
upsertDigitalTwin(string, string, DigitalTwinsAddOptionalParams)
Erstellen oder Aktualisieren eines digitalen Zwillings
function upsertDigitalTwin(digitalTwinId: string, digitalTwinJson: string, options?: DigitalTwinsAddOptionalParams): Promise<DigitalTwinsAddResponse>Parameter
- digitalTwinId
-
string
Die ID des digitalen Zwillings zum Erstellen oder Aktualisieren.
- digitalTwinJson
-
string
Der zu erstellende digitale Zwilling der Anwendung/json.
- options
- DigitalTwinsAddOptionalParams
Erweiterte Vorgangsoptionen, einschließlich ifNoneMatch: Führen Sie den Vorgang nur aus, wenn die Entität noch nicht vorhanden ist.
Gibt zurück
Promise<DigitalTwinsAddResponse>
Der erstellte application/json Digital Twin.
upsertEventRoute(string, string, string, OperationOptions)
Erstellen oder Aktualisieren einer Ereignisroute.
function upsertEventRoute(eventRouteId: string, endpointId: string, filter: string, options?: OperationOptions): Promise<void>Parameter
- eventRouteId
-
string
Die ID der Ereignisroute zum Erstellen oder Aktualisieren.
- endpointId
-
string
Die ID des Endpunkts, an den diese Ereignisroute gebunden ist.
- filter
-
string
Ein Ausdruck, der die Ereignisse beschreibt, die an den Endpunkt weitergeleitet werden.
- options
- OperationOptions
Die Vorgangsoptionen
Gibt zurück
Promise<void>
upsertRelationship(string, string, Record<string, unknown>, DigitalTwinsAddRelationshipOptionalParams)
Erstellen oder Aktualisieren einer Beziehung zu einem digitalen Zwilling.
function upsertRelationship(digitalTwinId: string, relationshipId: string, relationship: Record<string, unknown>, options?: DigitalTwinsAddRelationshipOptionalParams): Promise<DigitalTwinsAddRelationshipResponse>Parameter
- digitalTwinId
-
string
Die ID des digitalen Zwillings der Quelle.
- relationshipId
-
string
Die ID der zu erstellenden Beziehung.
- relationship
-
Record<string, unknown>
Die zu erstellende Anwendungs-/JSON-Beziehung.
Erweiterte Vorgangsoptionen, einschließlich ifNoneMatch: Führen Sie den Vorgang nur aus, wenn die Entität noch nicht vorhanden ist.
Gibt zurück
Promise<DigitalTwinsAddRelationshipResponse>