Exportar dados de IoT para Webhook

Este artigo descreve como configurar a exportação de dados para enviar dados para o Webhook.

Use esse recurso para exportar continuamente dados de IoT filtrados e enriquecidos de seu aplicativo IoT Central. A exportação de dados envia as alterações quase em tempo real para outras partes da sua solução de nuvem para obter informações, análises e armazenamento de caminho quente.

Por exemplo, pode:

• Exporte continuamente telemetria, alterações de propriedade, conectividade do dispositivo, ciclo de vida do dispositivo, ciclo de vida do modelo de dispositivo e dados de log de auditoria no formato JSON quase em tempo real.
• Filtre os fluxos de dados para exportar dados que correspondam às condições personalizadas.
• Enriqueça os fluxos de dados com valores personalizados e valores de propriedade do dispositivo.
• Transforme os fluxos de dados para modificar sua forma e conteúdo.

Gorjeta

Ao ativar a exportação de dados, você obtém apenas os dados a partir desse momento. Para reter mais dados históricos, ative a exportação de dados antecipadamente. Para exportar manualmente dados de momentos em que a exportação de dados estava desativada, consulte Como usar a API REST do IoT Central para consultar dispositivos.

Nota

Em algumas circunstâncias, pode levar até 60 segundos para que as mensagens sejam exportadas. Esse tempo é medido desde quando o IoT Central recebe a mensagem do hub IoT subjacente até quando a mensagem é entregue ao ponto de extremidade de destino.

Pré-requisitos

Para usar os recursos de exportação de dados, você deve ter a permissão de exportação de dados.

Configurar um destino de exportação Webhook

Para destinos Webhook, o IoT Central exporta dados quase em tempo real. Os dados no corpo da mensagem estão no mesmo formato dos Hubs de Eventos e do Service Bus.

Criar um destino Webhook

Você pode exportar dados para um ponto de extremidade HTTP Webhook disponível publicamente. Você pode criar um ponto de extremidade Webhook de teste usando RequestBin. RequestBin limita a solicitação quando o limite de solicitação é atingido:

1. Navegue até RequestBin.

2. Selecione Criar um RequestBin.

3. Inicie sessão com um dos métodos disponíveis.

4. Copie o URL do seu RequestBin Você usa esse URL quando testa sua exportação de dados.

Para criar o destino do Azure Data Explorer no IoT Central na página Exportação de dados:

1. Selecione + Novo destino.

2. Selecione Webhook como o tipo de destino.

3. Cole o URL de retorno de chamada para seu ponto de extremidade Webhook. Opcionalmente, você pode configurar a autorização Webhook e adicionar cabeçalhos personalizados.

   • Para OAuth2.0, apenas o fluxo de concessão de credenciais do cliente é suportado. Quando você salva o destino, o IoT Central se comunica com seu provedor OAuth para recuperar um token de autorização. Este token é anexado ao cabeçalho de Authorization cada mensagem enviada para este destino.
   • Para o token de autorização, você pode especificar um valor de token diretamente anexado Authorization ao cabeçalho para cada mensagem enviada para esse destino.

4. Selecione Guardar.

Exemplo de configuração do OAuth 2.0

Este exemplo mostra como configurar um destino Webhook para usar um Aplicativo de Função do Azure protegido usando a entrada do Microsoft Entra:

