Freigeben über


az iot central diagnostics

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 eine az iot zentrale Diagnose Befehl ausführen. Erfahren Sie mehr über Erweiterungen.

Diese Befehlsgruppe befindet sich in der Vorschau und in der Entwicklung. Referenz- und Supportebenen: https://aka.ms/CLI_refstatus

Führen Sie die Diagnose auf Anwendung und Geräteebene aus.

Befehle

Name Beschreibung Typ Status
az iot central diagnostics monitor-events

Anzeigen von Telemetriemeldungen des Geräts, die an die IoT Central-App gesendet werden.

Extension Preview
az iot central diagnostics monitor-properties

Zeigen Sie die gewünschten und gemeldeten Eigenschaften an/von der IoT Central-App an.View desired and reported properties sent to/from the IoT Central app.

Extension Preview
az iot central diagnostics registration-summary

Zeigen Sie die Registrierungszusammenfassung aller Geräte in einer App an.

Extension Preview
az iot central diagnostics validate-messages

Überprüfen Sie nachrichten, die an den IoT Hub für eine IoT Central-App gesendet wurden.

Extension Preview
az iot central diagnostics validate-properties

Überprüfen sie gemeldete Eigenschaften, die an die IoT Central-Anwendung gesendet wurden.

Extension Preview

az iot central diagnostics monitor-events

Vorschau

Die Befehlsgruppe "iot central diagnostics" befindet sich in der Vorschau und in der Entwicklung. Referenz- und Supportebenen: https://aka.ms/CLI_refstatus

Anzeigen von Telemetriemeldungen des Geräts, die an die IoT Central-App gesendet werden.

Zeigt die Telemetriedaten an, die an die IoT Central-Anwendung gesendet werden. Standardmäßig werden alle von allen Geräten gesendeten Daten angezeigt. Verwenden Sie den Parameter "-device-id", um nach einem bestimmten Gerät zu filtern.

az iot central diagnostics monitor-events --app-id
                                          [--central-api-uri --central-dns-suffix]
                                          [--cg --consumer-group]
                                          [--device-id]
                                          [--enqueued-time --et]
                                          [--module-id]
                                          [--properties --props {all, anno, app, sys}]
                                          [--repair {false, true}]
                                          [--timeout --to]
                                          [--token]
                                          [--yes {false, true}]

Beispiele

Grundlegende Nutzung

az iot central diagnostics monitor-events --app-id {app_id}

Grundlegende Verwendung beim Filtern auf dem Zielgerät

az iot central diagnostics monitor-events --app-id {app_id} -d {device_id}

Grundlegende Verwendung beim Filtern von Zielgeräten mit einem Wildcard in der ID

az iot central diagnostics monitor-events --app-id {app_id} -d Device*d

Grundlegende Verwendung beim Filtern nach Modul.

az iot central diagnostics monitor-events --app-id {app_id} -m {module_id}

Grundlegende Verwendung beim Filtern gezielter Module mit einem Wildcard in der ID

az iot central diagnostics monitor-events --app-id {app_id} -m Module*

Filtern Sie das Gerät, und geben Sie eine Event Hub-Consumergruppe an, an die eine Bindung erfolgen soll.

az iot central diagnostics monitor-events --app-id {app_id} -d {device_id} --cg {consumer_group_name}

Empfangen von Nachrichtenanmerkungen (Nachrichtenkopfzeilen)

az iot central diagnostics monitor-events --app-id {app_id} -d {device_id} --properties anno

Empfangen von Nachrichtenanmerkungen + Systemeigenschaften. Timeout nie.

az iot central diagnostics monitor-events --app-id {app_id} -d {device_id} --properties anno sys --timeout 0

Empfangen aller Nachrichtenattribute von allen Gerätenachrichten

az iot central diagnostics monitor-events --app-id {app_id} --props all

Empfangen aller Nachrichten und Analysieren der Nachrichtennutzlast als JSON

az iot central diagnostics monitor-events --app-id {app_id} --output json

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

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.

--central-api-uri --central-dns-suffix

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

Eigenschaft Wert
Standardwert: azureiotcentral.com
--cg --consumer-group -c

Geben Sie die Consumergruppe an, die beim Herstellen einer Verbindung mit dem Event Hub-Endpunkt verwendet werden soll.

Eigenschaft Wert
Standardwert: $Default
--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.

--enqueued-time --et -e

Gibt die Zeit an, die als Ausgangspunkt zum Lesen von Nachrichten aus den Partitionen verwendet werden soll. Einheiten sind Millisekunden seit unix-Epoche. Wenn keine Uhrzeit angegeben ist, wird "jetzt" verwendet.

--module-id -m

Die IoT Edge-Modul-ID, wenn der Gerätetyp IoT Edge ist.

--properties --props -p

Geben Sie wichtige Nachrichteneigenschaften an, die ausgegeben werden sollen. sys = Systemeigenschaften, App = Anwendungseigenschaften, anno = Anmerkungen.

Eigenschaft Wert
Zulässige Werte: all, anno, app, sys
--repair -r

