DigitalTwinsClient class

Paquete:

@azure/digital-twins-core

Cliente para La API de Azure IoT DigitalTwins.

Constructores

DigitalTwinsClient(string, TokenCredential, DigitalTwinsClientOptions)

Crea una instancia de AzureDigitalTwinsAPI. Ejemplo de uso: const { DigitalTwinsClient, ServiceClientCredentials } = require("@azure/digital-twins-core"); const client = new DigitalTwinsClient( "<endpoint>", new DefaultAzureCredential(); );

Métodos

createModels(any[], OperationOptions)	Crear uno o varios
decomissionModel(string, OperationOptions)	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.
deleteDigitalTwin(string, DigitalTwinsDeleteOptionalParams)	Eliminación de un gemelo digital
deleteEventRoute(string, OperationOptions)	Elimine una ruta de eventos.
deleteModel(string, OperationOptions)	Elimine un modelo.
deleteRelationship(string, string, DigitalTwinsDeleteRelationshipOptionalParams)	Elimine una relación en un gemelo digital.
getComponent(string, string, OperationOptions)	Obtenga un componente en un gemelo digital.
getDigitalTwin(string, OperationOptions)	Obtención de un gemelo digital
getEventRoute(string, OperationOptions)	Obtenga una ruta de eventos.
getModel(string, boolean, OperationOptions)	Obtenga un modelo, incluidos los metadatos del modelo y la definición del modelo.
getRelationship(string, string, OperationOptions)	Obtener una relación en un gemelo digital.
listEventRoutes(number, OperationOptions & PageSettings)	Enumere las rutas de eventos en una instancia de gemelos digitales.
listIncomingRelationships(string, OperationOptions & PageSettings)	Recupere todas las relaciones entrantes de un gemelo digital.
listModels(string[], boolean, number, OperationOptions & PageSettings)	Obtener la lista de modelos
listRelationships(string, OperationOptions & PageSettings)	Recupere las relaciones de un gemelo digital.
publishComponentTelemetry(string, string, string, string, OperationOptions)	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.
publishTelemetry(string, any, string, OperationOptions)	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.
queryTwins(string, number, OperationOptions & PageSettings)	Consulta de gemelos digitales.
updateComponent(string, string, any[], DigitalTwinsUpdateComponentOptionalParams)	Actualice las propiedades de un componente en un gemelo digital mediante una revisión JSON.
updateDigitalTwin(string, any, DigitalTwinsUpdateOptionalParams)	Actualice un gemelo digital mediante una revisión json.
updateRelationship(string, string, any[], DigitalTwinsUpdateRelationshipOptionalParams)	Novedades las propiedades de una relación en un gemelo digital mediante una revisión JSON.
upsertDigitalTwin(string, string, DigitalTwinsAddOptionalParams)	Creación o actualización de un gemelo digital
upsertEventRoute(string, string, string, OperationOptions)	Cree o actualice una ruta de eventos.
upsertRelationship(string, string, any, DigitalTwinsAddRelationshipOptionalParams)	Cree o actualice una relación en un gemelo digital.

Detalles del constructor

DigitalTwinsClient(string, TokenCredential, DigitalTwinsClientOptions)

Crea una instancia de AzureDigitalTwinsAPI.

Ejemplo de uso:

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

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

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

Parámetros

endpointUrl

string

Dirección URL del punto de conexión del servicio.

credential

TokenCredential

Se usa para autenticar las solicitudes en el servicio.

options

DigitalTwinsClientOptions

Se usa para configurar el cliente de servicio.

Detalles del método

createModels(any[], OperationOptions)

Crear uno o varios

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

Parámetros

dtdlModels

any[]

options

OperationOptions

Opciones de operación

Devoluciones

Promise<DigitalTwinModelsAddResponse>

Los modelos de aplicación/json creados y la respuesta http.

decomissionModel(string, OperationOptions)

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<RestResponse>

Parámetros

modelId

string

Identificador del modelo que se va a retirar. se puede reemplazar la propiedad .

options

OperationOptions

Opciones de operación

Devoluciones

Promise<RestResponse>

Respuesta http.

deleteDigitalTwin(string, DigitalTwinsDeleteOptionalParams)

Eliminación de un gemelo digital

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

Parámetros

digitalTwinId

string

Identificador del gemelo digital que se va a eliminar.

options

DigitalTwinsDeleteOptionalParams

Opciones de operación extendidas, incluidas ifMatch: solo realiza la operación si la etag de la entidad coincide con una de las etiquetas de etag proporcionadas o * .

Devoluciones

Promise<RestResponse>

Respuesta http.

deleteEventRoute(string, OperationOptions)

Elimine una ruta de eventos.

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

Parámetros

eventRouteId

string

Identificador del eventRoute que se va a eliminar.

options

OperationOptions

