DigitalTwinsClient class

Crea un'istanza di AzureDigitalTwinsAPI.

Esempio di utilizzo:

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

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

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

Parametri

Creare uno o più

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

Parametri

Restituisce

I modelli di applicazione/json creati e la risposta HTTP.

Rimuovere le autorizzazioni di un modello usando una patch JSON. Quando un modello viene rimosso, i nuovi gemelli digitali non saranno più in grado di essere definiti da questo modello. Tuttavia, i gemelli digitali esistenti possono continuare a usare questo modello. Una volta rimosso un modello, è possibile che non venga ricommissionato.

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

Parametri

Restituisce

Risposta HTTP.

Eliminare un gemello digitale

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

Parametri

Restituisce

Risposta HTTP.

Eliminare una route evento.

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

Parametri

Restituisce

Risposta HTTP.

Eliminare un modello.

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

Parametri

Restituisce

Risposta HTTP.

Eliminare una relazione su un gemello digitale.

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

Parametri

Restituisce

Risposta HTTP.

Ottenere un componente in un gemello digitale.

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

Parametri

Restituisce

Rappresentazione di stringa JSON del componente corrispondente al componentName fornito e alla risposta HTTP.

Ottenere un gemello digitale

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

Parametri

Restituisce

Il gemello digitale application/json e la risposta http.

Ottenere una route di eventi.

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

Parametri

Restituisce

Route dell'evento application/json e della risposta http.

Ottenere un modello, inclusi i metadati del modello e la definizione del modello.

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

Parametri

Restituisce

Modello application/json e risposta http.

Ottenere una relazione su un gemello digitale.

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

Parametri

Restituisce

Elenco paginabile delle relazioni application/json appartenenti al gemello digitale specificato e alla risposta http.

Elencare le route degli eventi in un'istanza di gemelli digitali.

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

Parametri

Restituisce

Route dell'evento application/json e della risposta http.

Recuperare tutte le relazioni in ingresso per un gemello digitale.

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

Parametri

Restituisce

Ottenere l'elenco di modelli

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

Parametri

Restituisce

Set di modelli application/json paginabili e risposta http.

Recuperare le relazioni per un gemello digitale.

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

Parametri

Restituisce

Pubblicare i dati di telemetria dal componente di un gemello digitale, che viene quindi utilizzato da uno o più endpoint di destinazione (sottoscrittori) definiti in .

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

Parametri

Restituisce

Risposta HTTP.

Pubblicare i dati di telemetria da un gemello digitale, che viene quindi utilizzato da uno o più endpoint di destinazione (sottoscrittori) definiti in .

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

Parametri

Restituisce

Risposta HTTP.

Eseguire una query per gemelli digitali.

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

Parametri

Restituisce

Elenco paginabile dei risultati della query.

Aggiornare le proprietà di un componente in un gemello digitale usando una patch JSON.

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

Parametri

Restituisce

Risposta HTTP.

Aggiornare un gemello digitale usando una patch json.

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

Parametri

Restituisce

Risposta HTTP.

Aggiornamenti le proprietà di una relazione su un gemello digitale usando una patch JSON.

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

Parametri

Restituisce

Creare o aggiornare un gemello digitale

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

Parametri

Restituisce

Il gemello digitale /json creato e la risposta http.

Creare o aggiornare una route di eventi.

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

Parametri

Restituisce

Risposta HTTP.

Creare o aggiornare una relazione su un gemello digitale.

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

Parametri

Restituisce