Installieren Sie uamqp-Abhängigkeit neu, die mit der Erweiterungsversion kompatibel ist. Standardwert: false.

Eigenschaft Wert
Standardwert: False
Zulässige Werte: false, true
--timeout --to -t

Maximale Anzahl von Sekunden, um die Verbindung ohne Empfang einer Nachricht aufrechtzuerhalten. Verwenden Sie 0 für Unendlichkeit.

Eigenschaft Wert
Standardwert: 300
--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.

--yes -y

Benutzeraufforderungen überspringen. Gibt die Annahme der Aktion an. Wird hauptsächlich für Automatisierungsszenarien verwendet. Standardwert: false.

Eigenschaft Wert
Standardwert: False
Zulässige Werte: false, true
Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft Wert
Standardwert: False
--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft Wert
Standardwert: False
--output -o

Ausgabeformat.

Eigenschaft Wert
Standardwert: json
Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft Wert
Standardwert: False

az iot central diagnostics monitor-properties

Vorschau

Die Befehlsgruppe "iot central diagnostics" befindet sich in der Vorschau und in der Entwicklung. Referenz- und Supportebenen: https://aka.ms/CLI_refstatus

Zeigen Sie die gewünschten und gemeldeten Eigenschaften an/von der IoT Central-App an.View desired and reported properties sent to/from the IoT Central app.

Fragt geräte-twin von zentral ab und vergleicht es mit den letzten Geräte-Twin Pars out-Eigenschaften von "device-twin", und erkennt, ob Änderungen vorgenommen wurden Prints Teilmenge der Eigenschaften, die innerhalb des Abrufintervalls geändert wurden.

az iot central diagnostics monitor-properties --app-id
                                              --device-id
                                              [--central-api-uri --central-dns-suffix]
                                              [--token]

Beispiele

Grundlegende Nutzung

az iot central diagnostics monitor-properties --app-id {app_id} -d {device_id}

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

Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.

--central-api-uri --central-dns-suffix

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

Eigenschaft Wert
Standardwert: azureiotcentral.com
--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

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft Wert
Standardwert: False
--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft Wert
Standardwert: False
--output -o

Ausgabeformat.

Eigenschaft Wert
Standardwert: json
Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft Wert
Standardwert: False

az iot central diagnostics registration-summary

Vorschau

Die Befehlsgruppe "iot central diagnostics" befindet sich in der Vorschau und in der Entwicklung. Referenz- und Supportebenen: https://aka.ms/CLI_refstatus

Zeigen Sie die Registrierungszusammenfassung aller Geräte in einer App an.

Hinweis: Dieser Befehl kann viel Zeit in Anspruch nehmen, um zurückzugeben, wenn Ihre App viele Geräte enthält.

az iot central diagnostics registration-summary --app-id
                                                [--api-version --av {2022-06-30-preview, 2022-07-31}]
                                                [--central-api-uri --central-dns-suffix]
                                                [--token]

Beispiele

Registrierungszusammenfassung

az iot central diagnostics registration-summary --app-id {appid}

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

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.

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

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

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

Eigenschaft Wert
Standardwert: azureiotcentral.com
--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

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft Wert
Standardwert: False
--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft Wert
Standardwert: False
--output -o

Ausgabeformat.

Eigenschaft Wert
Standardwert: json
Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft Wert
Standardwert: False

az iot central diagnostics validate-messages

Vorschau

Die Befehlsgruppe "iot central diagnostics" befindet sich in der Vorschau und in der Entwicklung. Referenz- und Supportebenen: https://aka.ms/CLI_refstatus

Überprüfen Sie nachrichten, die an den IoT Hub für eine IoT Central-App gesendet wurden.

Führt Überprüfungen für Telemetriemeldungen aus und meldet Daten zurück, die nicht in der Gerätevorlage oder den Daten modelliert werden, bei denen der Datentyp nicht mit den in der Gerätevorlage definierten Daten übereinstimmt.

az iot central diagnostics validate-messages --app-id
                                             [--central-api-uri --central-dns-suffix]
                                             [--cg --consumer-group]
                                             [--device-id]
                                             [--dr --duration]
                                             [--enqueued-time --et]
                                             [--max-messages --mm]
                                             [--minimum-severity {error, info, warning}]
                                             [--module-id]
                                             [--properties --props {all, anno, app, sys}]
                                             [--repair {false, true}]
                                             [--style {csv, json, scroll}]
                                             [--timeout --to]
                                             [--token]
                                             [--yes {false, true}]

Beispiele

Grundlegende Nutzung

az iot central diagnostics validate-messages --app-id {app_id}

Ausgabefehler, während sie erkannt werden

az iot central diagnostics validate-messages --app-id {app_id} --style scroll

Grundlegende Verwendung beim Filtern auf dem Zielgerät

az iot central diagnostics validate-messages --app-id {app_id} -d {device_id}

Grundlegende Verwendung beim Filtern von Zielgeräten mit einem Wildcard in der ID

az iot central diagnostics validate-messages --app-id {app_id} -d Device*

Grundlegende Verwendung beim Filtern nach Modul.

