DigitalTwinsClient class

Crea una instancia de AzureDigitalTwinsAPI.

Uso de ejemplo:

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)

Parámetros

Crear uno o varios

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

Parámetros

Devoluciones

Los modelos application/json creados.

Retirar un modelo mediante una revisión json. Cuando se retira un modelo, este modelo ya no podrá definir nuevos gemelos digitales. Sin embargo, los gemelos digitales existentes pueden seguir usando este modelo. Una vez que se retira un modelo, es posible que no se vuelva a retirar.

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

Parámetros

Devoluciones

Eliminación de un gemelo digital

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

Parámetros

Devoluciones

Elimine una ruta de eventos.

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

Parámetros

Devoluciones

Eliminar un modelo.

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

Parámetros

Devoluciones

Elimina una relación en un gemelo digital.

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

Parámetros

Devoluciones

Obtenga un componente en un gemelo digital.

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

Parámetros

Devoluciones

Representación de cadena JSON del componente correspondiente al componentName proporcionado.

Obtención de un gemelo digital

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

Parámetros

Devoluciones

El gemelo digital application/json.

Obtener una ruta de eventos.

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

Parámetros

Devoluciones

La ruta del evento application/json.

Obtenga un modelo, incluidos los metadatos del modelo y la definición del modelo.

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

Parámetros

Devoluciones

El modelo application/json.

Obtener una relación en un gemelo digital.

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

Parámetros

Devoluciones

La lista paginable de relaciones application/json que pertenecen al gemelo digital especificado.

Enumere las rutas de eventos en una instancia de gemelos digitales.

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

Parámetros

Devoluciones

La ruta del evento application/json.

Recupere todas las relaciones entrantes de un gemelo digital.

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

Parámetros

Devoluciones

Obtener la lista de modelos

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

Parámetros

Devoluciones

Un conjunto paginable de modelos application/json.

Recupere las relaciones de un gemelo digital.

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

Parámetros

Devoluciones

Publique la telemetría desde el componente de un gemelo digital, que luego se consume en uno o varios puntos de conexión de destino (suscriptores) definidos en.

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

Parámetros

Devoluciones

Publique la telemetría desde un gemelo digital, que luego se consume en uno o varios puntos de conexión de destino (suscriptores) definidos en.

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

Parámetros

Devoluciones

Consulta de gemelos digitales.

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

Parámetros

Devoluciones

Lista paginable de resultados de la consulta.

Actualice las propiedades de un componente de un gemelo digital mediante una revisión JSON.

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

Parámetros

Devoluciones

Actualice un gemelo digital mediante una revisión json.

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

Parámetros

Devoluciones

Actualiza las propiedades de una relación en un gemelo digital mediante una revisión JSON.

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

Parámetros

Devoluciones

Creación o actualización de un gemelo digital

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

Parámetros

Devoluciones

La aplicación creada/gemelo digital json.

Cree o actualice una ruta de eventos.

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

Parámetros

Devoluciones

Cree o actualice una relación en un gemelo digital.

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

Parámetros

Devoluciones