Share via

az iot central diagnostics

  • Anteprima
  • Riferimento

Nota

Questo riferimento fa parte dell'estensione azure-iot per l'interfaccia della riga di comando di Azure (versione 2.37.0 o successiva). L'estensione installerà automaticamente la prima volta che si esegue un comando az iot central diagnostics . Altre informazioni sulle estensioni.

Questo gruppo di comandi è in anteprima e in fase di sviluppo. Livelli di riferimento e supporto: https://aka.ms/CLI_refstatus

Eseguire la diagnostica a livello di applicazione e dispositivo.

Comandi

Nome Descrizione Tipo Stato
az iot central diagnostics monitor-events

Visualizzare i messaggi di telemetria dei dispositivi inviati all'app IoT Central.

 Estensione Anteprima
az iot central diagnostics monitor-properties

Visualizzare le proprietà desiderate e segnalate inviate all'app IoT Central.

 Estensione Anteprima
az iot central diagnostics registration-summary

Visualizzare il riepilogo della registrazione di tutti i dispositivi in un'app.

 Estensione Anteprima
az iot central diagnostics validate-messages

Convalidare i messaggi inviati al hub IoT per un'app IoT Central.

 Estensione Anteprima
az iot central diagnostics validate-properties

Convalidare le proprietà segnalate inviate all'applicazione IoT Central.

 Estensione Anteprima

az iot central diagnostics monitor-events

Anteprima

Il gruppo di comandi 'iot central diagnostics' è in anteprima e in fase di sviluppo. Livelli di riferimento e supporto: https://aka.ms/CLI_refstatus

Visualizzare i messaggi di telemetria dei dispositivi inviati all'app IoT Central.

Mostra i dati di telemetria inviati all'applicazione IoT Central. Per impostazione predefinita, mostra tutti i dati inviati da tutti i dispositivi. Usare il parametro --device-id per filtrare in base a un dispositivo specifico.

az iot central diagnostics monitor-events --app-id
                                          [--central-api-uri]
                                          [--cg]
                                          [--device-id]
                                          [--enqueued-time]
                                          [--module-id]
                                          [--properties {all, anno, app, sys}]
                                          [--repair {false, true}]
                                          [--timeout]
                                          [--token]
                                          [--yes {false, true}]

Esempio

Utilizzo di base

az iot central diagnostics monitor-events --app-id {app_id}

Utilizzo di base durante il filtro sul dispositivo di destinazione

az iot central diagnostics monitor-events --app-id {app_id} -d {device_id}

Utilizzo di base quando si filtrano i dispositivi di destinazione con un carattere jolly nell'ID

az iot central diagnostics monitor-events --app-id {app_id} -d Device*d

Utilizzo di base quando si filtra il modulo.

az iot central diagnostics monitor-events --app-id {app_id} -m {module_id}

Utilizzo di base quando si filtrano i moduli di destinazione con un carattere jolly nell'ID

az iot central diagnostics monitor-events --app-id {app_id} -m Module*

Filtrare il dispositivo e specificare un gruppo di consumer dell'hub eventi a cui eseguire l'associazione.

az iot central diagnostics monitor-events --app-id {app_id} -d {device_id} --cg {consumer_group_name}

Ricevere annotazioni di messaggio (intestazioni di messaggio)

az iot central diagnostics monitor-events --app-id {app_id} -d {device_id} --properties anno

Ricevere annotazioni di messaggio e proprietà di sistema. Mai timeout.

az iot central diagnostics monitor-events --app-id {app_id} -d {device_id} --properties anno sys --timeout 0

Ricevere tutti gli attributi dei messaggi da tutti i messaggi del dispositivo

az iot central diagnostics monitor-events --app-id {app_id} --props all

Ricevere tutti i messaggi e analizzare il payload del messaggio come JSON

az iot central diagnostics monitor-events --app-id {app_id} --output json

Parametri necessari

--app-id -n

ID app dell'app IoT Central che si vuole gestire. È possibile trovare l'ID app nella pagina "Informazioni" per l'applicazione nel menu della Guida.

Parametri facoltativi

--central-api-uri --central-dns-suffix

Suffisso DNS di IoT Central associato all'applicazione.

valore predefinito: azureiotcentral.com
--cg --consumer-group -c

Specificare il gruppo di consumer da usare per la connessione all'endpoint dell'hub eventi.

