az iot device registration

  • Préversion

Note

Cette référence fait partie de l’extension azure-iot pour la Azure CLI (version 2.73.0 ou ultérieure). L’extension installe automatiquement la première fois que vous exécutez une az iot device registration command. Apprenez-en davantage sur les extensions.

Ce groupe de commandes est en préversion et en cours de développement. Niveaux de référence et de support : https://aka.ms/CLI_refstatus

Inscrivez un appareil via Azure IoT Hub Device Provisioning Service (DPS).

Utilisez la création pour une inscription individuelle ou de groupe, puis l’état de l’opération pour suivre une inscription acceptée. Authentifiez l’appareil avec sa clé symétrique ou un certificat X.509. Les enregistrements d’inscription de service et l’administration de l’état d’inscription restent sous az iot dps.

Commandes

Nom Description Type État
az iot device registration create

Inscrivez un appareil et émettez éventuellement son certificat opérationnel.

 Extension Preview
az iot device registration operation-status

Affichez l’état d’une opération d’inscription d’appareil DPS.

 Extension Preview

az iot device registration create

Préversion

Le groupe de commandes « iot device registration » est en préversion et en cours de développement. Niveaux de référence et de support : https://aka.ms/CLI_refstatus

Inscrivez un appareil et émettez éventuellement son certificat opérationnel.

Pour une inscription individuelle, fournissez son appareil --symmetric-key. Pour une inscription de groupe, fournissez la clé de groupe avec --compute-key ou fournissez une clé d’appareil déjà dérivée sans ---compute-key. Vous pouvez également utiliser --dps-name avec la connexion --auth-type pour découvrir l’étendue/le point de terminaison d’ID et récupérer les clés d’inscription ; ajoutez --group-id et --compute-key pour une inscription de groupe. Entra login autorise cette recherche bootstrap, et non la demande d’inscription de l’appareil.

Utilisez --id-scope avec des informations d’identification d’appareil explicites pour ignorer la découverte des ressources DPS. Définissez --host lors de l’utilisation d’un point de terminaison d’approvisionnement non par défaut. Pour l’authentification X.509, fournissez --certificate-file-path et --key-file-path ; add --passphrase uniquement si la clé privée est chiffrée.

Ajoutez --csr (alias --csr-file-path) pour demander un certificat opérationnel. Il accepte PEM ou base64 DER PKCS #10, inline ou à partir d’un fichier. La signature CSR doit être valide et son nom commun doit correspondre à --registration-id. Une demande de signature de certificat ne remplace pas l’authentification symétrique ou X.509 de l’appareil.

La commande interroge les inscriptions acceptées, en respectant Retry-After. S’il expire après avoir reçu un ID d’opération, utilisez l’état de l’opération avec cet ID et le même ID d’inscription, l’étendue d’ID, le point de terminaison et l’authentification de l’appareil. Un délai d’expiration n’annule pas l’opération back-end ; ne réexécutez pas la création de manière aveugle. --le délai d’expiration applique une échéance difficile au même flux REST pour l’inscription csr et non-CSR, y compris le démarrage du travail, les nouvelles tentatives HTTP et l’interrogation, après l’étendue de l’ID préliminaire et la découverte des informations d’identification de démarrage. Sans --timeout, le comportement d’interrogation limité existant de cinq minutes est conservé.

La sortie JSON conserve issuedCertificateChain et connectionProfile lorsque DPS les retourne, ainsi que registryDeviceExternalId pour la corrélation de l’appareil de Registre. Le contrat RegisterDeviceAndIssueCertificateChain émis décrit uniquement le tableau d’octets 2026-11-02-preview et ne définit pas son encodage filaire ou son ordre de certificat. Par conséquent, cette commande conserve ce champ dans la sortie JSON, mais n’offre pas d’option de sortie de fichier de certificat ; l’écriture d’une chaîne devinée peut produire un bundle non-TLS prêt ou mal ordonné. --endorsement-key et --storage-root-key sont conservés en tant que champs de schéma de requête avancé, mais l’authentification TPM uniquement n’est pas prise en charge explicitement, car ce contrat ne fournit aucun protocole de défi de module de plateforme sécurisée client.

