DigitalTwinsClient class

Pakiet:

@azure/digital-twins-core

Klient interfejsu API usługi Azure IoT DigitalTwins.

Konstruktory

DigitalTwinsClient(string, TokenCredential, DigitalTwinsClientOptions)

Tworzy wystąpienie interfejsu AzureDigitalTwinsAPI. Przykład użycia: const { DigitalTwinsClient, ServiceClientCredentials } = require("@azure/digital-twins-core"); const client = new DigitalTwinsClient( "<endpoint>", new DefaultAzureCredential(); );

Metody

createModels(any[], OperationOptions)	Utwórz jedną lub wiele
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 skompmisji.
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)	Pobieranie składnika w cyfrowej reprezentacji bliźniaczej.
getDigitalTwin(string, OperationOptions)	Uzyskiwanie cyfrowej reprezentacji bliźniaczej
getEventRoute(string, OperationOptions)	Pobieranie trasy zdarzeń.
getModel(string, boolean, OperationOptions)	Pobierz model, w tym metadane modelu i definicję modelu.
getRelationship(string, string, OperationOptions)	Uzyskiwanie relacji na cyfrowej reprezentacji bliźniaczej.
listEventRoutes(number, OperationOptions & PageSettings)	Wyświetl listę tras zdarzeń w wystąpieniu cyfrowych reprezentacji bliźniaczych.
listIncomingRelationships(string, OperationOptions & PageSettings)	Pobieranie wszystkich relacji przychodzących dla cyfrowej reprezentacji bliźniaczej.
listModels(string[], boolean, number, OperationOptions & PageSettings)	Pobieranie listy modeli
listRelationships(string, OperationOptions & PageSettings)	Pobieranie relacji dla cyfrowej reprezentacji bliźniaczej.
publishComponentTelemetry(string, string, string, 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, any, 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 obszarze.
queryTwins(string, number, OperationOptions & PageSettings)	Wykonywanie zapytań dotyczących cyfrowych reprezentacji bliźniaczych.
updateComponent(string, string, any[], DigitalTwinsUpdateComponentOptionalParams)	Aktualizowanie właściwości składnika w cyfrowej reprezentacji bliźniaczej przy użyciu poprawki JSON.
updateDigitalTwin(string, any, DigitalTwinsUpdateOptionalParams)	Aktualizowanie cyfrowej reprezentacji bliźniaczej przy użyciu poprawki JSON.
updateRelationship(string, string, any[], DigitalTwinsUpdateRelationshipOptionalParams)	Aktualizacje 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, any, DigitalTwinsAddRelationshipOptionalParams)	Tworzenie lub aktualizowanie relacji w cyfrowej reprezentacji bliźniaczej.

Szczegóły konstruktora

DigitalTwinsClient(string, TokenCredential, DigitalTwinsClientOptions)

Tworzy wystąpienie interfejsu AzureDigitalTwinsAPI.

Przykład użycia:

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

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

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(any[], OperationOptions)

Utwórz jedną lub wiele

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

Parametry

dtdlModels

any[]

options

OperationOptions

Opcje operacji

Zwraca

Promise<DigitalTwinModelsAddResponse>

Utworzone modele aplikacji/json i odpowiedź HTTP.

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 skompmisji.

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

Parametry

modelId

string

Identyfikator modelu do likwidacji. Właściwość można zastąpić.

options

OperationOptions

Opcje operacji

Zwraca

Promise<RestResponse>

Odpowiedź HTTP.

deleteDigitalTwin(string, DigitalTwinsDeleteOptionalParams)

Usuwanie cyfrowej reprezentacji bliźniaczej

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

Parametry

digitalTwinId

string

Identyfikator cyfrowej reprezentacji bliźniaczej do usunięcia.

options

DigitalTwinsDeleteOptionalParams

Rozszerzone opcje operacji, w tym ifMatch: wykonaj operację tylko wtedy, gdy element etag jednostki jest zgodny z jednym z podanych tagów etag lub * .

Zwraca

Promise<RestResponse>

Odpowiedź HTTP.

deleteEventRoute(string, OperationOptions)

Usuwanie trasy zdarzeń.

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

Parametry

eventRouteId

string

Identyfikator zdarzenia do usunięcia.

options

OperationOptions

Opcje operacji

