Comunicarse con edgeAgent mediante métodos directos integrados

Se aplica a: IoT Edge 1.5 IoT Edge 1.4

Importante

IoT Edge 1.5 LTS e IoT Edge 1.4 LTS son versiones compatibles. IoT Edge 1.4 LTS finaliza el 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 las implementaciones de IoT Edge con los métodos directos incluidos en el módulo IoT Edge Agent. Los métodos directos se implementan en el dispositivo y, a continuación, se pueden invocar desde la nube. El agente de IoT Edge incluye métodos directos que le ayudan a supervisar y administrar los 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.

Ping

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

Por ejemplo:

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

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

Reinicie el módulo

El método RestartModule permite la administración remota de los módulos que se ejecutan en un dispositivo IoT Edge. Si un módulo informa un estado de error u otro comportamiento incorrecto, puede desencadenar el agente de IoT Edge para reiniciarlo. Un comando de reinicio correcto devuelve una carga vacía y "status": 200.

El método RestartModule está disponible en IoT Edge versión 1.0.9 y versiones posteriores.

Sugerencia

La página de solución de problemas de IoT Edge en Azure Portal proporciona una experiencia simplificada para reiniciar los módulos. Para más información, consulte Supervisión y solución de problemas de dispositivos IoT Edge desde Azure Portal.

Puede usar el método directo RestartModule en cualquier módulo que se ejecute en un dispositivo IoT Edge, incluido el propio módulo edgeAgent. Sin embargo, si usa este método directo para cerrar el edgeAgent, no recibirá un resultado correcto, ya que la conexión se interrumpe mientras se reinicia el 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 el Azure Portal, invoque el método con el nombre de método RestartModule y la siguiente carga útil de JSON:

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

Métodos directos de diagnóstico

• GetModuleLogs: Recupere los registros de módulo insertados en la respuesta del método directo.
• UploadModuleLogs: Recupere los registros de módulo y cárguelos en Azure Blob Storage.
• UploadSupportBundle: Recupere los registros de módulo mediante un paquete de soporte y cargue un archivo zip en Azure Blob Storage.
• GetTaskStatus: Compruebe el estado de una solicitud de registros de carga o 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