Definição	Exemplo	Notas
Tipo de destino	Webhook
URL de retorno de chamada	https://myapp.azurewebsites.net/api/HttpExample	O URL da função.
Autorização	OAuth 2.0
Token URL	https://login.microsoftonline.com/your-tenant-id/oauth2/v2.0/token	A URL a ser usada para recuperar um token. Você pode encontrar esse valor em seu aplicativo de função: autenticação > seus pontos de extremidade do provedor de > identidade da Microsoft Ponto > de extremidade de token OAuth 2.0 (v2)
ID de Cliente	your-client-id	A ID do cliente do seu aplicativo de função. Você pode encontrar esse valor em seu aplicativo de função: autenticação > sua ID de aplicativo (cliente) do provedor de > identidade da Microsoft
Segredo do cliente	your-client-secret	O segredo do cliente do seu aplicativo de função. Você pode encontrar esse valor em seu aplicativo de função: Autenticação > Seu provedor de > identidade Microsoft Certificados & segredos
Audiência	N/A	Em branco se estiver a utilizar uma aplicação funcional.
Âmbito	https://your-client-id/.default	O escopo do token. Para um aplicativo de função, use o valor de ID do cliente.**
Tipo de conteúdo de solicitação de token	Automático

Outros destinos de webhook podem exigir valores diferentes para essas configurações.

Configurar uma exportação de dados

Agora que você tem um destino para exportar seus dados, configure a exportação de dados em seu aplicativo IoT Central:

1. Faça login no seu aplicativo IoT Central.

2. No painel esquerdo, selecione Exportação de dados.

   Gorjeta

   Se não vir Exportação de dados no painel esquerdo, não tem permissões para configurar a exportação de dados na sua aplicação. Fale com um administrador para configurar a exportação de dados.

3. Selecione + Nova exportação.

4. Introduza um nome para apresentação para a nova exportação e certifique-se de que a exportação de dados está Ativada.

5. Escolha o tipo de dados a exportar. A tabela a seguir lista os tipos de exportação de dados suportados:

   Tipo de dados	Description	Formato dos dados
   Telemetria	Exporte mensagens de telemetria de dispositivos quase em tempo real. Cada mensagem exportada contém o conteúdo completo da mensagem original do dispositivo, normalizada.	Formato de mensagem de telemetria
   Alterações de propriedade	Exporte alterações para propriedades de dispositivos e nuvem quase em tempo real. Para propriedades de dispositivo somente leitura, as alterações nos valores relatados são exportadas. Para propriedades de leitura-gravação, os valores relatados e desejados são exportados.	Alterar formato de mensagem de propriedade
   Conectividade dos dispositivos	Exporte eventos conectados e desconectados do dispositivo.	Formato de mensagem de conectividade do dispositivo
   Ciclo de vida dos dispositivos	Exporte eventos de dispositivo registrado, excluído, provisionado, habilitado, desabilitado, displayNameChanged e deviceTemplateChanged.	O ciclo de vida do dispositivo altera o formato da mensagem
   Ciclo de vida do modelo de dispositivo	Exporte alterações de modelo de dispositivo publicadas, incluindo criado, atualizado e excluído.	O ciclo de vida do modelo de dispositivo altera o formato da mensagem
   Registos de auditoria	Logs de atualizações iniciadas pelo usuário para entidades no aplicativo. Para saber mais, consulte Usar logs de auditoria para controlar a atividade em seu aplicativo IoT Central	Formato de mensagem do log de auditoria

6. Opcionalmente, adicione filtros para reduzir a quantidade de dados exportados. Existem diferentes tipos de filtro disponíveis para cada tipo de exportação de dados:

   Tipo de dados	Filtros disponíveis
   Telemetria	Filtrar por nome do dispositivo, ID do dispositivo, modelo de dispositivo e se o dispositivo for simulado Fluxo de filtro para conter apenas telemetria que atenda às condições de filtro Fluxo de filtro para conter apenas telemetria de dispositivos com propriedades correspondentes às condições do filtro Fluxo de filtro para conter apenas telemetria que tenha propriedades de mensagem que atendam à condição de filtro. As propriedades da mensagem (também conhecidas como propriedades do aplicativo) são enviadas em um pacote de pares chave-valor em cada mensagem de telemetria. Para criar um filtro de propriedade de mensagem, insira a chave de propriedade da mensagem que você está procurando e especifique uma condição. Somente mensagens de telemetria com propriedades que correspondem à condição de filtro especificada são exportadas. Saiba mais sobre as propriedades do aplicativo nos documentos do Hub IoT
   Alterações de propriedade	Filtrar por nome do dispositivo, ID do dispositivo, modelo de dispositivo e se o dispositivo for simulado Fluxo de filtro para conter apenas alterações de propriedade que atendam às condições de filtro
   Conectividade dos dispositivos	Filtrar por nome de dispositivo, ID do dispositivo, modelo de dispositivo, organizações e se o dispositivo é simulado Fluxo de filtro para conter apenas alterações de dispositivos com propriedades correspondentes às condições do filtro
   Ciclo de vida dos dispositivos	Filtrar por nome de dispositivo, ID do dispositivo, modelo de dispositivo e se o dispositivo estiver provisionado, habilitado ou simulado Fluxo de filtro para conter apenas alterações de dispositivos com propriedades correspondentes às condições do filtro
   Ciclo de vida do modelo de dispositivo	Filtrar por modelo de dispositivo
   Registos de auditoria	N/A

