Comunicare con edgeAgent usando i metodi diretti predefiniti

Articolo
07/17/2024

Si applica a: IoT Edge 1.5 IoT Edge 1.4

Importante

IoT Edge 1.5 LTS e IoT Edge 1.4 LTS sono versioni supportate. IoT Edge 1.4 LTS raggiungerà la fine del servizio il 12 novembre 2024. Se si usa una versione precedente, vedere Aggiornare IoT Edge.

Monitorare e gestire le distribuzioni di IoT Edge usando i metodi diretti inclusi nel modulo agente IoT Edge. I metodi diretti vengono implementati nel dispositivo e quindi possono essere richiamati dal cloud. L'agente IoT Edge include metodi diretti che consentono di monitorare e gestire i dispositivi IoT Edge da remoto.

Per altre informazioni sui metodi diretti, su come usarli e su come implementarli nei propri moduli, vedere Comprendere e richiamare metodi diretti dall'hub IoT.

I nomi di questi metodi diretti vengono gestiti senza distinzione tra maiuscole e minuscole.

Ping

Il metodo ping è utile per verificare se IoT Edge è in esecuzione in un dispositivo o se il dispositivo ha una connessione aperta all'hub IoT. Usare questo metodo diretto per effettuare il ping dell'agente IoT Edge e ottenerne lo stato. Un ping con esito positivo restituisce un payload vuoto e "status": 200.

Ad esempio:

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

Nel portale di Azure richiamare il metodo con il nome del metodo ping e un payload JSON vuoto {}.

Screenshot che mostra come richiamare il metodo diretto ping nel portale di Azure.

Riavviare il modulo

Il metodo RestartModule consente la gestione remota dei moduli in esecuzione in un dispositivo IoT Edge. Se un modulo segnala uno stato di errore o un altro comportamento non integro, è possibile attivare l'agente IoT Edge per riavviarlo. Un comando di riavvio riuscito restituisce un payload vuoto e "status": 200.

Il metodo RestartModule è disponibile in IoT Edge versione 1.0.9 e successive.

Suggerimento

La pagina di risoluzione dei problemi di IoT Edge nel portale di Azure offre un'esperienza semplificata per il riavvio dei moduli. Per altre informazioni, vedere Monitorare e risolvere i problemi dei dispositivi IoT Edge dal portale di Azure.

È possibile usare il metodo diretto RestartModule in qualsiasi modulo in esecuzione in un dispositivo IoT Edge, incluso il modulo edgeAgent stesso. Tuttavia, se si usa questo metodo diretto per arrestare edgeAgent, non si riceverà un risultato positivo perché la connessione viene interrotta durante il riavvio del modulo.

Ad esempio:

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

Nel portale di Azure richiamare il metodo con il nome del metodo RestartModule e il payload JSON seguente:

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

Screenshot che mostra come richiamare il metodo diretto RestartModule nel portale di Azure.

Metodi diretti di diagnostica

GetModuleLogs: consente di recuperare i log del modulo inline nella risposta del metodo diretto.
UploadModuleLogs: consente di recuperare i log dei moduli e caricarli in Archiviazione BLOB di Azure.
UploadSupportBundle: consente di recuperare i log dei moduli usando un bundle di supporto e caricare un file ZIP in Archiviazione BLOB di Azure.
GetTaskStatus: consente di controllare lo stato di una richiesta di caricamento dei log o del bundle di supporto.

Questi metodi diretti di diagnostica sono disponibili a partire dalla versione 1.0.10.

Passaggi successivi

Proprietà dei moduli gemelli "agente di IoT Edge" e "hub di IoT Edge"

Condividi tramite