Partager via

az iot central enrollment-group

  • Référence

Remarque

Cette référence fait partie de l’extension azure-iot pour Azure CLI (version 2.46.0 ou ultérieure). L’extension installe automatiquement la première fois que vous exécutez une commande az iot central enrollment-group . En savoir plus sur les extensions.

Gérez et configurez le groupe d’inscription IoT Central.

Commandes

Nom Description Type État
az iot central enrollment-group create

Créez un groupe d’inscription.

 Extension GA
az iot central enrollment-group delete

Supprimez un groupe d’inscription par ID.

 Extension GA
az iot central enrollment-group generate-verification-code

Générez un code de vérification pour le certificat x509 principal ou secondaire d’un groupe d’inscription.

 Extension GA
az iot central enrollment-group list

Obtenez la liste des groupes d’inscription dans une application.

 Extension GA
az iot central enrollment-group show

Obtenez des détails sur un groupe d’inscription par ID.

 Extension GA
az iot central enrollment-group update

Mettez à jour un groupe d’inscriptions.

 Extension GA
az iot central enrollment-group verify-certificate

Vérifiez le certificat x509 principal ou secondaire d’un groupe d’inscription.

 Extension GA

az iot central enrollment-group create

Créez un groupe d’inscription.

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]

Exemples

Création d’un groupe d’inscription

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

Créer un groupe d’inscription avec la certification principale x509

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

Créer un groupe d’inscription avec une certification de clé symétrique donnée

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

Paramètres obligatoires

--app-id -n

ID d’application de l’application IoT Central que vous souhaitez gérer. Vous trouverez l’ID d’application dans la page « À propos » de votre application sous le menu d’aide.

--at --attestation-type

Mécanisme d’attestation pour le groupe d’inscription. Seuls les « x509 » ou « symmetricKey » sont autorisés. Par défaut, « symmetricKey » sera utilisé pour l’attestation.

Valeurs acceptées: symmetricKey, x509
Valeur par défaut: symmetricKey
--display-name

Nom complet du groupe d’inscription.

--group-id --id

Identificateur unique pour le groupe d’inscription.

--type

Type d’appareils qui se connectent via le groupe.

Paramètres facultatifs

--api-version --av
Déprécié

L’argument 'api_version' a été déconseillé et sera supprimé dans une prochaine version.

Ce paramètre de commande a été déconseillé et sera ignoré. Dans la prochaine version, nous allons uniquement prendre en charge les API IoT Central à partir de la dernière version en disponibilité générale. Si une API n’est pas encore en disponibilité générale, nous appelons la dernière version préliminaire.

Valeurs acceptées: 2022-06-30-preview, 2022-07-31
Valeur par défaut: 2022-07-31
--central-api-uri --central-dns-suffix

Suffixe DNS IoT Central associé à votre application.

Valeur par défaut: azureiotcentral.com
--certificate-path --cp

Chemin d’accès au fichier contenant le certificat principal.

--etag -e

Étiquette d’entité ou etag correspondant au dernier état de la ressource. Si aucun etag n’est fourni, la valeur '*' est utilisée.

--pk --primary-key

Clé d’accès partagé symétrique primaire stockée au format base64.

--provisioning-status --ps

Indique si les appareils utilisant le groupe sont autorisés à se connecter à IoT Central. Vrai ou faux.

Valeurs acceptées: disabled, enabled
Valeur par défaut: enabled
--scp --secondary-certificate-path

Chemin d’accès au fichier contenant le certificat secondaire.

--secondary-key --sk

Clé d’accès partagé symétrique secondaire stockée au format base64.

--token

Si vous préférez envoyer votre demande sans vous authentifier auprès d’Azure CLI, vous pouvez spécifier un jeton d’utilisateur valide pour authentifier votre demande. Vous devez spécifier le type de clé dans le cadre de la requête. Pour en savoir plus, rendez-vous sur https://aka.ms/iotcentraldocsapi.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
Valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az iot central enrollment-group delete

Supprimez un groupe d’inscription par ID.

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

Exemples

Supprimer un groupe d’inscription par ID

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

Paramètres obligatoires

--app-id -n

ID d’application de l’application IoT Central que vous souhaitez gérer. Vous trouverez l’ID d’application dans la page « À propos » de votre application sous le menu d’aide.

--group-id --id

Identificateur unique pour le groupe d’inscription.

Paramètres facultatifs

--api-version --av
Déprécié

L’argument 'api_version' a été déconseillé et sera supprimé dans une prochaine version.

Ce paramètre de commande a été déconseillé et sera ignoré. Dans la prochaine version, nous allons uniquement prendre en charge les API IoT Central à partir de la dernière version en disponibilité générale. Si une API n’est pas encore en disponibilité générale, nous appelons la dernière version préliminaire.

Valeurs acceptées: 2022-06-30-preview, 2022-07-31
Valeur par défaut: 2022-07-31
--central-api-uri --central-dns-suffix

Suffixe DNS IoT Central associé à votre application.