az iot central diagnostics validate-messages --app-id {app_id} -m {module_id}

Grundlegende Verwendung beim Filtern gezielter Module mit einem Wildcard in der ID

az iot central diagnostics validate-messages --app-id {app_id} -m Module*

Filtern Sie das Gerät, und geben Sie eine Event Hub-Consumergruppe an, an die eine Bindung erfolgen soll.

az iot central diagnostics validate-messages --app-id {app_id} -d {device_id} --cg {consumer_group_name}

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

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.

--central-api-uri --central-dns-suffix

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

Eigenschaft Wert
Standardwert: azureiotcentral.com
--cg --consumer-group -c

Geben Sie die Consumergruppe an, die beim Herstellen einer Verbindung mit dem Event Hub-Endpunkt verwendet werden soll.

Eigenschaft Wert
Standardwert: $Default
--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.

--dr --duration

Maximale Dauer für den Empfang von Nachrichten vom Zielgerät vor dem Beenden der Verbindung. Verwenden Sie 0 für Unendlichkeit.

Eigenschaft Wert
Standardwert: 300
--enqueued-time --et -e

Gibt die Zeit an, die als Ausgangspunkt zum Lesen von Nachrichten aus den Partitionen verwendet werden soll. Einheiten sind Millisekunden seit unix-Epoche. Wenn keine Uhrzeit angegeben ist, wird "jetzt" verwendet.

--max-messages --mm

Maximale Anzahl von Nachrichten, die vom Zielgerät empfangen werden sollen, bevor die Verbindung beendet wird. Verwenden Sie 0 für Unendlichkeit.

Eigenschaft Wert
Standardwert: 10
--minimum-severity

Mindestschwere des Problems, das für die Berichterstellung erforderlich ist.

Eigenschaft Wert
Standardwert: warning
Zulässige Werte: error, info, warning
--module-id -m

Die IoT Edge-Modul-ID, wenn der Gerätetyp IoT Edge ist.

--properties --props -p

Geben Sie wichtige Nachrichteneigenschaften an, die ausgegeben werden sollen. sys = Systemeigenschaften, App = Anwendungseigenschaften, anno = Anmerkungen.

Eigenschaft Wert
Zulässige Werte: all, anno, app, sys
--repair -r

Installieren Sie uamqp-Abhängigkeit neu, die mit der Erweiterungsversion kompatibel ist. Standardwert: false.

Eigenschaft Wert
Standardwert: False
Zulässige Werte: false, true
--style

Angeben von Ausgabestilencroll = Fehler beim Eintreffen, json = Ergebnisse als json zusammenfassen, csv = Ergebnisse als CSV zusammenfassen.

Eigenschaft Wert
Standardwert: scroll
Zulässige Werte: csv, json, scroll
--timeout --to -t

Maximale Anzahl von Sekunden, um die Verbindung ohne Empfang einer Nachricht aufrechtzuerhalten. Verwenden Sie 0 für Unendlichkeit.

Eigenschaft Wert
Standardwert: 300
--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.

--yes -y

Benutzeraufforderungen überspringen. Gibt die Annahme der Aktion an. Wird hauptsächlich für Automatisierungsszenarien verwendet. Standardwert: false.

Eigenschaft Wert
Standardwert: False
Zulässige Werte: false, true
Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft Wert
Standardwert: False
--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft Wert
Standardwert: False
--output -o

Ausgabeformat.

Eigenschaft Wert
Standardwert: json
Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft Wert
Standardwert: False

az iot central diagnostics validate-properties

Vorschau

Die Befehlsgruppe "iot central diagnostics" befindet sich in der Vorschau und in der Entwicklung. Referenz- und Supportebenen: https://aka.ms/CLI_refstatus

Überprüfen sie gemeldete Eigenschaften, die an die IoT Central-Anwendung gesendet wurden.

Führt Überprüfungen für gemeldete Eigenschaftenaktualisierungen durch:

  1. Warnung : Vom Gerät gesendete Eigenschaften, die nicht zentral modelliert sind.
  2. Warnung : Eigenschaften mit demselben Namen, die in mehreren Schnittstellen deklariert sind, sollten im Rahmen der Eigenschaftenaktualisierung enthalten sein.
az iot central diagnostics validate-properties --app-id
                                               --device-id
                                               [--central-api-uri --central-dns-suffix]
                                               [--minimum-severity {error, info, warning}]
                                               [--token]

Beispiele

Grundlegende Nutzung

az iot central diagnostics validate-properties --app-id {app_id} -d {device_id}

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

Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.

--central-api-uri --central-dns-suffix

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

Eigenschaft Wert
Standardwert: azureiotcentral.com
--minimum-severity

Mindestschwere des Problems, das für die Berichterstellung erforderlich ist.

Eigenschaft Wert
Standardwert: warning
Zulässige Werte: error, info, warning
--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

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft Wert
Standardwert: False
--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft Wert
Standardwert: False
--output -o

Ausgabeformat.

Eigenschaft Wert
Standardwert: json
Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft Wert
Standardwert: False