Twins - DigitalTwins SendComponentTelemetry

Service:

Azure Digital Twins

API Version:

2023-10-31

Envia telemetria em nome de um componente em um gêmeo digital. Códigos de status:

• 204 Sem Conteúdo
• 400 Solicitação Inválida
  • InvalidArgument - A ID do gêmeo digital, a ID da mensagem ou o caminho do componente são inválidos.
  • ValidationFailed – o conteúdo da telemetria é inválido.
• 404 Não Encontrado
  • DigitalTwinNotFound - O gêmeo digital não foi encontrado.
  • ComponentNotFound - O caminho do componente não foi encontrado.

POST https://digitaltwins-hostname/digitaltwins/{id}/components/{componentPath}/telemetry?api-version=2023-10-31

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
componentPath	path	True	string	O nome do componente DTDL.
id	path	True	string	A ID do gêmeo digital. A ID é exclusiva dentro do serviço e diferencia maiúsculas de minúsculas.
api-version	query	True	string	A versão da API solicitada.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Message-Id	True	string	Um identificador de mensagem exclusivo (no escopo da ID do gêmeo digital) que normalmente é usado para duplicar mensagens.
Telemetry-Source-Time		string	Um carimbo de data/hora RFC 3339 que identifica a hora em que a telemetria foi medida.
traceparent		string	Identifica a solicitação em um sistema de rastreamento distribuído.
tracestate		string	Fornece informações de identificação de rastreamento específicas do fornecedor e é um complemento para o rastreamentoparente.

Corpo da solicitação

Nome	Tipo	Description
telemetry	object	As medidas de telemetria a serem enviadas do componente do gêmeo digital.

Respostas

Nome	Tipo	Description
204 No Content		Sucesso
Other Status Codes	ErrorResponse	Resposta padrão. Headers x-ms-error-code: string

Segurança

oauth2

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize?resource=0b07f429-9f4b-4714-9392-cc5e8e80c8b0

Exemplos

Send telemetry in a component

Sample Request

HTTP

POST https://digitaltwins-hostname/digitaltwins/myTwinId/components/myComponent/telemetry?api-version=2023-10-31



{
  "temperature": 1
}

Sample Response

Status code:

204

Definições

Nome	Description
Error	Definição de erro.
ErrorResponse	Resposta de erro.
InnerError	Uma descrição de erro mais específica do que foi fornecida pelo erro que contém.

Error

Definição de erro.

Nome	Tipo	Description
code	string	Código de erro específico do serviço que serve como substatus para o código de erro HTTP.
details	Error[]	Detalhes do erro interno.
innererror	InnerError	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message	string	Uma representação legível pelo homem do erro.

ErrorResponse

Resposta de erro.

Nome	Tipo	Description
error	Error	Os detalhes do erro.

InnerError

Uma descrição de erro mais específica do que foi fornecida pelo erro que contém.

Nome	Tipo	Description
code	string	Um código de erro mais específico do que foi fornecido pelo erro que contém.
innererror	InnerError	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.