az iot edge deployment

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

Gérer les déploiements IoT Edge à grande échelle.

Commandes

Nom Description Type État
az iot edge deployment create

Créez un déploiement IoT Edge dans un hub IoT cible.

 Extension GA
az iot edge deployment delete

Supprimez un déploiement IoT Edge.

 Extension GA
az iot edge deployment list

Répertorier les déploiements IoT Edge dans un IoT Hub.

 Extension GA
az iot edge deployment show

Obtenez les détails d’un déploiement IoT Edge.

 Extension GA
az iot edge deployment show-metric

Évaluez une métrique système cible définie dans un déploiement IoT Edge.

 Extension GA
az iot edge deployment update

Mettez à jour les propriétés spécifiées d’un déploiement IoT Edge.

 Extension GA

az iot edge deployment create

Créez un déploiement IoT Edge dans un hub IoT cible.

Le contenu du déploiement est json et sous la forme de {"modulesContent » :{...}} ou {"content » :{"modulesContent » :{...}}}.

Par défaut, les propriétés des modules système $edgeAgent et $edgeHub sont validées par rapport aux schémas installés avec l’extension IoT. Cette validation est destinée aux déploiements de base. Si le schéma correspondant n’est pas disponible ou si le format de déploiement de base n’est pas détecté, cette étape est ignorée. La validation de schéma peut être désactivée à l’aide du commutateur --no-validation.

Un déploiement de périphérie est classé en tant que couche si un module a des propriétés.souhaitées.* défini. Tout appareil edge ciblé par un déploiement en couches a tout d’abord besoin d’un déploiement de base appliqué à celui-ci.

Tous les déploiements en couches ciblant un appareil doivent avoir une priorité plus élevée que le déploiement de base pour cet appareil.

Remarque : Si le champ properties.souhaité d’un jumeau de module est défini dans un déploiement en couches, properties.desired remplace les propriétés souhaitées pour ce module dans les déploiements de priorité inférieure.

az iot edge deployment create --content
                              --deployment-id
                              [--auth-type {key, login}]
                              [--cl]
                              [--cmq]
                              [--hub-name]
                              [--lab]
                              [--layered {false, true}]
                              [--login]
                              [--metrics]
                              [--no-validation {false, true}]
                              [--pri]
                              [--resource-group]
                              [--target-condition]

Exemples

Créez un déploiement avec des étiquettes (exemple de syntaxe bash) qui s’applique aux appareils dans « building 9 » et l’environnement est « test ».

az iot edge deployment create -d {deployment_name} -n {iothub_name} --content ./modules_content.json --labels '{"key0":"value0", "key1":"value1"}' --target-condition "tags.building=9 and tags.environment='test'" --priority 3

Créez un déploiement avec des étiquettes (exemple de syntaxe PowerShell) qui s’applique aux appareils marqués avec l’environnement « dev ».

az iot edge deployment create -d {deployment_name} -n {iothub_name} --content ./modules_content.json --labels "{'key':'value'}" --target-condition "tags.environment='dev'"

Créez un déploiement en couches qui s’applique aux appareils marqués avec l’environnement « dev ». Les métriques utilisateur et le contenu des modules définis en ligne (exemple de syntaxe PowerShell). Notez qu’il s’agit d’un format de déploiement en couches tel que properties.desired.* a été défini.

az iot edge deployment create -d {deployment_name} -n {iothub_name} --content "{'modulesContent':{'`$edgeAgent':{
  'properties.desired.modules.mymodule0':{ }},'`$edgeHub':{'properties.desired.routes.myroute0':'FROM /messages/* INTO `$upstream'}}}"
--target-condition "tags.environment='dev'" --priority 10 --metrics "{'queries':{'mymetrik':'SELECT deviceId from devices where properties.reported.lastDesiredStatus.code = 200'}}"

Créez un déploiement en couches qui s’applique aux appareils dans « building 9 » et à l’environnement « test ». Les métriques utilisateur et le contenu des modules définis en ligne (exemple de syntaxe bash). Notez qu’il s’agit d’un format de déploiement en couches tel que properties.desired.* a été défini.

az iot edge deployment create -d {deployment_name} -n {iothub_name} --content '{"modulesContent":{"$edgeAgent":{"properties.desired.modules.mymodule0":{ }},"$edgeHub":{"properties.desired.routes.myroute0":"FROM /messages/* INTO $upstream"}}}' --target-condition "tags.building=9 and tags.environment='test'" --metrics '{"queries":{"mymetrik":"SELECT deviceId from devices where properties.reported.lastDesiredStatus.code = 200"}}'

Créez un déploiement qui s’applique aux appareils dans « building 9 » et à l’environnement « test ». Les métriques utilisateur et le contenu des modules définis à partir du fichier.

az iot edge deployment create -d {deployment_name} -n {iothub_name} --content ./modules_content.json --target-condition "tags.building=9 and tags.environment='test'" --metrics ./metrics_content.json

Créez un déploiement dont la définition provient d’un fichier avec une entrée indépendante de l’interpréteur de commandes des étiquettes et des métriques.

az iot edge deployment create -d {deployment_name} -n {iothub_name} --content ./modules_content.json --target-condition "tags.building=9 and tags.environment='test'" --custom-labels key0=value0 key1=value1 --custom-metric-queries mymetric1="select deviceId from devices where tags.location='US'" mymetric2="select *"

Paramètres obligatoires

--content -k

Contenu du déploiement IoT Edge. Fournissez le chemin d’accès au fichier ou json brut.

--deployment-id -d

