DigitalTwinsClient class
Client für Azure IoT DigitalTwins-API.
Konstruktoren
| Digital |
Erstellt eine Instanz von AzureDigitalTwinsAPI. Beispielverwendung: |
Methoden
| create |
Erstellen einer oder mehrerer |
| decomission |
Setzen Sie ein Modell mithilfe eines JSON-Patches außer Betrieb. Wenn ein Modell außer Betrieb genommen wird, können neue digitale Zwillinge nicht mehr durch dieses Modell definiert werden. Vorhandene digitale Zwillinge können dieses Modell jedoch weiterhin verwenden. Sobald ein Modell außer Betrieb genommen wurde, wird es möglicherweise nicht mehr in Betrieb genommen. |
| delete |
Löschen eines digitalen Zwillings |
| delete |
Löschen sie eine Ereignisroute. |
| delete |
Löschen Sie ein Modell. |
| delete |
Löschen einer Beziehung zu einem digitalen Zwilling. |
| get |
Rufen Sie eine Komponente für einen 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 |
Rufen Sie eine Beziehung zu einem digitalen Zwilling auf. |
| list |
Listen Sie die Ereignisrouten in einer Digital Twins-Instanz auf. |
| list |
Ruft alle eingehenden Beziehungen für einen digitalen Zwilling ab. |
| list |
Abrufen der Liste der Modelle |
| list |
Abrufen von Beziehungen für einen digitalen Zwilling. |
| publish |
Veröffentlichen Sie Telemetriedaten aus der Komponente eines digitalen Zwillings, die dann von einem oder mehreren Unter definierten Zielendpunkten (Abonnenten) genutzt wird. |
| publish |
Veröffentlichen Sie Telemetriedaten aus einem digitalen Zwilling, die dann von einem oder mehreren Zielendpunkten (Abonnenten) genutzt werden, die unter definiert sind. |
| query |
Abfragen für digitale Zwillinge. |
| 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 |
Aktualisierungen die Eigenschaften einer Beziehung zu 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:
const { DigitalTwinsClient, ServiceClientCredentials } = require("@azure/digital-twins-core");
const client = new DigitalTwinsClient(
"<endpoint>",
new DefaultAzureCredential();
);
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(any[], OperationOptions)
Erstellen einer oder mehrerer
function createModels(dtdlModels: any[], options?: OperationOptions): Promise<DigitalTwinModelsAddResponse>Parameter
- dtdlModels
-
any[]
- options
- OperationOptions
Die Vorgangsoptionen
Gibt zurück
Promise<DigitalTwinModelsAddResponse>
Die erstellten Anwendungs-/JSON-Modelle und die HTTP-Antwort.
decomissionModel(string, OperationOptions)
Setzen Sie ein Modell mithilfe eines JSON-Patches außer Betrieb. Wenn ein Modell außer Betrieb genommen wird, können neue digitale Zwillinge nicht mehr durch dieses Modell definiert werden. Vorhandene digitale Zwillinge können dieses Modell jedoch weiterhin verwenden. Sobald ein Modell außer Betrieb genommen wurde, wird es möglicherweise nicht mehr in Betrieb genommen.
function decomissionModel(modelId: string, options?: OperationOptions): Promise<RestResponse>Parameter
- modelId
-
string
Die ID des außer Betrieb zu setzenden Modells. -Eigenschaft kann ersetzt werden.
- options
- OperationOptions
Die Vorgangsoptionen
Gibt zurück
Promise<RestResponse>
Die HTTP-Antwort.
deleteDigitalTwin(string, DigitalTwinsDeleteOptionalParams)
Löschen eines digitalen Zwillings
function deleteDigitalTwin(digitalTwinId: string, options?: DigitalTwinsDeleteOptionalParams): Promise<RestResponse>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 oder * übereinstimmt.
Gibt zurück
Promise<RestResponse>
Die HTTP-Antwort.
deleteEventRoute(string, OperationOptions)
Löschen sie eine Ereignisroute.
function deleteEventRoute(eventRouteId: string, options?: OperationOptions): Promise<RestResponse>Parameter
- eventRouteId
-
string
Die ID des zu löschenden eventRoute.The ID of the eventRoute to delete.
- options
- OperationOptions
Die Vorgangsoptionen
Gibt zurück
Promise<RestResponse>
Die HTTP-Antwort.
deleteModel(string, OperationOptions)
Löschen Sie ein Modell.
function deleteModel(modelId: string, options?: OperationOptions): Promise<RestResponse>Parameter
- modelId
-
string
Die ID des zu löschenden Modells.
- options
- OperationOptions
Die Vorgangsoptionen
Gibt zurück
Promise<RestResponse>
Die HTTP-Antwort.
deleteRelationship(string, string, DigitalTwinsDeleteRelationshipOptionalParams)
Löschen einer Beziehung zu einem digitalen Zwilling.
function deleteRelationship(digitalTwinId: string, relationshipId: string, options?: DigitalTwinsDeleteRelationshipOptionalParams): Promise<RestResponse>Parameter
- digitalTwinId
-
string
Die ID des digitalen Quellzwillens.
- 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 oder * übereinstimmt.
Gibt zurück
Promise<RestResponse>
Die HTTP-Antwort.
getComponent(string, string, OperationOptions)
Rufen Sie eine Komponente für einen 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 bereitgestellten componentName und der HTTP-Antwort 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 und die HTTP-Antwort.
getEventRoute(string, OperationOptions)
Rufen Sie eine Ereignisroute ab.
function getEventRoute(eventRouteId: string, options?: OperationOptions): Promise<EventRoutesGetByIdResponse>Parameter
- eventRouteId
-
string
- options
- OperationOptions
Die Vorgangsoptionen
Gibt zurück
Promise<EventRoutesGetByIdResponse>
Die Anwendungs-/JSON-Ereignisroute und die HTTP-Antwort.
getModel(string, boolean, OperationOptions)
Rufen Sie ein Modell ab, einschließlich der Modellmetadaten und der Modelldefinition.
function getModel(modelId: string, includeModelDefinition?: boolean, options?: OperationOptions): Promise<DigitalTwinModelsGetByIdResponse>Parameter
- modelId
-
string
Die ID des Modells.
- includeModelDefinition
-
boolean
- options
- OperationOptions
Erweiterte Vorgangsoptionen, einschließlich includeModelDefinition: Wenn true, wird die Modelldefinition als Teil des Ergebnisses zurückgegeben. Standardwert: False
Gibt zurück
Promise<DigitalTwinModelsGetByIdResponse>
Das Anwendungs-/JSON-Modell und die HTTP-Antwort.
getRelationship(string, string, OperationOptions)
Rufen Sie eine Beziehung zu einem digitalen Zwilling auf.
function getRelationship(digitalTwinId: string, relationshipId: string, options?: OperationOptions): Promise<DigitalTwinsGetRelationshipByIdResponse>Parameter
- digitalTwinId
-
string
Die ID des digitalen Quellzwillens.
- 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 und zur HTTP-Antwort gehören.
listEventRoutes(number, OperationOptions & PageSettings)
Listen Sie die Ereignisrouten in einer Digital Twins-Instanz auf.
function listEventRoutes(resultsPerPage?: number, options?: OperationOptions & PageSettings): PagedAsyncIterableIterator<EventRoute, EventRoutesListNextResponse, PageSettings>Parameter
- resultsPerPage
-
number
Die maximale Anzahl von Elementen, die pro Anforderung abgerufen werden sollen. Der Server kann sich dafür entscheiden, weniger als den angeforderten Max zurückzugeben.
- options
Gibt zurück
Die Anwendungs-/JSON-Ereignisroute und die HTTP-Antwort.
listIncomingRelationships(string, OperationOptions & PageSettings)
Ruft alle eingehenden Beziehungen für einen digitalen Zwilling ab.
function listIncomingRelationships(digitalTwinId: string, options?: OperationOptions & PageSettings): PagedAsyncIterableIterator<IncomingRelationship, DigitalTwinsListIncomingRelationshipsResponse, PageSettings>Parameter
- digitalTwinId
-
string
Die ID des digitalen Zwillings.
- options
Gibt zurück
listModels(string[], boolean, number, OperationOptions & PageSettings)
Abrufen der Liste der Modelle
function listModels(dependeciesFor?: string[], includeModelDefinition?: boolean, resultsPerPage?: number, options?: OperationOptions & PageSettings): PagedAsyncIterableIterator<DigitalTwinsModelData, DigitalTwinModelsListResponse, PageSettings>Parameter
- dependeciesFor
-
string[]
Die Modell-IDs, die Abhängigkeiten abgerufen werden sollen. Wenn nicht angegeben, werden alle Modelle abgerufen.
- includeModelDefinition
-
boolean
Gibt an, ob die Modelldefinition in das Ergebnis eingeschlossen werden soll. Bei false werden nur die Modellmetadaten zurückgegeben.
- resultsPerPage
-
number
Die maximale Anzahl von Elementen, die pro Anforderung abgerufen werden sollen. Der Server kann sich dafür entscheiden, weniger als den angeforderten Max zurückzugeben.
- options
Gibt zurück
Ein auslagerungsfähiger Satz von Anwendungs-/JSON-Modellen und der HTTP-Antwort.
listRelationships(string, OperationOptions & PageSettings)
Abrufen von Beziehungen für einen digitalen Zwilling.
function listRelationships(digitalTwinId: string, options?: OperationOptions & PageSettings): PagedAsyncIterableIterator<any, DigitalTwinsListRelationshipsResponse, PageSettings>Parameter
- digitalTwinId
-
string
Die ID des digitalen Zwillings.
- options
Gibt zurück
publishComponentTelemetry(string, string, string, string, OperationOptions)
Veröffentlichen Sie Telemetriedaten aus der Komponente eines digitalen Zwillings, die dann von einem oder mehreren Unter definierten Zielendpunkten (Abonnenten) genutzt wird.
function publishComponentTelemetry(digitalTwinId: string, componentName: string, payload: string, messageId: string, options?: OperationOptions): Promise<RestResponse>Parameter
- digitalTwinId
-
string
Die ID des zu löschenden digitalen Zwillings.
- componentName
-
string
Der Name der DTDL-Komponente.
- payload
-
string
Die zu sendende Anwendungs-/JSON-Telemetrienutzlast.
- messageId
-
string
Die Meldungs-ID.
- options
- OperationOptions
Die Vorgangsoptionen
Gibt zurück
Promise<RestResponse>
Die HTTP-Antwort.
publishTelemetry(string, any, string, OperationOptions)
Veröffentlichen Sie Telemetriedaten aus einem digitalen Zwilling, die dann von einem oder mehreren Zielendpunkten (Abonnenten) genutzt werden, die unter definiert sind.
function publishTelemetry(digitalTwinId: string, payload: any, messageId: string, options?: OperationOptions): Promise<RestResponse>Parameter
- digitalTwinId
-
string
Die ID des zu löschenden digitalen Zwillings.
- payload
-
any
Die zu sendende Anwendungs-/JSON-Telemetrienutzlast.
- messageId
-
string
Die Meldungs-ID.
- options
- OperationOptions
Die Vorgangsoptionen
Gibt zurück
Promise<RestResponse>
Die HTTP-Antwort.
queryTwins(string, number, OperationOptions & PageSettings)
Abfragen für digitale Zwillinge.
function queryTwins(query: string, resultsPerPage?: number, options?: OperationOptions & PageSettings): PagedAsyncIterableIterator<any, QueryQueryTwinsResponse, PageSettings>Parameter
- query
-
string
Die Abfragezeichenfolge in SQL-ähnlicher Syntax.
- resultsPerPage
-
number
Die maximale Anzahl von Elementen, die pro Anforderung abgerufen werden sollen. Der Server kann sich dafür entscheiden, weniger als den angeforderten Max zurückzugeben.
- options
Gibt zurück
Die auslagerungsfähige Liste der Abfrageergebnisse.
updateComponent(string, string, any[], DigitalTwinsUpdateComponentOptionalParams)
Aktualisieren sie die Eigenschaften einer Komponente auf einem digitalen Zwilling mithilfe eines JSON-Patches.
function updateComponent(digitalTwinId: string, componentName: string, jsonPatch: any[], options?: DigitalTwinsUpdateComponentOptionalParams): Promise<DigitalTwinsUpdateComponentResponse>Parameter
- digitalTwinId
-
string
Die ID des digitalen Zwillings.
- componentName
-
string
Die Komponente, die aktualisiert wird.
- jsonPatch
-
any[]
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 oder * übereinstimmt.
Gibt zurück
Promise<DigitalTwinsUpdateComponentResponse>
Die HTTP-Antwort.
updateDigitalTwin(string, any, DigitalTwinsUpdateOptionalParams)
Aktualisieren Sie einen digitalen Zwilling mithilfe eines JSON-Patches.
function updateDigitalTwin(digitalTwinId: string, jsonPatch: any, options?: DigitalTwinsUpdateOptionalParams): Promise<DigitalTwinsUpdateResponse>Parameter
- digitalTwinId
-
string
Die ID des digitalen Zwillings.
- jsonPatch
-
any
Eine Updatespezifikation, die von JSON Patch beschrieben wird. Aktualisierungen zu Eigenschaftswerten und $model Elementen kann in derselben Anforderung erfolgen. 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 oder * übereinstimmt.
Gibt zurück
Promise<DigitalTwinsUpdateResponse>
Die HTTP-Antwort.
updateRelationship(string, string, any[], DigitalTwinsUpdateRelationshipOptionalParams)
Aktualisierungen die Eigenschaften einer Beziehung zu einem digitalen Zwilling mithilfe eines JSON-Patches.
function updateRelationship(digitalTwinId: string, relationshipId: string, jsonPatch: any[], options?: DigitalTwinsUpdateRelationshipOptionalParams): Promise<DigitalTwinsUpdateRelationshipResponse>Parameter
- digitalTwinId
-
string
Die ID des zu löschenden digitalen Zwillings.
- relationshipId
-
string
Die ID der zu aktualisierenden Beziehung.
- jsonPatch
-
any[]
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 oder * übereinstimmt.
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 zu erstellenden oder zu aktualisierenden digitalen Zwillings.
- 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 digitale Anwendungs-/JSON-Zwilling und die HTTP-Antwort.
upsertEventRoute(string, string, string, OperationOptions)
Erstellen oder Aktualisieren einer Ereignisroute
function upsertEventRoute(eventRouteId: string, endpointId: string, filter: string, options?: OperationOptions): Promise<RestResponse>Parameter
- eventRouteId
-
string
Die ID der zu erstellenden oder zu aktualisierenden Ereignisroute.
- 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<RestResponse>
Die HTTP-Antwort.
upsertRelationship(string, string, any, DigitalTwinsAddRelationshipOptionalParams)
Erstellen oder Aktualisieren einer Beziehung zu einem digitalen Zwilling
function upsertRelationship(digitalTwinId: string, relationshipId: string, relationship: any, options?: DigitalTwinsAddRelationshipOptionalParams): Promise<DigitalTwinsAddRelationshipResponse>Parameter
- digitalTwinId
-
string
Die ID des digitalen Quellzwillens.
- relationshipId
-
string
Die ID der zu erstellenden Beziehung.
- relationship
-
any
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>