DigitalTwinsClient class
Cliente da API do Azure IoT DigitalTwins.
Construtores
| Digital |
Cria uma instância do AzureDigitalTwinsAPI. Uso de exemplo: |
Métodos
Detalhes do construtor
DigitalTwinsClient(string, TokenCredential, DigitalTwinsClientOptions)
Cria uma instância do AzureDigitalTwinsAPI.
Uso de exemplo:
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
- endpointUrl
-
string
A URL do ponto de extremidade do serviço.
- credential
- TokenCredential
Usado para autenticar solicitações no serviço.
- options
- DigitalTwinsClientOptions
Usado para configurar o cliente de serviço.
Detalhes do método
createModels(Record<string, unknown>[], OperationOptions)
Criar um ou muitos
function createModels(dtdlModels: Record<string, unknown>[], options?: OperationOptions): Promise<DigitalTwinModelsAddResponse>Parâmetros
- dtdlModels
-
Record<string, unknown>[]
O conjunto de modelos a serem criados. Cada string corresponde a exatamente um modelo.
- options
- OperationOptions
As opções de operação
Retornos
Promise<DigitalTwinModelsAddResponse>
Os modelos application/json criados.
decomissionModel(string, OperationOptions)
Desativar um modelo usando um patch json. Quando um modelo for 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<void>Parâmetros
- modelId
-
string
A ID do modelo a ser desativado. a propriedade pode ser substituída.
- options
- OperationOptions
As opções de operação
Retornos
Promise<void>
deleteDigitalTwin(string, DigitalTwinsDeleteOptionalParams)
Excluir um gêmeo digital
function deleteDigitalTwin(digitalTwinId: string, options?: DigitalTwinsDeleteOptionalParams): Promise<void>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<void>
deleteEventRoute(string, OperationOptions)
Excluir uma rota de evento.
function deleteEventRoute(eventRouteId: string, options?: OperationOptions): Promise<void>Parâmetros
- eventRouteId
-
string
A ID do eventRoute a ser excluído.
- options
- OperationOptions
As opções de operação
Retornos
Promise<void>
deleteModel(string, OperationOptions)
Excluir um modelo.
function deleteModel(modelId: string, options?: OperationOptions): Promise<void>Parâmetros
- modelId
-
string
A ID do modelo a ser excluído.
- options
- OperationOptions
As opções de operação
Retornos
Promise<void>
deleteRelationship(string, string, DigitalTwinsDeleteRelationshipOptionalParams)
Exclua uma relação em um gêmeo digital.
function deleteRelationship(digitalTwinId: string, relationshipId: string, options?: DigitalTwinsDeleteRelationshipOptionalParams): Promise<void>Parâmetros
- digitalTwinId
-
string
A ID do gêmeo digital de origem.
- relationshipId
-
string
A ID da relação a ser excluída.
As opções de operação seMatch: somente executar a operação se a etag da entidade corresponder a uma das etags fornecidas ou * for
Retornos
Promise<void>
getComponent(string, string, OperationOptions)
Obtenha 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.
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 gêmeo digital application/json.
getEventRoute(string, OperationOptions)
Obter uma rota de evento.
function getEventRoute(eventRouteId: string, options?: OperationOptions): Promise<EventRoute>Parâmetros
- eventRouteId
-
string
- options
- OperationOptions
As opções de operação
Retornos
Promise<EventRoute>
A rota de eventos application/json.
getModel(string, DigitalTwinModelsGetByIdOptionalParams)
Obtenha um modelo, incluindo os metadados do modelo e a definição do modelo.
function getModel(modelId: string, options?: DigitalTwinModelsGetByIdOptionalParams): Promise<DigitalTwinsModelData>Parâmetros
- modelId
-
string
A ID do modelo.
- options
- GetModelOptions
Opções para esta operação
Retornos
Promise<DigitalTwinsModelData>
O modelo application/json.
getRelationship(string, string, OperationOptions)
Obter um relacionamento 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
A lista paginável de relações application/json pertencentes ao gêmeo digital especificado.
listEventRoutes(EventRoutesListOptionalParams)
Liste as rotas de evento em uma instância de gêmeos digitais.
function listEventRoutes(options?: EventRoutesListOptionalParams): PagedAsyncIterableIterator<EventRoute, EventRoute[], PageSettings>Parâmetros
- options
- ListEventRoutesOptions
Opções para listEventRoutes.
Retornos
A rota de eventos application/json.
listIncomingRelationships(string, DigitalTwinsListIncomingRelationshipsOptionalParams)
Recupere todas as relações de entrada para um gêmeo digital.
function listIncomingRelationships(digitalTwinId: string, options?: DigitalTwinsListIncomingRelationshipsOptionalParams): PagedAsyncIterableIterator<IncomingRelationship, IncomingRelationship[], PageSettings>Parâmetros
- digitalTwinId
-
string
A ID do gêmeo digital.
- options
- ListIncomingRelationshipsOptions
Retornos
listModels(DigitalTwinModelsListOptionalParams)
Obter a lista de modelos
function listModels(options?: DigitalTwinModelsListOptionalParams): PagedAsyncIterableIterator<DigitalTwinsModelData, DigitalTwinsModelData[], PageSettings>Parâmetros
- options
- ListModelsOptions
Opções para listagem de modelos.
Retornos
Um conjunto paginável de modelos application/json.
listRelationships(string, DigitalTwinsListRelationshipsOptionalParams)
Recuperar relações para um gêmeo digital.
function listRelationships(digitalTwinId: string, options?: DigitalTwinsListRelationshipsOptionalParams): PagedAsyncIterableIterator<Record<string, unknown>, Record<string, unknown>[], PageSettings>Parâmetros
- digitalTwinId
-
string
A ID do gêmeo digital.
- options
- ListRelationshipsOptions
Retornos
PagedAsyncIterableIterator<Record<string, unknown>, Record<string, unknown>[], PageSettings>
publishComponentTelemetry(string, string, Record<string, unknown>, string, OperationOptions)
Publique a telemetria do componente de um gêmeo digital, que é então consumido por um ou muitos pontos de extremidade de destino (assinantes) definidos.
function publishComponentTelemetry(digitalTwinId: string, componentName: string, payload: Record<string, unknown>, messageId: string, options?: OperationOptions): Promise<void>Parâmetros
- digitalTwinId
-
string
A ID do gêmeo digital a ser excluído.
- componentName
-
string
O nome do componente DTDL.
- payload
-
Record<string, unknown>
O conteúdo da telemetria do aplicativo/json a ser enviado.
- messageId
-
string
A ID da mensagem.
- options
- OperationOptions
As opções de operação
Retornos
Promise<void>
publishTelemetry(string, Record<string, unknown>, 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: Record<string, unknown>, messageId: string, options?: OperationOptions): Promise<void>Parâmetros
- digitalTwinId
-
string
A ID do gêmeo digital a ser excluído.
- payload
-
Record<string, unknown>
O conteúdo da telemetria do aplicativo/json a ser enviado.
- messageId
-
string
A ID da mensagem.
- options
- OperationOptions
As opções de operação
Retornos
Promise<void>
queryTwins(string, QueryQueryTwinsOptionalParams)
Consulta para gêmeos digitais.
function queryTwins(query: string, options?: QueryQueryTwinsOptionalParams): PagedAsyncIterableIterator<Record<string, unknown>, QueryQueryTwinsResponse, PageSettings>Parâmetros
- query
-
string
A cadeia de caracteres de consulta, na sintaxe semelhante a SQL.
- options
- QueryTwinsOptions
Opções para a operação de consulta.
Retornos
PagedAsyncIterableIterator<Record<string, unknown>, QueryQueryTwinsResponse, PageSettings>
A lista paginável de resultados da consulta.
updateComponent(string, string, Record<string, unknown>[], DigitalTwinsUpdateComponentOptionalParams)
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
- digitalTwinId
-
string
A ID do gêmeo digital.
- componentName
-
string
O componente que está sendo atualizado.
- jsonPatch
-
Record<string, unknown>[]
As operações application/json-patch+json a serem executadas no componente do gêmeo digital especificado.
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<DigitalTwinsUpdateComponentHeaders>
updateDigitalTwin(string, Record<string, unknown>[], DigitalTwinsUpdateOptionalParams)
Atualize um gêmeo digital usando um patch json.
function updateDigitalTwin(digitalTwinId: string, jsonPatch: Record<string, unknown>[], options?: DigitalTwinsUpdateOptionalParams): Promise<DigitalTwinsUpdateHeaders>Parâmetros
- digitalTwinId
-
string
A ID do gêmeo digital.
- jsonPatch
-
Record<string, unknown>[]
Uma especificação de atualização descrita pelo Patch JSON. Atualizações para valores de propriedade e elementos $model podem ocorrer na mesma solicitação. As operações são limitadas para 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<DigitalTwinsUpdateHeaders>
updateRelationship(string, string, Record<string, unknown>[], DigitalTwinsUpdateRelationshipOptionalParams)
Atualiza as propriedades de uma relação 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
- digitalTwinId
-
string
A ID do gêmeo digital a ser excluído.
- relationshipId
-
string
A ID da relação a ser atualizada.
- jsonPatch
-
Record<string, unknown>[]
As operações application/json-patch+json a serem executadas na relação do gêmeo digital especificado.
Opções de operação estendidas seMatch: execute a operação somente se a etag da entidade corresponder a uma das etags fornecidas ou * for fornecida.
Retornos
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 criada ou atualizada.
- digitalTwinJson
-
string
O gêmeo digital do aplicativo/json 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 gêmeo digital application/json criado.
upsertEventRoute(string, string, string, OperationOptions)
Crie ou atualize uma rota de evento.
function upsertEventRoute(eventRouteId: string, endpointId: string, filter: string, options?: OperationOptions): Promise<void>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<void>
upsertRelationship(string, string, Record<string, unknown>, DigitalTwinsAddRelationshipOptionalParams)
Criar ou atualizar uma relação em um gêmeo digital.
function upsertRelationship(digitalTwinId: string, relationshipId: string, relationship: Record<string, unknown>, 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
-
Record<string, unknown>
A relação de aplicativo/json a ser criada.
Opções de operação estendidas, incluindo ifNoneMatch: execute a operação somente se a entidade ainda não existir.
Retornos
Promise<DigitalTwinsAddRelationshipResponse>