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

S’applique à : IoT Edge 1.5

Surveillez et gérez les déploiements IoT Edge à l’aide des méthodes directes dans le module de l’agent IoT Edge. Les méthodes directes sont implémentées sur l’appareil et peuvent être appelées à partir du cloud. L’agent IoT Edge inclut des méthodes directes pour surveiller et gérer des 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 ne sont pas sensibles à la casse.

Ping

La méthode ping vérifie si IoT Edge s’exécute sur un appareil ou si l’appareil dispose d’une connexion ouverte à IoT Hub. Utilisez cette méthode pour effectuer un test ping sur l’agent IoT Edge et vérifier son état. Un test ping réussi retourne une charge utile vide et un « état » : 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 à l’aide du nom ping de la méthode et d’une charge utile {}JSON vide.

Redémarrer le module

La méthode RestartModule vous permet de gérer à distance les modules s’exécutant sur un appareil IoT Edge. Si un module signale un état d’échec ou un comportement défectueux, déclenchez l’agent IoT Edge pour le redémarrer. Une commande de redémarrage réussie retourne une charge utile vide avec « status » : 200.

La méthode RestartModule est disponible à partir d’IoT Edge version 1.0.9.

Utilisez la méthode directe RestartModule sur n’importe quel module s’exécutant sur un appareil IoT Edge, y compris le module edgeAgent. Si vous utilisez cette méthode directe pour arrêter edgeAgent, vous ne recevez pas de résultat de réussite, car la connexion est interrompue pendant le 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, utilisez le nom RestartModule de la méthode avec la charge utile JSON suivante :

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

Méthodes directes de diagnostic

• GetModuleLogs : Récupère les journaux des modules dans la réponse de la méthode directe.
• UploadModuleLogs : Récupère les journaux des modules et les charger dans le Stockage Blob Azure.
• UploadSupportBundle : Récupère les journaux de module avec un ensemble de support et charge un fichier zip dans le Stockage Blob Azure.
• GetTaskStatus : vérifiez l’état d’un fichier journal de chargement ou d’une demande 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