Freigeben über

az iot edge

  • Referenz

Hinweis

Diese Referenz ist Teil der Azure-iot-Erweiterung für die Azure CLI (Version 2.46.0 oder höher). Die Erweiterung wird automatisch installiert, wenn Sie einen Az iot Edge-Befehl zum ersten Mal ausführen. Weitere Informationen zu 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.

 Erweiterung Allgemein verfügbar
az iot edge deployment create

Erstellen Sie eine IoT Edge-Bereitstellung in einem IoT-Ziel-IoT-Hub.

 Erweiterung Allgemein verfügbar
az iot edge deployment delete

Löschen Sie eine IoT Edge-Bereitstellung.

 Erweiterung Allgemein verfügbar
az iot edge deployment list

Auflisten von IoT Edge-Bereitstellungen in einem IoT Hub.

 Erweiterung Allgemein verfügbar
az iot edge deployment show

Rufen Sie die Details einer IoT Edge-Bereitstellung ab.

 Erweiterung Allgemein verfügbar
az iot edge deployment show-metric

Bewerten einer Zielsystemmetrik, die in einer IoT Edge-Bereitstellung definiert ist.

 Erweiterung Allgemein verfügbar
az iot edge deployment update

Aktualisieren sie die angegebenen Eigenschaften einer IoT Edge-Bereitstellung.

 Erweiterung Allgemein verfügbar
az iot edge devices

Befehle zum Verwalten von IoT Edge-Geräten.

 Erweiterung Allgemein verfügbar
az iot edge devices create

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

 Erweiterung Experimentell
az iot edge export-modules

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

 Erweiterung Allgemein verfügbar
az iot edge set-modules

Legen Sie Edgemodule auf einem einzelnen Gerät fest.

 Erweiterung Allgemein verfügbar

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

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

--resource-group -g

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

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.

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

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

--resource-group -g

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

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.