Opciones de operación

Devoluciones

Promise<RestResponse>

Respuesta http.

deleteModel(string, OperationOptions)

Elimine un modelo.

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

Parámetros

modelId

string

Identificador del modelo que se va a eliminar.

options

OperationOptions

Opciones de operación

Devoluciones

Promise<RestResponse>

Respuesta http.

deleteRelationship(string, string, DigitalTwinsDeleteRelationshipOptionalParams)

Elimine una relación en un gemelo digital.

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

Parámetros

digitalTwinId

string

Identificador del gemelo digital de origen.

relationshipId

string

Identificador de la relación que se va a eliminar.

options

DigitalTwinsDeleteRelationshipOptionalParams

Las opciones de operación ifMatch: solo realizan la operación si la etag de la entidad coincide con una de las etag proporcionadas o *

Devoluciones

Promise<RestResponse>

Respuesta http.

getComponent(string, string, OperationOptions)

Obtenga un componente en un gemelo digital.

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

Parámetros

digitalTwinId

string

Identificador del gemelo digital.

componentName

string

Componente que se va a recuperar.

options

OperationOptions

Opciones de operación

Devoluciones

Promise<DigitalTwinsGetComponentResponse>

Representación de cadena JSON del componente correspondiente al componentName proporcionado y a la respuesta HTTP.

getDigitalTwin(string, OperationOptions)

Obtención de un gemelo digital

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

Parámetros

digitalTwinId

string

Identificador del gemelo digital.

options

OperationOptions

Opciones de operación

Devoluciones

Promise<DigitalTwinsGetByIdResponse>

El gemelo digital application/json y la respuesta http.

getEventRoute(string, OperationOptions)

Obtenga una ruta de eventos.

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

Parámetros

eventRouteId

string

options

OperationOptions

Opciones de operación

Devoluciones

Promise<EventRoutesGetByIdResponse>

Ruta de eventos application/json y la respuesta http.

getModel(string, boolean, OperationOptions)

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

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

Parámetros

modelId

string

Identificador del modelo.

includeModelDefinition

boolean

options

OperationOptions

Opciones de operación extendidas, como includeModelDefinition: cuando es true, la definición del modelo se devolverá como parte del resultado. Valor predeterminado: false.

Devoluciones

Promise<DigitalTwinModelsGetByIdResponse>

El modelo application/json y la respuesta http.

getRelationship(string, string, OperationOptions)

Obtener una relación en un gemelo digital.

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

Parámetros

digitalTwinId

string

Identificador del gemelo digital de origen.

relationshipId

string

Identificador de la relación que se va a recuperar.

options

OperationOptions

Opciones de operación

Devoluciones

Promise<DigitalTwinsGetRelationshipByIdResponse>

Lista paginable de relaciones application/json que pertenecen al gemelo digital especificado y a la respuesta http.

listEventRoutes(number, OperationOptions & PageSettings)

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

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

Parámetros

resultsPerPage

number

Número máximo de elementos que se van a recuperar por solicitud. El servidor puede optar por devolver menos del máximo solicitado.

options

OperationOptions & PageSettings

Devoluciones

PagedAsyncIterableIterator<EventRoute, EventRoutesListNextResponse, PageSettings>

Ruta de eventos application/json y la respuesta http.

listIncomingRelationships(string, OperationOptions & PageSettings)

Recupere todas las relaciones entrantes de un gemelo digital.

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

Parámetros

digitalTwinId

string

Identificador del gemelo digital.

options

OperationOptions & PageSettings

Devoluciones

PagedAsyncIterableIterator<IncomingRelationship, DigitalTwinsListIncomingRelationshipsResponse, PageSettings>

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

Obtener la lista de modelos

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

Parámetros

dependeciesFor

string[]

Identificadores de modelo para que se recuperen las dependencias. Si se omite, se recuperan todos los modelos.

includeModelDefinition

boolean

Si se va a incluir la definición del modelo en el resultado. Si es false, solo se devolverán los metadatos del modelo.

resultsPerPage

number

Número máximo de elementos que se van a recuperar por solicitud. El servidor puede optar por devolver menos del máximo solicitado.

options

OperationOptions & PageSettings

Devoluciones

PagedAsyncIterableIterator<DigitalTwinsModelData, DigitalTwinModelsListResponse, PageSettings>

Un conjunto paginable de modelos application/json y la respuesta http.

listRelationships(string, OperationOptions & PageSettings)

Recupere las relaciones de un gemelo digital.

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

Parámetros

digitalTwinId

string

Identificador del gemelo digital.

options

OperationOptions & PageSettings

Devoluciones

PagedAsyncIterableIterator<any, DigitalTwinsListRelationshipsResponse, PageSettings>

publishComponentTelemetry(string, string, string, string, OperationOptions)

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

Parámetros