valore predefinito: $Default
--device-id -d

ID dispositivo del dispositivo di destinazione. È possibile trovare l'ID dispositivo facendo clic sul pulsante Connessione nella pagina Dettagli dispositivo.

--enqueued-time --et -e

Indica l'ora che deve essere utilizzata come punto di partenza per leggere i messaggi dalle partizioni. Le unità sono millisecondi dall'epoca unix. Se non viene indicato "ora" viene usato .

--module-id -m

ID modulo IoT Edge se il tipo di dispositivo è IoT Edge.

--properties --props -p

Indicare le proprietà del messaggio chiave per l'output. sys = proprietà di sistema, app = proprietà dell'applicazione, anno = annotazioni.

valori accettati: all, anno, app, sys
--repair -r

Reinstallare la dipendenza uamqp compatibile con la versione dell'estensione. Valore predefinito: false.

valori accettati: false, true
valore predefinito: False
--timeout --to -t

Numero massimo di secondi per mantenere la connessione senza ricevere messaggi. Usare 0 per infinito.

valore predefinito: 300
--token

Se si preferisce inviare la richiesta senza eseguire l'autenticazione nell'interfaccia della riga di comando di Azure, è possibile specificare un token utente valido per autenticare la richiesta. È necessario specificare il tipo di chiave come parte della richiesta. Per ulteriori informazioni, vedi https://aka.ms/iotcentraldocsapi.

--yes -y

Ignorare le richieste dell'utente. Indica l'accettazione dell'azione. Usato principalmente per gli scenari di automazione. Valore predefinito: false.

valori accettati: false, true
valore predefinito: False
Parametri globali
--debug

Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.

--help -h

Visualizza questo messaggio della guida ed esce.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

--output -o

Formato di output.

valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
valore predefinito: json
--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

--verbose

Aumenta il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

az iot central diagnostics monitor-properties

Anteprima

Il gruppo di comandi 'iot central diagnostics' è in anteprima e in fase di sviluppo. Livelli di riferimento e supporto: https://aka.ms/CLI_refstatus

Visualizzare le proprietà desiderate e segnalate inviate all'app IoT Central.

Esegue il polling del dispositivo gemello dal dispositivo centrale e lo confronta con l'ultimo dispositivo gemello Analizza le proprietà dal dispositivo gemello e rileva se sono state apportate modifiche il subset di proprietà modificate nell'intervallo di polling.

az iot central diagnostics monitor-properties --app-id
                                              --device-id
                                              [--central-api-uri]
                                              [--token]

Esempio

Utilizzo di base

az iot central diagnostics monitor-properties --app-id {app_id} -d {device_id}

Parametri necessari

--app-id -n

ID app dell'app IoT Central che si vuole gestire. È possibile trovare l'ID app nella pagina "Informazioni" per l'applicazione nel menu della Guida.

--device-id -d

ID dispositivo del dispositivo di destinazione. È possibile trovare l'ID dispositivo facendo clic sul pulsante Connessione nella pagina Dettagli dispositivo.

Parametri facoltativi

--central-api-uri --central-dns-suffix

Suffisso DNS di IoT Central associato all'applicazione.

valore predefinito: azureiotcentral.com
--token

Se si preferisce inviare la richiesta senza eseguire l'autenticazione nell'interfaccia della riga di comando di Azure, è possibile specificare un token utente valido per autenticare la richiesta. È necessario specificare il tipo di chiave come parte della richiesta. Per ulteriori informazioni, vedi https://aka.ms/iotcentraldocsapi.

Parametri globali
--debug

Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.

--help -h

Visualizza questo messaggio della guida ed esce.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

--output -o

Formato di output.

valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
valore predefinito: json
--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

--verbose

Aumenta il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

az iot central diagnostics registration-summary

Anteprima

Il gruppo di comandi 'iot central diagnostics' è in anteprima e in fase di sviluppo. Livelli di riferimento e supporto: https://aka.ms/CLI_refstatus

Visualizzare il riepilogo della registrazione di tutti i dispositivi in un'app.

Nota: questo comando può richiedere una quantità significativa di tempo per restituire se l'app contiene molti dispositivi.

az iot central diagnostics registration-summary --app-id
                                                [--api-version {2022-06-30-preview, 2022-07-31}]
                                                [--central-api-uri]
                                                [--token]

Esempio

Riepilogo della registrazione

