Share via

Comunicar com o edgeAgent através da utilização de métodos diretos incorporados

  • Artigo

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

Importante

IoT Edge 1.5 LTS e IoT Edge 1.4 LTS são versões suportadas. O IoT Edge 1.4 LTS termina a vida útil em 12 de novembro de 2024. Se tiver uma versão anterior, consulte Atualizar IoT Edge.

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

Para obter mais informações sobre métodos diretos, como usá-los e como implementá-los em seus próprios módulos, consulte Compreender e invocar métodos diretos do Hub IoT.

Os nomes desses métodos diretos são manipulados sem distinção entre maiúsculas e minúsculas.

Ping

O método ping é útil para verificar se o IoT Edge está sendo executado 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 bem-sucedido retorna uma carga vazia 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 com o nome ping do método e uma carga {}JSON vazia.

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 executados em um dispositivo IoT Edge. Se um módulo estiver relatando um estado com falha ou outro comportamento não íntegro, você poderá acionar o agente do IoT Edge para reiniciá-lo. Um comando de reinicialização bem-sucedido retorna uma carga vazia e "status": 200.

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

Gorjeta

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 obter mais informações, 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 IoT Edge, incluindo o próprio módulo edgeAgent. No entanto, se você usar esse método direto para desligar o edgeAgent, não receberá um resultado bem-sucedido, pois a conexão é interrompida enquanto o módulo é 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 com o nome RestartModule do método e a seguinte carga 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: Recupere logs de módulo embutidos na resposta do método direto.
  • UploadModuleLogs: recupere logs de módulo e carregue-os no Armazenamento de Blobs do Azure.
  • UploadSupportBundle: recupere logs de módulo usando um pacote de suporte e carregue um arquivo zip no Armazenamento de Blobs do Azure.
  • GetTaskStatus: Verifique o status de um upload de logs ou solicitação de pacote de suporte.

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

Próximos passos

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