Partager via

az iot du device group

  • Référence

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 du groupe d’appareils. En savoir plus sur les extensions.

Gestion des groupes d’appareils.

Un groupe d’appareils est une collection d’appareils. Les groupes d’appareils permettent de mettre à l’échelle des déploiements sur de nombreux appareils. Chaque appareil appartient à un seul groupe d’appareils à la fois. Un groupe d’appareils est créé automatiquement lorsqu’un appareil avec Device Update est connecté au hub et signale ses propriétés.

Commandes

Nom Description Type État
az iot du device group delete

Supprimez un groupe d’appareils.

 Extension GA
az iot du device group list

Répertorier les groupes d’appareils au sein d’une instance.

 Extension GA
az iot du device group show

Affichez des détails sur un groupe d’appareils, y compris la meilleure mise à jour et la conformité des mises à jour.

 Extension GA

az iot du device group delete

Supprimez un groupe d’appareils.

Les groupes d’appareils ne sont pas automatiquement nettoyés, mais sont conservés à des fins d’historique. Cette opération peut être utilisée s’il n’est pas nécessaire pour le groupe ou de conserver l’historique pour celui-ci. Si un appareil est connecté à nouveau pour un groupe après la suppression du groupe, il est automatiquement recréé sans historique.

az iot du device group delete --account
                              --gid
                              --instance
                              [--resource-group]
                              [--yes {false, true}]

Exemples

Supprimez un groupe d’appareils.

az iot du device group delete -n {account_name} -i {instance_name} --group-id {device_group_id}

Supprimez un groupe d’appareils en ignorant l’invite de confirmation.

az iot du device group delete -n {account_name} -i {instance_name} --group-id {device_group_id} -y

Paramètres obligatoires

--account -n

Nom du compte Device Update. Vous pouvez configurer le nom du compte par défaut à l’aide az config set defaults.adu_account=<name>de .

--gid --group-id

ID du groupe d’appareils. Cette opération est créée à partir de la valeur de la balise ADUGroup dans le jumeau d’appareil/module d’IoT Hub connecté ou $default pour les appareils sans balise.

--instance -i

Nom de l’instance Device Update. Vous pouvez configurer le nom d’instance par défaut à l’aide az config set defaults.adu_instance=<name>de .

Paramètres facultatifs

--resource-group -g

Nom du groupe de ressources du compte Device Update. Vous pouvez configurer le groupe par défaut en utilisant az config set defaults.adu_group=<name>.

--yes -y

Ignorez les invites de l’utilisateur. Indique l’acceptation de l’action. Utilisé principalement pour les scénarios d’automatisation. Valeur par défaut : false.

Valeurs acceptées: false, true
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 du device group list

Répertorier les groupes d’appareils au sein d’une instance.

az iot du device group list --account
                            --instance
                            [--order-by]
                            [--resource-group]

Exemples

Répertorier les groupes d’appareils.

az iot du device group list -n {account_name} -i {instance_name}

Répertoriez les groupes d’appareils dans un ordre souhaité, dans ce cas par deviceCount.

az iot du device group list -n {account_name} -i {instance_name} --order-by deviceCount

Paramètres obligatoires

--account -n

Nom du compte Device Update. Vous pouvez configurer le nom du compte par défaut à l’aide az config set defaults.adu_account=<name>de .

--instance -i

Nom de l’instance Device Update. Vous pouvez configurer le nom d’instance par défaut à l’aide az config set defaults.adu_instance=<name>de .

Paramètres facultatifs

--order-by

Commande l’ensemble de groupes retournés. Vous pouvez commander par groupId, deviceCount, createdDateTime, sous-groupesWithNewUpdatesAvailableCount, sous-groupesWithUpdatesInProgressCount ou sous-groupesWithOnLatestUpdateCount.

--resource-group -g

Nom du groupe de ressources du compte Device Update. Vous pouvez configurer le groupe par défaut en utilisant az config set defaults.adu_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 du device group show

Affichez des détails sur un groupe d’appareils, y compris la meilleure mise à jour et la conformité des mises à jour.

az iot du device group show --account
                            --gid
                            --instance
                            [--best-updates {false, true}]
                            [--resource-group]
                            [--update-compliance {false, true}]

Exemples

Afficher un groupe d’appareils.

az iot du device group show -n {account_name} -i {instance_name} --group-id {device_group_id}

Affichez les meilleures mises à jour disponibles pour un groupe d’appareils. Cet indicateur modifie la commande pour renvoyer une liste.

az iot du device group show -n {account_name} -i {instance_name} --group-id {device_group_id} --best-updates

Afficher la conformité des mises à jour pour un groupe d’appareils.

az iot du device group show -n {account_name} -i {instance_name} --group-id {device_group_id} --update-compliance

Paramètres obligatoires

--account -n

Nom du compte Device Update. Vous pouvez configurer le nom du compte par défaut à l’aide az config set defaults.adu_account=<name>de .

--gid --group-id

ID du groupe d’appareils. Cette opération est créée à partir de la valeur de la balise ADUGroup dans le jumeau d’appareil/module d’IoT Hub connecté ou $default pour les appareils sans balise.

--instance -i

Nom de l’instance Device Update. Vous pouvez configurer le nom d’instance par défaut à l’aide az config set defaults.adu_instance=<name>de .

Paramètres facultatifs

--best-updates

Indicateur indiquant que la commande doit récupérer les meilleures mises à jour disponibles pour le groupe d’appareils, y compris le nombre d’appareils dont chaque mise à jour a besoin. Une mise à jour optimale est la dernière mise à jour qui répond à toutes les spécifications de compatibilité d’une classe d’appareil.

Valeurs acceptées: false, true
--resource-group -g

Nom du groupe de ressources du compte Device Update. Vous pouvez configurer le groupe par défaut en utilisant az config set defaults.adu_group=<name>.

--update-compliance

Indicateur indiquant que la commande doit récupérer les informations de conformité de mise à jour du groupe d’appareils, telles que le nombre d’appareils sur leur dernière mise à jour, le nombre de nouvelles mises à jour et le nombre en cours de réception d’une nouvelle mise à jour.

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