Share via

az iot edge devices

  • Referenz

Hinweis

Diese Referenz ist Teil der Azure-iot-Erweiterung für die Azure CLI (Version 2.37.0 oder höher). Die Erweiterung wird automatisch installiert, wenn Sie einen Az iot Edge-Gerätebefehl zum ersten Mal ausführen. Weitere Informationen zu Erweiterungen

Befehle zum Verwalten von IoT Edge-Geräten.

Befehle

Name Beschreibung Typ Status
az iot edge devices create

Erstellen und Konfigurieren mehrerer Edgegeräte in einem IoT Hub.

 Durchwahl Experimentell

az iot edge devices create

Experimentell

Dieser Befehl ist experimentell und wird entwickelt. Referenz- und Supportebenen: https://aka.ms/CLI_refstatus

Erstellen und Konfigurieren mehrerer Edgegeräte in einem IoT Hub.

Dieser Vorgang akzeptiert Inlinegeräteargumente oder eine Konfigurationsdatei für Edgegeräte im YAML- oder JSON-Format. Inlinebefehlsargumente (z. B. "--device-auth") haben Vorrang und überschreiben Konfigurationsdateieigenschaften, wenn sie bereitgestellt werden. Eine Beispielkonfigurationsdatei finden Sie hier: https://aka.ms/aziotcli-edge-devices-config Sehen Sie sich Beispiele und Parameterbeschreibungen an, um details zur vollständigen Nutzung dieses Vorgangs zu erhalten.

az iot edge devices create [--auth-type {key, login}]
                           [--cfg]
                           [--clean {false, true}]
                           [--dct]
                           [--dea]
                           [--device]
                           [--device-auth {shared_private_key, x509_thumbprint}]
                           [--hub-name]
                           [--login]
                           [--out]
                           [--rc]
                           [--resource-group]
                           [--rk]
                           [--root-pass]
                           [--vis {false, true}]
                           [--yes {false, true}]

Beispiele

Erstellen mehrerer Edgegeräte mit symmetrischer Schlüsselauthentifizierung (Standard)

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

Erstellen Sie eine flache Liste von Edgegeräten mithilfe der selbstsignierten Zertifikatauthentifizierung mit verschiedenen Edgeeigenschaftenkonfigurationen mithilfe von Inlineargumenten.

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}

Löschen Sie alle vorhandenen Geräteidentitäten auf einem Hub, und erstellen Sie neue Geräte basierend auf einer Konfigurationsdatei (mit Statusanzeigen und Visualisierungsausgabe).

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

Erstellen Sie eine Gruppe von geschachtelten Edgegeräten mit benutzerdefinierten Modulbereitstellungen , die 2 übergeordnete Geräte mit jeweils 1 untergeordneten Geräten mit Inlineargumenten enthalten. Gibt auch den Ausgabepfad für Gerätezertifikatbundle an.

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

Erstellen Sie eine einfache geschachtelte Edgegerätekonfiguration mit einer vorhandenen Stammzertifizierungsstelle, die x509-Authentifizierung verwendet, und geben Sie einen benutzerdefinierten Ausgabepfad für Gerätebundle an.

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

Optionale Parameter

--auth-type

Gibt an, ob der Vorgang einen Richtlinienschlüssel automatisch ableiten oder die aktuelle Azure AD-Sitzung verwenden soll. Wenn der Authentifizierungstyp login ist und der Ressourcenhost bereitgestellt wird, wird die Ressourcensuche übersprungen, es sei denn, dies ist erforderlich. Sie können die Standardeinstellung mithilfe von az configure --defaults iothub-data-auth-type=<auth-type-value>.

Zulässige Werte: key, login
Standardwert: key
--cfg --config --config-file

Pfad zur Gerätekonfigurationsdatei. Beispielkonfigurationsdatei: https://aka.ms/aziotcli-edge-devices-config.

--clean -c

Löscht alle Geräte im Zielhub, bevor neue Geräte erstellt werden.

Zulässige Werte: false, true
Standardwert: False
--dct --device-config-template

Pfad zur IoT Edge config.toml-Datei, die als Grundlage für Edgegerätekonfigurationen verwendet werden soll.

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

Standard-Edge-Agent für erstellte Edgegeräte, wenn nicht einzeln angegeben.

--device -d

Durch Leerzeichen getrennte Schlüssel=Wertpaare, die eigenschaften des zu erstellenden Edgegeräts entsprechen. Die folgenden Schlüsselwerte werden unterstützt: id (device_id), deployment (Inline-JSON oder Pfad zu Datei), hostname, parent (device_id), edge_agent (Bild-URL) und container_auth (Inline-JSON oder Pfad zu Datei). --Gerät kann 1 oder mehr verwendet werden. Sehen Sie sich Hilfebeispiele für die vollständige Parameterverwendung an – diese Parameter beziehen sich auch auf ihre entsprechenden Werte in unserer Beispielkonfigurationsdatei: https://aka.ms/aziotcli-edge-devices-config.

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

Gerät zum Hub-Autorisierungsmechanismus.

Zulässige Werte: shared_private_key, x509_thumbprint
--hub-name -n

IoT Hub-Name oder Hostname. Erforderlich, wenn --login nicht angegeben wird.

--login -l

Dieser Befehl unterstützt eine Entität Verbindungszeichenfolge mit Rechten zum Ausführen von Aktionen. Wird verwendet, um die Sitzungsanmeldung über "az login" zu vermeiden. Wenn sowohl eine Entität Verbindungszeichenfolge als auch ein Name angegeben werden, hat die Verbindungszeichenfolge Vorrang. Erforderlich, wenn --hub-name nicht angegeben wird.

--out --output-path

Verzeichnispfad zu Ausgabegerätekonfigurationspaketen. Wenn dieser Wert nicht angegeben ist, wird keine Dateiausgabe erstellt.

--rc --root-cert

Pfad zum Stammzertifikat für öffentliche Schlüssel, um geschachtelte Edgegerätezertifikate zu signieren.

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

--rk --root-key

Pfad zum privaten Stammschlüssel zum Signieren geschachtelter Edgegerätezertifikate.

--root-pass --rp

Stammschlüsselkennwort.

--vis --visualize -v

Zeigt Visualisierungen von Geräten und Fortschritt verschiedener Aufgaben an (Geräteerstellung, Festlegen von Übergeordneten, Aktualisieren von Konfigurationen usw.).

Zulässige Werte: false, true
Standardwert: False
--yes -y

Fordern Sie keine Bestätigung auf, wenn der Schalter --sauber zum Löschen vorhandener Hubgeräte verwendet wird.

Zulässige Werte: false, true
Standardwert: False
Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.