az iot hub digital-twin

  • Referenz

Hinweis

Diese Referenz ist Teil der Azure-iot-Erweiterung für die Azure CLI (Version 2.37.0 oder höher). Die Erweiterung wird automatisch installiert, wenn Sie einen az iot Hub Digital-Twin-Befehl zum ersten Mal ausführen. Weitere Informationen zu Erweiterungen

Bearbeiten und interagieren Sie mit dem digitalen Zwilling eines IoT Hub-Geräts.

Befehle

Name Beschreibung Typ Status
az iot hub digital-twin invoke-command

Rufen Sie einen Befehl auf Stamm- oder Komponentenebene eines digitalen Twin-Geräts auf.

 Durchwahl Allgemein verfügbar
az iot hub digital-twin show

Zeigen Sie den digitalen Zwilling eines IoT Hub-Geräts an.

 Durchwahl Allgemein verfügbar
az iot hub digital-twin update

Aktualisieren Sie die Lese-/Schreibeigenschaften eines digitalen Twin-Geräts über die JSON-Patchspezifikation.

 Durchwahl Allgemein verfügbar

az iot hub digital-twin invoke-command

Rufen Sie einen Befehl auf Stamm- oder Komponentenebene eines digitalen Twin-Geräts auf.

az iot hub digital-twin invoke-command --cn
                                       --device-id
                                       [--component-path]
                                       [--connect-timeout]
                                       [--hub-name]
                                       [--login]
                                       [--payload]
                                       [--resource-group]
                                       [--response-timeout]

Beispiele

Rufen Sie im Allgemeinen den Befehl auf, der eine Nutzlast verwendet, die bestimmte Eigenschaften mithilfe von Inline-JSON enthält.

az iot hub digital-twin invoke-command --command-name {command_name} -n {iothub_name} -d {device_id} --payload '{"property_name": "property_value"}'

Aufrufen des Befehls "reboot" auf Stammebene, der eine Nutzlast mit dem Namen "delay" verwendet, die dem DTDL-Modell entspricht https://github.com/Azure/opendigitaltwins-dtdl/blob/master/DTDL/v2/samples/TemperatureController.json.

az iot hub digital-twin invoke-command --command-name reboot -n {iothub_name} -d {device_id} --payload 5

Rufen Sie den Befehl "getMaxMinReport" für komponente "thermometer1" auf, der keine Eingaben akzeptiert.

az iot hub digital-twin invoke-command --cn getMaxMinReport -n {iothub_name} -d {device_id} --component-path thermostat1

Erforderliche Parameter

--cn --command-name

Name des digitalen Twin-Befehls.

--device-id -d

Zielgeräte-ID.

Optionale Parameter

--component-path

Digital Twin Component Path. Beispiel: Thermometer1.

--connect-timeout --cto

Maximale Zeitintervall in Sekunden, die IoT Hub versucht, eine Verbindung mit dem Gerät herzustellen.

--hub-name -n

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

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

--payload

JSON-Nutzlasteingabe für Befehl. Geben Sie dateipfad oder inline JSON an.

Standardwert: {}
--resource-group -g

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

--response-timeout --rto

Maximale Zeitintervall in Sekunden, dass der Digitale Zwillingsbefehl auf das Ergebnis wartet.

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.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--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 digital-twin show

Zeigen Sie den digitalen Zwilling eines IoT Hub-Geräts an.

az iot hub digital-twin show --device-id
                             [--hub-name]
                             [--login]
                             [--resource-group]

Beispiele

Zeigen Sie den digitalen Zwilling des Zielgeräts an.

az iot hub digital-twin show -n {iothub_name} -d {device_id}

Erforderliche Parameter

--device-id -d

Zielgeräte-ID.

Optionale Parameter

--hub-name -n

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

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

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

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--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 digital-twin update

Aktualisieren Sie die Lese-/Schreibeigenschaften eines digitalen Twin-Geräts über die JSON-Patchspezifikation.

Derzeit sind Vorgänge auf das Hinzufügen, Ersetzen und Entfernen beschränkt.

az iot hub digital-twin update --device-id
                               --json-patch
                               [--etag]
                               [--hub-name]
                               [--login]
                               [--resource-group]

Beispiele

Aktualisieren Sie einen digitalen Zwilling über die JSON-Patchspezifikation.

az iot hub digital-twin update --hub-name {iothub_name} --device-id {device_id} --json-patch '{"op":"add", "path":"/thermostat1/targetTemperature", "value": 54}'

Aktualisieren Sie einen digitalen Zwilling über die JSON-Patchspezifikation.

az iot hub digital-twin update -n {iothub_name} -d {device_id} --json-patch '[
  {"op":"remove", "path":"/thermostat1/targetTemperature"},
  {"op":"add", "path":"/thermostat2/targetTemperature", "value": 22}
]'

Aktualisieren Sie eine digitale Twin-Eigenschaft über die JSON-Patchspezifikation, die in einer Datei definiert ist.

az iot hub digital-twin update -n {iothub_name} -d {device_id} --json-patch ./my/patch/document.json

Erforderliche Parameter

--device-id -d

Zielgeräte-ID.

--json-patch --patch

Eine vom JSON-Patch beschriebene Updatespezifikation. Vorgänge sind auf das Hinzufügen, Ersetzen und Entfernen beschränkt. Geben Sie dateipfad oder inline JSON an.

Optionale Parameter

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

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

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

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--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.