az iot edge deployment

Hinweis

Diese Referenz ist Teil der Azure-iot-Erweiterung für die Azure CLI (Version 2.30.0 oder höher). Die Erweiterung installiert automatisch beim ersten Ausführen eines Az iot Edge-Bereitstellungsbefehls . Weitere Informationen zu Erweiterungen

Verwalten sie IoT Edge Bereitstellungen im Maßstab.

Befehle

az iot edge deployment create	Erstellen Sie eine IoT Edge Bereitstellung in einem Ziel-IoT Hub.
az iot edge deployment delete	Löschen einer IoT Edge Bereitstellung.
az iot edge deployment list	Listen Sie IoT Edge Bereitstellungen in einem IoT Hub auf.
az iot edge deployment show	Erhalten Sie die Details einer IoT Edge Bereitstellung.
az iot edge deployment show-metric	Bewerten Sie eine Zielsystemmetrik, die in einer IoT Edge Bereitstellung definiert ist.
az iot edge deployment update	Aktualisieren sie die angegebenen Eigenschaften einer IoT Edge-Bereitstellung. Verwenden Sie --set gefolgt von Eigenschaftenzuweisungen zum Aktualisieren einer Bereitstellung. Hinweis: IoT Edge Bereitstellungsinhalt ist unveränderlich. Bereitstellungseigenschaften, die aktualisiert werden können, sind "Bezeichnungen", "Metriken", "Priorität" und "targetCondition".

az iot edge deployment create

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

Bereitstellungsinhalt ist json und in Form von {"modulesContent":{...}} oder {"content":{"modulesContent":{...}}}}.

Standardmäßig werden die 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.

Edgebereitstellungen können mit benutzerdefinierten Metriken für die Bedarfsbewertung erstellt werden. Benutzermetriken sind json und in Form von {"query":{...}} oder {"Metriken":{"query":{...}}}}.

az iot edge deployment create --content
                              --deployment-id
                              [--auth-type {key, login}]
                              [--hub-name]
                              [--lab]
                              [--layered {false, true}]
                              [--login]
                              [--metrics]
                              [--no-validation {false, true}]
                              [--pri]
                              [--resource-group]
                              [--target-condition]

Beispiele

Erstellen Sie eine Bereitstellung mit Bezeichnungen (Bash-Syntaxbeispiel), die für Geräte in "Building 9" gilt und die Umgebung "test" ist.

az iot edge deployment create -d {deployment_name} -n {iothub_name} --content modules_content.json --labels '{"key0":"value0", "key1":"value1"}' --target-condition "tags.building=9 and tags.environment='test'" --priority 3

Erstellen Sie eine Bereitstellung mit Bezeichnungen (Beispiel für die Powershell-Syntax), die für Geräte gilt, die mit der Umgebung "dev" gekennzeichnet sind.

az iot edge deployment create -d {deployment_name} -n {iothub_name} --content modules_content.json --labels "{'key':'value'}" --target-condition "tags.environment='dev'"

Erstellen Sie eine layerierte Bereitstellung, die für Geräte gilt, die mit der Umgebung "dev" gekennzeichnet sind. Sowohl Benutzermetriken als auch Modulinhalte, die inline definiert sind (Beispiel für powershell-Syntax).

az iot edge deployment create -d {deployment_name} -n {iothub_name} --content "{'modulesContent':{'`$edgeAgent':{'properties.desired.modules.mymodule0':{ }},'`$edgeHub':{'properties.desired.routes.myroute0':'FROM /messages/* INTO `$upstream'}}}" --target-condition "tags.environment='dev'" --priority 10 --metrics "{'queries':{'mymetrik':'SELECT deviceId from devices where properties.reported.lastDesiredStatus.code = 200'}}" --layered

Erstellen Sie eine layerierte Bereitstellung, die für Geräte in "Building 9" und "Test" gilt. Sowohl Benutzermetriken als auch Modulinhalte, die inline definiert sind (Beispiel für bash-Syntax).

