DigitalTwinsClient class

Odwołanie

Pakiet:: @azure/digital-twins-core

Klient interfejsu API usługi Azure IoT DigitalTwins.

Konstruktory

DigitalTwinsClient(string, TokenCredential, DigitalTwinsClientOptions)

Tworzy wystąpienie interfejsu AZUREDigitalTwinsAPI.

Przykładowe użycie:

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);

Metody

createModels(Record<string, unknown>[], OperationOptions)	Tworzenie jednej lub wielu
decomissionModel(string, OperationOptions)	Likwiduj model przy użyciu poprawki json. Po zlikwidowaniu modelu nowe cyfrowe reprezentacje bliźniacze nie będą już mogły być zdefiniowane przez ten model. Jednak istniejące cyfrowe reprezentacje bliźniacze mogą nadal korzystać z tego modelu. Po zlikwidowaniu modelu może nie zostać ponownie skompisjona.
deleteDigitalTwin(string, DigitalTwinsDeleteOptionalParams)	Usuwanie cyfrowej reprezentacji bliźniaczej
deleteEventRoute(string, OperationOptions)	Usuwanie trasy zdarzeń.
deleteModel(string, OperationOptions)	Usuwanie modelu.
deleteRelationship(string, string, DigitalTwinsDeleteRelationshipOptionalParams)	Usuwanie relacji w cyfrowej reprezentacji bliźniaczej.
getComponent(string, string, OperationOptions)	Pobierz składnik w cyfrowej reprezentacji bliźniaczej.
getDigitalTwin(string, OperationOptions)	Uzyskiwanie cyfrowej reprezentacji bliźniaczej
getEventRoute(string, OperationOptions)	Pobieranie trasy zdarzeń.
getModel(string, DigitalTwinModelsGetByIdOptionalParams)	Pobierz model, w tym metadane modelu i definicję modelu.
getRelationship(string, string, OperationOptions)	Uzyskaj relację na cyfrowej reprezentacji bliźniaczej.
listEventRoutes(EventRoutesListOptionalParams)	Wyświetl listę tras zdarzeń w wystąpieniu cyfrowych reprezentacji bliźniaczych.
listIncomingRelationships(string, DigitalTwinsListIncomingRelationshipsOptionalParams)	Pobierz wszystkie relacje przychodzące dla cyfrowej reprezentacji bliźniaczej.
listModels(DigitalTwinModelsListOptionalParams)	Pobieranie listy modeli
listRelationships(string, DigitalTwinsListRelationshipsOptionalParams)	Pobieranie relacji dla cyfrowej reprezentacji bliźniaczej.
publishComponentTelemetry(string, string, Record<string, unknown>, string, OperationOptions)	Opublikuj dane telemetryczne ze składnika cyfrowej reprezentacji bliźniaczej, który jest następnie używany przez jeden lub wiele docelowych punktów końcowych (subskrybentów) zdefiniowanych w ramach.
publishTelemetry(string, Record<string, unknown>, string, OperationOptions)	Opublikuj dane telemetryczne z cyfrowej reprezentacji bliźniaczej, która jest następnie zużywana przez jeden lub wiele docelowych punktów końcowych (subskrybentów) zdefiniowanych w ramach.
queryTwins(string, QueryQueryTwinsOptionalParams)	Wykonywanie zapytań dotyczących cyfrowych reprezentacji bliźniaczych.
updateComponent(string, string, Record<string, unknown>[], DigitalTwinsUpdateComponentOptionalParams)	Aktualizowanie właściwości składnika w cyfrowej reprezentacji bliźniaczej przy użyciu poprawki JSON.
updateDigitalTwin(string, Record<string, unknown>[], DigitalTwinsUpdateOptionalParams)	Aktualizowanie cyfrowej reprezentacji bliźniaczej przy użyciu poprawki json.
updateRelationship(string, string, Record<string, unknown>[], DigitalTwinsUpdateRelationshipOptionalParams)	Aktualizuje właściwości relacji w cyfrowej reprezentacji bliźniaczej przy użyciu poprawki JSON.
upsertDigitalTwin(string, string, DigitalTwinsAddOptionalParams)	Tworzenie lub aktualizowanie cyfrowej reprezentacji bliźniaczej
upsertEventRoute(string, string, string, OperationOptions)	Tworzenie lub aktualizowanie trasy zdarzeń.
upsertRelationship(string, string, Record<string, unknown>, DigitalTwinsAddRelationshipOptionalParams)	Tworzenie lub aktualizowanie relacji w cyfrowej reprezentacji bliźniaczej.

