az iot hub device-identity children

  • Référence

Remarque

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

Gérez les relations des appareils enfants pour les appareils IoT Edge.

Commandes

Nom Description Type Statut
az iot hub device-identity children add

Ajoutez des appareils en tant qu’enfants à un appareil de périphérie cible.

 Extension GA
az iot hub device-identity children list

Génère la collection d’appareils enfants affectés.

 Extension GA
az iot hub device-identity children remove

Supprimez les appareils enfants d’un appareil de périphérie cible.

 Extension GA

az iot hub device-identity children add

Ajoutez des appareils en tant qu’enfants à un appareil de périphérie cible.

az iot hub device-identity children add --child-list
                                        --device-id
                                        [--auth-type {key, login}]
                                        [--force]
                                        [--hub-name]
                                        [--login]
                                        [--resource-group]

Exemples

Ajoutez une liste séparée par l’espace des ID d’appareil en tant qu’enfants à l’appareil de périphérie cible.

az iot hub device-identity children add -d {edge_device_id} --child-list {child_device_id_1} {child_device_id_2} -n {iothub_name}

Ajoutez des appareils en tant qu’enfants à l’appareil edge et remplacez le parent existant des appareils enfants.

az iot hub device-identity children add -d {edge_device_id} --child-list {child_device_id_1} {child_device_id_2} -n {iothub_name} -f

Paramètres obligatoires

--child-list --cl

Liste des appareils enfants (espace séparé).

--device-id -d

ID de l’appareil de périphérie.

Paramètres facultatifs

--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 iothub-data-auth-type=<auth-type-value>de .

valeurs acceptées: key, login
valeur par défaut: key
--force -f

Remplace l’appareil parent de l’appareil enfant.

valeur par défaut: False
--hub-name -n

Nom ou nom d’hôte IoT Hub. Obligatoire si --login n’est pas fourni.

--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 --hub-name n’est pas fourni.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

Paramètres globaux
--debug

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

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

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

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

--subscription

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

--verbose

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

az iot hub device-identity children list

Génère la collection d’appareils enfants affectés.

az iot hub device-identity children list --device-id
                                         [--auth-type {key, login}]
                                         [--hub-name]
                                         [--login]
                                         [--resource-group]

Exemples

Répertoriez tous les appareils enfants affectés.

az iot hub device-identity children list -d {edge_device_id} -n {iothub_name}

Répertoriez tous les appareils enfants affectés dont l’ID d’appareil contient une sous-chaîne de « test ».

az iot hub device-identity children list -d {edge_device_id} -n {iothub_name} --query "[?contains(@,'test')]"

Paramètres obligatoires

--device-id -d

ID de l’appareil de périphérie.

Paramètres facultatifs

--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 iothub-data-auth-type=<auth-type-value>de .

valeurs acceptées: key, login
valeur par défaut: key
--hub-name -n

Nom ou nom d’hôte IoT Hub. Obligatoire si --login n’est pas fourni.

--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 --hub-name n’est pas fourni.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

Paramètres globaux
--debug

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

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

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

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

--subscription

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

--verbose

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

az iot hub device-identity children remove

Supprimez les appareils enfants d’un appareil de périphérie cible.

az iot hub device-identity children remove --device-id
                                           [--auth-type {key, login}]
                                           [--child-list]
                                           [--hub-name]
                                           [--login]
                                           [--remove-all]
                                           [--resource-group]

Exemples

Supprimez une liste séparée par l’espace des appareils enfants d’un appareil parent cible.

az iot hub device-identity children remove -d {edge_device_id} --child-list {space_separated_device_id} -n {iothub_name}

Supprimez tous les appareils enfants d’un appareil parent cible.

az iot hub device-identity children remove -d {edge_device_id} --remove-all

Paramètres obligatoires

--device-id -d

ID de l’appareil de périphérie.

Paramètres facultatifs

--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 iothub-data-auth-type=<auth-type-value>de .

valeurs acceptées: key, login
valeur par défaut: key
--child-list --cl

Liste des appareils enfants (espace séparé).

--hub-name -n

Nom ou nom d’hôte IoT Hub. Obligatoire si --login n’est pas fourni.

--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 --hub-name n’est pas fourni.

--remove-all -a

Pour supprimer tous les enfants.

valeur par défaut: False
--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

Paramètres globaux
--debug

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

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

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

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

--subscription

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

--verbose

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