az iot edge deployment create -d {deployment_name} -n {iothub_name} --content '{"modulesContent":{"$edgeAgent":{"properties.desired.modules.mymodule0":{ }},"$edgeHub":{"properties.desired.routes.myroute0":"FROM /messages/* INTO $upstream"}}}' --target-condition "tags.building=9 and tags.environment='test'" --metrics '{"queries":{"mymetrik":"SELECT deviceId from devices where properties.reported.lastDesiredStatus.code = 200"}}' --layered

Erstellen Sie eine layerierte Bereitstellung, die für Geräte in "Building 9" und "Test" gilt. Sowohl Benutzermetriken als auch Modulinhalte, die aus der Datei definiert sind.

az iot edge deployment create -d {deployment_name} -n {iothub_name} --content layered_modules_content.json --target-condition "tags.building=9 and tags.environment='test'" --metrics metrics_content.json --layered

Erforderliche Parameter

--content -k

IoT Edge Bereitstellungsinhalt. Geben Sie Dateipfad oder unformatierte JSON an.

--deployment-id -d

Zielbereitstellungsname.

Optionale Parameter

--auth-type

Gibt an, ob der Vorgang einen Richtlinienschlüssel automatisch abgeleitet oder die aktuelle Azure AD-Sitzung verwenden soll. Sie können die Standardeinstellung mithilfe az configure --defaults iothub-data-auth-type=<auth-type-value>von .

Zulässige Werte: key, login

Standardwert: key

--hub-name -n

IoT Hub Name. Erforderlich, wenn die Anmeldung nicht bereitgestellt wird.

--lab --labels

Zuordnung der Bezeichnungen, die auf die Zielbereitstellung angewendet werden sollen. Verwenden Sie das folgende Format: '{"key0":"value0", "key1":"value1"}'.

--layered

Layered Deployments ermöglichen es Ihnen, gewünschte Eigenschaften in $edgeAgent, $edgeHub und Benutzermodulen zu definieren, die sich oben in einer Basisbereitstellung befinden. Beispielsweise werden die in einer layerierten Bereitstellung angegebenen Routen mit Routen der Basisbereitstellung zusammengeführt. Routen mit demselben Namen werden basierend auf der Bereitstellungspriorität überschrieben.

Zulässige Werte: false, true

--login -l

Dieser Befehl unterstützt eine Entitätsverbindungszeichenfolge mit Rechten zum Ausführen von Aktionen. Verwenden Sie die Verwendung, um die Sitzungsanmeldung über "az login" zu vermeiden. Wenn sowohl eine Entitätsverbindungszeichenfolge als auch ein Name bereitgestellt werden, wird die Verbindungszeichenfolge vorrangig verwendet. Erforderlich, wenn --hub-name nicht bereitgestellt wird.

--metrics -m

IoT Edge Bereitstellungsmetrikdefinitionen. Geben Sie Dateipfad oder unformatierte JSON an.

--no-validation

Deaktiviert die clientseitige Schemaüberprüfung für die Erstellung von Edgebereitstellungen.

Zulässige Werte: false, true

--pri --priority

Gewichtung der Bereitstellung bei konkurrierenden Regeln (höchste Gewinne).

--resource-group -g

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

--target-condition --tc -t

Zielbedingung, auf die eine Edgebereitstellung angewendet wird. Bereitstellungen ohne Zielbedingung zielen auf kein Gerät ab.

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.

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

Löschen einer IoT Edge Bereitstellung.

az iot edge deployment delete --deployment-id
                              [--auth-type {key, login}]
                              [--etag]
                              [--hub-name]
                              [--login]
                              [--resource-group]

Erforderliche Parameter

--deployment-id -d

Zielbereitstellungsname.

Optionale Parameter

--auth-type

Gibt an, ob der Vorgang einen Richtlinienschlüssel automatisch abgeleitet oder die aktuelle Azure AD-Sitzung verwenden soll. Sie können die Standardeinstellung mithilfe az configure --defaults iothub-data-auth-type=<auth-type-value>von .

