Comunicar-se com o edgeAgent usando métodos diretos internos

  • Artigo

Aplica-se a:Marca de seleção do IoT Edge 1.5 IoT Edge 1.5 marca de seleção do IoT Edge 1.4 IoT Edge 1.4

Importante

O IoT Edge 1.5 LTS e o IoT Edge 1.4 LTS são versões com suporte. O fim da vida útil do IoT Edge 1.4 LTS é 12 de novembro de 2024. Se você estiver em uma versão anterior, confira Atualizar o IoT Edge.

Monitore e gerencie implantações do IoT Edge usando os métodos diretos incluídos no módulo de agente do IoT Edge. Os métodos diretos são implementados no dispositivo e depois podem ser invocados na nuvem. O agente do IoT Edge inclui métodos diretos que ajudam você a monitorar e gerenciar seus dispositivos do IoT Edge remotamente.

Para obter mais informações sobre os métodos diretos, como usá-los e como implementá-los nos seus módulos, confira Entender e invocar métodos diretos do Hub IoT.

Os nomes desses métodos diretos são tratados sem diferenciação de maiúsculas e minúsculas.

Ping

O método ping é útil para verificar se o IoT Edge está em execução em um dispositivo ou se o dispositivo tem uma conexão aberta com o Hub IoT. Use esse método direto para executar ping no agente do IoT Edge e obter seu status. Um ping efetuado com sucesso retorna um conteúdo vazio e "status": 200.

Por exemplo:

az iot hub invoke-module-method --method-name 'ping' -n <hub name> -d <device name> -m '$edgeAgent'

No portal do Azure, invoque o método de nome ping e um conteúdo JSON vazio {}.

Captura de tela mostrando como invocar o ping do método direto no portal do Azure.

Reiniciar módulo

O método RestartModule permite o gerenciamento remoto de módulos em execução em um dispositivo do IoT Edge. Se um módulo estiver relatando um estado de falha ou outro comportamento não íntegro, você poderá disparar o agente do IoT Edge para reiniciá-lo. Um comando de reinicialização bem-sucedido retorna um conteúdo vazio e "status": 200.

O método RestartModule está disponível no IoT Edge versão 1.0.9 ou posterior.

Dica

A página de solução de problemas do IoT Edge no portal do Azure fornece uma experiência simplificada para reiniciar módulos. Para saber mais, consulte Monitorar e solucionar problemas de dispositivos IoT Edge no portal do Azure.

Você pode usar o método direto RestartModule em qualquer módulo em execução em um dispositivo do IoT Edge, incluindo o próprio módulo edgeAgent. No entanto, se você usar esse método direto para desligar o edgeAgent, você não receberá um resultado de sucesso, pois a conexão será interrompida enquanto o módulo for reiniciado.

Por exemplo:

az iot hub invoke-module-method --method-name 'RestartModule' -n <hub name> -d <device name> -m '$edgeAgent' --method-payload \
'
    {
        "schemaVersion": "1.0",
        "id": "<module name>"
    }
'

No portal do Azure, invoque o método de nome RestartModule e o seguinte conteúdo JSON:

{
    "schemaVersion": "1.0",
    "id": "<module name>"
}

Captura de tela mostrando como invocar o método direto RestartModule no portal do Azure.

Métodos diretos de diagnóstico

  • GetModuleLogs: recupera os logs de módulo embutidos na resposta do método direto.
  • UploadModuleLogs: recupera os logs de módulo e os carrega no Armazenamento de Blobs do Azure.
  • UploadSupportBundle: recupera os logs de módulo usando um pacote de suporte e carrega um arquivo zip no Armazenamento de Blobs do Azure.
  • GetTaskStatus: verifica o status de uma solicitação de logs de upload ou de pacote de suporte.

Esses métodos diretos de diagnóstico estão disponíveis desde a versão 1.0.10.

Próximas etapas

Propriedades do agente do IoT Edge e dos gêmeos de módulo do hub do IoT Edge