Feedback

az iot hub digital-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 automatisch installiert, wenn Sie zum ersten Mal einen az iot Hub digital-twin-Befehl ausführen. Weitere Informationen zu Erweiterungen

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

Befehle

az iot hub digital-twin invoke-command

Rufen Sie einen Stamm- oder Komponentenebenenbefehl eines digitalen Zwillingsgeräts auf.
az iot hub digital-twin show

Zeigen Sie den digitalen Twin eines IoT Hub Geräts an.
az iot hub digital-twin update

Aktualisieren Sie die Lesezugriffseigenschaften eines digitalen Zwillingsgeräts über JSON-Patchspezifikation.

az iot hub digital-twin invoke-command

Rufen Sie einen Stamm- oder Komponentenebenenbefehl eines digitalen Zwillingsgerä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 den Befehl "Neustart" auf Stammebene auf, der eine Nutzlast verwendet, die die Eigenschaft "delay" enthält.

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

Rufen Sie den Befehl "getMaxMinReport" auf der Komponente "Thermostat1" auf, die keine Eingabe verwendet.

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

Optionale Parameter

--component-path

Digitaler Twin-Komponentenpfad. Beispiel: Thermostat1.

--connect-timeout --cto

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

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

--payload

JSON-Nutzlasteingabe für Befehl. Bereitstellen des Dateipfads oder inline-JSON.

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.

az iot hub digital-twin show

Zeigen Sie den digitalen Twin 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ät.

Optionale Parameter

--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 digital-twin update

Aktualisieren Sie die Lesezugriffseigenschaften eines digitalen Zwillingsgeräts über 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 Eines digitalen Twins über 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 Eines digitalen Twins über 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 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ät.

--json-patch --patch

Eine Updatespezifikation, die von JSON-Patch beschrieben wird. Vorgänge sind auf das Hinzufügen, Ersetzen und Entfernen beschränkt. Bereitstellen des Dateipfads oder inline-JSON.

Optionale Parameter

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