Communiquer avec edgeAgent à l’aide de méthodes directes intégrées

S’applique à : IoT Edge 1.5 IoT Edge 1.4

Important

IoT Edge 1.5 LTS et IoT Edge 1.4 LTS sont des versions prises en charge. IoT Edge 1.4 LTS sera en fin de vie le 12 novembre 2024. Si vous utilisez une version antérieure, consultez l’article Mettre à jour IoT Edge.

Surveillez et gérez les déploiements d’IoT Edge à l’aide des méthodes directes incluses dans le module de l’agent IoT Edge. Les méthodes directes sont implémentées sur l’appareil, puis peuvent être appelées à partir du cloud. L’agent IoT Edge comprend des méthodes directes qui vous aident à surveiller et gérer vos appareils IoT Edge à distance.

Pour plus d’informations sur les méthodes directes, leur utilisation et la façon de les implémenter dans vos propres modules, consultez Comprendre et appeler des méthodes directes à partir d’IoT Hub.

Les noms de ces méthodes directes sont gérés sans tenir compte de la casse.

Ping

La méthode ping est utile pour vérifier si IoT Edge s’exécute sur un appareil, ou si l’appareil dispose d’une connexion ouverte à IoT Hub. Utilisez cette méthode directe pour envoyer une requête ping à l'agent IoT Edge et obtenir son état. Un test ping réussi renvoie une charge utile vide et "status": 200.

Par exemple :

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

Dans le portail Azure, appelez la méthode avec le nom de la méthode ping et une charge utile JSON vide {}.

Redémarrer le module

La méthode RestartModule permet la gestion à distance des modules qui s’exécutent sur un appareil IoT Edge. Si un module signale un état d’échec ou un autre comportement anormal, vous pouvez déclencher l’agent IoT Edge pour le redémarrer. Une commande de redémarrage réussie renvoie une charge utile vide et "status": 200.

La méthode RestartModule est disponible dans IoT Edge version 1.0.9 et versions ultérieures.

Conseil

La page de résolution des problèmes d’IoT Edge dans le portail Azure fournit une expérience simplifiée pour le redémarrage des modules. Pour plus d’informations, consultez Surveillance et résolution des problèmes des appareils IoT Edge sur le Portail Azure.

Vous pouvez utiliser la méthode directe RestartModule sur n’importe quel module s’exécutant sur un appareil IoT Edge, y compris le module edgeAgent lui-même. Toutefois, si vous utilisez cette méthode directe pour arrêter edgeAgent, vous ne recevrez pas de résultat de réussite, car la connexion est interrompue lors du redémarrage du module.

Par exemple :

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

Dans le portail Azure, appelez la méthode avec le nom de la méthode RestartModule et la charge utile JSON suivante :

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

Méthodes directes de diagnostic

• GetModuleLogs : récupérez les journaux de module inline dans la réponse de la méthode directe.
• UploadModuleLogs : récupérez les journaux de module et chargez-les dans le Stockage Blob Azure.
• UploadSupportBundle : récupérez les journaux de module en utilisant un bundle de support et chargez un fichier zip dans le Stockage Blob Azure.
• GetTaskStatus : vérifiez l’état d’une demande de chargement de journaux ou de bundle de support.

Ces méthodes directes de diagnostic sont disponibles à partir de la version 1.0.10.

Étapes suivantes

Propriétés des jumeaux de module de l’agent IoT Edge et du hub IoT Edge