Zulässige Werte: key, login

Standardwert: key

--etag -e

Etag oder Entitätstag, das dem letzten Zustand der Ressource entspricht. Wenn kein Etag bereitgestellt wird, wird der Wert '*' verwendet.

--hub-name -n

IoT Hub Name. Erforderlich, wenn die Anmeldung nicht bereitgestellt wird.

--login -l

Dieser Befehl unterstützt eine Entitätsverbindungszeichenfolge mit Rechten zum Ausführen von Aktionen. Verwenden Sie die Verwendung, um die Sitzungsanmeldung über "az login" zu vermeiden. Wenn sowohl eine Entitätsverbindungszeichenfolge als auch ein Name bereitgestellt werden, wird die Verbindungszeichenfolge vorrangig verwendet. Erforderlich, wenn --hub-name nicht bereitgestellt 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.

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

Auflisten IoT Edge Bereitstellungen in einem IoT Hub.

az iot edge deployment list [--auth-type {key, login}]
                            [--hub-name]
                            [--login]
                            [--resource-group]
                            [--top]

Optionale Parameter

--auth-type

Gibt an, ob der Vorgang einen Richtlinienschlüssel automatisch abgeleitet oder die aktuelle Azure AD-Sitzung verwenden soll. Sie können die Standardeinstellung mithilfe az configure --defaults iothub-data-auth-type=<auth-type-value>von .

Zulässige Werte: key, login

Standardwert: key

--hub-name -n

IoT Hub Name. Erforderlich, wenn die Anmeldung nicht bereitgestellt wird.

--login -l

Dieser Befehl unterstützt eine Entitätsverbindungszeichenfolge mit Rechten zum Ausführen von Aktionen. Verwenden Sie die Verwendung, um die Sitzungsanmeldung über "az login" zu vermeiden. Wenn sowohl eine Entitätsverbindungszeichenfolge als auch ein Name bereitgestellt werden, wird die Verbindungszeichenfolge vorrangig verwendet. Erforderlich, wenn --hub-name nicht bereitgestellt wird.

--resource-group -g

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

--top

Maximale Anzahl von Bereitstellungen, die zurückgegeben werden sollen. Standardmäßig werden alle Bereitstellungen zurückgegeben.

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.

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

Rufen Sie die Details einer IoT Edge Bereitstellung ab.

az iot edge deployment show --deployment-id
                            [--auth-type {key, login}]
                            [--hub-name]
                            [--login]
                            [--resource-group]

Erforderliche Parameter

--deployment-id -d

Zielbereitstellungsname.

Optionale Parameter

--auth-type

Gibt an, ob der Vorgang einen Richtlinienschlüssel automatisch ableiten oder die aktuelle Azure AD-Sitzung verwenden soll. 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. Erforderlich, wenn die Anmeldung nicht angegeben wird.

--login -l

Dieser Befehl unterstützt eine Entitätsverbindungszeichenfolge mit Rechten zum Ausführen einer Aktion. Verwenden Sie die Verwendung, um die Sitzungsanmeldung über "az login" zu vermeiden. Wenn sowohl eine Entitätsverbindungszeichenfolge 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.

--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 deployment show-metric

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

az iot edge deployment show-metric --deployment-id
                                   --metric-id
                                   [--auth-type {key, login}]
                                   [--hub-name]
                                   [--login]
                                   [--metric-type {system, user}]
                                   [--resource-group]

Beispiele

Bewerten der Systemmetrik "appliedCount"

az iot edge deployment show-metric -m appliedCount -d {deployment_name} -n {iothub_name} --mt system

Bewerten der Benutzermetrik "myCustomMetric"

az iot edge deployment show-metric -m myCustomMetric -d {deployment_name} -n {iothub_name}

Erforderliche Parameter

--deployment-id -d

Zielbereitstellungsname.

