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

Aplica-se a: IoT Edge 1.5

Monitore e gerencie implantações do IoT Edge usando os métodos diretos no módulo do agente do IoT Edge. Os métodos diretos são implementados no dispositivo e podem ser invocados a partir da nuvem. O agente IoT Edge inclui métodos diretos para monitorar e gerenciar 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 não diferenciam maiúsculas de minúsculas.

Ping

O método ping verifica 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 para executar ping no agente do IoT Edge e verificar seu status. Um ping bem-sucedido retorna uma carga vazia e um "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 usando o nome ping do método e uma carga {}JSON vazia.

Reiniciar módulo

O método RestartModule permite gerenciar remotamente módulos em execução em um dispositivo IoT Edge. Se um módulo relatar um estado com falha ou um comportamento não íntegro, acione o agente do IoT Edge para reiniciá-lo. Um comando de reinicialização bem-sucedido retorna uma carga vazia com "status": 200.

O método RestartModule está disponível a partir do IoT Edge versão 1.0.9.

Use o método direto RestartModule em qualquer módulo em execução em um dispositivo IoT Edge, incluindo o módulo edgeAgent. Se você usar esse método direto para desligar o edgeAgent, não receberá um resultado de sucesso porque a conexão é interrompida durante a reinicialização do módulo.

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, use o nome do método RestartModule com a seguinte carga JSON:

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

Métodos diretos de diagnóstico

• GetModuleLogs: Recuperar os logs do módulo na resposta do método direto.
• UploadModuleLogs: obtenha logs de módulo e carregue-os no Armazenamento de Blobs do Azure.
• UploadSupportBundle: recupere registos do módulo com um pacote de suporte e carregue um ficheiro zip para o 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