Freigeben über

az iot hub module-twin

Note

Diese Referenz ist Teil der Azure-iot-Erweiterung für die Azure CLI (Version 2.67.0 oder höher). Die Erweiterung wird automatisch installiert, wenn Sie ein az iot hub module-twin Befehl ausführen. Erfahren Sie mehr über Erweiterungen.

Verwalten der Konfiguration von IoT-Modulgerätezwillingen.

Befehle

Name Beschreibung Typ Status
az iot hub module-twin replace

Ersetzen Sie eine Twin-Definition eines Moduls durch die Ziel-JSON.

 Extension GA
az iot hub module-twin show

Zeigen Sie eine Twin-Definition des Moduls an.

 Extension GA
az iot hub module-twin update

Aktualisieren Sie die zwillingswilligen Eigenschaften und Tags des Moduls.

 Extension GA

az iot hub module-twin replace

Ersetzen Sie eine Twin-Definition eines Moduls durch die Ziel-JSON.

Geben Sie json direkt ein, oder verwenden Sie einen Dateipfad.

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äte-ID.

--json -j

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

--module-id -m

Zielmodul-ID.

Optionale Parameter

Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.

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

Eigenschaft Wert
Parametergruppe: Access Control Arguments
Standardwert: key
Zulässige Werte: key, login
--etag -e

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

--hub-name -n

IoT Hub-Name oder Hostname. Erforderlich, wenn --login nicht angegeben wird.

Eigenschaft Wert
Parametergruppe: IoT Hub Identifier Arguments
--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.

Eigenschaft Wert
Parametergruppe: IoT Hub Identifier Arguments
--resource-group -g

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

Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft Wert
Standardwert: False
--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft Wert
Standardwert: False
--output -o

Ausgabeformat.

Eigenschaft Wert
Standardwert: json
Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft Wert
Standardwert: False

az iot hub module-twin show

Zeigen Sie eine Twin-Definition des 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äte-ID.

--module-id -m

Zielmodul-ID.

Optionale Parameter

Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.

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

Eigenschaft Wert
Parametergruppe: Access Control Arguments
Standardwert: key
Zulässige Werte: key, login
--hub-name -n

IoT Hub-Name oder Hostname. Erforderlich, wenn --login nicht angegeben wird.

Eigenschaft Wert
Parametergruppe: IoT Hub Identifier Arguments
--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.

Eigenschaft Wert
Parametergruppe: IoT Hub Identifier Arguments
--resource-group -g

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

Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft Wert
Standardwert: False
--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft Wert
Standardwert: False
--output -o

Ausgabeformat.

Eigenschaft Wert
Standardwert: json
Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft Wert
Standardwert: False

az iot hub module-twin update

Aktualisieren Sie die zwillingswilligen Eigenschaften und Tags des Moduls.

Stellen Sie Argumente vom Typ --desired oder --tags 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 desired properties.

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-Twin-Tags mit JSON-Dateiinhalten.

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

Patchentfernung der 'kritischen' gewünschten Eigenschaft aus übergeordnetem '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äte-ID.

--module-id -m

Zielmodul-ID.

Optionale Parameter

Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.

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

Eigenschaft Wert
Parametergruppe: Generic Update Arguments
Standardwert: []
--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}.

Eigenschaft Wert
Parametergruppe: Access Control Arguments
Standardwert: key
Zulässige Werte: key, login
--desired

Twin desired properties.

Eigenschaft Wert
Parametergruppe: Twin Patch Arguments
--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.

Eigenschaft Wert
Parametergruppe: Generic Update Arguments
Standardwert: False
--hub-name -n

IoT Hub-Name oder Hostname. Erforderlich, wenn --login nicht angegeben wird.

Eigenschaft Wert
Parametergruppe: IoT Hub Identifier Arguments
--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.

Eigenschaft Wert
Parametergruppe: IoT Hub Identifier Arguments
--remove

Entfernen sie eine Eigenschaft oder ein Element aus einer Liste. Beispiel: --remove property.list <indexToRemove> ODER --remove propertyToRemove.

Eigenschaft Wert
Parametergruppe: Generic Update Arguments
Standardwert: []
--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 festzulegenden Eigenschaftspfad und -wert angeben. Beispiel: --set property1.property2=<value>.

Eigenschaft Wert
Parametergruppe: Generic Update Arguments
Standardwert: []
--tags

Twin Tags.

Eigenschaft Wert
Parametergruppe: Twin Patch Arguments
Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft Wert
Standardwert: False
--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft Wert
Standardwert: False
--output -o

Ausgabeformat.

Eigenschaft Wert
Standardwert: json
Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft Wert
Standardwert: False