Szczegóły konstruktora

DigitalTwinsClient(string, TokenCredential, DigitalTwinsClientOptions)

Tworzy wystąpienie interfejsu AZUREDigitalTwinsAPI.

Przykładowe użycie:

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)

Parametry

endpointUrl: string

Adres URL punktu końcowego usługi.

credential: TokenCredential

Służy do uwierzytelniania żądań w usłudze.

options: DigitalTwinsClientOptions

Służy do konfigurowania klienta usługi.

Szczegóły metody

createModels(Record<string, unknown>[], OperationOptions)

Tworzenie jednej lub wielu

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

Parametry

dtdlModels: Record<string, unknown>[]

Zestaw modeli do stworzenia. Każdy ciąg odpowiada dokładnie jednemu modelowi.

options: OperationOptions

Opcje operacji

Zwraca

Promise<DigitalTwinModelsAddResponse>

Utworzone modele aplikacji/json.

decomissionModel(string, OperationOptions)

Likwiduj model przy użyciu poprawki json. Po zlikwidowaniu modelu nowe cyfrowe reprezentacje bliźniacze nie będą już mogły być zdefiniowane przez ten model. Jednak istniejące cyfrowe reprezentacje bliźniacze mogą nadal korzystać z tego modelu. Po zlikwidowaniu modelu może nie zostać ponownie skompisjona.

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

Parametry

modelId: string

Identyfikator modelu do zlikwidowania. Właściwość można zamienić.

options: OperationOptions

Opcje operacji

Zwraca

Promise<void>

deleteDigitalTwin(string, DigitalTwinsDeleteOptionalParams)

Usuwanie cyfrowej reprezentacji bliźniaczej

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

Parametry

digitalTwinId: string

Identyfikator cyfrowej reprezentacji bliźniaczej do usunięcia.

options: DigitalTwinsDeleteOptionalParams

Opcje rozszerzonej operacji, w tym ifMatch: wykonaj operację tylko wtedy, gdy element etag jednostki pasuje do jednego z podanych elementów etag lub *.

Zwraca

Promise<void>

deleteEventRoute(string, OperationOptions)

Usuwanie trasy zdarzeń.

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

Parametry

eventRouteId: string

Identyfikator zdarzenia do usunięcia.

options: OperationOptions

Opcje operacji

Zwraca

Promise<void>

deleteModel(string, OperationOptions)

Usuwanie modelu.

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

Parametry

modelId: string

Identyfikator modelu do usunięcia.

options: OperationOptions

Opcje operacji

Zwraca

Promise<void>

deleteRelationship(string, string, DigitalTwinsDeleteRelationshipOptionalParams)

Usuwanie relacji w cyfrowej reprezentacji bliźniaczej.

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

Parametry

digitalTwinId: string

Identyfikator źródłowej cyfrowej reprezentacji bliźniaczej.

relationshipId: string

Identyfikator relacji do usunięcia.

options: DigitalTwinsDeleteRelationshipOptionalParams

Opcje operacji ifMatch: wykonaj operację tylko wtedy, gdy element etag jednostki pasuje do jednego z podanych elementów etag lub *

Zwraca

Promise<void>

getComponent(string, string, OperationOptions)

Pobierz składnik w cyfrowej reprezentacji bliźniaczej.

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

Parametry

digitalTwinId: string

Identyfikator cyfrowej reprezentacji bliźniaczej.

componentName: string

Pobierany składnik.

options: OperationOptions

Opcje operacji

Zwraca

Promise<DigitalTwinsGetComponentResponse>

Reprezentacja ciągu JSON składnika odpowiadającego podanej nazwie componentName.

getDigitalTwin(string, OperationOptions)

Uzyskiwanie cyfrowej reprezentacji bliźniaczej

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

Parametry

digitalTwinId: string

Identyfikator cyfrowej reprezentacji bliźniaczej.

options: OperationOptions

Opcje operacji

Zwraca

Promise<DigitalTwinsGetByIdResponse>

Cyfrowy bliźniak aplikacji/json.

getEventRoute(string, OperationOptions)

Pobieranie trasy zdarzeń.

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

Parametry

eventRouteId: string

options: OperationOptions

Opcje operacji

Zwraca

Promise<EventRoute>

Trasa zdarzenia application/json.

getModel(string, DigitalTwinModelsGetByIdOptionalParams)

Pobierz model, w tym metadane modelu i definicję modelu.

