Partager via

az iot du instance

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

Gestion des instances de mise à jour d’appareil.

Commandes

Nom Description Type État
az iot du instance create

Créez une instance Device Update.

 Extension GA
az iot du instance delete

Supprimez une instance device Update.

 Extension GA
az iot du instance list

Répertorier les instances device Update.

 Extension GA
az iot du instance show

Afficher une instance Device Update.

 Extension GA
az iot du instance update

Mettez à jour une instance device Update.

 Extension GA
az iot du instance wait

Bloquer jusqu’à ce qu’un état de ressource d’instance souhaité soit atteint.

 Extension GA

az iot du instance create

Créez une instance Device Update.

Cette commande peut également être utilisée pour mettre à jour l’état d’une instance existante.

az iot du instance create --account
                          --instance
                          --iothub-ids
                          [--diagnostics-storage-id]
                          [--enable-diagnostics {false, true}]
                          [--no-wait]
                          [--resource-group]
                          [--tags]

Exemples

Créez une instance avec une configuration minimale.

az iot du instance create -n {account_name} -i {instance_name} --iothub-ids {iothub_resource_id}

Créez une instance avec diagnostics activés, jumelés à un compte de stockage fourni par l’utilisateur. Inclure des balises.

az iot du instance create -n {account_name} -i {instance_name} --iothub-ids {iothub_resource_id} --enable-diagnostics --diagnostics-storage-id {storage_account_resource_id} --tags a=b

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 .

--iothub-ids

ID de ressource IoT Hub séparés par l’espace.

Paramètres facultatifs

--diagnostics-storage-id

ID de ressource de compte de stockage fourni par l’utilisateur pour une utilisation dans la collecte des journaux de diagnostic.

--enable-diagnostics

Active la collecte des journaux de diagnostic.

Valeurs acceptées: false, true
--no-wait

Ne pas attendre la fin de l’opération de longue durée.

Valeur par défaut: False
--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>.

--tags

Balises de ressource. Conteneur de propriétés dans des paires clé-valeur au format suivant : a=b c=d.

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

Supprimez une instance device Update.

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

Exemples

Supprimez une instance associée au compte cible.

az iot du instance delete -n {account_name} -i {instance_name}

Supprimez une instance associée au compte cible et ignorez l’invite de confirmation.

az iot du instance delete -n {account_name} -i {instance_name} -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 .

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

--no-wait

Ne pas attendre la fin de l’opération de longue durée.

Valeur par défaut: False
--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 instance list

Répertorier les instances device Update.

az iot du instance list --account
                        [--resource-group]

Exemples

Répertorier les instances associées au compte cible.

az iot du instance list -n {account_name}

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 .

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

Afficher une instance Device Update.

az iot du instance show --account
                        --instance
                        [--resource-group]

Exemples

Affichez les détails d’une instance associée au compte cible.

az iot du instance show -n {account_name} -i {instance_name}

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

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

Mettez à jour une instance device Update.

Actuellement, les propriétés d’instance suivantes peuvent être mises à jour : iotHubs, enableDiagnostics, diagnosticStorageProperties et balises.

az iot du instance update --account
                          --instance
                          [--add]
                          [--force-string]
                          [--no-wait]
                          [--remove]
                          [--resource-group]
                          [--set]

Exemples

Définissez un attribut d’étiquette d’instance spécifique.

az iot du instance update -n {account_name} -i {instance_name} --set tags.env='test'

Activez les diagnostics et configurez un compte de stockage pour la collecte de journaux.

az iot du instance update -n {account_name} -i {instance_name} --set enableDiagnostics=true diagnosticStorageProperties.resourceId={storage_account_resource_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 .

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

--add

Ajoutez un objet à une liste d’objets en spécifiant un chemin d’accès et des paires clé-valeur. Exemple : --add property.listProperty <key=value, string or JSON string>.

Valeur par défaut: []
--force-string

Lorsque vous utilisez « set » ou « add », conservez les littéraux de chaîne au lieu de tenter de convertir en JSON.

Valeur par défaut: False
--no-wait

Ne pas attendre la fin de l’opération de longue durée.

Valeur par défaut: False
--remove

Supprimez une propriété ou un élément d’une liste. Exemple : --remove property.list <indexToRemove> OR --remove propertyToRemove.

Valeur par défaut: []
--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>.

--set

Mettez à jour un objet en spécifiant un chemin d’accès et une valeur de propriété à définir. Exemple : --set property1.property2=<value>.

Valeur par défaut: []
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 instance wait

Bloquer jusqu’à ce qu’un état de ressource d’instance souhaité soit atteint.

az iot du instance wait --account
                        --instance
                        [--created]
                        [--custom]
                        [--deleted]
                        [--exists]
                        [--interval]
                        [--resource-group]
                        [--timeout]
                        [--updated]

Exemples

Bloquer jusqu’à ce que l’instance cible ait été supprimée.

az iot du instance wait -n {account_name} -i {instance_name} --deleted

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

--created

Attendez la création avec « provisioningState » sur « Succeeded ».

Valeur par défaut: False
--custom

Attendez que la condition réponde à une requête JMESPath personnalisée. Par exemple, provisioningState !='InProgress', instanceView.statuses[ ?code=='PowerState/running'].

--deleted

Attendez la suppression.

Valeur par défaut: False
--exists

Attendez que la ressource existe.

Valeur par défaut: False
--interval

Intervalle d’interrogation en secondes.

Valeur par défaut: 30
--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>.

--timeout

Délai maximal d’attente en secondes.

Valeur par défaut: 3600
--updated

Attendez la mise à jour avec provisioningState sur « Réussi ».

Valeur par défaut: False
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.