az iot central enrollment-group

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

Gestire e configurare il gruppo di registrazione IoT Central.

Comandi

Nome Descrizione Tipo Status
az iot central enrollment-group create

Creare un gruppo di registrazione.

 Estensione Disponibilità generale
az iot central enrollment-group delete

Eliminare un gruppo di registrazione in base all'ID.

 Estensione Disponibilità generale
az iot central enrollment-group generate-verification-code

Generare un codice di verifica per il certificato x509 primario o secondario di un gruppo di registrazione.

 Estensione Disponibilità generale
az iot central enrollment-group list

Ottenere l'elenco dei gruppi di registrazione in un'applicazione.

 Estensione Disponibilità generale
az iot central enrollment-group show

Ottenere informazioni dettagliate su un gruppo di registrazioni in base all'ID.

 Estensione Disponibilità generale
az iot central enrollment-group update

Aggiornare un gruppo di registrazione.

 Estensione Disponibilità generale
az iot central enrollment-group verify-certificate

Verificare il certificato x509 primario o secondario di un gruppo di registrazione.

 Estensione Disponibilità generale

az iot central enrollment-group create

Creare un gruppo di registrazione.

az iot central enrollment-group create --app-id
                                       --at {symmetricKey, x509}
                                       --display-name
                                       --group-id
                                       --type
                                       [--api-version {2022-06-30-preview, 2022-07-31}]
                                       [--central-api-uri]
                                       [--certificate-path]
                                       [--etag]
                                       [--pk]
                                       [--provisioning-status {disabled, enabled}]
                                       [--scp]
                                       [--secondary-key]
                                       [--token]

Esempio

Creare un gruppo di registrazioni

az iot central enrollment-group create --app-id {appid} --id {enrollmentGroupId} --at {attestation} --display-name {displayName} --type {type}

Creare un gruppo di registrazioni con certificazione primaria x509

az iot central enrollment-group create --app-id {appid} --id {enrollmentGroupId} --at 'x509' --display-name {displayName} --type {type} --cp {primayCertPath}

Creare un gruppo di registrazione con la certificazione chiave simmetrica specificata

az iot central enrollment-group create --app-id {appid} --id {enrollmentGroupId} --at 'symmetricKey' --display-name {displayName} --type {type} --pk {primaryKey} --sk {secondaryKey}

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.

--at --attestation-type

Meccanismo di attestazione per il gruppo di registrazioni. Sono consentiti solo 'x509' o 'symmetricKey'. Per impostazione predefinita, 'symmetricKey' verrà usato per l'attestazione.

Valori accettati: symmetricKey, x509
Valore predefinito: symmetricKey
--display-name

Nome visualizzato del gruppo di registrazione.

--group-id --id

Identificatore univoco per il gruppo di registrazione.

--type

Tipo di dispositivi che si connettono tramite il gruppo.

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
--certificate-path --cp

Percorso del file contenente il certificato primario.

--etag -e

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

--pk --primary-key

Chiave di accesso condiviso simmetrica primaria archiviata in formato Base64.

--provisioning-status --ps

Indica se i dispositivi che usano il gruppo possono connettersi a IoT Central. Vero o falso.

Valori accettati: disabled, enabled
Valore predefinito: enabled
--scp --secondary-certificate-path

Percorso del file contenente il certificato secondario.

--secondary-key --sk

Chiave di accesso condiviso simmetrica secondaria archiviata in formato Base64.

--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 enrollment-group delete

Eliminare un gruppo di registrazione in base all'ID.

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

Esempio

Eliminare un gruppo di registrazione in base all'ID

az iot central enrollment-group delete --app-id {appid} --id {enrollmentGroupId}

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.

--group-id --id

Identificatore univoco per il gruppo di registrazione.

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 enrollment-group generate-verification-code

Generare un codice di verifica per il certificato x509 primario o secondario di un gruppo di registrazione.

az iot central enrollment-group generate-verification-code --app-id
                                                           --group-id
                                                           [--api-version {2022-06-30-preview, 2022-07-31}]
                                                           [--central-api-uri]
                                                           [--certificate-entry {primary, secondary}]
                                                           [--token]

Esempio

Generare un codice di verifica per il certificato x509 primario di un gruppo di registrazione

az iot central enrollment-group generate-verification-code --app-id {appid} --id {enrollmentGroupId} --entry 'primary'

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.

--group-id --id