az iot device registration create --registration-id --rid
                                  [--acquire-policy-token]
                                  [--auth-type {key, login}]
                                  [--certificate-file-path --cp]
                                  [--change-reference]
                                  [--ck --compute-key]
                                  [--csr --csr-file-path]
                                  [--dps-name]
                                  [--endorsement-key]
                                  [--enrollment-group-id --gid --group-id]
                                  [--host --provisioning-host]
                                  [--id-scope --scope]
                                  [--key --symmetric-key]
                                  [--key-file-path --kp]
                                  [--login]
                                  [--pass --passphrase]
                                  [--payload]
                                  [--resource-group]
                                  [--storage-root-key]
                                  [--timeout]

Exemples

Inscrire une inscription individuelle à l’aide de la recherche de clé d’amorçage autorisée par Entra

az iot device registration create --dps-name MyDps --resource-group MyResourceGroup \
  --registration-id device-01 --auth-type login

Inscrire un membre de groupe à l’aide de la recherche de clé d’amorçage autorisée par Entra

az iot device registration create --dps-name MyDps --registration-id device-01 \
  --group-id MyEnrollmentGroup --compute-key --auth-type login

S’inscrire auprès d’une clé d’appareil et d’une étendue d’ID connue, sans recherche de démarrage

az iot device registration create --id-scope 0ne00000000 \
  --registration-id device-01 --symmetric-key DEVICE_KEY

Dériver une clé d’appareil d’une clé de groupe d’inscription et inscrire

az iot device registration create --id-scope 0ne00000000 \
  --registration-id device-01 --symmetric-key GROUP_KEY --compute-key

Inscrire et demander un certificat opérationnel auprès d’une demande de signature de certificat PEM

az iot device registration create --id-scope 0ne00000000 --registration-id device-01 \
  --symmetric-key DEVICE_KEY --csr ./device-01.csr --timeout 120

S’inscrire auprès d’un certificat d’appareil X.509

az iot device registration create --id-scope 0ne00000000 \
  --registration-id device-01 --certificate-file-path ./device.pem \
  --key-file-path ./device-key.pem

Paramètres obligatoires

--registration-id --rid

ID d’inscription d’appareil ou ID d’inscription individuel.

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--acquire-policy-token

Acquisition automatique d’un jeton Azure Policy pour cette opération de ressource.

Propriété Valeur
Groupe de paramètres: Global Policy Arguments
--auth-type

Indique si l’opération doit dériver automatiquement une clé de stratégie ou utiliser la session active Azure AD. Si le type d’authentification est login et que le nom d’hôte de ressource est fourni, la recherche de ressources est ignorée, sauf si nécessaire. Vous pouvez configurer la valeur par défaut à l’aide az configure --defaults iothub-data-auth-type={auth-type-value}de .

Propriété Valeur
Groupe de paramètres: Access Control Arguments
Valeur par défaut: key
Valeurs acceptées: key, login
--certificate-file-path --cp

Chemin d’accès au fichier PEM de certificat. Obligatoire pour les inscriptions x509.

Propriété Valeur
Groupe de paramètres: x509 Authentication Arguments
--change-reference

ID de référence de modification associé pour cette opération de ressource.

Propriété Valeur
Groupe de paramètres: Global Policy Arguments
--ck --compute-key

Calculez la clé par appareil à partir de --symmetric-key ou à partir de la clé enrollment-group résolue par --group-id avec --dps-name/-login. Impossible de combiner les entrées X.509.

Propriété Valeur
Groupe de paramètres: Symmetric Key Authentication Arguments
Valeur par défaut: False
--csr --csr-file-path

PEM/base64 DER PKCS #10 CSR inline ou chemin d’accès à un fichier CSR. Sa signature doit être valide et le nom commun doit correspondre à l’ID d’inscription. La requête envoie un DER en base64 sans en-tête PEM.

Propriété Valeur
Groupe de paramètres: Certificate Issuance Arguments
--dps-name -n

Nom du service Azure IoT Hub Device Provisioning. Obligatoire si --login n’est pas fourni ou si les arguments authenticaton et --id-scope ne sont pas fournis.

Propriété Valeur
Groupe de paramètres: DPS Identifier Arguments
--endorsement-key