Zwraca

Promise<RestResponse>

Odpowiedź HTTP.

deleteModel(string, OperationOptions)

Usuwanie modelu.

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

Parametry

modelId

string

Identyfikator modelu do usunięcia.

options

OperationOptions

Opcje operacji

Zwraca

Promise<RestResponse>

Odpowiedź HTTP.

deleteRelationship(string, string, DigitalTwinsDeleteRelationshipOptionalParams)

Usuwanie relacji w cyfrowej reprezentacji bliźniaczej.

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

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 tagów etag lub *

Zwraca

Promise<RestResponse>

Odpowiedź HTTP.

getComponent(string, string, OperationOptions)

Pobieranie składnika 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 podanemu składnikowi componentName i odpowiedzi HTTP.

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>

Aplikacja/json — reprezentacja bliźniacza cyfrowa i odpowiedź HTTP.

getEventRoute(string, OperationOptions)

Pobieranie trasy zdarzeń.

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

Parametry

eventRouteId

string

options

OperationOptions

Opcje operacji

Zwraca

Promise<EventRoutesGetByIdResponse>

Trasa zdarzeń application/json i odpowiedź HTTP.

getModel(string, boolean, OperationOptions)

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

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

Parametry

modelId

string

Identyfikator modelu.

includeModelDefinition

boolean

options

OperationOptions

Opcje rozszerzonej operacji, w tym includeModelDefinition: po wartości true definicja modelu zostanie zwrócona jako część wyniku. Wartość domyślna: false.

Zwraca

Promise<DigitalTwinModelsGetByIdResponse>

Model aplikacji/json i odpowiedź HTTP.

getRelationship(string, string, OperationOptions)

Uzyskiwanie relacji 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>

Lista stronicowalnych relacji aplikacji/json należących do określonej cyfrowej reprezentacji bliźniaczej i odpowiedzi HTTP.

listEventRoutes(number, OperationOptions & PageSettings)

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

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

Parametry

resultsPerPage

number

Maksymalna liczba elementów do pobrania na żądanie. Serwer może zdecydować się na zwrócenie mniejszej niż żądana wartość maksymalna.

options

OperationOptions & PageSettings

Zwraca

PagedAsyncIterableIterator<EventRoute, EventRoutesListNextResponse, PageSettings>

Trasa zdarzeń application/json i odpowiedź HTTP.

listIncomingRelationships(string, OperationOptions & PageSettings)

Pobieranie wszystkich relacji przychodzących dla cyfrowej reprezentacji bliźniaczej.

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

Parametry

digitalTwinId

string

Identyfikator cyfrowej reprezentacji bliźniaczej.

options

OperationOptions & PageSettings

Zwraca

PagedAsyncIterableIterator<IncomingRelationship, DigitalTwinsListIncomingRelationshipsResponse, PageSettings>

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

Pobieranie listy modeli

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

Parametry

dependeciesFor

string[]

Identyfikatory modelu do pobrania zależności. W przypadku pominięcia wszystkie modele są pobierane.

includeModelDefinition

boolean

Określa, czy definicja modelu ma być uwzględnina w wyniku. Jeśli wartość false, zostaną zwrócone tylko metadane modelu.

resultsPerPage

number

Maksymalna liczba elementów do pobrania na żądanie. Serwer może zdecydować się na zwrócenie mniejszej niż żądana wartość maksymalna.

options

OperationOptions & PageSettings

Zwraca

PagedAsyncIterableIterator<DigitalTwinsModelData, DigitalTwinModelsListResponse, PageSettings>

Stronicowy zestaw modeli aplikacji/json i odpowiedzi HTTP.

listRelationships(string, OperationOptions & PageSettings)

Pobieranie relacji dla cyfrowej reprezentacji bliźniaczej.

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

Parametry

digitalTwinId

string

Identyfikator cyfrowej reprezentacji bliźniaczej.

options

OperationOptions & PageSettings

Zwraca

PagedAsyncIterableIterator<any, DigitalTwinsListRelationshipsResponse, PageSettings>

publishComponentTelemetry(string, string, string, 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: string, messageId: string, options?: OperationOptions): Promise<RestResponse>

Parametry

digitalTwinId

string

Identyfikator cyfrowej reprezentacji bliźniaczej do usunięcia.