7. Opcionalmente, enriqueça as mensagens exportadas com metadados extras do par chave-valor. Os seguintes enriquecimentos estão disponíveis para os tipos de exportação de dados de telemetria, alterações de propriedade, conectividade de dispositivos e ciclo de vida do dispositivo:

   • Cadeia de caracteres personalizada: adiciona uma cadeia de caracteres estática personalizada a cada mensagem. Insira qualquer chave e insira qualquer valor de cadeia de caracteres.
   • Propriedade, que adiciona a cada mensagem:
     • Metadados do dispositivo, como nome do dispositivo, nome do modelo de dispositivo, habilitado, organizações, provisionado e simulado.
     • O dispositivo atual relatou a propriedade ou o valor da propriedade de nuvem para cada mensagem. Se a mensagem exportada for de um dispositivo que não tem a propriedade especificada, a mensagem exportada não receberá o enriquecimento.

Configure o destino da exportação:

1. Selecione + Destino para adicionar um destino que você já criou ou selecione Criar um novo.

2. Para transformar seus dados antes de serem exportados, selecione + Transformar. Para saber mais, consulte Transformar dados dentro do seu aplicativo IoT Central para exportação.

3. Selecione + Destino para adicionar até cinco destinos a uma única exportação.

4. Quando terminar de configurar a exportação, selecione Guardar. Após alguns minutos, seus dados aparecem em seus destinos.

Monitorize a sua exportação

No IoT Central, a página Exportação de dados permite verificar o status de suas exportações. Também pode utilizar o Azure Monitor para ver a quantidade de dados que está a exportar e quaisquer erros de exportação. Você pode acessar métricas de exportação e integridade do dispositivo em gráficos no portal do Azure usando a API REST, consultas no PowerShell ou a CLI do Azure. Atualmente, você pode monitorar as seguintes métricas de exportação de dados no Azure Monitor:

• Número de mensagens recebidas para exportação antes que os filtros sejam aplicados.
• Número de mensagens que passam por filtros.
• Número de mensagens exportadas com êxito para destinos.
• Número de erros encontrados.

Para saber mais, consulte Monitorar a integridade do aplicativo.

Formatos de dados

As seções a seguir descrevem os formatos dos dados exportados:

Formato de telemetria

Cada mensagem exportada contém uma forma normalizada da mensagem completa que o dispositivo enviou no corpo da mensagem. A mensagem está no formato JSON e codificada como UTF-8. As informações em cada mensagem incluem:

• applicationId: A ID do aplicativo IoT Central.
• messageSource: A fonte da mensagem - telemetry.
• deviceId: A ID do dispositivo que enviou a mensagem de telemetria.
• schema: O nome e a versão do esquema de carga útil.
• templateId: A ID do modelo de dispositivo atribuído ao dispositivo.
• enqueuedTime: A hora em que o IoT Central recebeu esta mensagem.
• enrichments: Eventuais enriquecimentos estabelecidos na exportação.
• module: O módulo IoT Edge que enviou esta mensagem. Este campo só aparece se a mensagem tiver vindo de um módulo do IoT Edge.
• component: O componente que enviou esta mensagem. Este campo só aparece se os recursos enviados na mensagem foram modelados como um componente no modelo de dispositivo
• messageProperties: Outras propriedades que o dispositivo enviou com a mensagem. Essas propriedades às vezes são chamadas de propriedades do aplicativo. Saiba mais nos documentos do Hub IoT.

