az iot du device deployment

  • 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 du device deployment . En savoir plus sur les extensions.

Gestion du déploiement d’appareils.

Les déploiements appliquent une mise à jour compatible souhaitée sur un groupe d’appareils cible distribuant la mise à jour entre les classes d’appareils au sein du groupe. La stratégie de restauration initiée par le cloud peut éventuellement être configurée.

Commandes

Nom Description Type Statut
az iot du device deployment cancel

Annulez un déploiement d’un sous-groupe de classes d’appareils.

 Extension GA
az iot du device deployment create

Créez un déploiement pour un groupe d’appareils. Le déploiement sera multi-cast sur chaque sous-groupe de classes d’appareils au sein du groupe cible.

 Extension GA
az iot du device deployment delete

Supprimez un déploiement par groupe d’appareils ou sous-groupe de classes d’appareils.

 Extension GA
az iot du device deployment list

Répertorier les déploiements d’un groupe d’appareils ou d’un sous-groupe de classes d’appareils.

 Extension GA
az iot du device deployment list-devices

Répertorier les appareils d’un déploiement de sous-groupes de classes d’appareils, ainsi que leur état. Utile pour obtenir la liste des appareils ayant échoué.

 Extension GA
az iot du device deployment retry

Réessayez un déploiement de sous-groupe de classes d’appareils.

 Extension GA
az iot du device deployment show

Afficher un déploiement pour un groupe d’appareils ou un sous-groupe de classes d’appareils, y compris l’état qui détaille le nombre d’appareils dans le déploiement en cours, terminés ou ayant échoué.

 Extension GA

az iot du device deployment cancel

Annulez un déploiement d’un sous-groupe de classes d’appareils.

az iot du device deployment cancel --account
                                   --cid
                                   --deployment-id
                                   --gid
                                   --instance
                                   [--resource-group]

Exemples

Annulez le déploiement du sous-groupe de classes d’appareils cible.

az iot du device deployment cancel -n {account_name} -i {instance_name} --deployment-id {deployment_id} --group-id {device_group_id} --class-id {device_class_id}

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 .

--cid --class-id

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.

--deployment-id --did

ID de déploiement fourni par l’appelant. Cela ne peut pas comporter plus de 73 caractères, doit être tout en minuscules et ne peut pas contenir '&', '^', '[', ']', '{', '}', '|', '<', '>', barre oblique, barre oblique, barre oblique inverse ou guillemet double.

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

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

Créez un déploiement pour un groupe d’appareils. Le déploiement sera multi-cast sur chaque sous-groupe de classes d’appareils au sein du groupe cible.

az iot du device deployment create --account
                                   --deployment-id
                                   --gid
                                   --instance
                                   --un
                                   --up
                                   --update-version
                                   [--failed-count]
                                   [--failed-percentage]
                                   [--rbun]
                                   [--rbup]
                                   [--rbuv]
                                   [--resource-group]
                                   [--start-time]

Exemples

Créez un déploiement de groupe d’appareils planifié pour démarrer immédiatement (par rapport à l’heure UTC).

az iot du device deployment create -n {account_name} -i {instance_name} --group-id {device_group_id} --deployment-id {deployment_id} --update-name {update_name} --update-provider {update_provider} --update-version {update_version}

Créez un déploiement de groupe d’appareils planifié pour démarrer sur une datetime conforme iso-8601 souhaitée.

az iot du device deployment create -n {account_name} -i {instance_name} --group-id {device_group_id} --deployment-id {deployment_id} --update-name {update_name} --update-provider {update_provider} --update-version {update_version} --start-time "2022-12-20T01:00:00"

Créez un déploiement de groupe d’appareils planifié pour démarrer immédiatement avec une stratégie de restauration initiée par le cloud définie. La restauration cloud est lancée lorsque le nombre d’échecs ou les cibles de pourcentage ayant échoué sont remplies.

az iot du device deployment create -n {account_name} -i {instance_name} --group-id {device_group_id} --deployment-id {deployment_id} --update-name {update_name} --update-provider {update_provider} --update-version {update_version} --failed-count 10 --failed-percentage 5 --rollback-update-name {rollback_update_name} --rollback-update-provider {rollback_update_provider} --rollback-update-version {rollback_update_version}

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 .

--deployment-id --did

ID de déploiement fourni par l’appelant. Cela ne peut pas comporter plus de 73 caractères, doit être tout en minuscules et ne peut pas contenir '&', '^', '[', ']', '{', '}', '|', '<', '>', barre oblique, barre oblique, barre oblique inverse ou guillemet double.

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

--un --update-name

Nom de la mise à jour.

--up --update-provider

Fournisseur de mise à jour.

--update-version --uv

Version de mise à jour.

Paramètres facultatifs

--failed-count --fc

Entier représentant le nombre d’appareils ayant échoué dans un déploiement avant qu’une restauration initée dans le cloud ne se produise. Obligatoire lors de la définition de la stratégie de restauration.

--failed-percentage --fp

Entier représentant le pourcentage d’appareils ayant échoué dans un déploiement avant qu’une restauration initée dans le cloud ne se produise. Obligatoire lors de la définition de la stratégie de restauration.

--rbun --rollback-update-name

Nom de la mise à jour de restauration.

--rbup --rollback-update-provider

Fournisseur de mise à jour de restauration.

--rbuv --rollback-update-version

Version de mise à jour de restauration.

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

--start-time

