DigitalTwinsClient class

Pacote:

@azure/digital-twins-core

Cliente da API do Azure IoT DigitalTwins.

Construtores

DigitalTwinsClient(string, TokenCredential, DigitalTwinsClientOptions)

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(); );

Métodos

createModels(any[], OperationOptions)	Criar um ou muitos
decomissionModel(string, OperationOptions)	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.
deleteDigitalTwin(string, DigitalTwinsDeleteOptionalParams)	Eliminar um duplo digital
deleteEventRoute(string, OperationOptions)	Eliminar uma rota de eventos.
deleteModel(string, OperationOptions)	Eliminar um modelo.
deleteRelationship(string, string, DigitalTwinsDeleteRelationshipOptionalParams)	Eliminar uma relação num duplo digital.
getComponent(string, string, OperationOptions)	Obtenha um componente num duplo digital.
getDigitalTwin(string, OperationOptions)	Obter um duplo 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 num duplo digital.
listEventRoutes(number, OperationOptions & PageSettings)	Liste as rotas de eventos numa instância de duplos digitais.
listIncomingRelationships(string, OperationOptions & PageSettings)	Obter todas as relações recebidas de um duplo digital.
listModels(string[], boolean, number, OperationOptions & PageSettings)	Obter a lista de modelos
listRelationships(string, OperationOptions & PageSettings)	Obter relações para um duplo digital.
publishComponentTelemetry(string, string, string, string, OperationOptions)	Publicar telemetria a partir do componente de um duplo digital, que é depois consumida por um ou muitos pontos finais de destino (subscritores) definidos em.
publishTelemetry(string, any, string, OperationOptions)	Publique a telemetria de um duplo digital, que é depois consumida por um ou muitos pontos finais de destino (subscritores) definidos em.
queryTwins(string, number, OperationOptions & PageSettings)	Consulta para duplos digitais.
updateComponent(string, string, any[], DigitalTwinsUpdateComponentOptionalParams)	Atualize as propriedades de um componente num duplo digital com um patch JSON.
updateDigitalTwin(string, any, DigitalTwinsUpdateOptionalParams)	Atualize um duplo digital com um patch de json.
updateRelationship(string, string, any[], DigitalTwinsUpdateRelationshipOptionalParams)	Atualizações as propriedades de uma relação num duplo digital através de um patch JSON.
upsertDigitalTwin(string, string, DigitalTwinsAddOptionalParams)	Criar ou atualizar um duplo digital
upsertEventRoute(string, string, string, OperationOptions)	Criar ou atualizar uma rota de evento.
upsertRelationship(string, string, any, DigitalTwinsAddRelationshipOptionalParams)	Criar ou atualizar uma relação num duplo digital.

Detalhes do Construtor

DigitalTwinsClient(string, TokenCredential, DigitalTwinsClientOptions)

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

endpointUrl

string

O URL do ponto final do serviço.

credential

TokenCredential

Utilizado para autenticar pedidos para o serviço.

options

DigitalTwinsClientOptions

Utilizado para configurar o cliente de serviço.

Detalhes de 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

Devoluções

Promise<DigitalTwinModelsAddResponse>

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

decomissionModel(string, OperationOptions)

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

modelId

string

O ID do modelo a desativar. a propriedade pode ser substituída.

options

OperationOptions

As opções de operação

Devoluções

Promise<RestResponse>

A resposta http.

deleteDigitalTwin(string, DigitalTwinsDeleteOptionalParams)

Eliminar um duplo digital

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

Parâmetros

digitalTwinId

string

O ID do duplo digital a eliminar.

options

DigitalTwinsDeleteOptionalParams

Opções de operação alargadas, incluindo ifMatch: execute apenas a operação se o etag da entidade corresponder a um dos etags fornecidos ou * for fornecido.

Devoluções

Promise<RestResponse>

A resposta http.

deleteEventRoute(string, OperationOptions)

Eliminar uma rota de eventos.

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

Parâmetros

eventRouteId

string

O ID do eventRoute a eliminar.

options

OperationOptions

As opções de operação

Devoluções

Promise<RestResponse>

A resposta http.

deleteModel(string, OperationOptions)

Eliminar um modelo.

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

Parâmetros

modelId

string

O ID do modelo a eliminar.

options

OperationOptions

As opções de operação

Devoluções

Promise<RestResponse>

A resposta http.

deleteRelationship(string, string, DigitalTwinsDeleteRelationshipOptionalParams)

Eliminar uma relação num duplo digital.

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

Parâmetros

digitalTwinId

string

O ID do duplo digital de origem.

relationshipId

string

O ID da relação a eliminar.

options

DigitalTwinsDeleteRelationshipOptionalParams

As opções de operação ifMatch: execute apenas a operação se o etag da entidade corresponder a um dos etags fornecidos ou * for

Devoluções

Promise<RestResponse>

A resposta http.

getComponent(string, string, OperationOptions)

Obtenha um componente num duplo digital.

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

Parâmetros

digitalTwinId

string

O ID do duplo digital.

componentName

string

O componente que está a ser obtido.

options

OperationOptions

As opções de operação

Devoluções

Promise<DigitalTwinsGetComponentResponse>

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

getDigitalTwin(string, OperationOptions)

Obter um duplo digital

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

Parâmetros

digitalTwinId

string

O ID do duplo digital.

options

OperationOptions

As opções de operação

Devoluções

Promise<DigitalTwinsGetByIdResponse>

A aplicação/json digital twin 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

Devoluções

Promise<EventRoutesGetByIdResponse>

A rota de eventos 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

O ID do modelo.

includeModelDefinition

boolean

options

OperationOptions

