Partager via


az iot dps enrollment-group

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 commande az iot dps enrollment-group. Apprenez-en davantage 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 --rid
                                               [--auth-type {key, login}]
                                               [--dps-name]
                                               [--eid --enrollment-id --gid --group-id]
                                               [--key --symmetric-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

--registration-id --rid

ID de l’inscription de l’appareil.

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.

--auth-type

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
--dps-name -n

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
--eid --enrollment-id --gid --group-id

ID de groupe d’inscription.

--key --symmetric-key

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.

--login -l

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

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 --enrollment-id --gid --group-id
                                   [--allocation-policy --ap {custom, geoLatency, hashed, static}]
                                   [--api-version --av]
                                   [--auth-type {key, login}]
                                   [--ca-name --cn --root-ca-name]
                                   [--certificate-path --cp]
                                   [--cpn --credential-policy-name]
                                   [--dps-name]
                                   [--edge-enabled --ee {false, true}]
                                   [--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]
                                   [--scn --secondary-ca-name --secondary-root-ca-name]
                                   [--scp --secondary-certificate-path]
                                   [--secondary-key --sk]
                                   [--webhook-url --wh]

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}

Créez un groupe d’inscription avec une stratégie d’informations d’identification d’espace de noms device Registry personnalisée spécifiée.

az iot dps enrollment-group create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --allocation-policy hashed --credential-policy-name {policy_name}

Paramètres obligatoires

--eid --enrollment-id --gid --group-id

ID de groupe d’inscription.

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.

--allocation-policy --ap

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
--api-version --av

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
--auth-type

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
--ca-name --cn --root-ca-name

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.

Propriété Valeur
Groupe de paramètres: Authentication Arguments
--certificate-path --cp

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.

Propriété Valeur
Groupe de paramètres: Authentication Arguments
--cpn --credential-policy-name

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
--dps-name -n

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
--edge-enabled --ee

Indicateur indiquant l’activation de périphérie.

Propriété Valeur
Valeur par défaut: False
Valeurs acceptées: false, true
--ih --iot-hubs

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
--initial-twin-properties --props

Propriétés initiales du jumeau d’appareil.

--initial-twin-tags --tags

Balises de jumeau d’appareil initiales.

--login -l

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
--pk --primary-key

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

Propriété Valeur
Groupe de paramètres: Authentication Arguments
--provisioning-status --ps

Activez ou désactivez l’entrée d’inscription.

Propriété Valeur
Valeurs acceptées: disabled, enabled
--reprovision-policy --rp

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
--resource-group -g

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

--scn --secondary-ca-name --secondary-root-ca-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.

Propriété Valeur
Groupe de paramètres: Authentication Arguments
--scp --secondary-certificate-path

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.

Propriété Valeur
Groupe de paramètres: Authentication Arguments
--secondary-key --sk

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

Propriété Valeur
Groupe de paramètres: Authentication Arguments
--webhook-url --wh

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

Supprimez un groupe d’inscription dans un service Azure IoT Hub Device Provisioning.

az iot dps enrollment-group delete --eid --enrollment-id --gid --group-id
                                   [--auth-type {key, login}]
                                   [--dps-name]
                                   [--etag]
                                   [--login]
                                   [--resource-group]

Paramètres obligatoires

--eid --enrollment-id --gid --group-id

ID de groupe d’inscription.

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.

--auth-type

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
--dps-name -n

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

--login -l

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

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

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.

--auth-type

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
--dps-name -n

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
--login -l

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
--resource-group -g

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

--top

Nombre maximal d’éléments à retourner. Utilisez -1 pour un nombre illimité.

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 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 --enrollment-id --gid --group-id
                                 [--auth-type {key, login}]
                                 [--dps-name]
                                 [--keys --show-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

--eid --enrollment-id --gid --group-id

ID de groupe d’inscription.

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.

--auth-type

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
--dps-name -n

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
--keys --show-keys

Incluez des clés d’attestation et des informations dans les résultats du groupe d’inscription.

Propriété Valeur
Valeurs acceptées: false, true
--login -l

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

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 --enrollment-id --gid --group-id
                                   [--allocation-policy --ap {custom, geoLatency, hashed, static}]
                                   [--api-version --av]
                                   [--auth-type {key, login}]
                                   [--ca-name --cn --root-ca-name]
                                   [--certificate-path --cp]
                                   [--cpn --credential-policy-name]
                                   [--dps-name]
                                   [--edge-enabled --ee {false, true}]
                                   [--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]
                                   [--scn --secondary-ca-name --secondary-root-ca-name]
                                   [--scp --secondary-certificate-path]
                                   [--secondary-key --sk]
                                   [--webhook-url --wh]

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=

Mettez à jour le groupe d’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-group update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --credential-policy-name {my_policy}

Paramètres obligatoires

--eid --enrollment-id --gid --group-id

ID de groupe d’inscription.

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.

--allocation-policy --ap

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
--api-version --av

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
--auth-type

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
--ca-name --cn --root-ca-name

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.

Propriété Valeur
Groupe de paramètres: Authentication Arguments
--certificate-path --cp

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.

Propriété Valeur
Groupe de paramètres: Authentication Arguments
--cpn --credential-policy-name

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
--dps-name -n

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
--edge-enabled --ee

Indicateur indiquant l’activation de périphérie.

Propriété Valeur
Valeurs acceptées: false, true
--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.

--ih --iot-hubs

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
--initial-twin-properties --props

Propriétés initiales du jumeau d’appareil.

--initial-twin-tags --tags

Balises de jumeau d’appareil initiales.

--login -l

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
--pk --primary-key

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

Propriété Valeur
Groupe de paramètres: Authentication Arguments
--provisioning-status --ps

Activez ou désactivez l’entrée d’inscription.

Propriété Valeur
Valeurs acceptées: disabled, enabled
--rc --remove-certificate

Indicateur pour supprimer le certificat principal actuel.

Propriété Valeur
Groupe de paramètres: Authentication Arguments
Valeurs acceptées: false, true
--remove-secondary-certificate --rsc

Indicateur pour supprimer le certificat secondaire actuel.

Propriété Valeur
Groupe de paramètres: Authentication Arguments
Valeurs acceptées: false, true
--reprovision-policy --rp

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
--resource-group -g

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

--scn --secondary-ca-name --secondary-root-ca-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.

Propriété Valeur
Groupe de paramètres: Authentication Arguments
--scp --secondary-certificate-path

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.

Propriété Valeur
Groupe de paramètres: Authentication Arguments
--secondary-key --sk

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

Propriété Valeur
Groupe de paramètres: Authentication Arguments
--webhook-url --wh

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