DigitalTwinsClient class

Cria uma instância do AzureDigitalTwinsAPI.

Utilização de exemplo:

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

Criar um ou muitos

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

Parâmetros

Devoluções

Os modelos de aplicação/json criados e a resposta http.

Desativar um modelo com um patch de json. Quando um modelo é desativado, os novos duplos digitais deixarão de poder ser definidos por este modelo. No entanto, os duplos digitais existentes podem continuar a utilizar este modelo. Assim que um modelo for desativado, poderá não ser recommissionado.

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

Parâmetros

Devoluções

A resposta http.

Eliminar um duplo digital

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

Parâmetros

Devoluções

A resposta http.

Eliminar uma rota de eventos.

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

Parâmetros

Devoluções

A resposta http.

Eliminar um modelo.

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

Parâmetros

Devoluções

A resposta http.

Eliminar uma relação num duplo digital.

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

Parâmetros

Devoluções

A resposta http.

Obtenha um componente num duplo digital.

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

Parâmetros

Devoluções

Representação da cadeia Json do componente correspondente ao componentName fornecido e à resposta HTTP.

Obter um duplo digital

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

Parâmetros

Devoluções

A aplicação/json digital twin e a resposta http.

Obter uma rota de evento.

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

Parâmetros

Devoluções

A rota de eventos application/json e a resposta http.

Obtenha um modelo, incluindo os metadados do modelo e a definição do modelo.

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

Parâmetros

Devoluções

O modelo application/json e a resposta http.

Obter uma relação num duplo digital.

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

Parâmetros

Devoluções

A lista paginável de relações application/json pertencentes ao duplo digital especificado e à resposta http.

Liste as rotas de eventos numa instância de duplos digitais.

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

Parâmetros

Devoluções

A rota de eventos application/json e a resposta http.

Obter todas as relações recebidas de um duplo digital.

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

Parâmetros

Devoluções

Obter a lista de modelos

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

Parâmetros

Devoluções

Um conjunto paginável de modelos de aplicação/json e a resposta http.

Obter relações para um duplo digital.

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

Parâmetros

Devoluções

Publicar telemetria a partir do componente de um duplo digital, que é depois consumida por um ou muitos pontos finais de destino (subscritores) definidos em.

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

Parâmetros

Devoluções

A resposta http.

Publique a telemetria de um duplo digital, que é depois consumida por um ou muitos pontos finais de destino (subscritores) definidos em.

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

Parâmetros

Devoluções

A resposta http.

Consulta para duplos digitais.

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

Parâmetros

Devoluções

A lista paginável dos resultados da consulta.

Atualize as propriedades de um componente num duplo digital com um patch JSON.

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

Parâmetros

Devoluções

A resposta http.

Atualize um duplo digital com um patch de json.

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

Parâmetros

Devoluções

A resposta http.

Atualizações as propriedades de uma relação num duplo digital através de um patch JSON.

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

Parâmetros

Devoluções

Criar ou atualizar um duplo digital

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

Parâmetros

Devoluções

A aplicação/json digital twin criada e a resposta http.

Criar ou atualizar uma rota de evento.

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

Parâmetros

Devoluções

A resposta http.

Criar ou atualizar uma relação num duplo digital.

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

Parâmetros

Devoluções