Valeur par défaut: azureiotcentral.com
--token

Si vous préférez envoyer votre demande sans vous authentifier auprès d’Azure CLI, vous pouvez spécifier un jeton d’utilisateur valide pour authentifier votre demande. Vous devez spécifier le type de clé dans le cadre de la requête. Pour en savoir plus, rendez-vous sur https://aka.ms/iotcentraldocsapi.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
Valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az iot central enrollment-group generate-verification-code

Générez un code de vérification pour le certificat x509 principal ou secondaire d’un groupe d’inscription.

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]

Exemples

Générer un code de vérification pour le certificat x509 principal d’un groupe d’inscription

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

Paramètres obligatoires

--app-id -n

ID d’application de l’application IoT Central que vous souhaitez gérer. Vous trouverez l’ID d’application dans la page « À propos » de votre application sous le menu d’aide.

--group-id --id

Identificateur unique pour le groupe d’inscription.

Paramètres facultatifs

--api-version --av
Déprécié

L’argument 'api_version' a été déconseillé et sera supprimé dans une prochaine version.

Ce paramètre de commande a été déconseillé et sera ignoré. Dans la prochaine version, nous allons uniquement prendre en charge les API IoT Central à partir de la dernière version en disponibilité générale. Si une API n’est pas encore en disponibilité générale, nous appelons la dernière version préliminaire.

Valeurs acceptées: 2022-06-30-preview, 2022-07-31
Valeur par défaut: 2022-07-31
--central-api-uri --central-dns-suffix

Suffixe DNS IoT Central associé à votre application.

Valeur par défaut: azureiotcentral.com
--certificate-entry --entry

Type d’entrée du certificat x509 qui autorise uniquement « primary » et « secondary ».

Valeurs acceptées: primary, secondary
--token

Si vous préférez envoyer votre demande sans vous authentifier auprès d’Azure CLI, vous pouvez spécifier un jeton d’utilisateur valide pour authentifier votre demande. Vous devez spécifier le type de clé dans le cadre de la requête. Pour en savoir plus, rendez-vous sur https://aka.ms/iotcentraldocsapi.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
Valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az iot central enrollment-group list

Obtenez la liste des groupes d’inscription dans une application.

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

Exemples

Obtenir la liste des groupes d’inscription dans une application

az iot central enrollment-group list --app-id {appid}

Paramètres obligatoires

--app-id -n

ID d’application de l’application IoT Central que vous souhaitez gérer. Vous trouverez l’ID d’application dans la page « À propos » de votre application sous le menu d’aide.

Paramètres facultatifs

--api-version --av
Déprécié

L’argument 'api_version' a été déconseillé et sera supprimé dans une prochaine version.

Ce paramètre de commande a été déconseillé et sera ignoré. Dans la prochaine version, nous allons uniquement prendre en charge les API IoT Central à partir de la dernière version en disponibilité générale. Si une API n’est pas encore en disponibilité générale, nous appelons la dernière version préliminaire.

Valeurs acceptées: 2022-06-30-preview, 2022-07-31
Valeur par défaut: 2022-07-31
--central-api-uri --central-dns-suffix

Suffixe DNS IoT Central associé à votre application.

Valeur par défaut: azureiotcentral.com
--token

Si vous préférez envoyer votre demande sans vous authentifier auprès d’Azure CLI, vous pouvez spécifier un jeton d’utilisateur valide pour authentifier votre demande. Vous devez spécifier le type de clé dans le cadre de la requête. Pour en savoir plus, rendez-vous sur https://aka.ms/iotcentraldocsapi.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
Valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az iot central enrollment-group show

Obtenez des détails sur un groupe d’inscription par 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]

Exemples

Obtenir des détails sur un groupe d’inscription par ID

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

Paramètres obligatoires

--app-id -n

ID d’application de l’application IoT Central que vous souhaitez gérer. Vous trouverez l’ID d’application dans la page « À propos » de votre application sous le menu d’aide.

--group-id --id

Identificateur unique pour le groupe d’inscription.

Paramètres facultatifs

--api-version --av
Déprécié

L’argument 'api_version' a été déconseillé et sera supprimé dans une prochaine version.

Ce paramètre de commande a été déconseillé et sera ignoré. Dans la prochaine version, nous allons uniquement prendre en charge les API IoT Central à partir de la dernière version en disponibilité générale. Si une API n’est pas encore en disponibilité générale, nous appelons la dernière version préliminaire.

Valeurs acceptées: 2022-06-30-preview, 2022-07-31
Valeur par défaut: 2022-07-31
--central-api-uri --central-dns-suffix

Suffixe DNS IoT Central associé à votre application.

Valeur par défaut: azureiotcentral.com
--certificate-entry --entry

Type d’entrée du certificat x509 qui autorise uniquement « primary » et « secondary ».

Valeurs acceptées: primary, secondary
--token

