az iot du device class
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 du device class command. Apprenez-en davantage sur les extensions.
Gestion des sous-groupes de classes d’appareils et de classe d’appareil.
Une classe d’appareil décrit un ensemble d’appareils qui partagent un ensemble commun d’attributs entre les groupes, tandis qu’un sous-groupe de classes d’appareils est un sous-ensemble d’appareils d’un groupe qui partagent le même ID de classe d’appareil. Les classes d’appareil sont créées automatiquement lorsque les appareils avec Device Update sont connectés au hub.
Commandes
| Nom | Description | Type | État |
|---|---|---|---|
| az iot du device class delete |
Supprimez un sous-groupe de classes d’appareil ou de classe d’appareil. |
Extension | GA |
| az iot du device class list |
Répertorier les classes d’appareils ou les sous-groupes de classes d’appareils. |
Extension | GA |
| az iot du device class show |
Affichez des détails sur une classe d’appareil ou un sous-groupe de classes d’appareil, y compris les mises à jour installables, la meilleure mise à jour et la conformité des mises à jour. |
Extension | GA |
| az iot du device class update |
Mettez à jour une classe d’appareil. |
Extension | GA |
az iot du device class delete
Supprimez un sous-groupe de classes d’appareil ou de classe d’appareil.
Les classes d’appareil sont créées automatiquement lorsque les appareils activés pour Device Update sont connectés au hub, mais ne sont pas automatiquement nettoyés, car ils sont référencés par les sous-groupes de classes d’appareils. Si tous les sous-groupes de classes d’appareil pour une classe d’appareil cible sont supprimés, la classe d’appareil elle-même peut également être supprimée pour supprimer les enregistrements du système et arrêter de vérifier la compatibilité de la classe d’appareil avec de nouvelles mises à jour. Si un appareil est jamais reconnecté, sa classe d’appareil est recréée s’il n’existe pas.
az iot du device class delete --account
--cid --class-id
--instance
[--gid --group-id]
[--resource-group]
[--yes {false, true}]
Exemples
Supprimez une classe d’appareil.
az iot du device class delete -n {account_name} -i {instance_name} --class-id {device_class_id}
Supprimez une classe d’appareil et ignorez l’invite de confirmation.
az iot du device class delete -n {account_name} -i {instance_name} --class-id {device_class_id} -y
Supprimez un sous-groupe de classes d’appareil.
az iot du device class delete -n {account_name} -i {instance_name} --class-id {device_class_id} --group-id {device_group_id}
Paramètres obligatoires
Nom du compte Device Update. Vous pouvez configurer le nom du compte par défaut à l’aide de az config set defaults.adu_account={name}.
| Propriété | Valeur |
|---|---|
| Groupe de paramètres: | Account Identifier Arguments |
ID de classe d’appareil. Cela est généré à partir de l’ID de modèle et des propriétés de compatibilité signalées par l’agent de mise à jour d’appareil dans l’interface PnP device Update dans IoT Hub. Il s’agit d’un hachage SHA1 codé en hexadécimal.
Nom de l’instance Device Update. Vous pouvez configurer le nom d’instance par défaut à l’aide de az config set defaults.adu_instance={name}.
| Propriété | Valeur |
|---|---|
| Groupe de paramètres: | Account Identifier Arguments |
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.
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.
Nom du groupe de ressources du compte Device Update. Vous pouvez configurer le groupe par défaut à l’aide de az config set defaults.adu_group={name}.
| Propriété | Valeur |
|---|---|
| Groupe de paramètres: | Account Identifier Arguments |
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.
| Propriété | Valeur |
|---|---|
| Valeurs acceptées: | false, true |
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 du device class list
Répertorier les classes d’appareils ou les sous-groupes de classes d’appareils.
az iot du device class list --account
--instance
[--filter]
[--gid --group-id]
[--resource-group]
Exemples
Répertorier les classes d’appareil au sein d’une instance.
az iot du device class list -n {account_name} -i {instance_name}
Répertorier les classes d’appareils d’instance filtrées par nom convivial.
az iot du device class list -n {account_name} -i {instance_name} --filter "friendlyName eq 'my-favorite-class'"
Répertorier les sous-groupes de classes d’appareils pour le groupe.
az iot du device class list -n {account_name} -i {instance_name} --group-id {device_group_id}
Répertorier les sous-groupes de classes d’appareils pour le groupe, filtrés par compatProperties/manufacturer.
az iot du device class list -n {account_name} -i {instance_name} --group-id {device_group_id} --filter "compatProperties/manufacturer eq 'Contoso'"
Paramètres obligatoires
Nom du compte Device Update. Vous pouvez configurer le nom du compte par défaut à l’aide de az config set defaults.adu_account={name}.
| Propriété | Valeur |
|---|---|
| Groupe de paramètres: | Account Identifier Arguments |
Nom de l’instance Device Update. Vous pouvez configurer le nom d’instance par défaut à l’aide de az config set defaults.adu_instance={name}.
| Propriété | Valeur |
|---|---|
| Groupe de paramètres: | Account Identifier Arguments |
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.
S’il est fourni avec --group-id, prend en charge le filtrage en fonction des noms et valeurs des propriétés compat de classe d’appareil. Par exemple, « compatProperties/manufacturer eq 'Contoso' ». Sinon, prend en charge le filtrage par nom convivial de classe.
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.
Nom du groupe de ressources du compte Device Update. Vous pouvez configurer le groupe par défaut à l’aide de az config set defaults.adu_group={name}.
| Propriété | Valeur |
|---|---|
| Groupe de paramètres: | Account Identifier 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 du device class show
Affichez des détails sur une classe d’appareil ou un sous-groupe de classes d’appareil, y compris les mises à jour installables, la meilleure mise à jour et la conformité des mises à jour.
az iot du device class show --account
--cid --class-id
--instance
[--best-update {false, true}]
[--gid --group-id]
[--installable-updates {false, true}]
[--resource-group]
[--update-compliance {false, true}]
Exemples
Afficher une classe d’appareil.
az iot du device class show -n {account_name} -i {instance_name} --class-id {device_class_id}
Afficher les mises à jour installables pour la classe d’appareil. Cet indicateur modifie la commande pour renvoyer une liste.
az iot du device class show -n {account_name} -i {instance_name} --class-id {device_class_id} --installable-updates
Afficher un sous-groupe de classes d’appareil.
az iot du device class show -n {account_name} -i {instance_name} --class-id {device_class_id} --group-id {device_group_id}
Affichez la meilleure mise à jour disponible pour un sous-groupe de classes d’appareils.
az iot du device class show -n {account_name} -i {instance_name} --class-id {device_class_id} --group-id {device_group_id} --best-update
Afficher la conformité des mises à jour pour un sous-groupe de classes d’appareil.
az iot du device class show -n {account_name} -i {instance_name} --class-id {device_class_id} --group-id {device_group_id} --update-compliance
Paramètres obligatoires
Nom du compte Device Update. Vous pouvez configurer le nom du compte par défaut à l’aide de az config set defaults.adu_account={name}.
| Propriété | Valeur |
|---|---|
| Groupe de paramètres: | Account Identifier Arguments |
ID de classe d’appareil. Cela est généré à partir de l’ID de modèle et des propriétés de compatibilité signalées par l’agent de mise à jour d’appareil dans l’interface PnP device Update dans IoT Hub. Il s’agit d’un hachage SHA1 codé en hexadécimal.
Nom de l’instance Device Update. Vous pouvez configurer le nom d’instance par défaut à l’aide de az config set defaults.adu_instance={name}.
| Propriété | Valeur |
|---|---|
| Groupe de paramètres: | Account Identifier Arguments |
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.
Indicateur indiquant que la commande doit récupérer la meilleure mise à jour disponible pour le sous-groupe de classes d’appareils, y compris le nombre d’appareils dont la mise à jour est nécessaire. L’ID de groupe est requis pour cet indicateur. Une mise à jour optimale est la dernière mise à jour qui répond à toutes les spécifications de compatibilité d’une classe d’appareil.
| Propriété | Valeur |
|---|---|
| Groupe de paramètres: | Update Arguments |
| Valeurs acceptées: | false, true |
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.
Indicateur indiquant que la commande doit récupérer les mises à jour installables pour la classe d’appareil.
| Propriété | Valeur |
|---|---|
| Groupe de paramètres: | Update Arguments |
| Valeurs acceptées: | false, true |
Nom du groupe de ressources du compte Device Update. Vous pouvez configurer le groupe par défaut à l’aide de az config set defaults.adu_group={name}.
| Propriété | Valeur |
|---|---|
| Groupe de paramètres: | Account Identifier Arguments |
Indicateur indiquant que la commande doit récupérer les informations de conformité des mises à jour du sous-groupe de classes d’appareil, telles que le nombre d’appareils sur leur dernière mise à jour, le nombre de nouvelles mises à jour nécessaires et le nombre en cours de réception d’une nouvelle mise à jour. L’ID de groupe est requis pour cet indicateur.
| Propriété | Valeur |
|---|---|
| Groupe de paramètres: | Update Arguments |
| Valeurs acceptées: | false, true |
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 du device class update
Mettez à jour une classe d’appareil.
az iot du device class update --account
--cid --class-id
--instance
[--friendly-name]
[--resource-group]
Exemples
Mettez à jour le nom convivial de la classe d’appareil.
az iot du device class update -n {account_name} -i {instance_name} --class-id {device_class_id} --friendly-name "EU-region"
Paramètres obligatoires
Nom du compte Device Update. Vous pouvez configurer le nom du compte par défaut à l’aide de az config set defaults.adu_account={name}.
| Propriété | Valeur |
|---|---|
| Groupe de paramètres: | Account Identifier Arguments |
ID de classe d’appareil. Cela est généré à partir de l’ID de modèle et des propriétés de compatibilité signalées par l’agent de mise à jour d’appareil dans l’interface PnP device Update dans IoT Hub. Il s’agit d’un hachage SHA1 codé en hexadécimal.
Nom de l’instance Device Update. Vous pouvez configurer le nom d’instance par défaut à l’aide de az config set defaults.adu_instance={name}.
| Propriété | Valeur |
|---|---|
| Groupe de paramètres: | Account Identifier Arguments |
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.
Nom convivial de la classe d’appareil. Le nom convivial doit être de 1 à 100 caractères et prend en charge les valeurs alphanumériques, points et tirets.
Nom du groupe de ressources du compte Device Update. Vous pouvez configurer le groupe par défaut à l’aide de az config set defaults.adu_group={name}.
| Propriété | Valeur |
|---|---|
| Groupe de paramètres: | Account Identifier 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 |