az iot central diagnostics registration-summary --app-id {appid}

Parametri necessari

--app-id -n

ID app dell'app IoT Central che si vuole gestire. È possibile trovare l'ID app nella pagina "Informazioni" per l'applicazione nel menu della Guida.

Parametri facoltativi

--api-version --av
Deprecato

L'argomento 'api_version' è stato deprecato e verrà rimosso in una versione futura.

Questo parametro di comando è stato deprecato e verrà ignorato. Nella versione futura verranno supportate solo le API IoT Central dalla versione disponibile a livello generale più recente. Se un'API non è ancora disponibile a livello generale, verrà chiamata la versione di anteprima più recente.

valori accettati: 2022-06-30-preview, 2022-07-31
valore predefinito: 2022-07-31
--central-api-uri --central-dns-suffix

Suffisso DNS di IoT Central associato all'applicazione.

valore predefinito: azureiotcentral.com
--token

Se si preferisce inviare la richiesta senza eseguire l'autenticazione nell'interfaccia della riga di comando di Azure, è possibile specificare un token utente valido per autenticare la richiesta. È necessario specificare il tipo di chiave come parte della richiesta. Per ulteriori informazioni, vedi https://aka.ms/iotcentraldocsapi.

Parametri globali
--debug

Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.

--help -h

Visualizza questo messaggio della guida ed esce.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

--output -o

Formato di output.

valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
valore predefinito: json
--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

--verbose

Aumenta il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

az iot central diagnostics validate-messages

Anteprima

Il gruppo di comandi 'iot central diagnostics' è in anteprima e in fase di sviluppo. Livelli di riferimento e supporto: https://aka.ms/CLI_refstatus

Convalidare i messaggi inviati al hub IoT per un'app IoT Central.

Esegue convalide sui messaggi di telemetria e segnala i dati non modellati nel modello di dispositivo o nei dati in cui il tipo di dati non corrisponde a quello definito nel modello di dispositivo.

az iot central diagnostics validate-messages --app-id
                                             [--central-api-uri]
                                             [--cg]
                                             [--device-id]
                                             [--dr]
                                             [--enqueued-time]
                                             [--max-messages]
                                             [--minimum-severity {error, info, warning}]
                                             [--module-id]
                                             [--properties {all, anno, app, sys}]
                                             [--repair {false, true}]
                                             [--style {csv, json, scroll}]
                                             [--timeout]
                                             [--token]
                                             [--yes {false, true}]

Esempio

Utilizzo di base

az iot central diagnostics validate-messages --app-id {app_id}

Errori di output rilevati

az iot central diagnostics validate-messages --app-id {app_id} --style scroll

Utilizzo di base durante il filtro sul dispositivo di destinazione

az iot central diagnostics validate-messages --app-id {app_id} -d {device_id}

Utilizzo di base quando si filtrano i dispositivi di destinazione con un carattere jolly nell'ID

az iot central diagnostics validate-messages --app-id {app_id} -d Device*

Utilizzo di base quando si filtra il modulo.

az iot central diagnostics validate-messages --app-id {app_id} -m {module_id}

Utilizzo di base quando si filtrano i moduli di destinazione con un carattere jolly nell'ID

az iot central diagnostics validate-messages --app-id {app_id} -m Module*

Filtrare il dispositivo e specificare un gruppo di consumer dell'hub eventi a cui eseguire l'associazione.

az iot central diagnostics validate-messages --app-id {app_id} -d {device_id} --cg {consumer_group_name}

Parametri necessari

--app-id -n

ID app dell'app IoT Central che si vuole gestire. È possibile trovare l'ID app nella pagina "Informazioni" per l'applicazione nel menu della Guida.

Parametri facoltativi

--central-api-uri --central-dns-suffix

Suffisso DNS di IoT Central associato all'applicazione.

valore predefinito: azureiotcentral.com
--cg --consumer-group -c

Specificare il gruppo di consumer da usare per la connessione all'endpoint dell'hub eventi.

valore predefinito: $Default
--device-id -d

ID dispositivo del dispositivo di destinazione. È possibile trovare l'ID dispositivo facendo clic sul pulsante Connessione nella pagina Dettagli dispositivo.

--dr --duration

Durata massima per la ricezione di messaggi dal dispositivo di destinazione prima di terminare la connessione. Usare 0 per infinito.

