Freigeben über

az iot central device twin

  • Referenz

Hinweis

Diese Referenz ist Teil der Azure-iot-Erweiterung für die Azure CLI (Version 2.46.0 oder höher). Die Erweiterung wird automatisch installiert, wenn Sie einen az iot Central Device Twin-Befehl zum ersten Mal ausführen. Weitere Informationen zu 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.

 Erweiterung Allgemein verfügbar
az iot central device twin show

Rufen Sie alle Eigenschaftswerte eines Geräts, einer Gerätekomponente, eines Gerätemoduls oder einer Gerätemodulkomponente ab.

 Erweiterung Allgemein verfügbar
az iot central device twin update

Aktualisieren sie schreibbare Eigenschaftswerte eines Geräts, einer Gerätekomponente, eines Gerätemoduls oder einer Gerätemodulkomponente.

 Erweiterung Allgemein verfügbar

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 {2022-06-30-preview, 2022-07-31}]
                                   [--central-api-uri]
                                   [--co]
                                   [--mn]
                                   [--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

--app-id -n

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

--content -k

Konfiguration für Anforderung. Geben Sie Pfad zu JSON-Datei oder unformatierter JSON-Datei an. [Dateipfadbeispiel: ./path/to/file.json] [Stringified JSON-Beispiel: {'a': 'b'}].

--device-id -d

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

--api-version --av
Als veraltet markiert

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.

Zulässige Werte: 2022-06-30-preview, 2022-07-31
Standardwert: 2022-07-31
--central-api-uri --central-dns-suffix

Das IoT Central DNS-Suffix, das Ihrer Anwendung zugeordnet ist.

Standardwert: azureiotcentral.com
--co --component-name

Der Name der Gerätekomponente.

--mn --module-name

Der Name des Gerätemoduls.

--token

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
--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 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 {2022-06-30-preview, 2022-07-31}]
                                [--central-api-uri]
                                [--co]
                                [--mn]
                                [--token]

Beispiele

„Get device properties“ (Geräteeigenschaften abrufen)

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

--app-id -n

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

--device-id -d

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

--api-version --av
Als veraltet markiert

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.

Zulässige Werte: 2022-06-30-preview, 2022-07-31
Standardwert: 2022-07-31
--central-api-uri --central-dns-suffix

Das IoT Central DNS-Suffix, das Ihrer Anwendung zugeordnet ist.

Standardwert: azureiotcentral.com
--co --component-name

Der Name der Gerätekomponente.

--mn --module-name

Der Name des Gerätemoduls.

--token

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
--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 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 {2022-06-30-preview, 2022-07-31}]
                                  [--central-api-uri]
                                  [--co]
                                  [--mn]
                                  [--token]

Beispiele

„Update device properties“ (Geräteeigenschaften aktualisieren)

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

--app-id -n

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

--content -k

Konfiguration für Anforderung. Geben Sie Pfad zu JSON-Datei oder unformatierter JSON-Datei an. [Dateipfadbeispiel: ./path/to/file.json] [Stringified JSON-Beispiel: {'a': 'b'}].

--device-id -d

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

--api-version --av
Als veraltet markiert

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.

Zulässige Werte: 2022-06-30-preview, 2022-07-31
Standardwert: 2022-07-31
--central-api-uri --central-dns-suffix

Das IoT Central DNS-Suffix, das Ihrer Anwendung zugeordnet ist.

Standardwert: azureiotcentral.com
--co --component-name

Der Name der Gerätekomponente.

--mn --module-name

Der Name des Gerätemoduls.

--token

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