function getModel(modelId: string, options?: DigitalTwinModelsGetByIdOptionalParams): Promise<DigitalTwinsModelData>

Parametry

modelId: string

Identyfikator modelu.

options: GetModelOptions

Opcje dla tej operacji

Zwraca

Promise<DigitalTwinsModelData>

Model aplikacji/json.

getRelationship(string, string, OperationOptions)

Uzyskaj relację na cyfrowej reprezentacji bliźniaczej.

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

Parametry

digitalTwinId: string

Identyfikator źródłowej cyfrowej reprezentacji bliźniaczej.

relationshipId: string

Identyfikator relacji do pobrania.

options: OperationOptions

Opcje operacji

Zwraca

Promise<DigitalTwinsGetRelationshipByIdResponse>

Stronicowana lista relacji aplikacji/json należących do określonej cyfrowej reprezentacji bliźniaczej.

listEventRoutes(EventRoutesListOptionalParams)

Wyświetl listę tras zdarzeń w wystąpieniu cyfrowych reprezentacji bliźniaczych.

function listEventRoutes(options?: EventRoutesListOptionalParams): PagedAsyncIterableIterator<EventRoute, EventRoute[], PageSettings>

Parametry

options: ListEventRoutesOptions

Opcje dla listEventRoutes.

Zwraca

PagedAsyncIterableIterator<EventRoute, EventRoute[], PageSettings>

Trasa zdarzenia application/json.

listIncomingRelationships(string, DigitalTwinsListIncomingRelationshipsOptionalParams)

Pobierz wszystkie relacje przychodzące dla cyfrowej reprezentacji bliźniaczej.

function listIncomingRelationships(digitalTwinId: string, options?: DigitalTwinsListIncomingRelationshipsOptionalParams): PagedAsyncIterableIterator<IncomingRelationship, IncomingRelationship[], PageSettings>

Parametry

digitalTwinId: string

Identyfikator cyfrowej reprezentacji bliźniaczej.

options: ListIncomingRelationshipsOptions

Zwraca

PagedAsyncIterableIterator<IncomingRelationship, IncomingRelationship[], PageSettings>

listModels(DigitalTwinModelsListOptionalParams)

Pobieranie listy modeli

function listModels(options?: DigitalTwinModelsListOptionalParams): PagedAsyncIterableIterator<DigitalTwinsModelData, DigitalTwinsModelData[], PageSettings>

Parametry

options: ListModelsOptions

Opcje wyświetlania listy modeli.

Zwraca

PagedAsyncIterableIterator<DigitalTwinsModelData, DigitalTwinsModelData[], PageSettings>

Stronicowany zestaw modeli aplikacji/json.

listRelationships(string, DigitalTwinsListRelationshipsOptionalParams)

Pobieranie relacji dla cyfrowej reprezentacji bliźniaczej.

function listRelationships(digitalTwinId: string, options?: DigitalTwinsListRelationshipsOptionalParams): PagedAsyncIterableIterator<Record<string, unknown>, Record<string, unknown>[], PageSettings>

Parametry

digitalTwinId: string

Identyfikator cyfrowej reprezentacji bliźniaczej.

options: ListRelationshipsOptions

Zwraca

PagedAsyncIterableIterator<Record<string, unknown>, Record<string, unknown>[], PageSettings>

publishComponentTelemetry(string, string, Record<string, unknown>, string, OperationOptions)

Opublikuj dane telemetryczne ze składnika cyfrowej reprezentacji bliźniaczej, który jest następnie używany przez jeden lub wiele docelowych punktów końcowych (subskrybentów) zdefiniowanych w ramach.

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

Parametry

digitalTwinId: string

Identyfikator cyfrowej reprezentacji bliźniaczej do usunięcia.

componentName: string

Nazwa składnika DTDL.

payload: Record<string, unknown>

Ładunek telemetrii aplikacji/json do wysłania.

messageId: string

Identyfikator wiadomości.

options: OperationOptions

Opcje operacji

Zwraca

Promise<void>

publishTelemetry(string, Record<string, unknown>, string, OperationOptions)

Opublikuj dane telemetryczne z cyfrowej reprezentacji bliźniaczej, która jest następnie zużywana przez jeden lub wiele docelowych punktów końcowych (subskrybentów) zdefiniowanych w ramach.

function publishTelemetry(digitalTwinId: string, payload: Record<string, unknown>, messageId: string, options?: OperationOptions): Promise<void>

Parametry

digitalTwinId: string

Identyfikator cyfrowej reprezentacji bliźniaczej do usunięcia.

