Kommunikation mit edgeAgent über integrierte direkte Methoden

Artikel
05/06/2024

Gilt für: IoT Edge 1.5 IoT Edge 1.4

Wichtig

IoT Edge 1.5 LTS und IoT Edge 1.4 LTS sind unterstützte Releases. Das Dienstende von IoT Edge 1.4 LTS wird am 12. November 2024 erreicht. Wenn Sie ein früheres Release verwenden, finden Sie weitere Informationen unter Aktualisieren von IoT Edge.

Überwachen und verwalten Sie IoT Edge-Bereitstellungen mithilfe der direkten Methoden, die im IoT Edge-Agentmodul enthalten sind. Direkte Methoden werden auf dem Gerät implementiert und können dann über die Cloud aufgerufen werden. Der IoT Edge-Agent umfasst direkte Methoden, mit denen Sie Ihre IoT Edge-Geräte remote überwachen und verwalten können.

Weitere Informationen zu direkten Methoden sowie zu ihrer Verwendung und Implementierung in Ihren eigenen Modulen finden Sie unter Verstehen und Aufrufen direkter Methoden von IoT Hub.

Bei den Namen dieser direkten Methoden wird die Groß-/Kleinschreibung nicht beachtet.

Ping

Mit der ping-Methode kann überprüft werden, ob IoT Edge auf einem Gerät ausgeführt wird oder ob das Gerät über eine offene Verbindung mit IoT Hub verfügt. Verwenden Sie diese direkte Methode, um den IoT Edge-Agent zu pingen und seinen Status abzurufen. Bei einem erfolgreichen Ping werden leere Nutzdaten und "status": 200 angezeigt.

Zum Beispiel:

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

Rufen Sie im Azure-Portal die Methode mit dem Namen ping und einer leeren JSON-Nutzlast {} auf.

Screenshot des Aufrufens der direkten Methode ping im Azure-Portal

Neustart des Moduls

Die Methode RestartModule ermöglicht die Remoteverwaltung von Modulen, die auf einem IoT Edge-Gerät ausgeführt werden. Wenn ein Modul einen fehlerhaften Zustand oder ein fehlerhaftes Verhalten meldet, können Sie den Neustart des Moduls durch den IoT Edge-Agent auslösen. Bei einem erfolgreichen Befehl für den Neustart werden leere Nutzdaten und "status": 200 angezeigt.

Die RestartModule-Methode ist in IoT Edge-Version 1.0.9 und höher verfügbar.

Tipp

Die IoT Edge-Problembehandlungsseite im Azure-Portal bietet eine vereinfachte Benutzeroberfläche zum neu starten von Modulen. Weitere Informationen finden Sie unter Überwachen und Beheben von Problemen bei IoT Edge-Geräten über das Azure-Portal.

Sie können die direkte Methode „RestartModule“ auf jedem Modul verwenden, das auf einem IoT Edge-Gerät ausgeführt wird. Dazu zählt auch das edgeAgent-Modul selbst. Wenn Sie diese direkte Methode jedoch zum Herunterfahren des edgeAgent-Moduls verwenden, wird kein erfolgreiches Ergebnis zurückgegeben. Der Grund dafür ist, dass die Verbindung beim Neustart des Moduls unterbrochen wird.

Zum Beispiel:

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

Rufen Sie im Azure-Portal die Methode mit dem Namen RestartModule und der folgenden JSON-Nutzlast auf:

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

Screenshot des Aufrufens der direkten Methode RestartModule im Azure-Portal

Direkte Diagnosemethoden

GetModuleLogs: Rufen Sie Modulprotokolle inline in der Antwort der direkten Methode ab.
UploadModuleLogs: Rufen Sie Modulprotokolle ab, und laden Sie sie in Azure Blob Storage hoch.
UploadSupportBundle: Rufen Sie Modulprotokolle mithilfe eines Supportbundles ab, und laden Sie eine ZIP-Datei in Azure Blob Storage hoch.
GetTaskStatus: Überprüfen Sie den Status einer Anforderung zum Hochladen von Protokollen oder einer Supportbundleanforderung.

Diese direkten Diagnosemethoden sind ab Version 1.0.10 verfügbar.

Nächste Schritte

Eigenschaften der Modulzwillinge von IoT Edge-Agent und IoT Edge-Hub

Teilen über