DigitalTwinsClient class

Cria uma instância de AzureDigitalTwinsAPI.

Exemplo de uso:

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

Criar um ou vários

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

Parâmetros

Devoluções

Os modelos application/json criados.

Descomissione um modelo usando um patch json. Quando um modelo é desativado, novos gêmeos digitais não poderão mais ser definidos por esse modelo. No entanto, os gémeos digitais existentes podem continuar a utilizar este modelo. Uma vez que um modelo é desativado, ele não pode ser recomissionado.

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

Parâmetros

Devoluções

Excluir um gêmeo digital

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

Parâmetros

Devoluções

Exclua uma rota de evento.

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

Parâmetros

Devoluções

Exclua um modelo.

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

Parâmetros

Devoluções

Excluir um relacionamento em um gêmeo digital.

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

Parâmetros

Devoluções

Obtenha um componente em um gêmeo digital.

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

Parâmetros

Devoluções

Representação da cadeia de caracteres Json do componente correspondente ao componentName fornecido.

Obtenha um gémeo digital

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

Parâmetros

Devoluções

O gêmeo digital application/json.

Obtenha uma rota para o evento.

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

Parâmetros

Devoluções

A rota do evento application/json.

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

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

Parâmetros

Devoluções

O modelo application/json.

Tenha um relacionamento em um gêmeo 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 gêmeo digital especificado.

Liste as rotas de evento em uma instância de gêmeos digitais.

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

Parâmetros

Devoluções

A rota do evento application/json.

Recupere todos os relacionamentos de entrada para um gêmeo digital.

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

Parâmetros

Devoluções

Obter a lista de modelos

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

Parâmetros

Devoluções

Um conjunto paginável de modelos application/json.

Recupere relacionamentos para um gêmeo digital.

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

Parâmetros

Devoluções

Publique a telemetria do componente de um gêmeo digital, que é consumida por um ou vários pontos de extremidade de destino (assinantes) definidos em.

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

Parâmetros

Devoluções

Publique a telemetria de um gêmeo digital, que é consumida por um ou vários pontos de extremidade de destino (assinantes) definidos em.

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

Parâmetros

Devoluções

Consulta de gêmeos digitais.

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

Parâmetros

Devoluções

A lista paginável de resultados da consulta.

Atualize as propriedades de um componente em um gêmeo digital usando um patch JSON.

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

Parâmetros

Devoluções

Atualize um gêmeo digital usando um patch json.

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

Parâmetros

Devoluções

Atualiza as propriedades de um relacionamento em um gêmeo digital usando um patch JSON.

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

Parâmetros

Devoluções

Criar ou atualizar um gêmeo digital

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

Parâmetros

Devoluções

O aplicativo criado/gêmeo digital json.

Crie ou atualize uma rota de evento.

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

Parâmetros

Devoluções

Crie ou atualize um relacionamento em um gêmeo digital.

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

Parâmetros

Devoluções