payload: Record<string, unknown>

Ładunek telemetrii aplikacji/json do wysłania.

messageId: string

Identyfikator wiadomości.

options: OperationOptions

Opcje operacji

Zwraca

Promise<void>

queryTwins(string, QueryQueryTwinsOptionalParams)

Wykonywanie zapytań dotyczących cyfrowych reprezentacji bliźniaczych.

function queryTwins(query: string, options?: QueryQueryTwinsOptionalParams): PagedAsyncIterableIterator<Record<string, unknown>, QueryQueryTwinsResponse, PageSettings>

Parametry

query: string

Ciąg zapytania w składni podobnej do języka SQL.

options: QueryTwinsOptions

Opcje operacji zapytania.

Zwraca

PagedAsyncIterableIterator<Record<string, unknown>, QueryQueryTwinsResponse, PageSettings>

Lista wyników zapytania z możliwością stronicowania.

updateComponent(string, string, Record<string, unknown>[], DigitalTwinsUpdateComponentOptionalParams)

Aktualizowanie właściwości składnika w cyfrowej reprezentacji bliźniaczej przy użyciu poprawki JSON.

function updateComponent(digitalTwinId: string, componentName: string, jsonPatch: Record<string, unknown>[], options?: DigitalTwinsUpdateComponentOptionalParams): Promise<DigitalTwinsUpdateComponentHeaders>

Parametry

digitalTwinId: string

Identyfikator cyfrowej reprezentacji bliźniaczej.

componentName: string

Aktualizowany składnik.

jsonPatch: Record<string, unknown>[]

Operacje application/json-patch+json do wykonania w składniku określonej reprezentacji bliźniaczej.

options: DigitalTwinsUpdateComponentOptionalParams

Opcje rozszerzonej operacji, w tym ifMatch: wykonaj operację tylko wtedy, gdy element etag jednostki pasuje do jednego z podanych elementów etag lub *.

Zwraca

Promise<DigitalTwinsUpdateComponentHeaders>

updateDigitalTwin(string, Record<string, unknown>[], DigitalTwinsUpdateOptionalParams)

Aktualizowanie cyfrowej reprezentacji bliźniaczej przy użyciu poprawki json.

function updateDigitalTwin(digitalTwinId: string, jsonPatch: Record<string, unknown>[], options?: DigitalTwinsUpdateOptionalParams): Promise<DigitalTwinsUpdateHeaders>

Parametry

digitalTwinId: string

Identyfikator cyfrowej reprezentacji bliźniaczej.

jsonPatch: Record<string, unknown>[]

Specyfikacja aktualizacji opisana przez poprawkę JSON. Aktualizacje wartości właściwości i $model elementów mogą wystąpić w tym samym żądaniu. Operacje są ograniczone do dodawania, zastępowania i usuwania.

options: DigitalTwinsUpdateOptionalParams

Opcje rozszerzonej operacji, w tym ifMatch: wykonaj operację tylko wtedy, gdy element etag jednostki pasuje do jednego z podanych elementów etag lub *.

Zwraca

Promise<DigitalTwinsUpdateHeaders>

updateRelationship(string, string, Record<string, unknown>[], DigitalTwinsUpdateRelationshipOptionalParams)

Aktualizuje właściwości relacji w cyfrowej reprezentacji bliźniaczej przy użyciu poprawki JSON.

function updateRelationship(digitalTwinId: string, relationshipId: string, jsonPatch: Record<string, unknown>[], options?: DigitalTwinsUpdateRelationshipOptionalParams): Promise<DigitalTwinsUpdateRelationshipHeaders>

Parametry

digitalTwinId: string

Identyfikator cyfrowej reprezentacji bliźniaczej do usunięcia.

relationshipId: string

Identyfikator relacji do zaktualizowania.

jsonPatch: Record<string, unknown>[]

Operacje application/json-patch+json, które mają być wykonywane na relacji określonej reprezentacji cyfrowej bliźniaczej.

options: DigitalTwinsUpdateRelationshipOptionalParams

Opcje rozszerzonej operacji ifMatch: wykonaj operację tylko wtedy, gdy element etag jednostki pasuje do jednego z podanych elementów etag lub *.

Zwraca

Promise<DigitalTwinsUpdateRelationshipHeaders>

upsertDigitalTwin(string, string, DigitalTwinsAddOptionalParams)

Tworzenie lub aktualizowanie cyfrowej reprezentacji bliźniaczej

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

Parametry