Si vous préférez envoyer votre demande sans vous authentifier auprès d’Azure CLI, vous pouvez spécifier un jeton d’utilisateur valide pour authentifier votre demande. Vous devez spécifier le type de clé dans le cadre de la requête. Pour en savoir plus, rendez-vous sur https://aka.ms/iotcentraldocsapi.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
Valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az iot central enrollment-group update

Mettez à jour un groupe d’inscriptions.

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]

Exemples

Mettre à jour un groupe d’inscriptions

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

Supprimer le certificat principal x509 d’un groupe d’inscriptions

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

Paramètres obligatoires

--app-id -n

ID d’application de l’application IoT Central que vous souhaitez gérer. Vous trouverez l’ID d’application dans la page « À propos » de votre application sous le menu d’aide.

--group-id --id

Identificateur unique pour le groupe d’inscription.

Paramètres facultatifs

--api-version --av
Déprécié

L’argument 'api_version' a été déconseillé et sera supprimé dans une prochaine version.

Ce paramètre de commande a été déconseillé et sera ignoré. Dans la prochaine version, nous allons uniquement prendre en charge les API IoT Central à partir de la dernière version en disponibilité générale. Si une API n’est pas encore en disponibilité générale, nous appelons la dernière version préliminaire.

Valeurs acceptées: 2022-06-30-preview, 2022-07-31
Valeur par défaut: 2022-07-31
--central-api-uri --central-dns-suffix

Suffixe DNS IoT Central associé à votre application.

Valeur par défaut: azureiotcentral.com
--certificate-entry --entry

Type d’entrée du certificat x509 qui autorise uniquement « primary » et « secondary ».

Valeurs acceptées: primary, secondary
--certificate-path --cp

Chemin d’accès au fichier contenant le certificat principal.

--display-name

Nom complet du groupe d’inscription.

--etag

ETag utilisé pour empêcher le conflit dans les mises à jour de groupe d’inscription.

--provisioning-status --ps

Indique si les appareils utilisant le groupe sont autorisés à se connecter à IoT Central. Vrai ou faux.

Valeurs acceptées: disabled, enabled
Valeur par défaut: enabled
--remove-x509

Indique si le certificat x509 doit être supprimé du groupe. Vrai ou faux.

Valeurs acceptées: false, true
--scp --secondary-certificate-path

Chemin d’accès au fichier contenant le certificat secondaire.

--token

Si vous préférez envoyer votre demande sans vous authentifier auprès d’Azure CLI, vous pouvez spécifier un jeton d’utilisateur valide pour authentifier votre demande. Vous devez spécifier le type de clé dans le cadre de la requête. Pour en savoir plus, rendez-vous sur https://aka.ms/iotcentraldocsapi.

--type

Type d’appareils qui se connectent via le groupe.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
Valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az iot central enrollment-group verify-certificate

Vérifiez le certificat x509 principal ou secondaire d’un groupe d’inscription.

Vérifiez le certificat x509 principal ou secondaire d’un groupe d’inscription en fournissant un certificat avec le code de vérification signé.

Notez que si un groupe d’inscription a été créé avec un certificat x509 non vérifié, un certificat de vérification doit être créé à l’aide du certificat x509 non vérifié et d’un code de vérification avant d’utiliser cette commande. Un code de vérification peut être généré via cli à l’aide de la commande « enrollment-group generate-verification-code ». En savoir plus sur la création de certificats de vérification à l’aide du code de vérification à l’adresse https://zcusa.951200.xyz/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]

Exemples

Vérifier le certificat x509 principal d’un groupe d’inscription

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

Paramètres obligatoires

--app-id -n

ID d’application de l’application IoT Central que vous souhaitez gérer. Vous trouverez l’ID d’application dans la page « À propos » de votre application sous le menu d’aide.

--group-id --id

Identificateur unique pour le groupe d’inscription.

Paramètres facultatifs

--api-version --av
Déprécié

L’argument 'api_version' a été déconseillé et sera supprimé dans une prochaine version.

Ce paramètre de commande a été déconseillé et sera ignoré. Dans la prochaine version, nous allons uniquement prendre en charge les API IoT Central à partir de la dernière version en disponibilité générale. Si une API n’est pas encore en disponibilité générale, nous appelons la dernière version préliminaire.

Valeurs acceptées: 2022-06-30-preview, 2022-07-31
Valeur par défaut: 2022-07-31
--central-api-uri --central-dns-suffix

Suffixe DNS IoT Central associé à votre application.

Valeur par défaut: azureiotcentral.com
--certificate-path --cp

Chemin d’accès au fichier contenant le certificat principal.

--scp --secondary-certificate-path

Chemin d’accès au fichier contenant le certificat secondaire.

--token

Si vous préférez envoyer votre demande sans vous authentifier auprès d’Azure CLI, vous pouvez spécifier un jeton d’utilisateur valide pour authentifier votre demande. Vous devez spécifier le type de clé dans le cadre de la requête. Pour en savoir plus, rendez-vous sur https://aka.ms/iotcentraldocsapi.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
Valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.