valore predefinito: 300
--enqueued-time --et -e

Indica l'ora che deve essere utilizzata come punto di partenza per leggere i messaggi dalle partizioni. Le unità sono millisecondi dall'epoca unix. Se non viene indicato "ora" viene usato .

--max-messages --mm

Numero massimo di messaggi da ricevere dal dispositivo di destinazione prima di terminare la connessione. Usare 0 per infinito.

valore predefinito: 10
--minimum-severity

Gravità minima del problema necessario per la creazione di report.

valori accettati: error, info, warning
valore predefinito: warning
--module-id -m

ID modulo IoT Edge se il tipo di dispositivo è IoT Edge.

--properties --props -p

Indicare le proprietà del messaggio chiave per l'output. sys = proprietà di sistema, app = proprietà dell'applicazione, anno = annotazioni.

valori accettati: all, anno, app, sys
--repair -r

Reinstallare la dipendenza uamqp compatibile con la versione dell'estensione. Valore predefinito: false.

valori accettati: false, true
valore predefinito: False
--style

Indicare gli stili di outputcroll = recapitare gli errori man mano che arrivano, json = riepilogare i risultati come json, csv = riepilogare i risultati come csv.

valori accettati: csv, json, scroll
valore predefinito: scroll
--timeout --to -t

Numero massimo di secondi per mantenere la connessione senza ricevere messaggi. Usare 0 per infinito.

valore predefinito: 300
--token

Se si preferisce inviare la richiesta senza eseguire l'autenticazione nell'interfaccia della riga di comando di Azure, è possibile specificare un token utente valido per autenticare la richiesta. È necessario specificare il tipo di chiave come parte della richiesta. Per ulteriori informazioni, vedi https://aka.ms/iotcentraldocsapi.

--yes -y

Ignorare le richieste dell'utente. Indica l'accettazione dell'azione. Usato principalmente per gli scenari di automazione. Valore predefinito: false.

valori accettati: false, true
valore predefinito: False
Parametri globali
--debug

Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.

--help -h

Visualizza questo messaggio della guida ed esce.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

--output -o

Formato di output.

valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
valore predefinito: json
--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

--verbose

Aumenta il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

az iot central diagnostics validate-properties

Anteprima

Il gruppo di comandi 'iot central diagnostics' è in anteprima e in fase di sviluppo. Livelli di riferimento e supporto: https://aka.ms/CLI_refstatus

Convalidare le proprietà segnalate inviate all'applicazione IoT Central.

Esegue le convalide sugli aggiornamenti delle proprietà segnalate:

  1. Avviso: proprietà inviate dal dispositivo non modellate in central.
  2. Avviso: le proprietà con lo stesso nome dichiarato in più interfacce devono includere il nome dell'interfaccia nell'ambito dell'aggiornamento della proprietà.
az iot central diagnostics validate-properties --app-id
                                               --device-id
                                               [--central-api-uri]
                                               [--minimum-severity {error, info, warning}]
                                               [--token]

Esempio

Utilizzo di base

az iot central diagnostics validate-properties --app-id {app_id} -d {device_id}

Parametri necessari

--app-id -n

ID app dell'app IoT Central che si vuole gestire. È possibile trovare l'ID app nella pagina "Informazioni" per l'applicazione nel menu della Guida.

--device-id -d

ID dispositivo del dispositivo di destinazione. È possibile trovare l'ID dispositivo facendo clic sul pulsante Connessione nella pagina Dettagli dispositivo.

Parametri facoltativi

--central-api-uri --central-dns-suffix

Suffisso DNS di IoT Central associato all'applicazione.

valore predefinito: azureiotcentral.com
--minimum-severity

Gravità minima del problema necessario per la creazione di report.

valori accettati: error, info, warning
valore predefinito: warning
--token

Se si preferisce inviare la richiesta senza eseguire l'autenticazione nell'interfaccia della riga di comando di Azure, è possibile specificare un token utente valido per autenticare la richiesta. È necessario specificare il tipo di chiave come parte della richiesta. Per ulteriori informazioni, vedi https://aka.ms/iotcentraldocsapi.

Parametri globali
--debug

Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.

--help -h

Visualizza questo messaggio della guida ed esce.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

--output -o

Formato di output.

valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
valore predefinito: json
--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

--verbose

Aumenta il livello di dettaglio della registrazione. Usare --debug per log di debug completi.