az iot edge

Note

Diese Referenz ist Teil der Azure-iot-Erweiterung für die Azure CLI (Version 2.67.0 oder höher). Die Erweiterung wird automatisch installiert, wenn Sie einen az iot edge Befehl ausführen. Erfahren Sie mehr über Erweiterungen.

Verwalten von IoT-Lösungen am Edge

Befehle

Name	Beschreibung	Typ	Status
az iot edge deployment	Verwalten Sie IoT Edge-Bereitstellungen im großen Maßstab.	Extension	GA
az iot edge deployment create	Erstellen Sie eine IoT Edge-Bereitstellung in einem IoT-Ziel-IoT-Hub.	Extension	GA
az iot edge deployment delete	Löschen Sie eine IoT Edge-Bereitstellung.	Extension	GA
az iot edge deployment list	Auflisten von IoT Edge-Bereitstellungen in einem IoT Hub.	Extension	GA
az iot edge deployment show	Rufen Sie die Details einer IoT Edge-Bereitstellung ab.	Extension	GA
az iot edge deployment show-metric	Bewerten einer Zielsystemmetrik, die in einer IoT Edge-Bereitstellung definiert ist.	Extension	GA
az iot edge deployment update	Aktualisieren sie die angegebenen Eigenschaften einer IoT Edge-Bereitstellung.	Extension	GA
az iot edge devices	Befehle zum Verwalten von IoT Edge-Geräten.	Extension	GA
az iot edge devices create	Erstellen und Konfigurieren mehrerer Edgegeräte in einem IoT Hub.	Extension	Experimental
az iot edge export-modules	Exportieren Sie die Konfiguration der Edgemodule auf einem einzelnen Edgegerät.	Extension	GA
az iot edge set-modules	Legen Sie Edgemodule auf einem einzelnen Gerät fest.	Extension	GA

az iot edge export-modules

Exportieren Sie die Konfiguration der Edgemodule auf einem einzelnen Edgegerät.

Die Modul-Twin-Konfigurationsausgabe kann direkt als --content von "az iot edge set-modules" verwendet werden.

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

Beispiele

Exportieren Sie die Twin-Konfiguration des Moduls auf einem Zielgerät.

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

Erforderliche Parameter

--device-id -d

Zielgeräte-ID.

Optionale Parameter

Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.

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

Eigenschaft	Wert
Parametergruppe:	Access Control Arguments
Standardwert:	key
Zulässige Werte:	key, login

--hub-name -n

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

Eigenschaft	Wert
Parametergruppe:	IoT Hub Identifier Arguments

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

Eigenschaft	Wert
Parametergruppe:	IoT Hub Identifier Arguments

--resource-group -g

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

Globale Parameter

--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft	Wert
Standardwert:	False

--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft	Wert
Standardwert:	False

--output -o

Ausgabeformat.

Eigenschaft	Wert
Standardwert:	json
Zulässige Werte:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft	Wert
Standardwert:	False

az iot edge set-modules

Legen Sie Edgemodule auf einem einzelnen Gerät fest.

Der Inhalt von Modulen ist json und in Form von {"modulesContent":{...}} oder {"content":{"modulesContent":{...}}}.

Standardmäßig werden Eigenschaften von Systemmodulen $edgeAgent und $edgeHub anhand von Schemas überprüft, die mit der IoT-Erweiterung installiert sind. Dies kann mithilfe des Schalters "-no-validation" deaktiviert werden.

Hinweis: Bei der Ausführung gibt der Befehl die Sammlung von Modulen aus, die auf das Gerät angewendet wurden.

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

Beispiele

Testen Sie Edgemodule während der Entwicklung, indem Sie Module auf einem Zielgerät festlegen.

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

Erforderliche Parameter

--content -k

IoT Edge-Bereitstellungsinhalt. Geben Sie dateipfad oder unformatierte JSON an.

--device-id -d

Zielgeräte-ID.

Optionale Parameter

Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.

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

Eigenschaft	Wert
Parametergruppe:	Access Control Arguments
Standardwert:	key
Zulässige Werte:	key, login

--hub-name -n

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

Eigenschaft	Wert
Parametergruppe:	IoT Hub Identifier Arguments

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

Eigenschaft	Wert
Parametergruppe:	IoT Hub Identifier Arguments

--resource-group -g

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

Globale Parameter

--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft	Wert
Standardwert:	False

--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft	Wert
Standardwert:	False

--output -o

Ausgabeformat.

Eigenschaft	Wert
Standardwert:	json
Zulässige Werte:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft	Wert
Standardwert:	False