az iot edge

Note

This reference is part of the azure-iot extension for the Azure CLI (version 2.59.0 or higher). L’extension installe automatiquement la première fois que vous exécutez une az iot edge commande. Learn more about extensions.

Gérer les solutions IoT en périphérie.

Commandes

Nom	Description	Type	État
az iot edge deployment	Gérer les déploiements IoT Edge à grande échelle.	Extension	GA
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 devices	Commandes pour gérer les appareils IoT Edge.	Extension	GA
az iot edge devices create	Créez et configurez plusieurs appareils de périphérie dans un Hub IoT.	Extension	Experimental
az iot edge export-modules	Exportez la configuration des modules edge sur un seul appareil edge.	Extension	GA
az iot edge set-modules	Définissez des modules de périphérie sur un seul appareil.	Extension	GA

az iot edge export-modules

Exportez la configuration des modules edge sur un seul appareil edge.

La sortie de configuration du jumeau de module peut être utilisée directement en tant que --content de « az iot edge set-modules ».

az iot edge export-modules --device-id
                           [--auth-type {key, login}]
                           [--hub-name]
                           [--login]
                           [--resource-group]

Exemples

Exporter la configuration du jumeau de module sur un appareil cible.

az iot edge export-modules --hub-name {iothub_name} --device-id {device_id}

Paramètres obligatoires

--device-id -d

ID d’appareil cible.

Paramètres facultatifs

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Propriété	Valeur
Parameter group:	Access Control Arguments
Valeur par défaut:	key
Valeurs acceptées:	key, login

--hub-name -n

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

Propriété	Valeur
Parameter group:	IoT Hub Identifier Arguments

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

Propriété	Valeur
Parameter group:	IoT Hub Identifier Arguments

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

Paramètres globaux

--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété	Valeur
Valeur par défaut:	False

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété	Valeur
Valeur par défaut:	False

--output -o

Output format.

Propriété	Valeur
Valeur par défaut:	json
Valeurs acceptées:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

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 edge set-modules

Définissez des modules de périphérie sur un seul appareil.

Le contenu des modules est json et sous la forme de {"modulesContent » :{...}} or {"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. Cela peut être désactivé à l’aide du commutateur --no-validation.

Remarque : Lors de l’exécution, la commande génère la collection de modules appliqués à l’appareil.

az iot edge set-modules --content
                        --device-id
                        [--auth-type {key, login}]
                        [--hub-name]
                        [--login]
                        [--resource-group]

Exemples

Testez les modules edge pendant le développement en définissant des modules sur un appareil cible.

az iot edge set-modules --hub-name {iothub_name} --device-id {device_id} --content ../modules_content.json

Paramètres obligatoires

--content -k

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

--device-id -d

ID d’appareil cible.

Paramètres facultatifs

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Propriété	Valeur
Parameter group:	Access Control Arguments
Valeur par défaut:	key
Valeurs acceptées:	key, login

--hub-name -n

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

Propriété	Valeur
Parameter group:	IoT Hub Identifier Arguments

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

Propriété	Valeur
Parameter group:	IoT Hub Identifier Arguments

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

Paramètres globaux

--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété	Valeur
Valeur par défaut:	False

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété	Valeur
Valeur par défaut:	False

--output -o

Output format.

Propriété	Valeur
Valeur par défaut:	json
Valeurs acceptées:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

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