az iot hub state

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 hub state . Altre informazioni sulle estensioni.

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

Gestire lo stato di un hub IoT.

Per altre informazioni, vedere aka.ms/aziotcli-iot-hub-state.

Comandi

Nome	Descrizione	Tipo	Stato
az iot hub state export	Esportare lo stato di un hub IoT in un file.	Estensione	Sperimentale
az iot hub state import	Importare uno stato hub da un file in un hub IoT.	Estensione	Sperimentale
az iot hub state migrate	Eseguire la migrazione dello stato di un hub a un altro hub senza salvare in un file.	Estensione	Sperimentale

az iot hub state export

Sperimentale

Il gruppo di comandi 'iot hub state' è sperimentale e in fase di sviluppo. Livelli di riferimento e supporto: https://aka.ms/CLI_refstatus

Esportare lo stato di un hub IoT in un file.

Per impostazione predefinita, lo stato esportato includerà: modello arm per l'hub, configurazioni dell'hub (incluse configurazioni ADM e distribuzioni perimetrali), informazioni sul dispositivo (inclusi identiti dei dispositivi, dispositivi gemelli, identità del modulo e moduli gemelli).

Per altre informazioni, vedere aka.ms/aziotcli-iot-hub-state.

az iot hub state export --state-file
                        [--aspects {arm, configurations, devices}]
                        [--auth-type {key, login}]
                        [--hub-name]
                        [--login]
                        [--replace]
                        [--resource-group]

Esempio

Esportare lo stato supportato dell'hub specificato nel file specificato.

az iot hub state export -n {iothub_name} -f {state_filename}

Esportare lo stato supportato dell'hub specificato nel file specificato, sovrascrivendo il contenuto del file.

az iot hub state export -n {iothub_name} -f {state_filename} -r

Esportare solo i dispositivi e le configurazioni dell'hub specificato nel file specificato.

az iot hub state export -n {iothub_name} -f {state_filename} --aspects devices configurations

Parametri necessari

--state-file -f

Percorso del file in cui verranno archiviate le informazioni sullo stato.

Parametri facoltativi

--aspects

Aspetti dell'hub (separati da spazi).

valori accettati: arm, configurations, devices

--auth-type

Indica se l'operazione deve derivare automaticamente una chiave di criteri o usare la sessione di Azure AD corrente. Se il tipo di autenticazione è login e viene specificato il nome host della risorsa, la ricerca della risorsa verrà ignorata a meno che non sia necessario. È possibile configurare l'impostazione predefinita usando az configure --defaults iothub-data-auth-type=<auth-type-value>.

valori accettati: key, login

valore predefinito: key

--hub-name -n

hub IoT nome o nome host. Obbligatorio se non viene specificato --login.

--login -l

Questo comando supporta un'entità stringa di connessione con diritti per eseguire l'azione. Usare per evitare l'accesso di sessione tramite "az login". Se vengono forniti sia un stringa di connessione di entità che un nome, il stringa di connessione ha priorità. Obbligatorio se --hub-name non è specificato.

--replace -r

Se questo flag è impostato, il comando sovrascriverà il contenuto del file di output.

valore predefinito: False

--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.

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 hub state import

Sperimentale

Il gruppo di comandi 'iot hub state' è sperimentale e in fase di sviluppo. Livelli di riferimento e supporto: https://aka.ms/CLI_refstatus

Importare uno stato hub da un file in un hub IoT.

Se viene specificato l'aspetto del braccio, l'hub verrà creato se non esiste.

Per impostazione predefinita, lo stato importato includerà: modello arm per l'hub, configurazioni dell'hub (incluse configurazioni ADM e distribuzioni perimetrali), informazioni sul dispositivo (inclusi identiti dei dispositivi, dispositivi gemelli, identità del modulo e moduli gemelli).

Per gli endpoint importati con l'autenticazione di identità assegnata dal sistema, l'hub specificato deve disporre delle autorizzazioni corrette. In caso contrario, il comando avrà esito negativo.

Gli endpoint privati verranno ignorati nel processo di importazione.

Per altre informazioni, vedere aka.ms/aziotcli-iot-hub-state.

az iot hub state import --state-file
                        [--aspects {arm, configurations, devices}]
                        [--auth-type {key, login}]
                        [--hub-name]
                        [--login]
                        [--replace]
                        [--resource-group]

Esempio

Importare lo stato supportato dal file specificato nell'hub specificato.

az iot hub state import -n {iothub_name} -f {state_filename}

Importare lo stato supportato dal file specificato nell'hub specificato, sovrascrivendo lo stato precedente dell'hub. Tutti i certificati, le configurazioni e i dispositivi verranno eliminati prima del caricamento del nuovo stato.

az iot hub state import -n {iothub_name} -f {state_filename} -r

Importare solo il modello arm dal file specificato all'hub specificato. Si noti che verrà creato un nuovo hub, se non esiste. Il file può contenere i dispositivi e le configurazioni, ma verranno ignorati.

az iot hub state import -n {iothub_name} -g {resource_group} -f {state_filename} --aspects arm

Importare solo i dispositivi e le configurazioni dal file specificato all'hub specificato. Si noti che non verrà creato un nuovo hub se non esiste e il comando avrà esito negativo. Il file può contenere il modello arm, ma verrà ignorato.

az iot hub state import -n {iothub_name} -f {state_filename} --aspects devices configurations

Parametri necessari

--state-file -f

Percorso del file in cui verranno archiviate le informazioni sullo stato.

Parametri facoltativi

--aspects

Aspetti dell'hub (separati da spazi).

valori accettati: arm, configurations, devices

--auth-type

