az iot dps enrollment-group
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 dps enrollment-group . En savoir plus sur les extensions.
Gérez les groupes d’inscription dans un Service IoT Hub Device Provisioning Azure.
Commandes
Nom | Description | Type | État |
---|---|---|---|
az iot dps enrollment-group compute-device-key |
Générez une clé SAP d’appareil dérivée pour un groupe d’inscription dans un service Azure IoT Hub Device Provisioning. |
Extension | GA |
az iot dps enrollment-group create |
Créez un groupe d’inscription dans un service Azure IoT Hub Device Provisioning. |
Extension | GA |
az iot dps enrollment-group delete |
Supprimez un groupe d’inscription dans un service Azure IoT Hub Device Provisioning. |
Extension | GA |
az iot dps enrollment-group list |
Répertorier les groupes d’inscriptions dans un service Azure IoT Hub Device Provisioning. |
Extension | GA |
az iot dps enrollment-group registration |
Gérez les inscriptions d’appareils côté service pour un groupe d’inscription dans un service Azure IoT Hub Device Provisioning. |
Extension | GA |
az iot dps enrollment-group registration delete |
Supprimez une inscription d’appareil pour un groupe d’inscription dans un service Azure IoT Hub Device Provisioning. |
Extension | GA |
az iot dps enrollment-group registration list |
Répertoriez les inscriptions d’appareils pour un groupe d’inscriptions dans un service Azure IoT Hub Device Provisioning. |
Extension | GA |
az iot dps enrollment-group registration show |
Obtenez une inscription d’appareil pour un groupe d’inscription dans un service Azure IoT Hub Device Provisioning. |
Extension | GA |
az iot dps enrollment-group show |
Obtenez les détails d’un groupe d’inscription dans un service Azure IoT Hub Device Provisioning. |
Extension | GA |
az iot dps enrollment-group update |
Mettez à jour un groupe d’inscription dans un service Azure IoT Hub Device Provisioning. |
Extension | GA |
az iot dps enrollment-group compute-device-key
Générez une clé SAP d’appareil dérivée pour un groupe d’inscription dans un service Azure IoT Hub Device Provisioning.
az iot dps enrollment-group compute-device-key --registration-id
[--auth-type {key, login}]
[--dps-name]
[--eid]
[--key]
[--login]
[--resource-group]
Exemples
Calculez la clé d’appareil avec la clé symétrique donnée.
az iot dps enrollment-group compute-device-key --key {enrollement_group_symmetric_key} --registration-id {registration_id}
Calculez la clé d’appareil avec le groupe d’inscription donné.
az iot dps enrollment-group compute-device-key -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --registration-id {registration_id}
Paramètres obligatoires
ID de l’inscription de l’appareil.
Paramètres facultatifs
Indique si l’opération doit dériver automatiquement une clé de stratégie ou utiliser la session Azure AD actuelle. 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 iotdps-data-auth-type=<auth-type-value>
de .
Nom ou nom d’hôte du service Azure IoT Hub Device Provisioning. Obligatoire si --login n’est pas fourni.
ID de groupe d’inscription.
Clé d’accès partagé symétrique pour le groupe d’inscription. Cela contourne le registre du service Device Provisioning et génère le jeton SAP directement à partir de la clé symétrique fournie sans validation supplémentaire. Tous les autres paramètres de commande en dehors de l’ID d’inscription sont ignorés.
Cette commande prend en charge une entité chaîne de connexion avec des droits d’exécution d’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.
Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>
.
Paramètres globaux
Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.
Affichez ce message d’aide et quittez.
Afficher uniquement les erreurs, en supprimant les avertissements.
Format de sortie.
Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.
Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID
.
Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.
az iot dps enrollment-group create
Créez un groupe d’inscription dans un service Azure IoT Hub Device Provisioning.
Indiquez le format de certificat à l’aide de l’encodage ASCII Base64 et le certificat doit avoir des segments BEGIN et END correspondants, par exemple : commencer par « -----BEGIN CERTIFICATE----- » et se terminer par « -----END CERTIFICATE----- ».
az iot dps enrollment-group create --eid
[--allocation-policy {custom, geoLatency, hashed, static}]
[--api-version]
[--auth-type {key, login}]
[--ca-name]
[--certificate-path]
[--dps-name]
[--edge-enabled {false, true}]
[--ih]
[--initial-twin-properties]
[--initial-twin-tags]
[--login]
[--pk]
[--provisioning-status {disabled, enabled}]
[--reprovision-policy {never, reprovisionandmigratedata, reprovisionandresetdata}]
[--resource-group]
[--scn]
[--scp]
[--secondary-key]
[--webhook-url]
Exemples
Créez un groupe d’inscription « {enrollment_id} » dans le service d’approvisionnement Azure IoT « {dps_name} » dans le groupe de ressources « {resource_group_name} à l’aide d’un certificat intermédiaire en tant que certificat principal ».
az iot dps enrollment-group create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --certificate-path /certificates/Certificate.pem
Créez un groupe d’inscription « {enrollment_id} » dans le service d’approvisionnement Azure IoT « {dps_name} » dans le groupe de ressources « {resource_group_name} à l’aide d’un certificat d’autorité de certification {certificate_name} en tant que certificat secondaire ».
az iot dps enrollment-group create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --secondary-ca-name {certificate_name}
Créez un groupe d’inscription « {enrollment_id} » dans le service d’approvisionnement Azure IoT « MyDps » dans le groupe de ressources « {resource_group_name} » avec l’état d’approvisionnement « activé », les propriétés initiales de jumeau « {« location » :«region » :"US"}} et les balises de jumeau initiales « {"version_dps » :"1"} à l’aide d’un certificat intermédiaire en tant que certificat principal.
az iot dps enrollment-group create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --certificate-path /certificates/Certificate.pem --provisioning-status enabled --initial-twin-properties "{'location':{'region':'US'}}" --initial-twin-tags "{'version_dps':'1'}"
Créez un groupe d’inscription « {enrollment_id} » dans le service d’approvisionnement Azure IoT « {dps_name} » dans le groupe de ressources « {resource_group_name} avec le type d’attestation « symmetrickey ».
az iot dps enrollment-group create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --primary-key {primary_key} --secondary-key {secondary_key}
Créez un groupe d’inscription « {enrollment_id} » avec une stratégie d’allocation personnalisée,
az iot dps enrollment-group create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --allocation-policy custom --webhook-url {webhook_url} --api-version {api_version}
Paramètres obligatoires
ID de groupe d’inscription.
Paramètres facultatifs
Type de stratégie d’allocation pour déterminer comment un appareil est affecté à un hub IoT. Si elle n’est pas fournie, la stratégie d’allocation est la stratégie d’allocation par défaut définie pour l’instance du service Device Provisioning.
Version d’API des types de service d’approvisionnement envoyés dans la demande d’allocation personnalisée. Version minimale prise en charge : 2018-09-01-preview.
Indique si l’opération doit dériver automatiquement une clé de stratégie ou utiliser la session Azure AD actuelle. 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 iotdps-data-auth-type=<auth-type-value>
de .
Nom du certificat d’autorité de certification racine primaire. Si l’attestation avec un certificat d’autorité de certification racine est souhaitée, un nom d’autorité de certification racine doit être fourni.
Chemin d’accès au fichier contenant le certificat principal. Si l’attestation avec un certificat intermédiaire est souhaitée, un chemin d’accès de certificat doit être fourni.
Nom ou nom d’hôte du service Azure IoT Hub Device Provisioning. Obligatoire si --login n’est pas fourni.
Indicateur indiquant l’activation de périphérie.
Nom d’hôte du hub IoT cible associé à la stratégie d’allocation. Utilisez la liste séparée par l’espace pour plusieurs Hubs IoT.
Propriétés initiales du jumeau d’appareil.
Balises de jumeau d’appareil initiales.
Cette commande prend en charge une entité chaîne de connexion avec des droits d’exécution d’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.
Clé d’accès partagé symétrique primaire stockée au format base64.
Activez ou désactivez l’entrée d’inscription.
Stratégie pour déterminer la façon dont les données d’appareil doivent être gérées lors de la réapprovisionnement sur un autre IoT Hub.
Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>
.
Nom du certificat d’autorité de certification racine secondaire. Si l’attestation avec un certificat d’autorité de certification racine est souhaitée, un nom d’autorité de certification racine doit être fourni.
Chemin d’accès au fichier contenant le certificat secondaire. Si l’attestation avec un certificat intermédiaire est souhaitée, un chemin d’accès de certificat doit être fourni.
Clé d’accès partagé symétrique secondaire stockée au format base64.
URL du webhook Azure Function utilisée pour les demandes d’allocation personnalisées.
Paramètres globaux
Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.
Affichez ce message d’aide et quittez.
Afficher uniquement les erreurs, en supprimant les avertissements.
Format de sortie.
Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.
Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID
.
Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.
az iot dps enrollment-group delete
Supprimez un groupe d’inscription dans un service Azure IoT Hub Device Provisioning.
az iot dps enrollment-group delete --eid
[--auth-type {key, login}]
[--dps-name]
[--etag]
[--login]
[--resource-group]
Paramètres obligatoires
ID de groupe d’inscription.
Paramètres facultatifs
Indique si l’opération doit dériver automatiquement une clé de stratégie ou utiliser la session Azure AD actuelle. 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 iotdps-data-auth-type=<auth-type-value>
de .
Nom ou nom d’hôte du service Azure IoT Hub Device Provisioning. Obligatoire si --login n’est pas fourni.
Étiquette d’entité ou etag correspondant au dernier état de la ressource. Si aucun etag n’est fourni, la valeur '*' est utilisée.
Cette commande prend en charge une entité chaîne de connexion avec des droits d’exécution d’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.
Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>
.
Paramètres globaux
Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.
Affichez ce message d’aide et quittez.
Afficher uniquement les erreurs, en supprimant les avertissements.
Format de sortie.
Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.
Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID
.
Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.
az iot dps enrollment-group list
Répertorier les groupes d’inscriptions dans un service Azure IoT Hub Device Provisioning.
az iot dps enrollment-group list [--auth-type {key, login}]
[--dps-name]
[--login]
[--resource-group]
[--top]
Paramètres facultatifs
Indique si l’opération doit dériver automatiquement une clé de stratégie ou utiliser la session Azure AD actuelle. 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 iotdps-data-auth-type=<auth-type-value>
de .
Nom ou nom d’hôte du service Azure IoT Hub Device Provisioning. Obligatoire si --login n’est pas fourni.
Cette commande prend en charge une entité chaîne de connexion avec des droits d’exécution d’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.
Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>
.
Nombre maximal d’éléments à retourner. Utilisez -1 pour illimité.
Paramètres globaux
Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.
Affichez ce message d’aide et quittez.
Afficher uniquement les erreurs, en supprimant les avertissements.
Format de sortie.
Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.
Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID
.
Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.
az iot dps enrollment-group show
Obtenez les détails d’un groupe d’inscription dans un service Azure IoT Hub Device Provisioning.
az iot dps enrollment-group show --eid
[--auth-type {key, login}]
[--dps-name]
[--keys {false, true}]
[--login]
[--resource-group]
Exemples
Utilisation de base
az iot dps enrollment-group show --dps-name {dps_name} -g {resource_group} --enrollment-id {enrollment_id}
Inclure des informations d’attestation complètes dans les résultats d’un groupe d’inscriptions à clé symétrique
az iot dps enrollment-group show --dps-name {dps_name} -g {resource_group} --enrollment-id {symmetric_key_enrollment_id} --show-keys
Paramètres obligatoires
ID de groupe d’inscription.
Paramètres facultatifs
Indique si l’opération doit dériver automatiquement une clé de stratégie ou utiliser la session Azure AD actuelle. 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 iotdps-data-auth-type=<auth-type-value>
de .
Nom ou nom d’hôte du service Azure IoT Hub Device Provisioning. Obligatoire si --login n’est pas fourni.
Incluez des clés d’attestation et des informations dans les résultats du groupe d’inscription.
Cette commande prend en charge une entité chaîne de connexion avec des droits d’exécution d’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.
Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>
.
Paramètres globaux
Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.
Affichez ce message d’aide et quittez.
Afficher uniquement les erreurs, en supprimant les avertissements.
Format de sortie.
Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.
Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID
.
Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.
az iot dps enrollment-group update
Mettez à jour un groupe d’inscription dans un service Azure IoT Hub Device Provisioning.
Indiquez le format de certificat à l’aide de l’encodage ASCII Base64 et le certificat doit avoir des segments BEGIN et END correspondants, par exemple : commencer par « -----BEGIN CERTIFICATE----- » et se terminer par « -----END CERTIFICATE----- ».
az iot dps enrollment-group update --eid
[--allocation-policy {custom, geoLatency, hashed, static}]
[--api-version]
[--auth-type {key, login}]
[--ca-name]
[--certificate-path]
[--dps-name]
[--edge-enabled {false, true}]
[--etag]
[--ih]
[--initial-twin-properties]
[--initial-twin-tags]
[--login]
[--pk]
[--provisioning-status {disabled, enabled}]
[--rc {false, true}]
[--remove-secondary-certificate {false, true}]
[--reprovision-policy {never, reprovisionandmigratedata, reprovisionandresetdata}]
[--resource-group]
[--scn]
[--scp]
[--secondary-key]
[--webhook-url]
Exemples
Mettez à jour le groupe d’inscription « {enrollment_id} » dans le service d’approvisionnement Azure IoT « {dps_name} » dans le groupe de ressources « {resource_group_name} » avec des propriétés de jumeau initiales et des balises de jumeau initiales.
az iot dps enrollment-group update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --initial-twin-properties "{'location':{'region':'USA'}}" --initial-twin-tags "{'version_dps':'2'}" --etag AAAAAAAAAAA=
Mettez à jour le groupe d’inscription « {enrollment_id} » dans le service d’approvisionnement Azure IoT « {dps_name} » dans le groupe de ressources « {resource_group_name} » avec un nouveau certificat intermédiaire principal et supprimez le certificat intermédiaire secondaire existant.
az iot dps enrollment-group update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --certificate-path /certificates/NewCertificate.pem --remove-secondary-certificate --etag AAAAAAAAAAA=
Mettez à jour le groupe d’inscription « {enrollment_id} » dans le service d’approvisionnement Azure IoT « {dps_name} » dans le groupe de ressources « {resource_group_name} » avec le nouveau certificat d’autorité de certification secondaire « {certificate_name} » et supprimez le certificat d’autorité de certification primaire existant.
az iot dps enrollment-group update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --secondary-ca-name {certificate_name} --remove-certificate --etag AAAAAAAAAAA=
Mettez à jour le groupe d’inscription « {enrollment_id} » dans le service d’approvisionnement Azure IoT « {dps_name} » dans le groupe de ressources « {resource_group_name} » avec la nouvelle clé primaire.
az iot dps enrollment-group update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --primary-key {new_primary_key} --etag AAAAAAAAAAA=
Paramètres obligatoires
ID de groupe d’inscription.
Paramètres facultatifs
Type de stratégie d’allocation pour déterminer comment un appareil est affecté à un hub IoT. Si elle n’est pas fournie, la stratégie d’allocation est la stratégie d’allocation par défaut définie pour l’instance du service Device Provisioning.
Version d’API des types de service d’approvisionnement envoyés dans la demande d’allocation personnalisée. Version minimale prise en charge : 2018-09-01-preview.
Indique si l’opération doit dériver automatiquement une clé de stratégie ou utiliser la session Azure AD actuelle. 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 iotdps-data-auth-type=<auth-type-value>
de .
Nom du certificat d’autorité de certification racine primaire. Si l’attestation avec un certificat d’autorité de certification racine est souhaitée, un nom d’autorité de certification racine doit être fourni.
Chemin d’accès au fichier contenant le certificat principal. Si l’attestation avec un certificat intermédiaire est souhaitée, un chemin d’accès de certificat doit être fourni.
Nom ou nom d’hôte du service Azure IoT Hub Device Provisioning. Obligatoire si --login n’est pas fourni.
Indicateur indiquant l’activation de périphérie.
Étiquette d’entité ou etag correspondant au dernier état de la ressource. Si aucun etag n’est fourni, la valeur '*' est utilisée.
Nom d’hôte du hub IoT cible associé à la stratégie d’allocation. Utilisez la liste séparée par l’espace pour plusieurs Hubs IoT.
Propriétés initiales du jumeau d’appareil.
Balises de jumeau d’appareil initiales.
Cette commande prend en charge une entité chaîne de connexion avec des droits d’exécution d’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.
Clé d’accès partagé symétrique primaire stockée au format base64.
Activez ou désactivez l’entrée d’inscription.
Indicateur pour supprimer le certificat principal actuel.
Indicateur pour supprimer le certificat secondaire actuel.
Stratégie pour déterminer la façon dont les données d’appareil doivent être gérées lors de la réapprovisionnement sur un autre IoT Hub.
Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>
.
Nom du certificat d’autorité de certification racine secondaire. Si l’attestation avec un certificat d’autorité de certification racine est souhaitée, un nom d’autorité de certification racine doit être fourni.
Chemin d’accès au fichier contenant le certificat secondaire. Si l’attestation avec un certificat intermédiaire est souhaitée, un chemin d’accès de certificat doit être fourni.
Clé d’accès partagé symétrique secondaire stockée au format base64.
URL du webhook Azure Function utilisée pour les demandes d’allocation personnalisées.
Paramètres globaux
Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.
Affichez ce message d’aide et quittez.
Afficher uniquement les erreurs, en supprimant les avertissements.
Format de sortie.
Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.
Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID
.
Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.