digitalTwinId

string

Identificador del gemelo digital que se va a eliminar.

componentName

string

Nombre del componente DTDL.

payload

string

Carga de telemetría application/json que se va a enviar.

messageId

string

Identificador del mensaje.

options

OperationOptions

Opciones de operación

Devoluciones

Promise<RestResponse>

Respuesta http.

publishTelemetry(string, any, string, OperationOptions)

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

Parámetros

digitalTwinId

string

Identificador del gemelo digital que se va a eliminar.

payload

any

Carga de telemetría application/json que se va a enviar.

messageId

string

Identificador del mensaje.

options

OperationOptions

Opciones de operación

Devoluciones

Promise<RestResponse>

Respuesta http.

queryTwins(string, number, OperationOptions & PageSettings)

Consulta de gemelos digitales.

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

Parámetros

query

string

Cadena de consulta, en sintaxis similar a SQL.

resultsPerPage

number

Número máximo de elementos que se van a recuperar por solicitud. El servidor puede optar por devolver menos del máximo solicitado.

options

OperationOptions & PageSettings

Devoluciones

PagedAsyncIterableIterator<any, QueryQueryTwinsResponse, PageSettings>

Lista paginable de resultados de la consulta.

updateComponent(string, string, any[], DigitalTwinsUpdateComponentOptionalParams)

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

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

Parámetros

digitalTwinId

string

Identificador del gemelo digital.

componentName

string

Componente que se está actualizando.

jsonPatch

any[]

Las operaciones application/json-patch+json que se van a realizar en el componente del gemelo digital especificado.

options

DigitalTwinsUpdateComponentOptionalParams

Opciones de operación extendidas, incluidas ifMatch: solo realiza la operación si la etag de la entidad coincide con una de las etiquetas de etag proporcionadas o * .

Devoluciones

Promise<DigitalTwinsUpdateComponentResponse>

Respuesta http.

updateDigitalTwin(string, any, DigitalTwinsUpdateOptionalParams)

Actualice un gemelo digital mediante una revisión json.

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

Parámetros

digitalTwinId

string

Identificador del gemelo digital.

jsonPatch

any

Especificación de actualización descrita por la revisión JSON. Novedades a los valores de propiedad y los elementos $model pueden producirse en la misma solicitud. Las operaciones se limitan a agregar, reemplazar y quitar.

options

DigitalTwinsUpdateOptionalParams

Opciones de operación extendidas, incluidas ifMatch: solo realiza la operación si la etag de la entidad coincide con una de las etiquetas de etag proporcionadas o * .

Devoluciones

Promise<DigitalTwinsUpdateResponse>

Respuesta http.

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

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

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

Parámetros

digitalTwinId

string

Identificador del gemelo digital que se va a eliminar.

relationshipId

string

Identificador de la relación que se va a actualizar.

jsonPatch

any[]

Las operaciones application/json-patch+json que se realizarán en la relación del gemelo digital especificado.

options

DigitalTwinsUpdateRelationshipOptionalParams

Opciones de operación extendida ifMatch: realice solo la operación si la etag de la entidad coincide con una de las etag proporcionadas o * .

Devoluciones

Promise<DigitalTwinsUpdateRelationshipResponse>

upsertDigitalTwin(string, string, DigitalTwinsAddOptionalParams)

Creación o actualización de un gemelo digital

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

Parámetros

digitalTwinId

string

Identificador del gemelo digital que se va a crear o actualizar.

digitalTwinJson

string

Gemelo digital application/json que se va a crear.

options

DigitalTwinsAddOptionalParams

Opciones de operación extendidas, incluido ifNoneMatch: realice solo la operación si la entidad aún no existe.

Devoluciones

Promise<DigitalTwinsAddResponse>

El gemelo digital de application/json creado y la respuesta http.

upsertEventRoute(string, string, string, OperationOptions)

Cree o actualice una ruta de eventos.

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

Parámetros

eventRouteId

string

Identificador de la ruta de eventos que se va a crear o actualizar.

endpointId

string

El identificador del punto de conexión al que está enlazada esta ruta de evento.

filter

string

Expresión que describe los eventos que se enrutan al punto de conexión.

options

OperationOptions

Opciones de operación

Devoluciones

Promise<RestResponse>

Respuesta http.

upsertRelationship(string, string, any, DigitalTwinsAddRelationshipOptionalParams)

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

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

Parámetros

digitalTwinId

string

Identificador del gemelo digital de origen.

relationshipId

string

Identificador de la relación que se va a crear.

relationship

any

Relación application/json que se va a crear.

options

DigitalTwinsAddRelationshipOptionalParams

Opciones de operación extendidas, incluido ifNoneMatch: realice solo la operación si la entidad aún no existe.

Devoluciones

Promise<DigitalTwinsAddRelationshipResponse>