Condividi tramite

az iot hub state

  • Sperimentale

Note

This reference is part of the azure-iot extension for the Azure CLI (version 2.59.0 or higher). L'estensione installerà automaticamente la prima volta che si esegue un comando az iot hub state. Learn more about extensions.

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 Status
az iot hub state export

Esportare lo stato di un hub IoT in un file.

 Extension Experimental
az iot hub state import

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

 Extension Experimental
az iot hub state migrate

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

 Extension Experimental

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--aspects

Aspetti dell'hub (separati da spazi).

Proprietà Valore
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}.

Proprietà Valore
Parameter group: Access Control Arguments
Valore predefinito: key
Valori accettati: key, login
--hub-name -n

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

Proprietà Valore
Parameter group: IoT Hub Identifier Arguments
--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.

Proprietà Valore
Parameter group: IoT Hub Identifier Arguments
--replace -r

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

Proprietà Valore
Valore predefinito: False
--resource-group -g

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

Parametri globali
--debug

Aumentare la verbosità dei log per visualizzare tutti i log di debug.

Proprietà Valore
Valore predefinito: False
--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

Proprietà Valore
Valore predefinito: False
--output -o

Output format.

Proprietà Valore
Valore predefinito: json
Valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

Proprietà Valore
Valore predefinito: False

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--aspects

Aspetti dell'hub (separati da spazi).

Proprietà Valore
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}.

Proprietà Valore
Parameter group: Access Control Arguments
Valore predefinito: key
Valori accettati: key, login
--hub-name -n

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

Proprietà Valore
Parameter group: IoT Hub Identifier Arguments
--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.

Proprietà Valore
Parameter group: IoT Hub Identifier Arguments
--replace -r

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

Proprietà Valore
Valore predefinito: False
--resource-group -g

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

Parametri globali
--debug

Aumentare la verbosità dei log per visualizzare tutti i log di debug.

Proprietà Valore
Valore predefinito: False
--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

Proprietà Valore
Valore predefinito: False
--output -o

Output format.

Proprietà Valore
Valore predefinito: json
Valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

Proprietà Valore
Valore predefinito: False

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 --dh]
                         [--destination-hub-login --dl]
                         [--destination-resource-group --dg]
                         [--og --origin-resource-group]
                         [--oh --origin-hub]
                         [--ol --origin-hub-login]
                         [--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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--aspects

Aspetti dell'hub (separati da spazi).

Proprietà Valore
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}.

Proprietà Valore
Parameter group: Access Control Arguments
Valore predefinito: key
Valori accettati: key, login
--destination-hub --dh

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

Proprietà Valore
Parameter group: IoT Hub Identifier Arguments
--destination-hub-login --dl

Questo comando supporta una stringa di connessione di entità con diritti per eseguire un'azione nell'hub di destinazione. Usare per evitare l'accesso di sessione tramite az login per questa istanza dell'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.

Proprietà Valore
Parameter group: IoT Hub Identifier Arguments
--destination-resource-group --dg

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

Proprietà Valore
Parameter group: IoT Hub Identifier Arguments
--og --origin-resource-group

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

Proprietà Valore
Parameter group: IoT Hub Identifier Arguments
--oh --origin-hub

Nome dell'hub IoT che verrà copiato.

Proprietà Valore
Parameter group: IoT Hub Identifier Arguments
--ol --origin-hub-login

Questo comando supporta una stringa di connessione di entità con diritti per eseguire un'azione nell'hub di origine. Usare per evitare l'accesso di sessione tramite az login per questa istanza dell'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.

Proprietà Valore
Parameter group: IoT Hub Identifier Arguments
--replace -r

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

Proprietà Valore
Valore predefinito: False
Parametri globali
--debug

Aumentare la verbosità dei log per visualizzare tutti i log di debug.

Proprietà Valore
Valore predefinito: False
--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

Proprietà Valore
Valore predefinito: False
--output -o

Output format.

Proprietà Valore
Valore predefinito: json
Valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

Proprietà Valore
Valore predefinito: False