Kommunicera med edgeAgent med inbyggda direktmetoder

Gäller för: IoT Edge 1.5 IoT Edge 1.4

Viktigt!

IoT Edge 1.5 LTS och IoT Edge 1.4 LTS stöds. IoT Edge 1.4 LTS upphör den 12 november 2024. Om du har en tidigare version läser du Uppdatera IoT Edge.

Övervaka och hantera IoT Edge-distributioner med hjälp av de direkta metoder som ingår i IoT Edge-agentmodulen. Direktmetoder implementeras på enheten och kan sedan anropas från molnet. IoT Edge-agenten innehåller direkta metoder som hjälper dig att fjärrövervaka och hantera dina IoT Edge-enheter.

Mer information om direkta metoder, hur du använder dem och hur du implementerar dem i dina egna moduler finns i Förstå och anropa direktmetoder från IoT Hub.

Namnen på dessa direkta metoder hanteras skiftlägesokänsliga.

Ping

Ping-metoden är användbar för att kontrollera om IoT Edge körs på en enhet eller om enheten har en öppen anslutning till IoT Hub. Använd den här direktmetoden för att pinga IoT Edge-agenten och hämta dess status. En lyckad ping returnerar en tom nyttolast och "status": 200.

Till exempel:

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

I Azure-portalen anropar du metoden med metodnamnet ping och en tom JSON-nyttolast {}.

Starta om modulen

Metoden RestartModule möjliggör fjärrhantering av moduler som körs på en IoT Edge-enhet. Om en modul rapporterar ett feltillstånd eller något annat felfritt beteende kan du utlösa IoT Edge-agenten för att starta om den. Ett lyckat omstartskommando returnerar en tom nyttolast och "status": 200.

Metoden RestartModule är tillgänglig i IoT Edge version 1.0.9 och senare.

Dricks

IoT Edge-felsökningssidan i Azure-portalen ger en förenklad upplevelse för omstart av moduler. Mer information finns i Övervaka och felsöka IoT Edge-enheter från Azure-portalen.

Du kan använda direct-metoden RestartModule på valfri modul som körs på en IoT Edge-enhet, inklusive själva edgeAgent-modulen. Men om du använder den här direktmetoden för att stänga av edgeAgent får du inget lyckat resultat eftersom anslutningen avbryts när modulen startas om.

Till exempel:

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

I Azure-portalen anropar du metoden med metodnamnet RestartModule och följande JSON-nyttolast:

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

Diagnostikdirigeringsmetoder

• GetModuleLogs: Hämta modulloggar infogade i svaret från direktmetoden.
• UploadModuleLogs: Hämta modulloggar och ladda upp dem till Azure Blob Storage.
• UploadSupportBundle: Hämta modulloggar med hjälp av ett supportpaket och ladda upp en zip-fil till Azure Blob Storage.
• GetTaskStatus: Kontrollera statusen för en uppladdningslogg eller supportpaketbegäran.

Dessa diagnostikdirigeringsmetoder är tillgängliga från och med 1.0.10-versionen.

Nästa steg

Egenskaper för IoT Edge-agenten och IoT Edge-hubbmodultvillingar