az iot dps enrollment
Note
Cette référence fait partie de l’extension azure-iot pour Azure CLI (version 2.67.0 ou ultérieure). L’extension installe automatiquement la première fois que vous exécutez une az iot dps enrollment command. Apprenez-en davantage sur les extensions.
Gérez les inscriptions individuelles d’appareils dans un Service IoT Hub Device Provisioning.
Commandes
| Nom | Description | Type | État |
|---|---|---|---|
| az iot dps enrollment create |
Créez une inscription d’appareil individuelle dans un service Azure IoT Hub Device Provisioning. |
Extension | GA |
| az iot dps enrollment delete |
Supprimez une inscription d’appareil individuelle dans un service Azure IoT Hub Device Provisioning. |
Extension | GA |
| az iot dps enrollment list |
Répertorier les inscriptions d’appareils individuelles dans un service Azure IoT Hub Device Provisioning. |
Extension | GA |
| az iot dps enrollment registration |
Gérez les inscriptions d’appareils côté service pour une inscription individuelle dans un service Azure IoT Hub Device Provisioning. |
Extension | GA |
| az iot dps enrollment registration delete |
Supprimez une inscription d’appareil pour une inscription individuelle dans un service Azure IoT Hub Device Provisioning. |
Extension | GA |
| az iot dps enrollment registration show |
Obtenez une inscription d’appareil pour une inscription individuelle dans un service Azure IoT Hub Device Provisioning. |
Extension | GA |
| az iot dps enrollment show |
Obtenez des détails d’inscription d’appareil individuels dans un service Azure IoT Hub Device Provisioning. |
Extension | GA |
| az iot dps enrollment update |
Mettez à jour une inscription d’appareil individuelle dans un service Azure IoT Hub Device Provisioning. |
Extension | GA |
az iot dps enrollment create
Créez une inscription d’appareil individuelle 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 create --at --attestation-type {symmetricKey, tpm, x509}
--eid --enrollment-id
[--allocation-policy --ap {custom, geoLatency, hashed, static}]
[--api-version --av]
[--auth-type {key, login}]
[--certificate-path --cp]
[--cpn --credential-policy-name]
[--device-id]
[--device-information --info]
[--dps-name]
[--edge-enabled --ee {false, true}]
[--ek --endorsement-key]
[--ih --iot-hubs]
[--initial-twin-properties --props]
[--initial-twin-tags --tags]
[--login]
[--pk --primary-key]
[--provisioning-status --ps {disabled, enabled}]
[--reprovision-policy --rp {never, reprovisionandmigratedata, reprovisionandresetdata}]
[--resource-group]
[--scp --secondary-certificate-path]
[--secondary-key --sk]
[--webhook-url --wh]
Exemples
Créez une inscription « {enrollment_id} » avec le type d’attestation « x509 » dans le service Azure IoT Device Provisioning « {dps_name} » dans le groupe de ressources « {resource_group_name} » avec l’état d’approvisionnement « désactivé », ID d’appareil « {device_id} », propriétés initiales du jumeau « {«location » :{"region » :"US"}}', balises de jumeau initiales « {"version » :"1"}' et informations d’appareil « {"color » :"red"}'.
az iot dps enrollment create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --attestation-type x509 --certificate-path /certificates/Certificate.pem --provisioning-status disabled --initial-twin-properties "{'location':{'region':'US'}}" --initial-twin-tags "{'version':'1'}" --device-information "{'color':'red'}" --device-id {device_id}
Créez une inscription « MyEnrollment » avec le type d’attestation « tpm » dans le service Azure IoT Device Provisioning « {dps_name} » dans le groupe de ressources « {resource_group_name} ».
az iot dps enrollment create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --attestation-type tpm --endorsement-key 14963E8F3BA5B3984110B3C1CA8E8B89
Créez une inscription « MyEnrollment » avec le type d’attestation « symmetrickey » dans le service Azure IoT Device Provisioning « {dps_name} » dans le groupe de ressources « {resource_group_name} ».
az iot dps enrollment create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --attestation-type symmetrickey --primary-key {primary_key} --secondary-key {secondary_key}
Créez une inscription « MyEnrollment » avec reprovisionnement dans le service Azure IoT Device Provisioning « {dps_name} » dans le groupe de ressources « {resource_group_name} ».
az iot dps enrollment create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --attestation-type tpm --reprovision-policy {reprovision_type} --endorsement-key 14963E8F3BA5B3984110B3C1CA8E8B89
Créez une inscription « MyEnrollment » avec une stratégie d’allocation statique dans le service Azure IoT Device Provisioning « {dps_name} » dans le groupe de ressources « {resource_group_name} ».
az iot dps enrollment create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --attestation-type tpm --allocation-policy static --endorsement-key 14963E8F3BA5B3984110B3C1CA8E8B89 --iot-hubs {iot_hub_host_name}
Créez une inscription « MyEnrollment » avec une stratégie d’allocation hachée et plusieurs hubs dans le service Azure IoT Device Provisioning « {dps_name} » dans le groupe de ressources « {resource_group_name} ».
az iot dps enrollment create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --attestation-type tpm --allocation-policy hashed --endorsement-key 14963E8F3BA5B3984110B3C1CA8E8B89 --iot-hubs {iot_hub_host_name1} {iot_hub_host_name2}
Créez une inscription « MyEnrollment » avec une stratégie d’allocation personnalisée,
az iot dps enrollment create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --attestation-type symmetrickey --allocation-policy custom --webhook-url {webhook_url} --api-version {api_version}
Créez une inscription avec une stratégie d’informations d’identification d’espace de noms ADR personnalisée spécifiée.
az iot dps enrollment create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --attestation-type symmetrickey --credential-policy-name {policy_name}
Paramètres obligatoires
Mécanisme d’attestation utilisé pour l’authentification auprès du service DPS.
| Propriété | Valeur |
|---|---|
| Groupe de paramètres: | Authentication Arguments |
| Valeurs acceptées: | symmetricKey, tpm, x509 |
ID d’inscription d’appareil 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.
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.
| Propriété | Valeur |
|---|---|
| Groupe de paramètres: | Allocation Policy Arguments |
| Valeurs acceptées: | custom, geoLatency, hashed, static |
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.
| Propriété | Valeur |
|---|---|
| Groupe de paramètres: | Allocation Policy Arguments |
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 .
| Propriété | Valeur |
|---|---|
| Groupe de paramètres: | Access Control Arguments |
| Valeur par défaut: | key |
| Valeurs acceptées: | key, login |
Chemin d’accès au fichier contenant le certificat principal. Obligatoire lors du choix de x509 comme type d’attestation et que le chemin d’accès au certificat secondaire n’est pas fourni.
| Propriété | Valeur |
|---|---|
| Groupe de paramètres: | Authentication Arguments |
Nom de la stratégie d’informations d’identification de l’espace de noms ADR.
| Propriété | Valeur |
|---|---|
| Groupe de paramètres: | ADR Credential Policy Arguments |
ID d’appareil inscrit dans IoT Hub.
Informations facultatives sur l’appareil.
Nom ou nom d’hôte du service Azure IoT Hub Device Provisioning. Obligatoire si --login n’est pas fourni.
| Propriété | Valeur |
|---|---|
| Groupe de paramètres: | Device Provisioning Service Identifier Arguments |
Indicateur indiquant l’activation de périphérie.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | False |
| Valeurs acceptées: | false, true |
Clé d’approbation TPM pour un appareil TPM. Lorsque vous choisissez tpm comme type d’attestation, la clé d’approbation est requise.
| Propriété | Valeur |
|---|---|
| Groupe de paramètres: | Authentication Arguments |
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é | Valeur |
|---|---|
| Groupe de paramètres: | Allocation Policy Arguments |
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.
| Propriété | Valeur |
|---|---|
| Groupe de paramètres: | Device Provisioning Service Identifier Arguments |
Clé d’accès partagé symétrique primaire stockée au format base64.
| Propriété | Valeur |
|---|---|
| Groupe de paramètres: | Authentication Arguments |
Activez ou désactivez l’entrée d’inscription.
| Propriété | Valeur |
|---|---|
| Valeurs acceptées: | disabled, enabled |
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.
| Propriété | Valeur |
|---|---|
| Valeurs acceptées: | never, reprovisionandmigratedata, reprovisionandresetdata |
Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.
Chemin d’accès au fichier contenant le certificat secondaire. Obligatoire lors du choix de x509 comme type d’attestation et que le chemin d’accès du certificat principal n’est pas fourni.
| Propriété | Valeur |
|---|---|
| Groupe de paramètres: | Authentication Arguments |
Clé d’accès partagé symétrique secondaire stockée au format base64.
| Propriété | Valeur |
|---|---|
| Groupe de paramètres: | Authentication Arguments |
URL du webhook Azure Function utilisée pour les demandes d’allocation personnalisées.
| Propriété | Valeur |
|---|---|
| Groupe de paramètres: | Allocation Policy Arguments |
Paramètres globaux
Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | False |
Affichez ce message d’aide et quittez.
Afficher uniquement les erreurs, en supprimant les avertissements.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | False |
Format de sortie.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | json |
| Valeurs acceptées: | json, jsonc, none, table, tsv, yaml, yamlc |
Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.
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 dps enrollment delete
Supprimez une inscription d’appareil individuelle dans un service Azure IoT Hub Device Provisioning.
az iot dps enrollment delete --eid --enrollment-id
[--auth-type {key, login}]
[--dps-name]
[--etag]
[--login]
[--resource-group]
Paramètres obligatoires
ID d’inscription d’appareil 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.
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 .
| Propriété | Valeur |
|---|---|
| Groupe de paramètres: | Access Control Arguments |
| Valeur par défaut: | key |
| Valeurs acceptées: | key, login |
Nom ou nom d’hôte du service Azure IoT Hub Device Provisioning. Obligatoire si --login n’est pas fourni.
| Propriété | Valeur |
|---|---|
| Groupe de paramètres: | Device Provisioning Service Identifier Arguments |
É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.
| Propriété | Valeur |
|---|---|
| Groupe de paramètres: | Device Provisioning Service Identifier Arguments |
Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.
Paramètres globaux
Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | False |
Affichez ce message d’aide et quittez.
Afficher uniquement les erreurs, en supprimant les avertissements.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | False |
Format de sortie.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | json |
| Valeurs acceptées: | json, jsonc, none, table, tsv, yaml, yamlc |
Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.
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 dps enrollment list
Répertorier les inscriptions d’appareils individuelles dans un service Azure IoT Hub Device Provisioning.
az iot dps enrollment list [--auth-type {key, login}]
[--dps-name]
[--login]
[--resource-group]
[--top]
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.
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 .
| Propriété | Valeur |
|---|---|
| Groupe de paramètres: | Access Control Arguments |
| Valeur par défaut: | key |
| Valeurs acceptées: | key, login |
Nom ou nom d’hôte du service Azure IoT Hub Device Provisioning. Obligatoire si --login n’est pas fourni.
| Propriété | Valeur |
|---|---|
| Groupe de paramètres: | Device Provisioning Service Identifier Arguments |
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.
| Propriété | Valeur |
|---|---|
| Groupe de paramètres: | Device Provisioning Service Identifier Arguments |
Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.
Nombre maximal d’éléments à retourner. Utilisez -1 pour un nombre illimité.
Paramètres globaux
Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | False |
Affichez ce message d’aide et quittez.
Afficher uniquement les erreurs, en supprimant les avertissements.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | False |
Format de sortie.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | json |
| Valeurs acceptées: | json, jsonc, none, table, tsv, yaml, yamlc |
Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.
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 dps enrollment show
Obtenez des détails d’inscription d’appareil individuels dans un service Azure IoT Hub Device Provisioning.
az iot dps enrollment show --eid --enrollment-id
[--auth-type {key, login}]
[--dps-name]
[--keys --show-keys {false, true}]
[--login]
[--resource-group]
Exemples
Utilisation de base
az iot dps enrollment show --dps-name {dps_name} -g {resource_group} --enrollment-id {enrollment_id}
Inclure des informations d’attestation complètes dans les résultats d’une inscription à clé symétrique
az iot dps enrollment show --dps-name {dps_name} -g {resource_group} --enrollment-id {symmetric_key_enrollment_id} --show-keys
Paramètres obligatoires
ID d’inscription d’appareil 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.
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 .
| Propriété | Valeur |
|---|---|
| Groupe de paramètres: | Access Control Arguments |
| Valeur par défaut: | key |
| Valeurs acceptées: | key, login |
Nom ou nom d’hôte du service Azure IoT Hub Device Provisioning. Obligatoire si --login n’est pas fourni.
| Propriété | Valeur |
|---|---|
| Groupe de paramètres: | Device Provisioning Service Identifier Arguments |
Incluez des clés d’attestation et des informations dans les résultats de l’inscription.
| Propriété | Valeur |
|---|---|
| Valeurs acceptées: | false, true |
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.
| Propriété | Valeur |
|---|---|
| Groupe de paramètres: | Device Provisioning Service Identifier Arguments |
Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.
Paramètres globaux
Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | False |
Affichez ce message d’aide et quittez.
Afficher uniquement les erreurs, en supprimant les avertissements.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | False |
Format de sortie.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | json |
| Valeurs acceptées: | json, jsonc, none, table, tsv, yaml, yamlc |
Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.
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 dps enrollment update
Mettez à jour une inscription d’appareil individuelle 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 update --eid --enrollment-id
[--allocation-policy --ap {custom, geoLatency, hashed, static}]
[--api-version --av]
[--auth-type {key, login}]
[--certificate-path --cp]
[--cpn --credential-policy-name]
[--device-id]
[--device-information --info]
[--dps-name]
[--edge-enabled --ee {false, true}]
[--ek --endorsement-key]
[--etag]
[--ih --iot-hubs]
[--initial-twin-properties --props]
[--initial-twin-tags --tags]
[--login]
[--pk --primary-key]
[--provisioning-status --ps {disabled, enabled}]
[--rc --remove-certificate {false, true}]
[--remove-secondary-certificate --rsc {false, true}]
[--reprovision-policy --rp {never, reprovisionandmigratedata, reprovisionandresetdata}]
[--resource-group]
[--scp --secondary-certificate-path]
[--secondary-key --sk]
[--webhook-url --wh]
Exemples
Mettez à jour l’inscription « {enrollment_id} » avec un nouveau certificat x509 dans le service Azure IoT Device Provisioning « {dps_name} » dans le groupe de ressources « {resource_group_name} ».
az iot dps enrollment update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --certificate-path /certificates/NewCertificate.pem --etag AAAAAAAAAAA=
Mettez à jour l’inscription « {enrollment_id} » avec une nouvelle clé d’approbation dans le service Azure IoT Device Provisioning « {dps_name} » dans le groupe de ressources « {resource_group_name} ».
az iot dps enrollment update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --endorsement-key 14963E8F3BA5B3984110B3C1CA8E8B89 --etag AAAAAAAAAAA=
Mettez à jour l’inscription « {enrollment_id} » avec une nouvelle clé primaire dans le service Azure IoT Device Provisioning « {dps_name} » dans le groupe de ressources « {resource_group_name} ».
az iot dps enrollment update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --primary-key {new_primary_key} --etag AAAAAAAAAAA=
Mettez à jour l’inscription « {enrollment_id} » avec un nouveau type de réapprovisionnement dans le service Azure IoT Device Provisioning « {dps_name} » dans le groupe de ressources « {resource_group_name} ».
az iot dps enrollment update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --reprovision-policy {reprovision_type} --etag AAAAAAAAAAA=
Mettez à jour l’inscription « {enrollment_id} » avec une nouvelle stratégie d’allocation dans le service Azure IoT Device Provisioning « {dps_name} » dans le groupe de ressources « {resource_group_name} ».
az iot dps enrollment update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --allocation-policy geolatency --etag AAAAAAAAAAA= --iot-hubs {iot_hub_host_name1} {iot_hub_host_name2} {iot_hub_host_name3}
Mettez à jour l’inscription « {enrollment_id} » dans le service Azure IoT Device Provisioning « {dps_name} » dans le groupe de ressources « {resource_group_name} » avec les propriétés de jumeau initiales « {« location » :{«region » :"USA"}', les balises de jumeau initiales '{"version » :"2"}' et les informations d’appareil '{"color » :"red"}'.
az iot dps enrollment update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --initial-twin-properties "{'location':{'region':'USA'}}" --initial-twin-tags "{'version1':'2'}" --device-information "{'color':'red'}"
Mettez à jour l’inscription « {enrollment_id} » dans le service Azure IoT Device Provisioning « {dps_name} » pour utiliser une stratégie d’informations d’identification d’espace de noms ADR personnalisée.
az iot dps enrollment update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --credential-policy-name {my_policy}
Paramètres obligatoires
ID d’inscription d’appareil 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.
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.
| Propriété | Valeur |
|---|---|
| Groupe de paramètres: | Allocation Policy Arguments |
| Valeurs acceptées: | custom, geoLatency, hashed, static |
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.
| Propriété | Valeur |
|---|---|
| Groupe de paramètres: | Allocation Policy Arguments |
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 .
| Propriété | Valeur |
|---|---|
| Groupe de paramètres: | Access Control Arguments |
| Valeur par défaut: | key |
| Valeurs acceptées: | key, login |
Chemin d’accès au fichier contenant le certificat principal.
| Propriété | Valeur |
|---|---|
| Groupe de paramètres: | Authentication Arguments |
Nom de la stratégie d’informations d’identification de l’espace de noms ADR.
| Propriété | Valeur |
|---|---|
| Groupe de paramètres: | ADR Credential Policy Arguments |
ID d’appareil inscrit dans IoT Hub.
Informations facultatives sur l’appareil.
Nom ou nom d’hôte du service Azure IoT Hub Device Provisioning. Obligatoire si --login n’est pas fourni.
| Propriété | Valeur |
|---|---|
| Groupe de paramètres: | Device Provisioning Service Identifier Arguments |
Indicateur indiquant l’activation de périphérie.
| Propriété | Valeur |
|---|---|
| Valeurs acceptées: | false, true |
Clé d’approbation TPM pour un appareil TPM.
É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é | Valeur |
|---|---|
| Groupe de paramètres: | Allocation Policy Arguments |
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.
| Propriété | Valeur |
|---|---|
| Groupe de paramètres: | Device Provisioning Service Identifier Arguments |
Clé d’accès partagé symétrique primaire stockée au format base64.
| Propriété | Valeur |
|---|---|
| Groupe de paramètres: | Authentication Arguments |
Activez ou désactivez l’entrée d’inscription.
| Propriété | Valeur |
|---|---|
| Valeurs acceptées: | disabled, enabled |
Indicateur pour supprimer le certificat principal actuel.
| Propriété | Valeur |
|---|---|
| Groupe de paramètres: | Authentication Arguments |
| Valeurs acceptées: | false, true |
Indicateur pour supprimer le certificat secondaire actuel.
| Propriété | Valeur |
|---|---|
| Groupe de paramètres: | Authentication Arguments |
| Valeurs acceptées: | false, true |
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.
| Propriété | Valeur |
|---|---|
| Valeurs acceptées: | never, reprovisionandmigratedata, reprovisionandresetdata |
Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.
Chemin d’accès au fichier contenant le certificat secondaire.
| Propriété | Valeur |
|---|---|
| Groupe de paramètres: | Authentication Arguments |
Clé d’accès partagé symétrique secondaire stockée au format base64.
| Propriété | Valeur |
|---|---|
| Groupe de paramètres: | Authentication Arguments |
URL du webhook Azure Function utilisée pour les demandes d’allocation personnalisées.
| Propriété | Valeur |
|---|---|
| Groupe de paramètres: | Allocation Policy Arguments |
Paramètres globaux
Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | False |
Affichez ce message d’aide et quittez.
Afficher uniquement les erreurs, en supprimant les avertissements.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | False |
Format de sortie.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | json |
| Valeurs acceptées: | json, jsonc, none, table, tsv, yaml, yamlc |
Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.
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 |