Condividi tramite

az iot central device command

  • Riferimento

Nota

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

Eseguire i comandi del dispositivo.

Comandi

Nome Descrizione Tipo Status
az iot central device command history

Ottenere i dettagli per la richiesta di comando e la risposta più recenti inviate al dispositivo.

 Estensione Disponibilità generale
az iot central device command run

Eseguire un comando in un dispositivo e visualizzare la risposta associata. Non monitora gli aggiornamenti delle proprietà che il comando può eseguire.

 Estensione Disponibilità generale

az iot central device command history

Ottenere i dettagli per la richiesta di comando e la risposta più recenti inviate al dispositivo.

Elenca la richiesta di comando e la risposta più recenti inviate al dispositivo da IoT Central. Qualsiasi aggiornamento eseguito dal dispositivo alle proprietà del dispositivo in seguito all'esecuzione del comando non viene incluso nella risposta.

az iot central device command history --app-id
                                      --cn
                                      --device-id
                                      [--api-version {2022-06-30-preview, 2022-07-31}]
                                      [--central-api-uri]
                                      [--co]
                                      [--interface-id]
                                      [--mn]
                                      [--token]

Esempio

Mostra risposta del comando

az iot central device command history --app-id {appid} --device-id {deviceid} --interface-id {interfaceid} --command-name {commandname}

Mostra risposta al comando del componente

az iot central device command history --app-id {appid} --device-id {deviceid} --component-name {componentname} --command-name {commandname}

Mostra risposta al comando del componente del modulo

az iot central device command history --app-id {appid} --device-id {deviceid} --module-name {modulename} --component-name {componentname} --command-name {commandname}

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.

--cn --command-name

Nome del comando specificato nel modello di dispositivo. Il nome del comando può essere diverso dal nome visualizzato del comando.

--device-id -d

ID dispositivo del dispositivo di destinazione. Per trovare l'ID dispositivo, fare clic sul pulsante Connetti nella pagina Dettagli dispositivo.

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
--co --component-name

Nome del componente del dispositivo.

--interface-id -i

Nome dell'interfaccia/componente come specificato nel modello di dispositivo. È possibile trovarla passando a Modello di dispositivo e visualizzare l'identità dell'interfaccia/componente nella funzionalità del dispositivo corrispondente.

--mn --module-name

Nome del modulo del dispositivo.

--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 device command run

Eseguire un comando in un dispositivo e visualizzare la risposta associata. Non monitora gli aggiornamenti delle proprietà che il comando può eseguire.

--content può essere inline json o percorso di file.

az iot central device command run --app-id
                                  --cn
                                  --content
                                  --device-id
                                  [--api-version {2022-06-30-preview, 2022-07-31}]
                                  [--central-api-uri]
                                  [--co]
                                  [--interface-id]
                                  [--mn]
                                  [--token]

Esempio

Eseguire il comando con payload inline. Il payload deve essere in "request" nella stringa json

az iot central device command run --app-id {appid} --device-id {deviceid} --interface-id {interfaceid} --command-name {commandname} --content '{"request": {payload}}'

Comando a breve esecuzione con il percorso del payload JSON.

az iot central device command run -n {appid} -d {deviceid} -i {interfaceid} --cn {commandname} -k {payload_file_path}

Eseguire il comando componente.

az iot central device command run -n {appid} -d {deviceid} --co {componentname} --cn {commandname} -k {payload}

Eseguire il comando componente del modulo.

az iot central device command run -n {appid} -d {deviceid} --mn {modulename} --co {componentname} --cn {commandname} -k {payload}

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.

--cn --command-name

Nome del comando specificato nel modello di dispositivo. Il nome del comando può essere diverso dal nome visualizzato del comando.

--content -k

Configurazione per la richiesta. Specificare il percorso del file JSON o del codice JSON non elaborato. [Esempio di percorso file: ./path/to/file.json] [Esempio JSON stringato: {'a': 'b'}].

--device-id -d

ID dispositivo del dispositivo di destinazione. Per trovare l'ID dispositivo, fare clic sul pulsante Connetti nella pagina Dettagli dispositivo.

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
--co --component-name

Nome del componente del dispositivo.

--interface-id -i

Nome dell'interfaccia/componente come specificato nel modello di dispositivo. È possibile trovarla passando a Modello di dispositivo e visualizzare l'identità dell'interfaccia/componente nella funzionalità del dispositivo corrispondente.

--mn --module-name

Nome del modulo del dispositivo.

--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.