az iot edge devices

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 un appareil az iot edge commande. Learn more about extensions.

Commandes pour gérer les appareils IoT Edge.

Commandes

Nom	Description	Type	État
az iot edge devices create	Créez et configurez plusieurs appareils de périphérie dans un Hub IoT.	Extension	Experimental

az iot edge devices create

Expérimental

Cette commande est expérimentale et en cours de développement. Niveaux de référence et de support : https://aka.ms/CLI_refstatus

Créez et configurez plusieurs appareils de périphérie dans un Hub IoT.

Cette opération accepte les arguments d’appareil inline ou un fichier de configuration d’appareils edge au format YAML ou JSON. Les arguments de commande inline (comme « --device-auth ») sont prioritaires et remplacent les propriétés du fichier de configuration si elles sont fournies. Vous trouverez un exemple de fichier de configuration ici : https://aka.ms/aziotcli-edge-devices-config consultez des exemples et des descriptions de paramètres pour plus d’informations sur l’utilisation complète de cette opération.

az iot edge devices create [--auth-type {key, login}]
                           [--cfg --config --config-file]
                           [--clean {false, true}]
                           [--dct --device-config-template]
                           [--dea --default-agent --default-edge-agent]
                           [--device]
                           [--device-auth --device-auth-type {shared_private_key, x509_thumbprint}]
                           [--hub-name]
                           [--login]
                           [--out --output-path]
                           [--rc --root-cert]
                           [--resource-group]
                           [--rk --root-key]
                           [--root-pass --rp]
                           [--vis --visualize {false, true}]
                           [--yes {false, true}]

Exemples

Créer un couple d’appareils de périphérie à l’aide de l’authentification par clé symétrique (valeur par défaut)

az iot edge devices create -n {hub_name} --device id=device_1 --device id=device_2

Créez une liste plate d’appareils de périphérie à l’aide de l’authentification par certificat auto-signé avec différentes configurations de propriétés de périphérie, à l’aide d’arguments inline.

az iot edge devices create -n {hub_name} --device-auth x509_thumbprint --default-edge-agent "mcr.microsoft.com/azureiotedge-agent:1.4"
--device id=device_1 hostname={FQDN}
--device id=device_2 edge_agent={agent_image}
--device id=parent hostname={FQDN} edge_agent={agent_image} container_auth={path_or_json_string}

Supprimez toutes les identités d’appareil existantes sur un hub et créez de nouveaux appareils en fonction d’un fichier de configuration (avec des barres de progression et une sortie de visualisation).

az iot edge devices create -n {hub_name} --cfg path/to/config_yml_or_json -c -v

Créez un groupe d’appareils de périphérie imbriqués avec des déploiements de modules personnalisés , contenant 2 appareils parents avec 1 appareil enfant chacun, à l’aide d’arguments inline. Spécifie également le chemin de sortie des bundles de certificats d’appareil.

az iot edge devices create -n {hub_name} --out {device_bundle_path}
--device id=parent_1 deployment=/path/to/parentDeployment_1.json
--device id=child_1 parent=parent_1 deployment=/path/to/child_deployment_1.json
--device id=parent_2 deployment=/path/to/parentDeployment_2.json
--device id=child_2 parent=parent_2 deployment=/path/to/child_deployment_2.json

Créez une configuration d’appareil edge imbriquée simple avec une autorité de certification racine existante, à l’aide de l’authentification x509 et spécifiez un chemin de sortie de bundle d’appareils personnalisé.

az iot edge devices create -n {hub_name} --out {device_bundle_path}
--root-cert "root_cert.pem" --root-key "root_key.pem" --device-auth x509_thumbprint
--device id=parent1
--device id=child1 parent=parent1

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

--cfg --config --config-file

Chemin d’accès au fichier de configuration des appareils. Exemple de fichier de configuration : https://aka.ms/aziotcli-edge-devices-config.

--clean -c

Supprime tous les appareils dans le hub cible avant de créer de nouveaux appareils.

Propriété	Valeur
Valeur par défaut:	False
Valeurs acceptées:	false, true

--dct --device-config-template

Chemin d’accès au fichier config.toml IoT Edge à utiliser comme base pour les configurations d’appareil edge.

--dea --default-agent --default-edge-agent

Agent edge par défaut pour les appareils Edge créés s’il n’est pas spécifié individuellement.

--device -d

Paires clé=valeur séparées par l’espace correspondant aux propriétés de l’appareil de périphérie à créer. Les valeurs de clé suivantes sont prises en charge : id (device_id), deployment (json inline ou chemin d’accès au fichier), hostname, parent (device_id), edge_agent (URL de l’image) et container_auth (json inline ou chemin d’accès au fichier). --device peut être utilisé 1 ou plusieurs fois. Passez en revue les exemples d’aide pour l’utilisation complète des paramètres : ces paramètres font également référence à leurs valeurs correspondantes dans notre exemple de fichier de configuration : https://aka.ms/aziotcli-edge-devices-config.

--device-auth --device-auth-type

Mécanisme d’autorisation d’appareil vers hub.

Propriété	Valeur
Valeurs acceptées:	shared_private_key, x509_thumbprint

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

--out --output-path

Chemin d’accès au répertoire des bundles de configuration d’appareil de sortie. Si cette valeur n’est pas spécifiée, aucune sortie de fichier n’est créée.

--rc --root-cert

Chemin d’accès au certificat de clé publique racine pour signer des certificats d’appareil edge imbriqués.

Propriété	Valeur
Parameter group:	Root Certificate 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>.

--rk --root-key

Chemin d’accès à la clé privée racine pour signer des certificats d’appareil edge imbriqués.

Propriété	Valeur
Parameter group:	Root Certificate Arguments

--root-pass --rp

Mot de passe de clé racine.

Propriété	Valeur
Parameter group:	Root Certificate Arguments

--vis --visualize -v

Affiche les visualisations des appareils et la progression de diverses tâches (création d’appareils, définition des parents, mise à jour des configurations, etc.).

Propriété	Valeur
Valeur par défaut:	False
Valeurs acceptées:	false, true

--yes -y

N’invitez pas à confirmer le moment où le commutateur --clean est utilisé pour supprimer les appareils hub existants.

Propriété	Valeur
Valeur par défaut:	False
Valeurs acceptées:	false, true

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