az iot central device-template

  • 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-template . Altre informazioni sulle estensioni.

Gestire e configurare i modelli di dispositivo IoT Central.

Comandi

Nome Descrizione Tipo Status
az iot central device-template create

Creare un modello di dispositivo in IoT Central.

 Estensione Disponibilità generale
az iot central device-template delete

Eliminare un modello di dispositivo da IoT Central.

 Estensione Disponibilità generale
az iot central device-template list

Ottenere l'elenco dei modelli di dispositivo per un'applicazione IoT Central.

 Estensione Disponibilità generale
az iot central device-template show

Ottenere un modello di dispositivo da IoT Central.

 Estensione Disponibilità generale
az iot central device-template update

Aggiornare un modello di dispositivo in IoT Central.

 Estensione Disponibilità generale

az iot central device-template create

Creare un modello di dispositivo in IoT Central.

az iot central device-template create --app-id
                                      --content
                                      --device-template-id
                                      [--api-version {2022-06-30-preview, 2022-07-31}]
                                      [--central-api-uri]
                                      [--token]

Esempio

Creare un modello di dispositivo con payload letto da un file

az iot central device-template create --app-id {appid} --content {pathtofile} --device-template-id {devicetemplateid}

Creare un modello di dispositivo con payload letto da json non elaborato

az iot central device-template create --app-id {appid} --content {json} --device-template-id {devicetemplateid}

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.

--content -k

Definizione del modello di dispositivo. Specificare il percorso del file JSON o del codice JSON non elaborato. [Esempio di percorso file: ./path/to/file.json] [Esempio di JSON stringato: {}]. Il corpo della richiesta deve contenere CapabilityModel.

--device-template-id --dtid

Identificatore del modello di gemello digitale del modello di dispositivo. Per ulteriori informazioni, vedi https://aka.ms/iotcentraldtmi.

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 device-template delete

Eliminare un modello di dispositivo da IoT Central.

Nota: si prevede che questo errore non venga eseguito se a questo modello sono ancora associati dispositivi.

az iot central device-template delete --app-id
                                      --device-template-id
                                      [--api-version {2022-06-30-preview, 2022-07-31}]
                                      [--central-api-uri]
                                      [--token]

Esempio

Eliminare un modello di dispositivo da IoT Central

az iot central device-template delete --app-id {appid} --device-template-id {devicetemplateid}

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-template-id --dtid

ID del modello di dispositivo di destinazione. Esempio: somedevicetemplate.

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 device-template list

Ottenere l'elenco dei modelli di dispositivo per un'applicazione IoT Central.

az iot central device-template list --app-id
                                    [--api-version {2022-06-30-preview, 2022-07-31}]
                                    [--central-api-uri]
                                    [--compact]
                                    [--token]

Esempio

Elencare tutti i modelli di dispositivo in un'applicazione, ordinati in base all'ID modello (impostazione predefinita)

az iot central device-template list --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
--compact -c

Mostra i modelli in modalità compatta. Per ogni modello verranno visualizzati solo id, nome e tipi di modello.

Valore predefinito: False
--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-template show

Ottenere un modello di dispositivo da IoT Central.

az iot central device-template show --app-id
                                    --device-template-id
                                    [--api-version {2022-06-30-preview, 2022-07-31}]
                                    [--central-api-uri]
                                    [--token]

Esempio

Ottenere un modello di dispositivo

az iot central device-template show --app-id {appid} --device-template-id {devicetemplateid}

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-template-id --dtid

ID del modello di dispositivo di destinazione. Esempio: somedevicetemplate.

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 device-template update

Aggiornare un modello di dispositivo in IoT Central.

az iot central device-template update --app-id
                                      --content
                                      --device-template-id
                                      [--api-version {2022-06-30-preview, 2022-07-31}]
                                      [--central-api-uri]
                                      [--token]

Esempio

Aggiornare un modello di dispositivo con payload letto da un file

az iot central device-template update --app-id {appid} --content {pathtofile} --device-template-id {devicetemplateid}

Aggiornare un modello di dispositivo con payload letto da json non elaborato

az iot central device-template update --app-id {appid} --content {json} --device-template-id {devicetemplateid}

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.

--content -k

Definizione del modello di dispositivo. Specificare il percorso del file JSON o del codice JSON non elaborato. [Esempio di percorso file: ./path/to/file.json] [Esempio di JSON stringato: {}]. Il corpo della richiesta deve contenere CapabilityModel.

--device-template-id --dtid

ID del modello di dispositivo di destinazione. Esempio: somedevicetemplate.

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.