az iot hub module-identity

Note

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

Gestire i moduli di dispositivo IoT.

Comandi

Nome	Descrizione	Tipo	Status
az iot hub module-identity connection-string	Gestire le stringa di connessione del modulo per dispositivi IoT.	Extension	GA
az iot hub module-identity connection-string show	Visualizzare un modulo dispositivo IoT di destinazione stringa di connessione.	Extension	GA
az iot hub module-identity create	Creare un modulo in un dispositivo IoT di destinazione in un hub IoT.	Extension	GA
az iot hub module-identity delete	Eliminare un dispositivo in un hub IoT.	Extension	GA
az iot hub module-identity list	Elencare i moduli che si trovano in un dispositivo IoT in un hub IoT.	Extension	GA
az iot hub module-identity renew-key	Rinnovare le chiavi di destinazione dei moduli del dispositivo hub IoT con l'autenticazione sas.	Extension	GA
az iot hub module-identity show	Ottenere i dettagli di un modulo dispositivo IoT in un hub IoT.	Extension	GA
az iot hub module-identity update	Aggiornare un modulo del dispositivo hub IoT.	Extension	GA

az iot hub module-identity create

Creare un modulo in un dispositivo IoT di destinazione in un hub IoT.

Quando si usa il metodo di autenticazione di shared_private_key (noto anche come chiavi simmetriche), se non vengono fornite chiavi personalizzate, il servizio li genererà per il modulo.

az iot hub module-identity create --device-id
                                  --module-id
                                  [--am --auth-method {shared_private_key, x509_ca, x509_thumbprint}]
                                  [--auth-type {key, login}]
                                  [--hub-name]
                                  [--login]
                                  [--od --output-dir]
                                  [--pk --primary-key]
                                  [--primary-thumbprint --ptp]
                                  [--resource-group]
                                  [--secondary-key --sk]
                                  [--secondary-thumbprint --stp]
                                  [--valid-days --vd]

Parametri necessari

--device-id -d

ID dispositivo di destinazione.

--module-id -m

ID modulo di destinazione.

Parametri facoltativi

I seguenti parametri sono facoltativi, ma a seconda del contesto, uno o più di questi potrebbero diventare necessari per l'esecuzione corretta del comando.

--am --auth-method

Il metodo di autorizzazione con cui creare un'entità.

Proprietà	Valore
Valore predefinito:	shared_private_key
Valori accettati:	shared_private_key, x509_ca, x509_thumbprint

--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
Gruppo di parametri:	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
Gruppo di parametri:	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
Gruppo di parametri:	IoT Hub Identifier Arguments

--od --output-dir

Generare un certificato autofirmato e usarne l'identificazione personale. Output nella directory di destinazione specificata.

Proprietà	Valore
Gruppo di parametri:	X.509 Arguments

--pk --primary-key

Chiave di accesso condiviso simmetrica primaria archiviata in formato Base64.

Proprietà	Valore
Gruppo di parametri:	Symmetric Key Arguments

--primary-thumbprint --ptp

Identificazione personale del certificato autofirmato da usare per l'identificazione personale primaria.

Proprietà	Valore
Gruppo di parametri:	X.509 Arguments

--resource-group -g

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

--secondary-key --sk

Chiave di accesso condiviso simmetrica secondaria archiviata in formato Base64.

Proprietà	Valore
Gruppo di parametri:	Symmetric Key Arguments

--secondary-thumbprint --stp

Identificazione personale del certificato autofirmato da usare per l'identificazione personale secondaria.

Proprietà	Valore
Gruppo di parametri:	X.509 Arguments

--valid-days --vd

Generare un certificato autofirmato e usarne l'identificazione personale. Valido per il numero specificato di giorni. Impostazione predefinita: 365.

Proprietà	Valore
Gruppo di parametri:	X.509 Arguments

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

Formato dell'output.

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 module-identity delete

Eliminare un dispositivo in un hub IoT.

az iot hub module-identity delete --device-id
                                  --module-id
                                  [--auth-type {key, login}]
                                  [--etag]
                                  [--hub-name]
                                  [--login]
                                  [--resource-group]

Parametri necessari

--device-id -d

ID dispositivo di destinazione.

--module-id -m

ID modulo di destinazione.

Parametri facoltativi

I seguenti parametri sono facoltativi, ma a seconda del contesto, uno o più di questi potrebbero diventare necessari per l'esecuzione corretta del comando.

--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
Gruppo di parametri:	Access Control Arguments
Valore predefinito:	key
Valori accettati:	key, login

--etag -e

Tag Etag o tag di entità corrispondente all'ultimo stato della risorsa. Se non viene specificato alcun etag, viene usato il valore '*'.

--hub-name -n

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

Proprietà	Valore
Gruppo di parametri:	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
Gruppo di parametri:	IoT Hub Identifier Arguments

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

Formato dell'output.

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 module-identity list

Elencare i moduli che si trovano in un dispositivo IoT in un hub IoT.

az iot hub module-identity list --device-id
                                [--auth-type {key, login}]
                                [--hub-name]
                                [--login]
                                [--resource-group]
                                [--top]

Parametri necessari

--device-id -d

ID dispositivo di destinazione.

Parametri facoltativi

I seguenti parametri sono facoltativi, ma a seconda del contesto, uno o più di questi potrebbero diventare necessari per l'esecuzione corretta del comando.

--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
Gruppo di parametri:	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
Gruppo di parametri:	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
Gruppo di parametri:	IoT Hub Identifier Arguments

--resource-group -g

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

--top

Numero massimo di elementi da restituire. Usare -1 per un numero illimitato.

Proprietà	Valore
Valore predefinito:	1000

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

Formato dell'output.

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 module-identity renew-key