Nom du déploiement cible. Les minuscules et les caractères spéciaux suivants sont autorisés : [-+%_* !'].

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
--cl --custom-labels

Un autre style d’entrée (paires clé=valeur séparées par espace) pour --labels et destiné à le remplacer ultérieurement. Exemple de format : key1=value1 key2="this is my value ».

--cmq --custom-metric-queries

Style d’entrée alternatif (paires clé=valeur séparées par espace) pour --metrics et destiné à le remplacer ultérieurement. Exemple de format : metric1="select deviceId from devices where tags.location='US' » metric2="select * ».

--hub-name -n

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

--lab --labels

Mappage des étiquettes à appliquer au déploiement cible. Utilisez le format suivant : « {"key0 » :"value0 », « key1 » :"value1"}'. L’utilisation de --custom-labels au lieu de --labels est recommandée.

--layered

Les déploiements en couches vous permettent de définir les propriétés souhaitées dans $edgeAgent, $edgeHub et les modules utilisateur qui couchent sur un déploiement de base. Les propriétés spécifiées dans un déploiement en couches fusionnent avec les propriétés du déploiement de base. Les propriétés avec le même chemin d’accès seront remplacées en fonction de la priorité de déploiement. Cette option est un alias pour --no-validation.

Valeurs acceptées: false, true
Valeur par défaut: False
--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.

--metrics -m

Définitions de métriques utilisateur de déploiement IoT Edge. Fournissez le chemin d’accès au fichier ou json brut. Les métriques utilisateur sont sous la forme de {"requêtes » :{...}} ou {"metrics » :{"queries » :{...}}}. L’utilisation de requêtes --custom-metric-au lieu de --metrics est recommandée.

--no-validation

Désactive la validation de schéma côté client pour la création d’un déploiement edge.

Valeurs acceptées: false, true
Valeur par défaut: False
--pri --priority

Poids du déploiement en cas de règles concurrentes (victoires les plus élevées).

Valeur par défaut: 0
--resource-group -g

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

--target-condition --tc -t

Condition cible dans laquelle un déploiement edge s’applique. Les déploiements sans condition cible cible ciblent aucun appareil. Utilisez le format suivant : « tags.environment='test ».

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

Supprimez un déploiement IoT Edge.

az iot edge deployment delete --deployment-id
                              [--auth-type {key, login}]
                              [--etag]
                              [--hub-name]
                              [--login]
                              [--resource-group]

Paramètres obligatoires

--deployment-id -d

Nom du déploiement cible. Les minuscules et les caractères spéciaux suivants sont autorisés : [-+%_* !'].

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

Étiquette d’entité ou etag correspondant au dernier état de la ressource. Si aucun etag n’est fourni, la valeur '*' est utilisée.

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

Répertorier les déploiements IoT Edge dans un IoT Hub.

az iot edge deployment list [--auth-type {key, login}]
                            [--hub-name]
                            [--login]
                            [--resource-group]
                            [--top]

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

--top

Nombre maximal de déploiements à retourner. Par défaut, tous les déploiements sont retournés.

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

Obtenez les détails d’un déploiement IoT Edge.

az iot edge deployment show --deployment-id
                            [--auth-type {key, login}]
                            [--hub-name]
                            [--login]
                            [--resource-group]

Paramètres obligatoires

--deployment-id -d

Nom du déploiement cible. Les minuscules et les caractères spéciaux suivants sont autorisés : [-+%_* !'].

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

Évaluez une métrique système cible définie dans un déploiement IoT Edge.

az iot edge deployment show-metric --deployment-id
                                   --metric-id
                                   [--auth-type {key, login}]
                                   [--hub-name]
                                   [--login]
                                   [--metric-type {system, user}]
                                   [--resource-group]

Exemples

Évaluer la métrique système « appliedCount »

az iot edge deployment show-metric -m appliedCount -d {deployment_name} -n {iothub_name} --mt system

Évaluer la métrique utilisateur « myCustomMetric »

az iot edge deployment show-metric -m myCustomMetric -d {deployment_name} -n {iothub_name}

Paramètres obligatoires

--deployment-id -d

Nom du déploiement cible. Les minuscules et les caractères spéciaux suivants sont autorisés : [-+%_* !'].

--metric-id -m

Métrique cible pour l’évaluation.

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.

--metric-type --mt

Indique la collection de métriques à utiliser pour rechercher une métrique.

Valeurs acceptées: system, user
Valeur par défaut: user
--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 edge deployment update

Mettez à jour les propriétés spécifiées d’un déploiement IoT Edge.

Utilisez --set suivi des affectations de propriétés pour la mise à jour d’un déploiement.

Remarque : Le contenu du déploiement IoT Edge est immuable. Les propriétés de déploiement qui peuvent être mises à jour sont « étiquettes », « métriques », « priority » et « targetCondition ».

az iot edge deployment update --deployment-id
                              [--add]
                              [--auth-type {key, login}]
                              [--etag]
                              [--force-string]
                              [--hub-name]
                              [--login]
                              [--remove]
                              [--resource-group]
                              [--set]

Exemples

Modifier les étiquettes et la condition cible d’un déploiement edge existant

az iot edge deployment update -d {deployment_name} -n {iothub_name} --set labels='{"purpose":"dev", "owners":"IoTEngineering"}' targetCondition='tags.building=9'

Paramètres obligatoires

--deployment-id -d

Nom du déploiement cible. Les minuscules et les caractères spéciaux suivants sont autorisés : [-+%_* !'].

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: []
--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
--etag -e

Étiquette d’entité ou etag correspondant au dernier état de la ressource. Si aucun etag n’est fourni, la valeur '*' est utilisée.

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

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. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults 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.