Propriedades da mensagem

As mensagens de telemetria têm propriedades para metadados, bem como para a carga útil de telemetria. O trecho anterior mostra exemplos de mensagens do sistema, como deviceId e enqueuedTime. Para saber mais sobre as propriedades das mensagens do sistema, consulte Propriedades do sistema de mensagens do Hub IoT do dispositivo para a nuvem.

Você pode adicionar propriedades a mensagens de telemetria se precisar adicionar metadados personalizados às suas mensagens de telemetria. Por exemplo, você precisa adicionar um carimbo de data/hora quando o dispositivo cria a mensagem.

O trecho de código a seguir mostra como adicionar a iothub-creation-time-utc propriedade à mensagem quando você a cria no dispositivo:

Importante

O formato deste carimbo de data/hora deve ser UTC sem informações de fuso horário. Por exemplo, 2021-04-21T11:30:16Z é válido, 2021-04-21T11:30:16-07:00 é inválido.

JavaScript

async function sendTelemetry(deviceClient, index) {
  console.log('Sending telemetry message %d...', index);
  const msg = new Message(
    JSON.stringify(
      deviceTemperatureSensor.updateSensor().getCurrentTemperatureObject()
    )
  );
  msg.properties.add("iothub-creation-time-utc", new Date().toISOString());
  msg.contentType = 'application/json';
  msg.contentEncoding = 'utf-8';
  await deviceClient.sendEvent(msg);
}

Java

private static void sendTemperatureTelemetry() {
  String telemetryName = "temperature";
  String telemetryPayload = String.format("{\"%s\": %f}", telemetryName, temperature);

  Message message = new Message(telemetryPayload);
  message.setContentEncoding(StandardCharsets.UTF_8.name());
  message.setContentTypeFinal("application/json");
  message.setProperty("iothub-creation-time-utc", Instant.now().toString());

  deviceClient.sendEventAsync(message, new MessageIotHubEventCallback(), message);
  log.debug("My Telemetry: Sent - {\"{}\": {}°C} with message Id {}.", telemetryName, temperature, message.getMessageId());
  temperatureReadings.put(new Date(), temperature);
}

C#

private async Task SendTemperatureTelemetryAsync()
{
  const string telemetryName = "temperature";

  string telemetryPayload = $"{{ \"{telemetryName}\": {_temperature} }}";
  using var message = new Message(Encoding.UTF8.GetBytes(telemetryPayload))
  {
      ContentEncoding = "utf-8",
      ContentType = "application/json",
  };
  message.Properties.Add("iothub-creation-time-utc", DateTime.UtcNow.ToString("yyyy-MM-ddTHH:mm:ssZ"));
  await _deviceClient.SendEventAsync(message);
  _logger.LogDebug($"Telemetry: Sent - {{ \"{telemetryName}\": {_temperature}°C }}.");
}

Python

async def send_telemetry_from_thermostat(device_client, telemetry_msg):
    msg = Message(json.dumps(telemetry_msg))
    msg.custom_properties["iothub-creation-time-utc"] = datetime.now(timezone.utc).isoformat()
    msg.content_encoding = "utf-8"
    msg.content_type = "application/json"
    print("Sent message")
    await device_client.send_message(msg)

Alteração de formato de propriedade

Cada mensagem ou registro representa alterações nas propriedades do dispositivo e da nuvem. As informações na mensagem exportada incluem:

• applicationId: A ID do aplicativo IoT Central.
• messageSource: A fonte da mensagem - properties.
• messageType: Ou cloudPropertyChange, devicePropertyDesiredChange, ou devicePropertyReportedChange.
• deviceId: A ID do dispositivo que enviou a mensagem de telemetria.
• schema: O nome e a versão do esquema de carga útil.
• enqueuedTime: O momento em que o IoT Central detetou essa alteração.
• templateId: A ID do modelo de dispositivo atribuído ao dispositivo.
• properties: Uma matriz de propriedades que foram alteradas, incluindo os nomes das propriedades e valores que foram alterados. As informações do componente e do módulo serão incluídas se a propriedade for modelada dentro de um componente ou de um módulo IoT Edge.
• enrichments: Eventuais enriquecimentos estabelecidos na exportação.

Conectividade do dispositivo muda de formato

Cada mensagem ou registro representa um evento de conectividade de um único dispositivo. As informações na mensagem exportada incluem:

• applicationId: A ID do aplicativo IoT Central.
• messageSource: A fonte da mensagem - deviceConnectivity.
• messageType: Ou connected disconnectedou .
• deviceId: O ID do dispositivo que foi alterado.
• schema: O nome e a versão do esquema de carga útil.
• templateId: A ID do modelo de dispositivo atribuído ao dispositivo.
• enqueuedTime: O momento em que essa alteração ocorreu no IoT Central.
• enrichments: Eventuais enriquecimentos estabelecidos na exportação.

Formato das alterações no ciclo de vida do dispositivo

Cada mensagem ou registro representa uma alteração em um único dispositivo. As informações na mensagem exportada incluem:

• applicationId: A ID do aplicativo IoT Central.
• messageSource: A fonte da mensagem - deviceLifecycle.
• messageType: O tipo de alteração que ocorreu. Um dos: registered, deleted, , provisioned, enabled, displayNameChangeddisabled, e deviceTemplateChanged.
• deviceId: O ID do dispositivo que foi alterado.
• schema: O nome e a versão do esquema de carga útil.
• templateId: A ID do modelo de dispositivo atribuído ao dispositivo.
• enqueuedTime: O momento em que essa alteração ocorreu no IoT Central.
• enrichments: Eventuais enriquecimentos estabelecidos na exportação.

O ciclo de vida do modelo de dispositivo altera o formato

Cada mensagem ou registro representa uma alteração em um único modelo de dispositivo publicado. As informações na mensagem exportada incluem:

• applicationId: A ID do aplicativo IoT Central.
• messageSource: A fonte da mensagem - deviceTemplateLifecycle.
• messageType: Ou created, updated, ou deleted.
• schema: O nome e a versão do esquema de carga útil.
• templateId: A ID do modelo de dispositivo atribuído ao dispositivo.
• enqueuedTime: O momento em que essa alteração ocorreu no IoT Central.
• enrichments: Eventuais enriquecimentos estabelecidos na exportação.

Formato do registo de auditoria

Cada mensagem de log de auditoria representa uma alteração iniciada pelo usuário em uma entidade auditável dentro do aplicativo IoT Central. As informações na mensagem exportada incluem:

• actor: Informações sobre o usuário que modificou a entidade.
• applicationId: A ID do aplicativo IoT Central.
• messageSource: A fonte da mensagem - audit.
• messageType: O tipo de alteração que ocorreu. Um dos: updated, created, deleted.
• updated: Só presente se messageType for updated. Fornece mais detalhes sobre a atualização.
• resource: Detalhes da entidade modificada.
• schema: O nome e a versão do esquema de carga útil.
• deviceId: O ID do dispositivo que foi alterado.
• enqueuedTime: O momento em que essa alteração ocorreu no IoT Central.
• enrichments: Eventuais enriquecimentos estabelecidos na exportação.

Próximos passos

Agora que você sabe como exportar para o Service Bus, uma próxima etapa sugerida é aprender Exportar para Hubs de Eventos.