az iot hub configuration

Hinweis

Dieser Verweis ist Teil der Azure-iot-Erweiterung für die Azure CLI (Version 2.30.0 oder höher). Die Erweiterung wird beim ersten Ausführen eines Az iot Hub-Konfigurationsbefehls automatisch installiert. Weitere Informationen zu Erweiterungen

Verwalten Sie die Konfiguration für die automatische Verwaltung von IoT-Geräten im großen Stil.

Befehle

az iot hub configuration create	Erstellen Sie eine Automatische Geräteverwaltungskonfiguration in einem Ziel IoT Hub.
az iot hub configuration delete	Löschen einer IoT-Gerätekonfiguration.
az iot hub configuration list	Auflisten von automatischen Geräteverwaltungskonfigurationen in einem IoT Hub.
az iot hub configuration show	Rufen Sie die Details einer automatischen Geräteverwaltungskonfiguration für IoT ab.
az iot hub configuration show-metric	Bewerten Sie eine Zielbenutzer- oder Systemmetrik, die in einer IoT-Gerätekonfiguration definiert ist.
az iot hub configuration update	Aktualisieren sie die angegebenen Eigenschaften einer automatischen Geräteverwaltungskonfiguration für IoT. Verwenden Sie --set gefolgt von Eigenschaftenzuweisungen zum Aktualisieren einer Konfiguration. Hinweis: Der Konfigurationsinhalt ist unveränderlich. Konfigurationseigenschaften, die aktualisiert werden können, sind "Bezeichnungen", "Metriken", "Priorität" und "targetCondition".

az iot hub configuration create

Erstellen Sie eine Automatische Geräteverwaltungskonfiguration in einem Ziel IoT Hub.

Konfigurationsinhalte sind json und variieren leicht je nach Geräte- oder Modulabsicht.

Gerätekonfigurationen sind in Form von {"deviceContent":{...}} oder {"content":{"deviceContent":{...}}}

Modulkonfigurationen sind in Form von {"moduleContent":{...}} oder {"content":{"moduleContent":{...}}}

Konfigurationen können mit vom Benutzer bereitgestellten Metriken für die Bedarfsbewertung definiert werden. Benutzermetriken sind json und in Form von {"query":{...}} oder {"Metriken":{"query":{...}}}}.

Hinweis: Zielbedingung für Module muss mit "from devices.modules where" beginnen.

az iot hub configuration create --config-id
                                --content
                                [--auth-type {key, login}]
                                [--hub-name]
                                [--lab]
                                [--login]
                                [--metrics]
                                [--pri]
                                [--resource-group]
                                [--target-condition]

Beispiele

Erstellen Sie eine Gerätekonfiguration mit einer Priorität von 3, die auf Bedingung angewendet wird, wenn ein Gerät in Gebäude 9 gekennzeichnet ist und die Umgebung "Test" ist.

az iot hub configuration create -c {config_name} -n {iothub_name} --content device_content.json --target-condition "tags.building=9 and tags.environment='test'" --priority 3

Erstellen einer Gerätekonfiguration mit Bezeichnungen und Bereitstellen von Benutzermetriken inline (Bash-Syntaxbeispiel)

az iot hub configuration create -c {config_name} -n {iothub_name} --content device_content.json --target-condition "tags.building=9" --labels '{"key0":"value0", "key1":"value1"}' --priority 10 --metrics '{"metrics": {"queries": {"mymetric": "select deviceId from devices where tags.location='US'"}}}'

Erstellen einer Modulkonfiguration mit Bezeichnungen und Bereitstellen von Benutzermetriken inline (cmd-Syntaxbeispiel)

az iot hub configuration create -c {config_name} -n {iothub_name} --content module_content.json --target-condition "from devices.modules where tags.building=9" --labels "{\"key0\":\"value0\", \"key1\":\"value1\"}" --metrics "{\"metrics\": {\"queries\": {\"mymetric\": \"select moduleId from devices.modules where tags.location='US'\"}}}"

