Comunicarse con edgeAgent mediante métodos directos integrados

Se aplica a: IoT Edge 1.5

Importante

IoT Edge 1.5 LTS es la versión compatible. IoT Edge 1.4 LTS finaliza su ciclo de vida el 12 de noviembre de 2024. Si está usando una versión anterior, consulte Actualización de IoT Edge.

Supervise y administre implementaciones de IoT Edge mediante los métodos directos en el módulo del agente de IoT Edge. Los métodos directos se implementan en el dispositivo y se pueden invocar desde la nube. El agente de IoT Edge incluye métodos directos para supervisar y administrar dispositivos IoT Edge de forma remota.

Para obtener más información acerca de los métodos directos, cómo usarlos y cómo implementarlos en sus propios módulos, consulte Descripción e invocación de los métodos directos de IoT Hub.

Los nombres de estos métodos directos no distinguen mayúsculas de minúsculas.

Señal

El método ping comprueba si IoT Edge se está ejecutando en un dispositivo o si el dispositivo tiene una conexión abierta a IoT Hub. Use este método para hacer ping al agente de IoT Edge y comprobar su estado. Un ping correcto devuelve una carga vacía y un "estado": 200.

Por ejemplo:

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

En Azure Portal, invoque el método mediante el nombre ping del método y una carga {}JSON vacía.

Reinicie el módulo

El método RestartModule permite administrar de forma remota módulos que se ejecutan en un dispositivo IoT Edge. Si un módulo notifica un estado erróneo o un comportamiento incorrecto, desencadene el agente de IoT Edge para reiniciarlo. Un comando de reinicio correcto devuelve una carga vacía con "status": 200.

El método RestartModule está disponible a partir de la versión 1.0.9 de IoT Edge.

Sugerencia

La página de solución de problemas de IoT Edge en Azure Portal simplifica el reinicio de los módulos. Para más información, consulte Supervisión y solución de problemas de dispositivos IoT Edge desde Azure Portal.

Use el método directo RestartModule en cualquier módulo que se ejecute en un dispositivo IoT Edge, incluido el módulo edgeAgent. Si usa este método directo para apagar edgeAgent, no recibirá un resultado correcto porque la conexión se interrumpe durante el reinicio del módulo.

Por ejemplo:

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>"
    }
'

En Azure Portal, use el nombre RestartModule del método con la siguiente carga JSON:

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

Métodos directos de diagnóstico

• GetModuleLogs: recupere los registros del módulo en la respuesta del método directo.
• UploadModuleLogs: recupere los registros del módulo y cargue en Azure Blob Storage.
• UploadSupportBundle: recupere los registros de módulo con un paquete de soporte técnico y cargue un archivo ZIP en Azure Blob Storage.
• GetTaskStatus: Compruebe el estado de una solicitud de registros de carga o de un paquete de soporte.

Estos métodos directos de diagnóstico están disponibles a partir de la versión 1.0.10.

Pasos siguientes

Propiedades de los módulos gemelos del agente de IoT Edge y del centro de IoT Edge