Feedback

az iot hub module-twin

  • Referenz

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-Modul-Twin-Befehls automatisch installiert. Weitere Informationen zu Erweiterungen

Verwalten der Konfiguration von IoT-Modulgerätezwillingen.

Befehle

az iot hub module-twin replace

Ersetzen Sie eine Modul-Twin-Definition durch Ziel-JSON.
az iot hub module-twin show

Zeigen Sie eine Twin-Definition eines Moduls an.
az iot hub module-twin update

Aktualisieren sie die gewünschten Eigenschaften und Tags des Moduls.

az iot hub module-twin replace

Ersetzen Sie eine Modul-Twin-Definition durch Ziel-JSON.

Eingabe json direkt oder Verwenden eines Dateipfads.

az iot hub module-twin replace --device-id
                               --json
                               --module-id
                               [--auth-type {key, login}]
                               [--etag]
                               [--hub-name]
                               [--login]
                               [--resource-group]

Beispiele

Ersetzen Sie einen Modul-Twin durch Dateiinhalte.

az iot hub module-twin replace -d {device_id} -n {iothub_name} -m {module_name} -j ../mymodtwin.json

Erforderliche Parameter

--device-id -d

Zielgerät.

--json -j

JSON zum Ersetzen vorhandener Zwillinge durch. Geben Sie Dateipfad oder unformatierte JSON an.

--module-id -m

Zielmodul.

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.

az iot hub module-twin show

Zeigen Sie eine Twin-Definition eines Moduls an.

az iot hub module-twin show --device-id
                            --module-id
                            [--auth-type {key, login}]
                            [--hub-name]
                            [--login]
                            [--resource-group]

Erforderliche Parameter

--device-id -d

Zielgerät.

--module-id -m

Zielmodul.

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.

az iot hub module-twin update

Aktualisieren sie die gewünschten Eigenschaften und Tags des Moduls.

Stellen Sie Argumente für DAS PATCH-Verhalten bereit. Beide Parameter unterstützen inline json oder einen Dateipfad zu JSON-Inhalten. Die Verwendung generischer Updateargumente (d. h. -set) spiegelt DAS PUT-Verhalten wider und ist veraltet.

az iot hub module-twin update --device-id
                              --module-id
                              [--add]
                              [--auth-type {key, login}]
                              [--desired]
                              [--etag]
                              [--force-string]
                              [--hub-name]
                              [--login]
                              [--remove]
                              [--resource-group]
                              [--set]
                              [--tags]

Beispiele

Patchmodul twin gewünschte Eigenschaften.

az iot hub module-twin update -n {iothub_name} -d {device_id} -m {module_id} --desired '{"conditions":{"temperature":{"warning":70, "critical":100}}}'

Patchmodul-Twintags.

az iot hub module-twin update -n {iothub_name} -d {device_id} -m {module_id} --tags '{"country": "USA"}'

Patchmodul-Twintags mit JSON-Dateiinhalten.

az iot hub module-twin update -n {iothub_name} -d {device_id} -m {module_id} --tags /path/to/file

Patch-Entfernung der gewünschten Eigenschaft aus der übergeordneten "Temperatur"

az iot hub module-twin update -n {iothub_name} -d {device_id} -m {module_id} --desired '{"condition":{"temperature":{"critical": null}}}'

Erforderliche Parameter

--device-id -d

Zielgerät.

--module-id -m

Zielmodul.

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

Zwillingseigenschaften.

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

--tags

Zwillingstags.