Heure de début conforme iso-8601 pour le déploiement. Si aucune valeur n’est fournie, la valeur correspondante pour UTC 'now' est utilisée.

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

Supprimez un déploiement par groupe d’appareils ou sous-groupe de classes d’appareils.

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

Exemples

Supprimez le déploiement du groupe d’appareils cible.

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

Supprimez le déploiement du sous-groupe de classes d’appareils cible.

az iot du device deployment delete -n {account_name} -i {instance_name} --deployment-id {deployment_id} --group-id {device_group_id} --class-id {device_class_id}

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 .

--deployment-id --did

ID de déploiement fourni par l’appelant. Cela ne peut pas comporter plus de 73 caractères, doit être tout en minuscules et ne peut pas contenir '&', '^', '[', ']', '{', '}', '|', '<', '>', barre oblique, barre oblique, barre oblique inverse ou guillemet double.

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

--cid --class-id

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.

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

Répertorier les déploiements d’un groupe d’appareils ou d’un sous-groupe de classes d’appareils.

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

Exemples

Répertorier les déploiements d’un groupe d’appareils.

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

Répertorier les déploiements d’un groupe d’appareils triant les résultats en décroissant startDateTime.

az iot du device deployment list -n {account_name} -i {instance_name} --group-id {device_group_id} --order-by "startDateTime desc"

Répertorier les déploiements pour un sous-groupe de classes d’appareils.

az iot du device deployment list -n {account_name} -i {instance_name} --group-id {device_group_id} --class-id {device_class_id}

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

--cid --class-id

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.

--order-by

Commande l’ensemble des déploiements retournés. Vous pouvez commander par startDateTime [desc/asc].

--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 deployment list-devices

Répertorier les appareils d’un déploiement de sous-groupes de classes d’appareils, ainsi que leur état. Utile pour obtenir la liste des appareils ayant échoué.

az iot du device deployment list-devices --account
                                         --cid
                                         --deployment-id
                                         --gid
                                         --instance
                                         [--filter]
                                         [--resource-group]

Exemples

Répertorier les appareils dans un déploiement de sous-groupes de classes d’appareils.

az iot du device deployment list-devices -n {account_name} -i {instance_name} --group-id {device_group_id} --class-id {device_class_id} --deployment-id {deployment_id}

Répertorier les appareils d’un sous-groupe de classe d’appareil filtrant le filtrage par deviceId et deviceState.

az iot du device deployment list-devices -n {account_name} -i {instance_name} --group-id {device_group_id} --class-id {device_class_id} --deployment-id {deployment_id} --filter "deviceId eq 'd0' and deviceState eq 'InProgress'"

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 .

--cid --class-id

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.

--deployment-id --did

ID de déploiement fourni par l’appelant. Cela ne peut pas comporter plus de 73 caractères, doit être tout en minuscules et ne peut pas contenir '&', '^', '[', ']', '{', '}', '|', '<', '>', barre oblique, barre oblique, barre oblique inverse ou guillemet double.

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

--filter

Limite l’ensemble des états d’appareil de déploiement retournés. Vous pouvez filtrer sur deviceId et moduleId et/ou deviceState.

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

Réessayez un déploiement de sous-groupe de classes d’appareils.

az iot du device deployment retry --account
                                  --cid
                                  --deployment-id
                                  --gid
                                  --instance
                                  [--resource-group]

Exemples

Réessayez le déploiement du sous-groupe de classes d’appareils cibles.

az iot du device deployment retry -n {account_name} -i {instance_name} --deployment-id {deployment_id} --group-id {device_group_id} --class-id {device_class_id}

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 .

--cid --class-id

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.

--deployment-id --did

ID de déploiement fourni par l’appelant. Cela ne peut pas comporter plus de 73 caractères, doit être tout en minuscules et ne peut pas contenir '&', '^', '[', ']', '{', '}', '|', '<', '>', barre oblique, barre oblique, barre oblique inverse ou guillemet double.

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

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

Afficher un déploiement pour un groupe d’appareils ou un sous-groupe de classes d’appareils, y compris l’état qui détaille le nombre d’appareils dans le déploiement en cours, terminés ou ayant échoué.

az iot du device deployment show --account
                                 --deployment-id
                                 --gid
                                 --instance
                                 [--cid]
                                 [--resource-group]
                                 [--status {false, true}]

Exemples

Afficher un déploiement pour un groupe d’appareils.

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

Afficher l’état d’un déploiement de groupe d’appareils.

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

Afficher un déploiement pour un sous-groupe de classes d’appareils.

az iot du device deployment show -n {account_name} -i {instance_name} --group-id {device_group_id} --class-id {device_class_id} --deployment-id {deployment_id}

Afficher l’état d’un déploiement de sous-groupes de classes d’appareils.

az iot du device deployment show -n {account_name} -i {instance_name} --group-id {device_group_id} --class-id {device_class_id} --deployment-id {deployment_id} --status

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 .

--deployment-id --did

ID de déploiement fourni par l’appelant. Cela ne peut pas comporter plus de 73 caractères, doit être tout en minuscules et ne peut pas contenir '&', '^', '[', ']', '{', '}', '|', '<', '>', barre oblique, barre oblique, barre oblique inverse ou guillemet double.

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

--cid --class-id

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.

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

--status

Obtient l’état d’un déploiement, y compris la répartition du nombre d’appareils dans le déploiement en cours, terminés ou ayant échoué.

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.