Champ de requête TPM avancé conservé par le schéma de service. Doit être utilisé avec --storage-root-key. L’authentification du client TPM uniquement n’est pas prise en charge par cette commande.

Propriété Valeur
Groupe de paramètres: TPM Arguments
--enrollment-group-id --gid --group-id

ID de groupe d’inscription. Nécessaire uniquement pour récupérer les arguments d’authentification.

--host --provisioning-host

Point de terminaison d’appareil DPS. En cas d’omission, le point de terminaison est dérivé de la ressource DPS sélectionnée, puis revient au point de terminaison global.

--id-scope --scope

Étendue d’ID du service Azure IoT Hub Device Provisioning. L’étendue d’ID n’identifie pas un point de terminaison d’appareil : --dps-name ou --login est toujours résolu lorsqu’il est fourni. Avec uniquement --id-scope et les informations d’identification d’appareil explicites, le secours de point de terminaison global documenté est utilisé.

Propriété Valeur
Groupe de paramètres: DPS Identifier Arguments
--key --symmetric-key

Clé d’accès partagé symétrique pour l’inscription de l’appareil.

Propriété Valeur
Groupe de paramètres: Symmetric Key Authentication Arguments
--key-file-path --kp

Chemin d’accès au fichier PEM de clé. Obligatoire pour les inscriptions x509.

Propriété Valeur
Groupe de paramètres: x509 Authentication Arguments
--login -l

Cette commande prend en charge une entité chaîne de connexion avec les droits d’exécution d’une action. Permet d’éviter la connexion de session via « az login ». Si une entité chaîne de connexion et un nom sont fournis, le chaîne de connexion a la priorité. Obligatoire si --dps-name n’est pas fourni ou si les arguments authenticaton et --id-scope ne sont pas fournis.

Propriété Valeur
Groupe de paramètres: DPS Identifier Arguments
--pass --passphrase

Phrase secrète pour la clé privée X.509. Valide uniquement avec --certificate-file-path et --key-file-path.

Propriété Valeur
Groupe de paramètres: x509 Authentication Arguments
--payload

Charge utile d’inscription en tant qu’objet JSON ou chemin d’accès à un fichier JSON.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

--storage-root-key

Champ de requête TPM avancé conservé par le schéma de service. Doit être utilisé avec --endorsement-key. L’authentification du client TPM uniquement n’est pas prise en charge par cette commande.

Propriété Valeur
Groupe de paramètres: TPM Arguments
--timeout

Délai d’expiration du délai d’inscription REST dur entier positif en secondes, y compris le démarrage du worker, HTTP et l’interrogation. Exclut l’étendue de l’ID préliminaire et la découverte des informations d’identification de démarrage.

Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

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

Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

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

Propriété Valeur
Valeur par défaut: False

az iot device registration operation-status

Préversion

Le groupe de commandes « iot device registration » est en préversion et en cours de développement. Niveaux de référence et de support : https://aka.ms/CLI_refstatus

Affichez l’état d’une opération d’inscription d’appareil DPS.

Fournissez l’ID d’opération retourné par DPS ou signalé par la création après un délai d’expiration. Réutilisez l’ID d’inscription, l’étendue d’ID (ou le nom DPS), l’approvisionnement de l’hôte et de l’authentification de l’appareil à partir de la création. Il s’agit d’une lecture d’état, et non d’une nouvelle inscription.

az iot device registration operation-status --operation-id
                                            --registration-id --rid
                                            [--acquire-policy-token]
                                            [--auth-type {key, login}]
                                            [--certificate-file-path --cp]
                                            [--change-reference]
                                            [--ck --compute-key]
                                            [--dps-name]
                                            [--enrollment-group-id --gid --group-id]
                                            [--host --provisioning-host]
                                            [--id-scope --scope]
                                            [--key --symmetric-key]
                                            [--key-file-path --kp]
                                            [--login]
                                            [--pass --passphrase]
                                            [--resource-group]

Exemples

Suivre une inscription individuelle avec la recherche de clé de démarrage

az iot device registration operation-status --dps-name MyDps \
  --registration-id device-01 --operation-id OPERATION_ID --auth-type login

Suivre un membre de groupe avec la même clé de groupe et l’hôte d’approvisionnement