componentName

string

Nazwa składnika DTDL.

payload

string

Ładunek telemetrii aplikacji/json do wysłania.

messageId

string

Identyfikator wiadomości.

options

OperationOptions

Opcje operacji

Zwraca

Promise<RestResponse>

Odpowiedź HTTP.

publishTelemetry(string, any, 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 obszarze.

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

Parametry

digitalTwinId

string

Identyfikator cyfrowej reprezentacji bliźniaczej do usunięcia.

payload

any

Ładunek telemetrii aplikacji/json do wysłania.

messageId

string

Identyfikator wiadomości.

options

OperationOptions

Opcje operacji

Zwraca

Promise<RestResponse>

Odpowiedź HTTP.

queryTwins(string, number, OperationOptions & PageSettings)

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

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

Parametry

query

string

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

resultsPerPage

number

Maksymalna liczba elementów do pobrania na żądanie. Serwer może zdecydować się na zwrócenie mniejszej niż żądana wartość maksymalna.

options

OperationOptions & PageSettings

Zwraca

PagedAsyncIterableIterator<any, QueryQueryTwinsResponse, PageSettings>

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

updateComponent(string, string, any[], 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: any[], options?: DigitalTwinsUpdateComponentOptionalParams): Promise<DigitalTwinsUpdateComponentResponse>

Parametry

digitalTwinId

string

Identyfikator cyfrowej reprezentacji bliźniaczej.

componentName

string

Składnik, który jest aktualizowany.

jsonPatch

any[]

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

options

DigitalTwinsUpdateComponentOptionalParams

Rozszerzone opcje operacji, w tym ifMatch: wykonaj operację tylko wtedy, gdy element etag jednostki jest zgodny z jednym z podanych tagów etag lub * .

Zwraca

Promise<DigitalTwinsUpdateComponentResponse>

Odpowiedź HTTP.

updateDigitalTwin(string, any, DigitalTwinsUpdateOptionalParams)

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

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

Parametry

digitalTwinId

string

Identyfikator cyfrowej reprezentacji bliźniaczej.

jsonPatch

any

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

options

DigitalTwinsUpdateOptionalParams

Rozszerzone opcje operacji, w tym ifMatch: wykonaj operację tylko wtedy, gdy element etag jednostki jest zgodny z jednym z podanych tagów etag lub * .

Zwraca

Promise<DigitalTwinsUpdateResponse>

Odpowiedź HTTP.

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

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

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

Parametry

digitalTwinId

string

Identyfikator cyfrowej reprezentacji bliźniaczej do usunięcia.

relationshipId

string

Identyfikator relacji do zaktualizowania.

jsonPatch

any[]

Operacje application/json-patch+json do wykonania w relacji określonej reprezentacji cyfrowej bliźniaczej.

options

DigitalTwinsUpdateRelationshipOptionalParams

Opcje rozszerzonej operacji ifMatch: wykonaj operację tylko wtedy, gdy element etag jednostki jest zgodny z jednym z podanych tagów etag lub * .

Zwraca

Promise<DigitalTwinsUpdateRelationshipResponse>

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

Aplikacja/json — reprezentacja bliźniacza do utworzenia.

options

DigitalTwinsAddOptionalParams

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

Zwraca

Promise<DigitalTwinsAddResponse>

Utworzona aplikacja/json — cyfrowa reprezentacja bliźniacza i odpowiedź HTTP.

upsertEventRoute(string, string, string, OperationOptions)

Tworzenie lub aktualizowanie trasy zdarzeń.

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

Parametry

eventRouteId

string

Identyfikator trasy zdarzeń 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, które są kierowane do punktu końcowego.

options

OperationOptions

Opcje operacji

Zwraca

Promise<RestResponse>

Odpowiedź HTTP.

upsertRelationship(string, string, any, DigitalTwinsAddRelationshipOptionalParams)

Tworzenie lub aktualizowanie relacji w cyfrowej reprezentacji bliźniaczej.

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

Parametry

digitalTwinId

string

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

relationshipId

string

Identyfikator relacji do utworzenia.

relationship

any

Zostanie utworzona relacja application/json.

options

DigitalTwinsAddRelationshipOptionalParams

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

Zwraca

Promise<DigitalTwinsAddRelationshipResponse>