DigitalTwinsClient class

Referência

Pacote:: @azure/digital-twins-core

Cliente para a API digitalTwins do Azure IoT.

Construtores

DigitalTwinsClient(string, TokenCredential, DigitalTwinsClientOptions)

Cria uma instância do AzureDigitalTwinsAPI.

Exemplo de uso:

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

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

Métodos

createModels(any[], OperationOptions)	Criar um ou muitos
decomissionModel(string, OperationOptions)	Desativar 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 usar esse modelo. Depois que um modelo é desativado, ele pode não ser recomissionado.
deleteDigitalTwin(string, DigitalTwinsDeleteOptionalParams)	Excluir um gêmeo digital
deleteEventRoute(string, OperationOptions)	Exclua uma rota de evento.
deleteModel(string, OperationOptions)	Exclua um modelo.
deleteRelationship(string, string, DigitalTwinsDeleteRelationshipOptionalParams)	Exclua uma relação em um gêmeo digital.
getComponent(string, string, OperationOptions)	Obter um componente em um gêmeo digital.
getDigitalTwin(string, OperationOptions)	Obter um gêmeo digital
getEventRoute(string, OperationOptions)	Obter uma rota de evento.
getModel(string, boolean, OperationOptions)	Obtenha um modelo, incluindo os metadados do modelo e a definição do modelo.
getRelationship(string, string, OperationOptions)	Obter uma relação em um gêmeo digital.
listEventRoutes(number, OperationOptions & PageSettings)	Listar as rotas de evento em uma instância de gêmeos digitais.
listIncomingRelationships(string, OperationOptions & PageSettings)	Recupere todas as relações de entrada para um gêmeo digital.
listModels(string[], boolean, number, OperationOptions & PageSettings)	Obter a lista de modelos
listRelationships(string, OperationOptions & PageSettings)	Recuperar relações para um gêmeo digital.
publishComponentTelemetry(string, string, string, string, OperationOptions)	Publique a telemetria do componente de um gêmeo digital, que é consumido por um ou muitos pontos de extremidade de destino (assinantes) definidos em.
publishTelemetry(string, any, string, OperationOptions)	Publique a telemetria de um gêmeo digital, que é então consumida por um ou muitos pontos de extremidade de destino (assinantes) definidos em.
queryTwins(string, number, OperationOptions & PageSettings)	Consultar gêmeos digitais.
updateComponent(string, string, any[], DigitalTwinsUpdateComponentOptionalParams)	Atualize as propriedades de um componente em um gêmeo digital usando um patch JSON.
updateDigitalTwin(string, any, DigitalTwinsUpdateOptionalParams)	Atualize um gêmeo digital usando um patch json.
updateRelationship(string, string, any[], DigitalTwinsUpdateRelationshipOptionalParams)	Atualizações as propriedades de uma relação em um gêmeo digital usando um patch JSON.
upsertDigitalTwin(string, string, DigitalTwinsAddOptionalParams)	Criar ou atualizar um gêmeo digital
upsertEventRoute(string, string, string, OperationOptions)	Criar ou atualizar uma rota de evento.
upsertRelationship(string, string, any, DigitalTwinsAddRelationshipOptionalParams)	Criar ou atualizar uma relação em um gêmeo digital.

Detalhes do construtor

DigitalTwinsClient(string, TokenCredential, DigitalTwinsClientOptions)

Cria uma instância do AzureDigitalTwinsAPI.

Exemplo 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

A URL do ponto de extremidade do serviço.

credential: TokenCredential

Usado para autenticar solicitações para o serviço.

options: DigitalTwinsClientOptions

Usado para configurar o cliente de serviço.

Detalhes do método

createModels(any[], OperationOptions)

Criar um ou muitos

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

Parâmetros

dtdlModels: any[]

options: OperationOptions

As opções de operação

Retornos

Promise<DigitalTwinModelsAddResponse>

Os modelos de aplicativo/json criados e a resposta http.

decomissionModel(string, OperationOptions)

Desativar 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 usar esse modelo. Depois que um modelo é desativado, ele pode não ser recomissionado.

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

Parâmetros

modelId: string