--metric-id -m

Zielmetrik für die Auswertung.

Optionale Parameter

--auth-type

Gibt an, ob der Vorgang einen Richtlinienschlüssel automatisch ableiten oder die aktuelle Azure AD-Sitzung verwenden soll. 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. Erforderlich, wenn die Anmeldung nicht angegeben wird.

--login -l

Dieser Befehl unterstützt eine Entitätsverbindungszeichenfolge mit Rechten zum Ausführen einer Aktion. Verwenden Sie die Verwendung, um die Sitzungsanmeldung über "az login" zu vermeiden. Wenn sowohl eine Entitätsverbindungszeichenfolge als auch ein Name angegeben werden, hat die Verbindungszeichenfolge Vorrang. Erforderlich, wenn --hub-name nicht angegeben wird.

--metric-type --mt

Gibt an, welche Metriksammlung verwendet werden soll, um eine Metrik nachzuschlagen.

Zulässige Werte: system, user

Standardwert: user

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

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

Aktualisieren sie die angegebenen Eigenschaften einer IoT Edge Bereitstellung.

Verwenden Sie --set gefolgt von Eigenschaftszuweisungen zum Aktualisieren einer Bereitstellung.

Hinweis: IoT Edge Bereitstellungsinhalt ist unveränderlich. Bereitstellungseigenschaften, die aktualisiert werden können, sind "Bezeichnungen", "Metriken", "Priorität" und "targetCondition".

az iot edge deployment update --deployment-id
                              [--add]
                              [--auth-type {key, login}]
                              [--etag]
                              [--force-string]
                              [--hub-name]
                              [--login]
                              [--remove]
                              [--resource-group]
                              [--set]

Beispiele

Ändern der Bezeichnungen und Zielbedingung einer vorhandenen Edgebereitstellung

az iot edge deployment update -d {deployment_name} -n {iothub_name} --set labels='{"purpose":"dev", "owners":"IoTEngineering"}' targetCondition='tags.building=9'

Erforderliche Parameter

--deployment-id -d

Zielbereitstellungsname.

Optionale Parameter

--add

Fügen Sie einer Liste von Objekten ein Objekt hinzu, indem Sie ein Pfad- und Schlüsselwertpaar angeben. Beispiel: --add property.listProperty <key=value, string or JSON string>.

--auth-type

Gibt an, ob der Vorgang einen Richtlinienschlüssel automatisch ableiten oder die aktuelle Azure AD-Sitzung verwenden soll. Sie können die Standardeinstellung mithilfe von az configure --defaults iothub-data-auth-type=<auth-type-value>.

Zulässige Werte: key, login

Standardwert: key

--etag -e

Etag- oder Entitätstag, das dem letzten Status der Ressource entspricht. Wenn kein etag angegeben wird, wird der Wert '*' verwendet.

--force-string

Wenn Sie "set" oder "add" verwenden, behalten Sie Zeichenfolgenliterale bei, anstatt zu versuchen, in JSON zu konvertieren.

--hub-name -n

IoT Hub Name. Erforderlich, wenn die Anmeldung nicht angegeben wird.

--login -l

Dieser Befehl unterstützt eine Entitätsverbindungszeichenfolge mit Rechten zum Ausführen einer Aktion. Verwenden Sie die Verwendung, um die Sitzungsanmeldung über "az login" zu vermeiden. Wenn sowohl eine Entitätsverbindungszeichenfolge als auch ein Name angegeben werden, hat die Verbindungszeichenfolge Vorrang. Erforderlich, wenn --hub-name nicht angegeben wird.

--remove

Entfernen einer Eigenschaft oder eines Elements aus einer Liste. Beispiel: --remove property.list OR --remove propertyToRemove.

--resource-group -g

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

--set

Aktualisieren Sie ein Objekt, indem Sie einen Eigenschaftspfad und einen festzulegenden Wert angeben. Beispiel: --set property1.property2=.

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.

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