Rinnovare le chiavi di destinazione dei moduli del dispositivo hub IoT con l'autenticazione sas.

Attualmente gli etag e il tipo di swap chiave non sono supportati per la rigenerazione delle chiavi in blocco. La rigenerazione delle chiavi in blocco ha generato un formato di output diverso rispetto alla rigenerazione della chiave a modulo singolo.

az iot hub module-identity renew-key --device-id
                                     --hub-name
                                     --key-type --kt {both, primary, secondary, swap}
                                     --module-id
                                     [--auth-type {key, login}]
                                     [--etag]
                                     [--login]
                                     [--no-progress {false, true}]
                                     [--resource-group]

Esempio

Rinnovare la chiave primaria.

az iot hub module-identity renew-key -m {module_name} -d {device_id} -n {iothub_name} --kt primary

Scambiare le chiavi primarie e secondarie.

az iot hub module-identity renew-key -m {module_name} -d {device_id} -n {iothub_name} --kt swap

Rinnovare la chiave secondaria per due moduli.

az iot hub module-identity renew-key -m {module_name} {module_name} -d {device_id} -n {iothub_name} --kt secondary

Rinnovare entrambe le chiavi per tutti i moduli nel dispositivo.

az iot hub module-identity renew-key -m * -d {device_id} -n {iothub_name} --kt both

Parametri necessari

--device-id -d

ID dispositivo di destinazione.

--hub-name -n

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

Proprietà	Valore
Gruppo di parametri:	IoT Hub Identifier Arguments

--key-type --kt

Tipo di chiave di destinazione da rigenerare.

Proprietà	Valore
Valori accettati:	both, primary, secondary, swap

--module-id -m

Elenco separato dello spazio degli ID modulo di destinazione. Usare * per tutti i moduli.

Parametri facoltativi

I seguenti parametri sono facoltativi, ma a seconda del contesto, uno o più di questi potrebbero diventare necessari per l'esecuzione corretta del comando.

--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
Gruppo di parametri:	Access Control Arguments
Valore predefinito:	key
Valori accettati:	key, login

--etag -e

Tag Etag o tag di entità corrispondente all'ultimo stato della risorsa. Se non viene specificato alcun etag, viene usato il valore '*'. Questo argomento si applica solo a swap.

--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
Gruppo di parametri:	IoT Hub Identifier Arguments

--no-progress

Nascondere l'indicatore di stato per la rigenerazione delle chiavi bulk.

Proprietà	Valore
Valori accettati:	false, true

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

Formato dell'output.

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 module-identity show

Ottenere i dettagli di un modulo dispositivo IoT in un hub IoT.

az iot hub module-identity show --device-id
                                --module-id
                                [--auth-type {key, login}]
                                [--hub-name]
                                [--login]
                                [--resource-group]

Parametri necessari

--device-id -d

ID dispositivo di destinazione.

--module-id -m

ID modulo di destinazione.

Parametri facoltativi

I seguenti parametri sono facoltativi, ma a seconda del contesto, uno o più di questi potrebbero diventare necessari per l'esecuzione corretta del comando.

--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
Gruppo di parametri:	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
Gruppo di parametri:	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
Gruppo di parametri:	IoT Hub Identifier Arguments

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

Formato dell'output.

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 module-identity update

Aggiornare un modulo del dispositivo hub IoT.

Usare --set seguito dalle assegnazioni di proprietà per l'aggiornamento di un modulo. Sfruttare le proprietà restituite da 'iot hub module-identity show'.

az iot hub module-identity update --device-id
                                  --module-id
                                  [--add]
                                  [--auth-type {key, login}]
                                  [--etag]
                                  [--force-string]
                                  [--hub-name]
                                  [--login]
                                  [--remove]
                                  [--resource-group]
                                  [--set]

Esempio

Rigenerare le chiavi di autenticazione simmetrica del modulo

az iot hub module-identity update -m {module_name} -d {device_id} -n {iothub_name} --set authentication.symmetricKey.primaryKey="" authentication.symmetricKey.secondaryKey=""

Parametri necessari

--device-id -d

ID dispositivo di destinazione.

--module-id -m

ID modulo di destinazione.

Parametri facoltativi

I seguenti parametri sono facoltativi, ma a seconda del contesto, uno o più di questi potrebbero diventare necessari per l'esecuzione corretta del comando.

--add

Aggiungere un oggetto a un elenco di oggetti specificando un percorso e coppie chiave-valore. Esempio: --add property.listProperty <key=value, string or JSON string>.

Proprietà	Valore
Gruppo di parametri:	Generic Update Arguments
Valore predefinito:	[]

--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
Gruppo di parametri:	Access Control Arguments
Valore predefinito:	key
Valori accettati:	key, login

--etag -e

Tag Etag o tag di entità corrispondente all'ultimo stato della risorsa. Se non viene specificato alcun etag, viene usato il valore '*'.

--force-string

Quando si usa 'set' o 'add', mantenere i valori letterali stringa anziché tentare di eseguire la conversione in JSON.

Proprietà	Valore
Gruppo di parametri:	Generic Update Arguments
Valore predefinito:	False

--hub-name -n

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

Proprietà	Valore
Gruppo di parametri:	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
Gruppo di parametri:	IoT Hub Identifier Arguments

--remove

Rimuovere una proprietà o un elemento da un elenco. Esempio: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Proprietà	Valore
Gruppo di parametri:	Generic Update Arguments
Valore predefinito:	[]

--resource-group -g

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

--set

Aggiornare un oggetto specificando un percorso di proprietà e un valore da impostare. Esempio: --set property1.property2=<value>.

Proprietà	Valore
Gruppo di parametri:	Generic Update Arguments
Valore predefinito:	[]

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

Formato dell'output.

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