Erstellen einer Modulkonfiguration mit Inhalts- und Benutzermetriken inline (PowerShell-Syntaxbeispiel)

az iot hub configuration create -c {config_name} -n {iothub_name} --content '{\"moduleContent\": {\"properties.desired.chillerWaterSettings\": {\"temperature\": 38, \"pressure\": 78}}}' --target-condition "from devices.modules where tags.building=9" --priority 1 --metrics '{\"metrics\": {\"queries\": {\"mymetric\":\"select moduleId from devices.modules where tags.location=''US''\"}}}'

Erforderliche Parameter

--config-id -c

Zielgerätkonfigurationsname.

--content -k

Gerätekonfigurationsinhalte. Geben Sie Dateipfad oder unformatierte JSON an.

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 Zielkonfiguration angewendet werden sollen. Formatbeispiel: {"key0":"value0", "key1":"value1"}.

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

Gerätekonfigurationsmetrikdefinitionen. Geben Sie Dateipfad oder unformatierte JSON an.

--pri --priority

Gewichtung der Gerätekonfiguration 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 Geräte- oder Modulkonfiguration angewendet wird. Konfigurationen ohne Zielbedingung zielen auf kein Gerät oder Modul 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 hub configuration delete

Löschen einer IoT-Gerätekonfiguration.

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

Erforderliche Parameter

--config-id -c

Zielgerätkonfigurationsname.

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 hub configuration list

Auflisten von automatischen Geräteverwaltungskonfigurationen in einem IoT Hub.

az iot hub configuration 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 Konfigurationen, die zurückgegeben werden sollen. Standardmäßig werden alle Konfigurationen 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 hub configuration show

Rufen Sie die Details einer automatischen Geräteverwaltungskonfiguration für IoT ab.

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

Erforderliche Parameter

--config-id -c

Zielgerätkonfigurationsname.

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.

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 hub configuration show-metric

Bewerten Sie eine Zielbenutzer- oder Systemmetrik, die in einer IoT-Gerätekonfiguration definiert ist.

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

Beispiele

Bewerten der benutzerdefinierten "warningLimit"-Metrik

az iot hub configuration show-metric -m warningLimit -c {configuration_name} -n {iothub_name}

Bewerten der Metrik 'appliedCount' des Systems

az iot hub configuration show-metric --metric-id appliedCount -c {configuration_name} -n {iothub_name} --metric-type system

Erforderliche Parameter

--config-id -c

Zielgerätkonfigurationsname.

--metric-id -m

Zielmetrik für die Auswertung.

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.

--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 hub configuration update

Aktualisieren sie die angegebenen Eigenschaften einer automatischen Geräteverwaltungskonfiguration für IoT.

Verwenden Sie --set gefolgt von Eigenschaftenzuweisungen zum Aktualisieren einer Konfiguration.

Hinweis: Der Konfigurationsinhalt ist unveränderlich. Konfigurationseigenschaften, die aktualisiert werden können, sind "Bezeichnungen", "Metriken", "Priorität" und "targetCondition".

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

Beispiele

Ändern der Priorität einer Gerätekonfiguration und Aktualisieren der Zielbedingung

az iot hub configuration update -c {configuration_name} -n {iothub_name} --set priority=10 targetCondition="tags.building=43 and tags.environment='dev'"

Erforderliche Parameter

--config-id -c

Zielgerätkonfigurationsname.

Optionale Parameter

--add

Fügen Sie einem Objekt eine Liste von Objekten 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 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.

--force-string

Wenn Sie "set" oder "add" verwenden, behalten Sie Zeichenfolgen literale beibehalten, anstatt zu versuchen, in JSON zu konvertieren.

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

--remove

Entfernen Sie eine Eigenschaft oder ein Element 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 Eigenschaftenpfad und einen wert angeben, der festgelegt werden soll. 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.