A ID do modelo a ser desativado. pode ser substituída.

options: OperationOptions

As opções de operação

Retornos

Promise<RestResponse>

A resposta de http.

deleteDigitalTwin(string, DigitalTwinsDeleteOptionalParams)

Excluir um gêmeo digital

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

Parâmetros

digitalTwinId: string

A ID do gêmeo digital a ser excluído.

options: DigitalTwinsDeleteOptionalParams

Opções de operação estendidas, incluindo ifMatch: execute a operação somente se a etag da entidade corresponder a uma das etags fornecidas ou * for fornecida.

Retornos

Promise<RestResponse>

A resposta de http.

deleteEventRoute(string, OperationOptions)

Exclua uma rota de evento.

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

Parâmetros

eventRouteId: string

A ID do eventRoute a ser excluído.

options: OperationOptions

As opções de operação

Retornos

Promise<RestResponse>

A resposta de http.

deleteModel(string, OperationOptions)

Exclua um modelo.

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

Parâmetros

modelId: string

A ID do modelo a ser excluído.

options: OperationOptions

As opções de operação

Retornos

Promise<RestResponse>

A resposta de http.

deleteRelationship(string, string, DigitalTwinsDeleteRelationshipOptionalParams)

Exclua uma relação em um gêmeo digital.

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

Parâmetros

digitalTwinId: string

A ID do gêmeo digital de origem.

relationshipId: string

A ID da relação a ser excluída.

options: DigitalTwinsDeleteRelationshipOptionalParams

As opções de operação ifMatch: só executarão a operação se a etag da entidade corresponder a uma das etags fornecidas ou * for

Retornos

Promise<RestResponse>

A resposta de http.

getComponent(string, string, OperationOptions)

Obter um componente em um gêmeo digital.

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

Parâmetros

digitalTwinId: string

A ID do gêmeo digital.

componentName: string

O componente que está sendo recuperado.

options: OperationOptions

As opções de operação

Retornos

Promise<DigitalTwinsGetComponentResponse>

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

getDigitalTwin(string, OperationOptions)

Obter um gêmeo digital

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

Parâmetros

digitalTwinId: string

A ID do gêmeo digital.

options: OperationOptions

As opções de operação

Retornos

Promise<DigitalTwinsGetByIdResponse>

O aplicativo/json gêmeo digital e a resposta http.

getEventRoute(string, OperationOptions)

Obter uma rota de evento.

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

Parâmetros

eventRouteId: string

options: OperationOptions

As opções de operação

Retornos

Promise<EventRoutesGetByIdResponse>

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

getModel(string, boolean, OperationOptions)

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

modelId: string

A ID do modelo.

includeModelDefinition: boolean

options: OperationOptions

Opções de operação estendidas, incluindo includeModelDefinition: quando true, a definição do modelo será retornada como parte do resultado. Valor padrão: false.

Retornos

Promise<DigitalTwinModelsGetByIdResponse>

O modelo de aplicativo/json e a resposta http.

getRelationship(string, string, OperationOptions)

Obter uma relação em um gêmeo digital.

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

Parâmetros

digitalTwinId: string

A ID do gêmeo digital de origem.

relationshipId: string

A ID da relação a ser recuperada.

options: OperationOptions

As opções de operação

Retornos

Promise<DigitalTwinsGetRelationshipByIdResponse>

A lista paginável de relações de aplicativo/json que pertencem ao gêmeo digital especificado e à resposta http.

listEventRoutes(number, OperationOptions & PageSettings)

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

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

Parâmetros

resultsPerPage: number

O número máximo de itens a serem recuperados por solicitação. O servidor pode optar por retornar menos do que o máximo solicitado.

options: OperationOptions & PageSettings

Retornos

PagedAsyncIterableIterator<EventRoute, EventRoutesListNextResponse, PageSettings>

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

listIncomingRelationships(string, OperationOptions & PageSettings)

Recupere todas as relações de entrada para um gêmeo digital.

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

Parâmetros

digitalTwinId: string

A ID do gêmeo digital.

options: OperationOptions & PageSettings

Retornos

PagedAsyncIterableIterator<IncomingRelationship, DigitalTwinsListIncomingRelationshipsResponse, PageSettings>

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

