az iot edge deployment
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-Bereitstellungsbefehl zum ersten Mal ausführen. Weitere Informationen zu Erweiterungen
Verwalten Sie IoT Edge-Bereitstellungen im großen Maßstab.
Befehle
Name | Beschreibung | Typ | Status |
---|---|---|---|
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 deployment create
Erstellen Sie eine IoT Edge-Bereitstellung in einem IoT-Ziel-IoT-Hub.
Der Bereitstellungsinhalt 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. Diese Überprüfung ist für Basisbereitstellungen vorgesehen. Wenn das entsprechende Schema nicht verfügbar ist oder das Basisbereitstellungsformat nicht erkannt wird, wird dieser Schritt übersprungen. Die Schemaüberprüfung kann mithilfe des Schalters "-no-validation" deaktiviert werden.
Eine Edgebereitstellung wird als schichtweise klassifiziert, wenn ein Modul "properties.desired.*" definiert ist. Jedes Edgegerät, das auf eine mehrschichtige Bereitstellung ausgerichtet ist, benötigt zunächst eine Basisbereitstellung, die darauf angewendet wird.
Alle mehrschichtigen Bereitstellungen, die auf ein Gerät abzielen, müssen eine höhere Priorität haben als die Basisbereitstellung für dieses Gerät.
Hinweis: Wenn das "properties.desired"-Feld eines Modul-Zwillings in einer mehrschichtigen Bereitstellung festgelegt ist, überschreibt properties.desired die gewünschten Eigenschaften für dieses Modul in allen Bereitstellungen mit niedrigerer Priorität.
az iot edge deployment create --content
--deployment-id
[--auth-type {key, login}]
[--cl]
[--cmq]
[--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" lautet.
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 (PowerShell-Syntaxbeispiel), 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 mehrschichtige Bereitstellung, die für Geräte gilt, die mit der Umgebung "dev" gekennzeichnet sind. Sowohl Benutzermetriken als auch Modulinhalte, die inline definiert sind (PowerShell-Syntaxbeispiel). Beachten Sie, dass dies im Mehrschichtbereitstellungsformat als "properties.desired.*" definiert wurde.
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'}}"
Erstellen Sie eine mehrschichtige Bereitstellung, die für Geräte in "Building 9" und umgebung "test" gilt. Sowohl Benutzermetriken als auch Modulinhalte, die inline definiert sind (Bash-Syntaxbeispiel). Beachten Sie, dass dies im Mehrschichtbereitstellungsformat als "properties.desired.*" definiert wurde.
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"}}'
Erstellen Sie eine Bereitstellung, die für Geräte in "Building 9" und umgebung "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 ./modules_content.json --target-condition "tags.building=9 and tags.environment='test'" --metrics ./metrics_content.json
Erstellen Sie eine Bereitstellung, deren Definition aus einer Datei mit shellunabhängiger Eingabe von Bezeichnungen und Metriken stammt.
az iot edge deployment create -d {deployment_name} -n {iothub_name} --content ./modules_content.json --target-condition "tags.building=9 and tags.environment='test'" --custom-labels key0=value0 key1=value1 --custom-metric-queries mymetric1="select deviceId from devices where tags.location='US'" mymetric2="select *"
Erforderliche Parameter
IoT Edge-Bereitstellungsinhalt. Geben Sie dateipfad oder unformatierte JSON an.
Zielbereitstellungsname. Kleinbuchstaben und die folgenden Sonderzeichen sind zulässig: [-+%_*!'].
Optionale Parameter
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>
.
Ein alternativer Eingabestil (leerzeichentrennte Schlüssel=Wertpaare) für --Beschriftungen und soll es in Zukunft ersetzen. Formatbeispiel: key1=value1 key2="this is my value".
Ein alternativer Eingabestil (leerzeichentrennte Schlüssel=Wertpaare) für --Metriken und soll es in Zukunft ersetzen. Formatbeispiel: metric1="select deviceId from devices where tags.location='US'" metric2="select *".
IoT Hub-Name oder Hostname. Erforderlich, wenn --login nicht angegeben wird.
Zuordnung der Bezeichnungen, die auf die Zielbereitstellung angewendet werden sollen. Verwenden Sie das folgende Format: '{"key0":"value0", "key1":"value1"}'. Die Verwendung von --custom-labels anstelle von --labels wird empfohlen.
Layered deployments allow you to define desired properties in $edgeAgent, $edgeHub and user modules that will layer on top of a base deployment. Die in einer mehrschichtigen Bereitstellung angegebenen Eigenschaften werden mit Eigenschaften der Basisbereitstellung zusammengeführt. Eigenschaften mit demselben Pfad werden basierend auf der Bereitstellungspriorität überschrieben. Diese Option ist ein Alias für "-no-validation".
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.
Benutzermetrikdefinitionen für die IoT Edge-Bereitstellung. Geben Sie dateipfad oder unformatierte JSON an. Benutzermetriken befinden sich in Form von {"queries":{...}} oder {"metrics":{"queries":{...}}}.or {"metrics":{"queries":{...}}}. Die Verwendung von --custom-metric-queries anstelle von --metrics wird empfohlen.
Deaktiviert die clientseitige Schemaüberprüfung für die Erstellung von Edgebereitstellungen.
Gewicht der Bereitstellung bei konkurrierenden Regeln (höchste Gewinne).
Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name>
konfigurieren.
Zielbedingung, für die eine Edgebereitstellung gilt. Bereitstellungen ohne Zielbedingung zielen auf kein Gerät ab. Verwenden Sie das folgende Format: "tags.environment='test'".
Globale Parameter
Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.
Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.
Nur Fehler anzeigen und Warnungen unterdrücken.
Ausgabeformat.
JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.
Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID
konfigurieren.
Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.
az iot edge deployment delete
Löschen Sie eine IoT Edge-Bereitstellung.
az iot edge deployment delete --deployment-id
[--auth-type {key, login}]
[--etag]
[--hub-name]
[--login]
[--resource-group]
Erforderliche Parameter
Zielbereitstellungsname. Kleinbuchstaben und die folgenden Sonderzeichen sind zulässig: [-+%_*!'].
Optionale Parameter
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>
.
Etag oder Entitätstag, das dem letzten Status der Ressource entspricht. Wenn kein Etag angegeben wird, wird der Wert '*' verwendet.
IoT Hub-Name oder Hostname. Erforderlich, wenn --login nicht angegeben wird.
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.
Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name>
konfigurieren.
Globale Parameter
Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.
Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.
Nur Fehler anzeigen und Warnungen unterdrücken.
Ausgabeformat.
JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.
Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID
konfigurieren.
Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.
az iot edge deployment list
Auflisten von IoT Edge-Bereitstellungen in einem IoT Hub.
az iot edge deployment list [--auth-type {key, login}]
[--hub-name]
[--login]
[--resource-group]
[--top]
Optionale Parameter
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>
.
IoT Hub-Name oder Hostname. Erforderlich, wenn --login nicht angegeben wird.
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.
Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name>
konfigurieren.
Maximale Anzahl der zurückzugebenden Bereitstellungen. Standardmäßig werden alle Bereitstellungen zurückgegeben.
Globale Parameter
Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.
Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.
Nur Fehler anzeigen und Warnungen unterdrücken.
Ausgabeformat.
JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.
Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID
konfigurieren.
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
Zielbereitstellungsname. Kleinbuchstaben und die folgenden Sonderzeichen sind zulässig: [-+%_*!'].
Optionale Parameter
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>
.
IoT Hub-Name oder Hostname. Erforderlich, wenn --login nicht angegeben wird.
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.
Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name>
konfigurieren.
Globale Parameter
Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.
Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.
Nur Fehler anzeigen und Warnungen unterdrücken.
Ausgabeformat.
JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.
Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID
konfigurieren.
Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.
az iot edge deployment show-metric
Bewerten einer 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
Auswerten der Systemmetrik "appliedCount"
az iot edge deployment show-metric -m appliedCount -d {deployment_name} -n {iothub_name} --mt system
Auswerten der Benutzermetrik "myCustomMetric"
az iot edge deployment show-metric -m myCustomMetric -d {deployment_name} -n {iothub_name}
Erforderliche Parameter
Zielbereitstellungsname. Kleinbuchstaben und die folgenden Sonderzeichen sind zulässig: [-+%_*!'].
Zielmetrik für die Auswertung.
Optionale Parameter
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>
.
IoT Hub-Name oder Hostname. Erforderlich, wenn --login nicht angegeben wird.
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.
Gibt an, welche Metriksammlung zum Nachschlagen einer Metrik verwendet werden soll.
Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name>
konfigurieren.
Globale Parameter
Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.
Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.
Nur Fehler anzeigen und Warnungen unterdrücken.
Ausgabeformat.
JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.
Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID
konfigurieren.
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: Der 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 der 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
Zielbereitstellungsname. Kleinbuchstaben und die folgenden Sonderzeichen sind zulässig: [-+%_*!'].
Optionale Parameter
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>
.
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>
.
Etag oder Entitätstag, das dem letzten Status der Ressource entspricht. Wenn kein Etag angegeben wird, wird der Wert '*' verwendet.
Wenn Sie "set" oder "add" verwenden, behalten Sie Zeichenfolgenliterale bei, anstatt zu versuchen, in JSON zu konvertieren.
IoT Hub-Name oder Hostname. Erforderlich, wenn --login nicht angegeben wird.
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.
Entfernen sie eine Eigenschaft oder ein Element aus einer Liste. Beispiel: --remove property.list <indexToRemove>
ODER --remove propertyToRemove
.
Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name>
konfigurieren.
Aktualisieren Sie ein Objekt, indem Sie einen festzulegenden Eigenschaftspfad und -wert angeben. Beispiel: --set property1.property2=<value>
.
Globale Parameter
Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.
Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.
Nur Fehler anzeigen und Warnungen unterdrücken.
Ausgabeformat.
JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.
Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID
konfigurieren.
Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.