az iot device registration operation-status --id-scope 0ne00000000 \
  --registration-id device-01 --operation-id OPERATION_ID \
  --symmetric-key GROUP_KEY --compute-key --host MyProvisioningHost

Suivez une opération acceptée après un délai d’attente sans réinscrire l’inscription

az iot device registration operation-status --id-scope 0ne00000000 \
  --registration-id device-01 --operation-id OPERATION_ID --symmetric-key DEVICE_KEY

Paramètres obligatoires

--operation-id

Identificateur d’opération d’inscription retourné par la création.

--registration-id --rid

ID d’inscription d’appareil ou ID d’inscription individuel.

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--acquire-policy-token

Acquisition automatique d’un jeton Azure Policy pour cette opération de ressource.

Propriété Valeur
Groupe de paramètres: Global Policy Arguments
--auth-type

Indique si l’opération doit dériver automatiquement une clé de stratégie ou utiliser la session active Azure AD. Si le type d’authentification est login et que le nom d’hôte de ressource est fourni, la recherche de ressources est ignorée, sauf si nécessaire. Vous pouvez configurer la valeur par défaut à l’aide az configure --defaults iothub-data-auth-type={auth-type-value}de .

Propriété Valeur
Groupe de paramètres: Access Control Arguments
Valeur par défaut: key
Valeurs acceptées: key, login
--certificate-file-path --cp

Chemin d’accès au fichier PEM de certificat. Obligatoire pour les inscriptions x509.

Propriété Valeur
Groupe de paramètres: x509 Authentication Arguments
--change-reference

ID de référence de modification associé pour cette opération de ressource.

Propriété Valeur
Groupe de paramètres: Global Policy Arguments
--ck --compute-key

Calculez la clé par appareil à partir de --symmetric-key ou à partir de la clé enrollment-group résolue par --group-id avec --dps-name/-login. Impossible de combiner les entrées X.509.

Propriété Valeur
Groupe de paramètres: Symmetric Key Authentication Arguments
Valeur par défaut: False
--dps-name -n

Nom du service Azure IoT Hub Device Provisioning. Obligatoire si --login n’est pas fourni ou si les arguments authenticaton et --id-scope ne sont pas fournis.

Propriété Valeur
Groupe de paramètres: DPS Identifier Arguments
--enrollment-group-id --gid --group-id

ID de groupe d’inscription. Nécessaire uniquement pour récupérer les arguments d’authentification.

--host --provisioning-host

Point de terminaison d’appareil DPS. En cas d’omission, le point de terminaison est dérivé de la ressource DPS sélectionnée, puis revient au point de terminaison global.

--id-scope --scope

Étendue d’ID du service Azure IoT Hub Device Provisioning. L’étendue d’ID n’identifie pas un point de terminaison d’appareil : --dps-name ou --login est toujours résolu lorsqu’il est fourni. Avec uniquement --id-scope et les informations d’identification d’appareil explicites, le secours de point de terminaison global documenté est utilisé.

Propriété Valeur
Groupe de paramètres: DPS Identifier Arguments
--key --symmetric-key

Clé d’accès partagé symétrique pour l’inscription de l’appareil.

Propriété Valeur
Groupe de paramètres: Symmetric Key Authentication Arguments
--key-file-path --kp

Chemin d’accès au fichier PEM de clé. Obligatoire pour les inscriptions x509.

Propriété Valeur
Groupe de paramètres: x509 Authentication Arguments
--login -l

Cette commande prend en charge une entité chaîne de connexion avec les droits d’exécution d’une action. Permet d’éviter la connexion de session via « az login ». Si une entité chaîne de connexion et un nom sont fournis, le chaîne de connexion a la priorité. Obligatoire si --dps-name n’est pas fourni ou si les arguments authenticaton et --id-scope ne sont pas fournis.

Propriété Valeur
Groupe de paramètres: DPS Identifier Arguments
--pass --passphrase

Phrase secrète pour la clé privée X.509. Valide uniquement avec --certificate-file-path et --key-file-path.

Propriété Valeur
Groupe de paramètres: x509 Authentication Arguments
--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

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

Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

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

Propriété Valeur
Valeur par défaut: False