Identificatore univoco per il gruppo di registrazione.

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

Tipo di voce del certificato x509 che consente solo 'primary' e 'secondary'.

Valori accettati: primary, secondary
--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 enrollment-group list

Ottenere l'elenco dei gruppi di registrazione in un'applicazione.

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

Esempio

Ottenere l'elenco dei gruppi di registrazione in un'applicazione

az iot central enrollment-group 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
--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 enrollment-group show

Ottenere informazioni dettagliate su un gruppo di registrazioni in base all'ID.

az iot central enrollment-group show --app-id
                                     --group-id
                                     [--api-version {2022-06-30-preview, 2022-07-31}]
                                     [--central-api-uri]
                                     [--certificate-entry {primary, secondary}]
                                     [--token]

Esempio

Ottenere informazioni dettagliate su un gruppo di registrazione in base all'ID

az iot central enrollment-group show --app-id {appid} --id {enrollmentGroupId}

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.

--group-id --id

Identificatore univoco per il gruppo di registrazione.

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

Tipo di voce del certificato x509 che consente solo 'primary' e 'secondary'.

Valori accettati: primary, secondary
--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 enrollment-group update

Aggiornare un gruppo di registrazione.

az iot central enrollment-group update --app-id
                                       --group-id
                                       [--api-version {2022-06-30-preview, 2022-07-31}]
                                       [--central-api-uri]
                                       [--certificate-entry {primary, secondary}]
                                       [--certificate-path]
                                       [--display-name]
                                       [--etag]
                                       [--provisioning-status {disabled, enabled}]
                                       [--remove-x509 {false, true}]
                                       [--scp]
                                       [--token]
                                       [--type]

Esempio

Aggiornare un gruppo di registrazione

az iot central enrollment-group update --app-id {appid} --id {enrollmentGroupId} --display-name {displayName} --type {type} --ps {enabled}

Rimuovere il certificato primario x509 da un gruppo di registrazioni

az iot central enrollment-group update --app-id {appid} --id {enrollmentGroupId} --remove-x509 'true' --entry 'primary'

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.

--group-id --id

Identificatore univoco per il gruppo di registrazione.

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

Tipo di voce del certificato x509 che consente solo 'primary' e 'secondary'.

Valori accettati: primary, secondary
--certificate-path --cp

Percorso del file contenente il certificato primario.

--display-name

Nome visualizzato del gruppo di registrazione.

--etag

ETag usato per evitare conflitti negli aggiornamenti del gruppo di registrazione.

--provisioning-status --ps

Indica se i dispositivi che usano il gruppo possono connettersi a IoT Central. Vero o falso.

Valori accettati: disabled, enabled
Valore predefinito: enabled
--remove-x509

Indica se il certificato x509 deve essere rimosso dal gruppo. Vero o falso.

Valori accettati: false, true
--scp --secondary-certificate-path

Percorso del file contenente il certificato secondario.

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

--type

Tipo di dispositivi che si connettono tramite il gruppo.

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 enrollment-group verify-certificate

Verificare il certificato x509 primario o secondario di un gruppo di registrazione.

Verificare il certificato x509 primario o secondario di un gruppo di registrazioni fornendo un certificato con il codice di verifica firmato.

Si noti che se un gruppo di registrazione è stato creato con un certificato x509 non verificato, è necessario creare un certificato di verifica usando il certificato x509 non verificato e un codice di verifica prima di usare questo comando. È possibile generare un codice di verifica tramite l'interfaccia della riga di comando usando il comando 'enrollment-group generate-verification-code'. Altre informazioni su come creare certificati di verifica usando il codice di verifica all'indirizzo https://video2.skills-academy.com/en-us/azure/iot-central/core/how-to-connect-devices-x509.

az iot central enrollment-group verify-certificate --app-id
                                                   --group-id
                                                   [--api-version {2022-06-30-preview, 2022-07-31}]
                                                   [--central-api-uri]
                                                   [--certificate-path]
                                                   [--scp]
                                                   [--token]

Esempio

Verificare il certificato x509 primario di un gruppo di registrazione

az iot central enrollment-group verify-certificate --app-id {appid} --id {enrollmentGroupId} --cp {primayCertPath}

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.

--group-id --id

Identificatore univoco per il gruppo di registrazione.

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
--certificate-path --cp

Percorso del file contenente il certificato primario.

--scp --secondary-certificate-path

Percorso del file contenente il certificato secondario.

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