Obter a lista de modelos

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

Parâmetros

dependeciesFor: string[]

As IDs de modelo para ter dependências recuperadas. Se omitido, todos os modelos serão recuperados.

includeModelDefinition: boolean

Se a definição do modelo deve ser incluída no resultado. Se false, somente os metadados do modelo serão retornados.

resultsPerPage: number

O número máximo de itens a serem recuperados por solicitação. O servidor pode optar por retornar menos do que o máximo solicitado.

options: OperationOptions & PageSettings

Retornos

PagedAsyncIterableIterator<DigitalTwinsModelData, DigitalTwinModelsListResponse, PageSettings>

Um conjunto paginável de modelos de aplicativo/json e a resposta http.

listRelationships(string, OperationOptions & PageSettings)

Recuperar relações para um gêmeo digital.

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

Parâmetros

digitalTwinId: string

A ID do gêmeo digital.

options: OperationOptions & PageSettings

Retornos

PagedAsyncIterableIterator<any, DigitalTwinsListRelationshipsResponse, PageSettings>

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

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

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

Parâmetros

digitalTwinId: string

A ID do gêmeo digital a ser excluído.

componentName: string

O nome do componente DTDL.

payload: string

O conteúdo de telemetria do aplicativo/json a ser enviado.

messageId: string

A ID da mensagem.

options: OperationOptions

As opções de operação

Retornos

Promise<RestResponse>

A resposta de http.

publishTelemetry(string, any, string, OperationOptions)

Publique a telemetria de um gêmeo digital, que é então consumida por um ou muitos pontos de extremidade de destino (assinantes) definidos em.

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

Parâmetros

digitalTwinId: string

A ID do gêmeo digital a ser excluído.

payload: any

O conteúdo de telemetria do aplicativo/json a ser enviado.

messageId: string

A ID da mensagem.

options: OperationOptions

As opções de operação

Retornos

Promise<RestResponse>

A resposta de http.

queryTwins(string, number, OperationOptions & PageSettings)

Consultar gêmeos digitais.

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

Parâmetros

query: string

A cadeia de caracteres de consulta, na sintaxe semelhante a SQL.

resultsPerPage: number

O número máximo de itens a serem recuperados por solicitação. O servidor pode optar por retornar menos do que o máximo solicitado.

options: OperationOptions & PageSettings

Retornos

PagedAsyncIterableIterator<any, QueryQueryTwinsResponse, PageSettings>

A lista paginável dos resultados da consulta.

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

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

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

Parâmetros

digitalTwinId: string

A ID do gêmeo digital.

componentName: string

O componente que está sendo atualizado.

jsonPatch: any[]

As operações application/json-patch+json a serem executadas no componente do gêmeo digital especificado.

options: DigitalTwinsUpdateComponentOptionalParams

Opções de operação estendidas, incluindo ifMatch: execute a operação somente se a etag da entidade corresponder a uma das etags fornecidas ou * for fornecida.

Retornos

Promise<DigitalTwinsUpdateComponentResponse>

A resposta de http.

updateDigitalTwin(string, any, DigitalTwinsUpdateOptionalParams)

Atualize um gêmeo digital usando um patch json.

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

Parâmetros

digitalTwinId: string

A ID do gêmeo digital.

jsonPatch: any

Uma especificação de atualização descrita pelo Patch JSON. Atualizações a valores de propriedade e elementos $model podem ocorrer na mesma solicitação. As operações são limitadas a adicionar, substituir e remover.

options: DigitalTwinsUpdateOptionalParams

Opções de operação estendidas, incluindo ifMatch: execute a operação somente se a etag da entidade corresponder a uma das etags fornecidas ou * for fornecida.

Retornos

Promise<DigitalTwinsUpdateResponse>

A resposta de http.

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

Atualizações as propriedades de uma relação em um gêmeo digital usando um patch JSON.

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

Parâmetros

digitalTwinId: string

A ID do gêmeo digital a ser excluído.

relationshipId: string

A ID da relação a ser atualizada.

jsonPatch: any[]

As operações application/json-patch+json a serem executadas na relação do gêmeo digital especificado.

