Communiceren met edgeAgent met behulp van ingebouwde directe methoden

Van toepassing op: IoT Edge 1.5 IoT Edge 1.4

Belangrijk

IoT Edge 1.5 LTS en IoT Edge 1.4 LTS worden ondersteund releases. IoT Edge 1.4 LTS eindigt op 12 november 2024. Raadpleeg IoT Edge bijwerken als u een eerdere versie hebt.

IoT Edge-implementaties bewaken en beheren met behulp van de directe methoden die zijn opgenomen in de IoT Edge-agentmodule. Directe methoden worden geïmplementeerd op het apparaat en kunnen vervolgens vanuit de cloud worden aangeroepen. De IoT Edge-agent bevat directe methoden waarmee u uw IoT Edge-apparaten op afstand kunt bewaken en beheren.

Zie Directe methoden begrijpen en aanroepen vanuit IoT Hub voor meer informatie over directe methoden, hoe u deze kunt gebruiken en hoe u deze implementeert in uw eigen modules.

De namen van deze directe methoden worden niet hoofdlettergevoelig verwerkt.

Ping

De pingmethode is handig om te controleren of IoT Edge wordt uitgevoerd op een apparaat of of het apparaat een open verbinding met IoT Hub heeft. Gebruik deze directe methode om de IoT Edge-agent te pingen en de status ervan op te halen. Een geslaagde ping retourneert een lege nettolading en 'status': 200.

Voorbeeld:

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

Roep in Azure Portal de methode aan met de methodenaam ping en een lege JSON-nettolading {}.

Module opnieuw opstarten

Met de methode RestartModule kunt u modules extern beheren die worden uitgevoerd op een IoT Edge-apparaat. Als een module een mislukte status of ander beschadigd gedrag rapporteert, kunt u de IoT Edge-agent activeren om deze opnieuw op te starten. Een geslaagde herstartopdracht retourneert een lege nettolading en 'status': 200.

De methode RestartModule is beschikbaar in IoT Edge versie 1.0.9 en hoger.

Tip

De pagina voor het oplossen van problemen met IoT Edge in Azure Portal biedt een vereenvoudigde ervaring voor het opnieuw opstarten van modules. Zie IoT Edge-apparaten bewaken en problemen oplossen vanuit Azure Portal voor meer informatie.

U kunt de directe methode RestartModule gebruiken voor elke module die wordt uitgevoerd op een IoT Edge-apparaat, inclusief de edgeAgent-module zelf. Als u deze directe methode echter gebruikt om edgeAgent af te sluiten, ontvangt u geen succesresultaat omdat de verbinding wordt onderbroken terwijl de module opnieuw wordt opgestart.

Voorbeeld:

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

Roep in Azure Portal de methode aan met de methodenaam RestartModule en de volgende JSON-nettolading:

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

Directe diagnostische methoden

• GetModuleLogs: Modulelogboeken inline ophalen in het antwoord van de directe methode.
• UploadModuleLogs: modulelogboeken ophalen en uploaden naar Azure Blob Storage.
• UploadSupportBundle: modulelogboeken ophalen met behulp van een ondersteuningsbundel en een zip-bestand uploaden naar Azure Blob Storage.
• GetTaskStatus: Controleer de status van een uploadlogboeken of ondersteuningsbundelaanvraag.

Deze directe diagnostische methoden zijn beschikbaar vanaf de release 1.0.10.

Volgende stappen

Eigenschappen van de IoT Edge-agent en ioT Edge-hubmoduledubbels