Freigeben über

az iot central device command

  • 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-Zentralen Gerätebefehlsbefehl zum ersten Mal ausführen. Weitere Informationen zu Erweiterungen

Führen Sie Gerätebefehle aus.

Befehle

Name Beschreibung Typ Status
az iot central device command history

Rufen Sie die Details zu der neuesten Befehlsanforderung und -antwort ab, die an das Gerät gesendet wurde.

 Erweiterung Allgemein verfügbar
az iot central device command run

Führen Sie einen Befehl auf einem Gerät aus, und zeigen Sie die zugehörige Antwort an. Überwacht NICHT die Eigenschaftenaktualisierungen, die der Befehl ausführen kann.

 Erweiterung Allgemein verfügbar

az iot central device command history

Rufen Sie die Details zu der neuesten Befehlsanforderung und -antwort ab, die an das Gerät gesendet wurde.

Listet die letzte Befehlsanforderung und -antwort auf, die vom IoT Central an das Gerät gesendet wurde. Alle Aktualisierungen, die das Gerät als Ergebnis der Befehlsausführung ausführt, sind nicht in der Antwort enthalten.

az iot central device command history --app-id
                                      --cn
                                      --device-id
                                      [--api-version {2022-06-30-preview, 2022-07-31}]
                                      [--central-api-uri]
                                      [--co]
                                      [--interface-id]
                                      [--mn]
                                      [--token]

Beispiele

Befehlsantwort anzeigen

az iot central device command history --app-id {appid} --device-id {deviceid} --interface-id {interfaceid} --command-name {commandname}

Komponentenbefehlsantwort anzeigen

az iot central device command history --app-id {appid} --device-id {deviceid} --component-name {componentname} --command-name {commandname}

Anzeigen der Befehlsantwort für Modulkomponenten

az iot central device command history --app-id {appid} --device-id {deviceid} --module-name {modulename} --component-name {componentname} --command-name {commandname}

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

--cn --command-name

Der Befehlsname, wie in der Gerätevorlage angegeben. Der Befehlsname kann sich vom Anzeigenamen des Befehls unterscheiden.

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

--interface-id -i

Der Name der Schnittstelle/Komponente, wie in der Gerätevorlage angegeben. Sie finden sie, indem Sie zu "Gerätevorlage" navigieren und die Schnittstellen-/Komponentenidentität unter der entsprechenden Gerätefunktion anzeigen.

--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 command run

Führen Sie einen Befehl auf einem Gerät aus, und zeigen Sie die zugehörige Antwort an. Überwacht NICHT die Eigenschaftenaktualisierungen, die der Befehl ausführen kann.

--content kann inline json oder Dateipfad sein.

az iot central device command run --app-id
                                  --cn
                                  --content
                                  --device-id
                                  [--api-version {2022-06-30-preview, 2022-07-31}]
                                  [--central-api-uri]
                                  [--co]
                                  [--interface-id]
                                  [--mn]
                                  [--token]

Beispiele

Befehl mit Inlinenutzlast ausführen. Nutzlast sollte unter "Anforderung" in json-Zeichenfolge sein

az iot central device command run --app-id {appid} --device-id {deviceid} --interface-id {interfaceid} --command-name {commandname} --content '{"request": {payload}}'

Befehl für kurze Ausführung mit json-Nutzlastpfad.

az iot central device command run -n {appid} -d {deviceid} -i {interfaceid} --cn {commandname} -k {payload_file_path}

Ausführen des Komponentenbefehls.

az iot central device command run -n {appid} -d {deviceid} --co {componentname} --cn {commandname} -k {payload}

Führen Sie den Befehl "Modulkomponente" aus.

az iot central device command run -n {appid} -d {deviceid} --mn {modulename} --co {componentname} --cn {commandname} -k {payload}

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

--cn --command-name

Der Befehlsname, wie in der Gerätevorlage angegeben. Der Befehlsname kann sich vom Anzeigenamen des Befehls unterscheiden.

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

--interface-id -i

Der Name der Schnittstelle/Komponente, wie in der Gerätevorlage angegeben. Sie finden sie, indem Sie zu "Gerätevorlage" navigieren und die Schnittstellen-/Komponentenidentität unter der entsprechenden Gerätefunktion anzeigen.

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