digitalTwinId: string

Identyfikator cyfrowej reprezentacji bliźniaczej do utworzenia lub zaktualizowania.

digitalTwinJson: string

Do utworzenia aplikacji/json cyfrowej reprezentacji bliźniaczej.

options: DigitalTwinsAddOptionalParams

Opcje operacji rozszerzonej, w tym ifNoneMatch: wykonaj operację tylko wtedy, gdy jednostka jeszcze nie istnieje.

Zwraca

Promise<DigitalTwinsAddResponse>

Utworzony cyfrowy bliźniak aplikacji/json.

upsertEventRoute(string, string, string, OperationOptions)

Tworzenie lub aktualizowanie trasy zdarzeń.

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

Parametry

eventRouteId: string

Identyfikator trasy zdarzenia do utworzenia lub zaktualizowania.

endpointId: string

Identyfikator punktu końcowego, z którą jest powiązana ta trasa zdarzenia.

filter: string

Wyrażenie opisujące zdarzenia kierowane do punktu końcowego.

options: OperationOptions

Opcje operacji

Zwraca

Promise<void>

upsertRelationship(string, string, Record<string, unknown>, DigitalTwinsAddRelationshipOptionalParams)

Tworzenie lub aktualizowanie relacji w cyfrowej reprezentacji bliźniaczej.

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

Parametry

digitalTwinId: string

Identyfikator źródłowej cyfrowej reprezentacji bliźniaczej.

relationshipId: string

Identyfikator relacji do utworzenia.

relationship: Record<string, unknown>

Zostanie utworzona relacja application/json.

options: DigitalTwinsAddRelationshipOptionalParams

Opcje operacji rozszerzonej, w tym ifNoneMatch: wykonaj operację tylko wtedy, gdy jednostka jeszcze nie istnieje.

Zwraca

Promise<DigitalTwinsAddRelationshipResponse>

Udostępnij za pośrednictwem

DigitalTwinsClient class

Konstruktory

Metody

Szczegóły konstruktora

DigitalTwinsClient(string, TokenCredential, DigitalTwinsClientOptions)

Parametry

Szczegóły metody

createModels(Record<string, unknown>[], OperationOptions)

Parametry

Zwraca

decomissionModel(string, OperationOptions)

Parametry

Zwraca

deleteDigitalTwin(string, DigitalTwinsDeleteOptionalParams)

Parametry

Zwraca

deleteEventRoute(string, OperationOptions)

Parametry

Zwraca

deleteModel(string, OperationOptions)

Parametry

Zwraca

deleteRelationship(string, string, DigitalTwinsDeleteRelationshipOptionalParams)

Parametry

Zwraca

getComponent(string, string, OperationOptions)

Parametry

Zwraca

getDigitalTwin(string, OperationOptions)

Parametry

Zwraca

getEventRoute(string, OperationOptions)

Parametry

Zwraca

getModel(string, DigitalTwinModelsGetByIdOptionalParams)

Parametry

Zwraca

getRelationship(string, string, OperationOptions)

Parametry

Zwraca

listEventRoutes(EventRoutesListOptionalParams)

Parametry

Zwraca

listIncomingRelationships(string, DigitalTwinsListIncomingRelationshipsOptionalParams)

Parametry

Zwraca

listModels(DigitalTwinModelsListOptionalParams)

Parametry

Zwraca

listRelationships(string, DigitalTwinsListRelationshipsOptionalParams)

Parametry

Zwraca

publishComponentTelemetry(string, string, Record<string, unknown>, string, OperationOptions)

Parametry

Zwraca

publishTelemetry(string, Record<string, unknown>, string, OperationOptions)

Parametry

Zwraca

queryTwins(string, QueryQueryTwinsOptionalParams)

Parametry

Zwraca

updateComponent(string, string, Record<string, unknown>[], DigitalTwinsUpdateComponentOptionalParams)

Parametry

Zwraca

updateDigitalTwin(string, Record<string, unknown>[], DigitalTwinsUpdateOptionalParams)

Parametry

Zwraca

updateRelationship(string, string, Record<string, unknown>[], DigitalTwinsUpdateRelationshipOptionalParams)

Parametry

Zwraca

upsertDigitalTwin(string, string, DigitalTwinsAddOptionalParams)

Parametry

Zwraca

upsertEventRoute(string, string, string, OperationOptions)

Parametry

Zwraca

upsertRelationship(string, string, Record<string, unknown>, DigitalTwinsAddRelationshipOptionalParams)

Parametry

Zwraca