az iot central device 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 zum ersten Mal einen az iot central device twin Befehl ausführen. Erfahren Sie mehr über Erweiterungen.
Verwalten von IoT Central-Geräte-Twins.
Befehle
| Name | Beschreibung | Typ | Status |
|---|---|---|---|
| az iot central device twin replace |
Ersetzen Sie schreibbare Eigenschaftswerte eines Geräts, einer Gerätekomponente oder eines Gerätemoduls oder einer Gerätemodulkomponente. |
Extension | GA |
| az iot central device twin show |
Rufen Sie alle Eigenschaftswerte eines Geräts, einer Gerätekomponente, eines Gerätemoduls oder einer Gerätemodulkomponente ab. |
Extension | GA |
| az iot central device twin update |
Aktualisieren sie schreibbare Eigenschaftswerte eines Geräts, einer Gerätekomponente, eines Gerätemoduls oder einer Gerätemodulkomponente. |
Extension | GA |
az iot central device twin replace
Ersetzen Sie schreibbare Eigenschaftswerte eines Geräts, einer Gerätekomponente oder eines Gerätemoduls oder einer Gerätemodulkomponente.
Bereitstellen von --component-name, --module-name oder beides, um Gerätekomponenteneigenschaften, Gerätemoduleigenschaften oder Komponenteneigenschaften von Gerätemodulen zu ersetzen.
az iot central device twin replace --app-id
--content
--device-id
[--api-version --av {2022-06-30-preview, 2022-07-31}]
[--central-api-uri --central-dns-suffix]
[--co --component-name]
[--mn --module-name]
[--token]
Beispiele
Ersetzen von Geräteeigenschaften
az iot central device twin replace --app-id {appid} --device-id {deviceid} -k {content}
Ersetzen von Gerätekomponenteneigenschaften
az iot central device twin replace --app-id {appid} --device-id {deviceid} --co {componentname} -k {content}
Ersetzen von Komponenteneigenschaften für Gerätemodulen
az iot central device twin replace --app-id {appid} --device-id {deviceid} --mn {modulename} --co {componentname} -k {content}
Erforderliche Parameter
Die App-ID der IoT Central-App, die Sie verwalten möchten. Sie finden die App-ID auf der Seite "Info" für Ihre Anwendung im Hilfemenü.
Konfiguration für Anforderung. Geben Sie Pfad zu JSON-Datei oder unformatierter JSON-Datei an. [Dateipfad(Beispiel): ./path/to/file.json] [Stringified JSON-Beispiel: {'a': 'b'}].
Die Geräte-ID des Zielgeräts. Sie finden die Geräte-ID, indem Sie auf der Seite "Gerätedetails" auf die Schaltfläche "Verbinden" klicken.
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.
Das Argument "api_version" ist veraltet und wird in einer zukünftigen Version entfernt.
Dieser Befehlsparameter ist veraltet und wird ignoriert. In der zukünftigen Version werden wir nur IoT Central APIs von der neuesten GA-Version unterstützen. Wenn eine API noch nicht GA ist, rufen wir die neueste Vorschauversion auf.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | 2022-07-31 |
| Zulässige Werte: | 2022-06-30-preview, 2022-07-31 |
Das IoT Central DNS-Suffix, das Ihrer Anwendung zugeordnet ist.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | azureiotcentral.com |
Der Name der Gerätekomponente.
Der Name des Gerätemoduls.
Wenn Sie Ihre Anforderung lieber übermitteln möchten, ohne sich für die Azure CLI zu authentifizieren, können Sie ein gültiges Benutzertoken angeben, um Ihre Anforderung zu authentifizieren. Sie müssen den Schlüsseltyp als Teil der Anforderung angeben. Weitere Informationen finden Sie unter https://aka.ms/iotcentraldocsapi.
Globale Parameter
Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | False |
Diese Hilfemeldung anzeigen und schließen.
Nur Fehler anzeigen, Warnungen unterdrücken.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | False |
Ausgabeformat.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | json |
| Zulässige Werte: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.
Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.
Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | False |
az iot central device twin show
Rufen Sie alle Eigenschaftswerte eines Geräts, einer Gerätekomponente, eines Gerätemoduls oder einer Gerätemodulkomponente ab.
Bereitstellen von ---component-name, --module-name oder beides zum Abrufen von Gerätekomponenteneigenschaften, Gerätemoduleigenschaften oder Gerätemodulkomponenteneigenschaften.
az iot central device twin show --app-id
--device-id
[--api-version --av {2022-06-30-preview, 2022-07-31}]
[--central-api-uri --central-dns-suffix]
[--co --component-name]
[--mn --module-name]
[--token]
Beispiele
Abrufen von Geräteeigenschaften
az iot central device twin show --app-id {appid} --device-id {deviceid}
Abrufen von Gerätekomponenteneigenschaften
az iot central device twin show --app-id {appid} --device-id {deviceid} --co {componentname}
Abrufen von Komponenteneigenschaften für Gerätemodulen
az iot central device twin show --app-id {appid} --device-id {deviceid} --mn {modulename} --co {componentname}
Erforderliche Parameter
Die App-ID der IoT Central-App, die Sie verwalten möchten. Sie finden die App-ID auf der Seite "Info" für Ihre Anwendung im Hilfemenü.
Die Geräte-ID des Zielgeräts. Sie finden die Geräte-ID, indem Sie auf der Seite "Gerätedetails" auf die Schaltfläche "Verbinden" klicken.
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.
Das Argument "api_version" ist veraltet und wird in einer zukünftigen Version entfernt.
Dieser Befehlsparameter ist veraltet und wird ignoriert. In der zukünftigen Version werden wir nur IoT Central APIs von der neuesten GA-Version unterstützen. Wenn eine API noch nicht GA ist, rufen wir die neueste Vorschauversion auf.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | 2022-07-31 |
| Zulässige Werte: | 2022-06-30-preview, 2022-07-31 |
Das IoT Central DNS-Suffix, das Ihrer Anwendung zugeordnet ist.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | azureiotcentral.com |
Der Name der Gerätekomponente.
Der Name des Gerätemoduls.
Wenn Sie Ihre Anforderung lieber übermitteln möchten, ohne sich für die Azure CLI zu authentifizieren, können Sie ein gültiges Benutzertoken angeben, um Ihre Anforderung zu authentifizieren. Sie müssen den Schlüsseltyp als Teil der Anforderung angeben. Weitere Informationen finden Sie unter https://aka.ms/iotcentraldocsapi.
Globale Parameter
Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | False |
Diese Hilfemeldung anzeigen und schließen.
Nur Fehler anzeigen, Warnungen unterdrücken.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | False |
Ausgabeformat.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | json |
| Zulässige Werte: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.
Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.
Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | False |
az iot central device twin update
Aktualisieren sie schreibbare Eigenschaftswerte eines Geräts, einer Gerätekomponente, eines Gerätemoduls oder einer Gerätemodulkomponente.
Bereitstellen von --component-name, --module-name oder beides zum Aktualisieren von Gerätekomponenteneigenschaften, Gerätemoduleigenschaften oder Gerätemodulkomponenteneigenschaften.
az iot central device twin update --app-id
--content
--device-id
[--api-version --av {2022-06-30-preview, 2022-07-31}]
[--central-api-uri --central-dns-suffix]
[--co --component-name]
[--mn --module-name]
[--token]
Beispiele
Aktualisieren von Geräteeigenschaften
az iot central device twin update --app-id {appid} --device-id {deviceid} -k {content}
Aktualisieren von Gerätekomponenteneigenschaften
az iot central device twin update --app-id {appid} --device-id {deviceid} --co {componentname} -k {content}
Aktualisieren der Komponenteneigenschaften von Gerätemodulen
az iot central device twin update --app-id {appid} --device-id {deviceid} --mn {modulename} --co {componentname} -k {content}
Erforderliche Parameter
Die App-ID der IoT Central-App, die Sie verwalten möchten. Sie finden die App-ID auf der Seite "Info" für Ihre Anwendung im Hilfemenü.
Konfiguration für Anforderung. Geben Sie Pfad zu JSON-Datei oder unformatierter JSON-Datei an. [Dateipfad(Beispiel): ./path/to/file.json] [Stringified JSON-Beispiel: {'a': 'b'}].
Die Geräte-ID des Zielgeräts. Sie finden die Geräte-ID, indem Sie auf der Seite "Gerätedetails" auf die Schaltfläche "Verbinden" klicken.
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.
Das Argument "api_version" ist veraltet und wird in einer zukünftigen Version entfernt.
Dieser Befehlsparameter ist veraltet und wird ignoriert. In der zukünftigen Version werden wir nur IoT Central APIs von der neuesten GA-Version unterstützen. Wenn eine API noch nicht GA ist, rufen wir die neueste Vorschauversion auf.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | 2022-07-31 |
| Zulässige Werte: | 2022-06-30-preview, 2022-07-31 |
Das IoT Central DNS-Suffix, das Ihrer Anwendung zugeordnet ist.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | azureiotcentral.com |
Der Name der Gerätekomponente.
Der Name des Gerätemoduls.
Wenn Sie Ihre Anforderung lieber übermitteln möchten, ohne sich für die Azure CLI zu authentifizieren, können Sie ein gültiges Benutzertoken angeben, um Ihre Anforderung zu authentifizieren. Sie müssen den Schlüsseltyp als Teil der Anforderung angeben. Weitere Informationen finden Sie unter https://aka.ms/iotcentraldocsapi.
Globale Parameter
Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | False |
Diese Hilfemeldung anzeigen und schließen.
Nur Fehler anzeigen, Warnungen unterdrücken.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | False |
Ausgabeformat.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | json |
| Zulässige Werte: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.
Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.
Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | False |