options: DigitalTwinsUpdateRelationshipOptionalParams

Opções de operação estendidas ifMatch: execute a operação somente se a etag da entidade corresponder a uma das etags fornecidas ou * for fornecida.

Retornos

Promise<DigitalTwinsUpdateRelationshipResponse>

upsertDigitalTwin(string, string, DigitalTwinsAddOptionalParams)

Criar ou atualizar um gêmeo digital

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

Parâmetros

digitalTwinId: string

A ID do gêmeo digital a ser criado ou atualizado.

digitalTwinJson: string

O aplicativo/json gêmeo digital a ser criado.

options: DigitalTwinsAddOptionalParams

Opções de operação estendidas, incluindo ifNoneMatch: execute a operação somente se a entidade ainda não existir.

Retornos

Promise<DigitalTwinsAddResponse>

O aplicativo/json gêmeo digital criado e a resposta http.

upsertEventRoute(string, string, string, OperationOptions)

Criar ou atualizar uma rota de evento.

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

Parâmetros

eventRouteId: string

A ID da rota de evento a ser criada ou atualizada.

endpointId: string

A ID do ponto de extremidade à qual essa rota de evento está associada.

filter: string

Uma expressão que descreve os eventos que são roteados para o ponto de extremidade.

options: OperationOptions

As opções de operação

Retornos

Promise<RestResponse>

A resposta de http.

upsertRelationship(string, string, any, DigitalTwinsAddRelationshipOptionalParams)

Criar ou atualizar uma relação em um gêmeo digital.

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

Parâmetros

digitalTwinId: string

A ID do gêmeo digital de origem.

relationshipId: string

A ID da relação a ser criada.

relationship: any

A relação aplicativo/json a ser criada.

options: DigitalTwinsAddRelationshipOptionalParams

Opções de operação estendidas, incluindo ifNoneMatch: execute a operação somente se a entidade ainda não existir.

Retornos

Promise<DigitalTwinsAddRelationshipResponse>

Compartilhar via

DigitalTwinsClient class

Construtores

Métodos

Detalhes do construtor

DigitalTwinsClient(string, TokenCredential, DigitalTwinsClientOptions)

Parâmetros

Detalhes do método

createModels(any[], OperationOptions)

Parâmetros

Retornos

decomissionModel(string, OperationOptions)

Parâmetros

Retornos

deleteDigitalTwin(string, DigitalTwinsDeleteOptionalParams)

Parâmetros

Retornos

deleteEventRoute(string, OperationOptions)

Parâmetros

Retornos

deleteModel(string, OperationOptions)

Parâmetros

Retornos

deleteRelationship(string, string, DigitalTwinsDeleteRelationshipOptionalParams)

Parâmetros

Retornos

getComponent(string, string, OperationOptions)

Parâmetros

Retornos

getDigitalTwin(string, OperationOptions)

Parâmetros

Retornos

getEventRoute(string, OperationOptions)

Parâmetros

Retornos

getModel(string, boolean, OperationOptions)

Parâmetros

Retornos

getRelationship(string, string, OperationOptions)

Parâmetros

Retornos

listEventRoutes(number, OperationOptions & PageSettings)

Parâmetros

Retornos

listIncomingRelationships(string, OperationOptions & PageSettings)

Parâmetros

Retornos

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

Parâmetros

Retornos

listRelationships(string, OperationOptions & PageSettings)

Parâmetros

Retornos

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

Parâmetros

Retornos

publishTelemetry(string, any, string, OperationOptions)

Parâmetros

Retornos

queryTwins(string, number, OperationOptions & PageSettings)

Parâmetros

Retornos

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

Parâmetros

Retornos

updateDigitalTwin(string, any, DigitalTwinsUpdateOptionalParams)

Parâmetros

Retornos

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

Parâmetros

Retornos

upsertDigitalTwin(string, string, DigitalTwinsAddOptionalParams)

Parâmetros

Retornos

upsertEventRoute(string, string, string, OperationOptions)

Parâmetros

Retornos

upsertRelationship(string, string, any, DigitalTwinsAddRelationshipOptionalParams)

Parâmetros

Retornos