Opções de operação expandidas, incluindo includeModelDefinition: quando verdadeiro, a definição do modelo será devolvida como parte do resultado. Valor predefinido: falso.

Devoluções

Promise<DigitalTwinModelsGetByIdResponse>

O modelo application/json e a resposta http.

getRelationship(string, string, OperationOptions)

Obter uma relação num duplo digital.

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

Parâmetros

digitalTwinId

string

O ID do duplo digital de origem.

relationshipId

string

O ID da relação a obter.

options

OperationOptions

As opções de operação

Devoluções

Promise<DigitalTwinsGetRelationshipByIdResponse>

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

listEventRoutes(number, OperationOptions & PageSettings)

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

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

Parâmetros

resultsPerPage

number

O número máximo de itens a obter por pedido. O servidor pode optar por devolver menos do que o máximo pedido.

options

OperationOptions & PageSettings

Devoluções

PagedAsyncIterableIterator<EventRoute, EventRoutesListNextResponse, PageSettings>

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

listIncomingRelationships(string, OperationOptions & PageSettings)

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

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

Parâmetros

digitalTwinId

string

O ID do duplo digital.

options

OperationOptions & PageSettings

Devoluções

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[]

O modelo IDs para obter dependências. Se for omitido, todos os modelos são obtidos.

includeModelDefinition

boolean

Se pretende incluir a definição do modelo no resultado. Se for falso, apenas os metadados do modelo serão devolvidos.

resultsPerPage

number

O número máximo de itens a obter por pedido. O servidor pode optar por devolver menos do que o máximo pedido.

options

OperationOptions & PageSettings

Devoluções

PagedAsyncIterableIterator<DigitalTwinsModelData, DigitalTwinModelsListResponse, PageSettings>

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

listRelationships(string, OperationOptions & PageSettings)

Obter relações para um duplo digital.

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

Parâmetros

digitalTwinId

string

O ID do duplo digital.

options

OperationOptions & PageSettings

Devoluções

PagedAsyncIterableIterator<any, DigitalTwinsListRelationshipsResponse, PageSettings>

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

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

digitalTwinId

string

O ID do duplo digital a eliminar.

componentName

string

O nome do componente DTDL.

payload

string

O payload de telemetria de aplicação/json a ser enviado.

messageId

string

O ID da mensagem.

options

OperationOptions

As opções de operação

Devoluções

Promise<RestResponse>

A resposta http.

publishTelemetry(string, any, string, OperationOptions)

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

digitalTwinId

string

O ID do duplo digital a eliminar.

payload

any

O payload de telemetria de aplicação/json a ser enviado.

messageId

string

O ID da mensagem.

options

OperationOptions

As opções de operação

Devoluções

Promise<RestResponse>

A resposta http.

queryTwins(string, number, OperationOptions & PageSettings)

Consulta para duplos digitais.

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

Parâmetros

query

string

A cadeia de consulta, na sintaxe semelhante a SQL.

resultsPerPage

number

O número máximo de itens a obter por pedido. O servidor pode optar por devolver menos do que o máximo pedido.

options

OperationOptions & PageSettings

Devoluções

PagedAsyncIterableIterator<any, QueryQueryTwinsResponse, PageSettings>

A lista paginável dos resultados da consulta.

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

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

digitalTwinId

string

O ID do duplo digital.

componentName

string

O componente a ser atualizado.

jsonPatch

any[]

As operações application/json-patch+json a executar no componente do duplo digital especificado.

options

DigitalTwinsUpdateComponentOptionalParams

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

Devoluções

Promise<DigitalTwinsUpdateComponentResponse>

A resposta http.

updateDigitalTwin(string, any, DigitalTwinsUpdateOptionalParams)

Atualize um duplo digital com um patch de json.

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

Parâmetros

digitalTwinId

string

O ID do duplo digital.

jsonPatch

any

Uma especificação de atualização descrita pelo Patch JSON. Atualizações a valores de propriedade e $model elementos podem ocorrer no mesmo pedido. As operações estão limitadas a adicionar, substituir e remover.

options

DigitalTwinsUpdateOptionalParams

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

Devoluções

Promise<DigitalTwinsUpdateResponse>

A resposta http.

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

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

digitalTwinId

string

O ID do duplo digital a eliminar.

relationshipId

string

O ID da relação a atualizar.

jsonPatch

any[]

As operações application/json-patch+json a executar na relação do duplo digital especificado.

options

DigitalTwinsUpdateRelationshipOptionalParams

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

Devoluções

Promise<DigitalTwinsUpdateRelationshipResponse>

upsertDigitalTwin(string, string, DigitalTwinsAddOptionalParams)

Criar ou atualizar um duplo digital

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

Parâmetros

digitalTwinId

string

O ID do duplo digital a criar ou atualizar.

digitalTwinJson

string

A aplicação/json digital twin a criar.

options

DigitalTwinsAddOptionalParams

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

Devoluções

Promise<DigitalTwinsAddResponse>

A aplicação/json digital twin criada 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

O ID da rota do evento para criar ou atualizar.

endpointId

string

O ID do ponto final a que esta rota de eventos está vinculada.

filter

string

Uma expressão que descreve os eventos que são encaminhados para o ponto final.

options

OperationOptions

As opções de operação

Devoluções

Promise<RestResponse>

A resposta http.

upsertRelationship(string, string, any, DigitalTwinsAddRelationshipOptionalParams)

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

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

Parâmetros

digitalTwinId

string

O ID do duplo digital de origem.

relationshipId

string

O ID da relação a criar.

relationship

any

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

options

DigitalTwinsAddRelationshipOptionalParams

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

Devoluções

Promise<DigitalTwinsAddRelationshipResponse>