Indica se l'operazione deve derivare automaticamente una chiave di criteri o usare la sessione di Azure AD corrente. Se il tipo di autenticazione è login e viene specificato il nome host della risorsa, la ricerca della risorsa verrà ignorata a meno che non sia necessario. È possibile configurare l'impostazione predefinita usando az configure --defaults iothub-data-auth-type=<auth-type-value>.

valori accettati: key, login

valore predefinito: key

--hub-name -n

hub IoT nome o nome host. Obbligatorio se non viene specificato --login.

--login -l

Questo comando supporta un'entità stringa di connessione con diritti per eseguire l'azione. Usare per evitare l'accesso di sessione tramite "az login". Se vengono forniti sia un stringa di connessione di entità che un nome, il stringa di connessione ha priorità. Obbligatorio se --hub-name non è specificato.

--replace -r

Se questo flag è impostato, il comando eliminerà i dispositivi, le configurazioni e i certificati correnti dell'hub di destinazione.

valore predefinito: False

--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.

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 hub state migrate

Sperimentale

Il gruppo di comandi 'iot hub state' è sperimentale e in fase di sviluppo. Livelli di riferimento e supporto: https://aka.ms/CLI_refstatus

Eseguire la migrazione dello stato di un hub a un altro hub senza salvare in un file.

Se viene specificato l'aspetto del braccio, l'hub verrà creato se non esiste.

Per impostazione predefinita, lo stato migrato includerà: modello arm per l'hub, configurazioni dell'hub (incluse configurazioni ADM e distribuzioni perimetrali), informazioni sul dispositivo (inclusi identiti dei dispositivi, dispositivi gemelli, identità dei moduli e moduli gemelli).

Per gli endpoint migrati con l'autenticazione dell'identità assegnata dal sistema, l'hub specificato deve disporre delle autorizzazioni corrette. In caso contrario, il comando avrà esito negativo.

Gli endpoint privati verranno ignorati nel processo di migrazione.

Se si verificano problemi durante la migrazione, usare i comandi di esportazione e importazione per avere un file come backup.

Per altre informazioni, vedere aka.ms/aziotcli-iot-hub-state.

az iot hub state migrate [--aspects {arm, configurations, devices}]
                         [--auth-type {key, login}]
                         [--destination-hub]
                         [--destination-hub-login]
                         [--destination-resource-group]
                         [--og]
                         [--oh]
                         [--ol]
                         [--replace]

Esempio

Eseguire la migrazione dello stato supportato dell'hub di origine all'hub di destinazione.

az iot hub state migrate --destination-hub {dest_hub_name} --origin-hub {orig_hub_name}

Eseguire la migrazione dello stato supportato dell'hub di origine all'hub di destinazione, sovrascrivendo lo stato precedente dell'hub. Tutti i certificati, le configurazioni e i dispositivi nell'hub di destinazione verranno eliminati prima del caricamento del nuovo stato.

az iot hub state migrate --destination-hub {dest_hub_name} --origin-hub {orig_hub_name} -r

Eseguire la migrazione solo del modello arm dall'hub di origine all'hub di destinazione. Si noti che verrà creato un nuovo hub se l'hub di destinazione non esiste. L'hub di origine può contenere i dispositivi e le configurazioni, ma verranno ignorati.

az iot hub state migrate --destination-hub {dest_hub_name} --destination-resource-group {dest_hub_resource_group} --origin-hub {orig_hub_name} --aspects arm

Eseguire la migrazione solo dei dispositivi e delle configurazioni dall'hub di origine all'hub di destinazione. Si noti che non verrà creato un nuovo hub se l'hub di destinazione non esiste e il comando avrà esito negativo. Il modello arm per l'hub di origine verrà ignorato.

az iot hub state migrate --destination-hub {dest_hub_name} --origin-hub {orig_hub_name} --aspects devices configurations

Parametri facoltativi

--aspects

Aspetti dell'hub (separati da spazi).

valori accettati: arm, configurations, devices

--auth-type

Indica se l'operazione deve derivare automaticamente una chiave di criteri o usare la sessione di Azure AD corrente. Se il tipo di autenticazione è login e viene specificato il nome host della risorsa, la ricerca della risorsa verrà ignorata a meno che non sia necessario. È possibile configurare l'impostazione predefinita usando az configure --defaults iothub-data-auth-type=<auth-type-value>.

valori accettati: key, login

valore predefinito: key

--destination-hub --dh

Nome del hub IoT in cui verrà copiato lo stato dell'hub di origine.

--destination-hub-login --dl

Questo comando supporta un'entità stringa di connessione con diritti per eseguire un'azione nell'hub di destinazione. Usare per evitare l'accesso di sessione tramite az login per questa istanza di hub IoT. Se vengono forniti sia un stringa di connessione di entità che un nome, il stringa di connessione ha priorità. Obbligatorio se --destination-hub non è specificato.

--destination-resource-group --dg

Nome del gruppo di risorse del hub IoT in cui verrà copiato lo stato dell'hub di origine. Se non specificato, userà il gruppo di risorse del hub IoT di origine.

--og --origin-resource-group

Nome del gruppo di risorse del hub IoT che verrà copiato.

--oh --origin-hub

Nome del hub IoT che verrà copiato.

--ol --origin-hub-login

Questo comando supporta un'entità stringa di connessione con diritti per eseguire un'azione nell'hub di origine. Usare per evitare l'accesso di sessione tramite az login per questa istanza di hub IoT. Se vengono forniti sia un stringa di connessione di entità che un nome, il stringa di connessione ha priorità. Obbligatorio se --origin-hub non è specificato.

--replace -r

Se questo flag è impostato, il comando eliminerà i dispositivi, le configurazioni e i certificati correnti dell'hub di destinazione.

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.