az iot central diagnostics

Uwaga

Ta dokumentacja jest częścią rozszerzenia azure-iot dla interfejsu wiersza polecenia platformy Azure (wersja 2.37.0 lub nowsza). Rozszerzenie zostanie automatycznie zainstalowane przy pierwszym uruchomieniu polecenia az iot central diagnostics . Dowiedz się więcej o rozszerzeniach.

Ta grupa poleceń jest w wersji zapoznawczej i jest opracowywana. Poziomy odwołań i pomocy technicznej: https://aka.ms/CLI_refstatus

Wykonaj diagnostykę na poziomie aplikacji i urządzenia.

Polecenia

Nazwa Opis Typ Stan
az iot central diagnostics monitor-events

Wyświetlanie komunikatów telemetrycznych urządzenia wysyłanych do aplikacji usługi IoT Central.

Numer wewnętrzny Wersja zapoznawcza
az iot central diagnostics monitor-properties

Wyświetlanie żądanych i zgłoszonych właściwości wysłanych do/z aplikacji usługi IoT Central.

Numer wewnętrzny Wersja zapoznawcza
az iot central diagnostics registration-summary

Wyświetl podsumowanie rejestracji wszystkich urządzeń w aplikacji.

Numer wewnętrzny Wersja zapoznawcza
az iot central diagnostics validate-messages

Zweryfikuj komunikaty wysyłane do usługi IoT Hub dla aplikacji usługi IoT Central.

Numer wewnętrzny Wersja zapoznawcza
az iot central diagnostics validate-properties

Zweryfikuj zgłoszone właściwości wysłane do aplikacji usługi IoT Central.

Numer wewnętrzny Wersja zapoznawcza

az iot central diagnostics monitor-events

Wersja zapoznawcza

Grupa poleceń "centralna diagnostyka systemu iot" jest w wersji zapoznawczej i jest opracowywana. Poziomy odwołań i pomocy technicznej: https://aka.ms/CLI_refstatus

Wyświetlanie komunikatów telemetrycznych urządzenia wysyłanych do aplikacji usługi IoT Central.

Pokazuje dane telemetryczne wysyłane do aplikacji usługi IoT Central. Domyślnie wyświetla wszystkie dane wysyłane przez wszystkie urządzenia. Użyj parametru --device-id, aby filtrować do określonego urządzenia.

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

Przykłady

Podstawowy sposób użycia

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

Podstawowe użycie podczas filtrowania na urządzeniu docelowym

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

Podstawowe użycie podczas filtrowania urządzeń docelowych za pomocą symbolu wieloznakowego w identyfikatorze

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

Podstawowe użycie podczas filtrowania modułu.

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

Podstawowe użycie podczas filtrowania modułów docelowych za pomocą symbolu wieloznakowego w identyfikatorze

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

Filtruj urządzenie i określ grupę odbiorców centrum zdarzeń, z która ma być powiązana.

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

Odbieranie adnotacji komunikatów (nagłówki komunikatów)

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

Odbieranie adnotacji komunikatów i właściwości systemu. Nigdy nie przekroczono limitu czasu.

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

Odbieranie wszystkich atrybutów komunikatów ze wszystkich komunikatów urządzenia

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

Odbieranie wszystkich komunikatów i analizowanie ładunku komunikatu w formacie JSON

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

Parametry wymagane

--app-id -n

Identyfikator aplikacji usługi IoT Central, którą chcesz zarządzać. Identyfikator aplikacji można znaleźć na stronie "Informacje" dla aplikacji w menu pomocy.

Parametry opcjonalne

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

Sufiks DNS usługi IoT Central skojarzony z aplikacją.

wartość domyślna: azureiotcentral.com
--cg --consumer-group -c

Określ grupę odbiorców, która ma być używana podczas nawiązywania połączenia z punktem końcowym centrum zdarzeń.

wartość domyślna: $Default
--device-id -d

Identyfikator urządzenia docelowego. Identyfikator urządzenia można znaleźć, klikając przycisk Połączenie na stronie Szczegóły urządzenia.

--enqueued-time --et -e

Wskazuje czas, który powinien być używany jako punkt wyjścia do odczytywania komunikatów z partycji. Jednostki są milisekundami od epoki unix. Jeśli nie zostanie wyświetlony komunikat "now", jest używany żaden czas.

--module-id -m

Identyfikator modułu usługi IoT Edge, jeśli typ urządzenia to IoT Edge.

--properties --props -p

Wskaż kluczowe właściwości komunikatu do danych wyjściowych. sys = właściwości systemu, aplikacja = właściwości aplikacji, adnotacja = adnotacje.

akceptowane wartości: all, anno, app, sys
--repair -r

Zainstaluj ponownie zależność uamqp zgodną z wersją rozszerzenia. Wartość domyślna: false.

akceptowane wartości: false, true
wartość domyślna: False
--timeout --to -t

Maksymalna liczba sekund do utrzymania połączenia bez odbierania komunikatu. Użyj 0 dla nieskończoności.

wartość domyślna: 300
--token

Jeśli wolisz przesłać żądanie bez uwierzytelniania w interfejsie wiersza polecenia platformy Azure, możesz określić prawidłowy token użytkownika w celu uwierzytelnienia żądania. Musisz określić typ klucza w ramach żądania. Dowiedz się więcej na https://aka.ms/iotcentraldocsapi.

--yes -y

Pomiń monity użytkownika. Wskazuje akceptację akcji. Używane głównie w scenariuszach automatyzacji. Wartość domyślna: false.

akceptowane wartości: false, true
wartość domyślna: False
Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

--output -o

Format danych wyjściowych.

akceptowane wartości: json, jsonc, none, table, tsv, yaml, yamlc
wartość domyślna: json
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

az iot central diagnostics monitor-properties

Wersja zapoznawcza

Grupa poleceń "centralna diagnostyka systemu iot" jest w wersji zapoznawczej i jest opracowywana. Poziomy odwołań i pomocy technicznej: https://aka.ms/CLI_refstatus

Wyświetlanie żądanych i zgłoszonych właściwości wysłanych do/z aplikacji usługi IoT Central.

Sonduje bliźniacze reprezentacje urządzenia z centrum i porównuje je z ostatnimi właściwościami bliźniaczej reprezentacji urządzenia analizuje właściwości z bliźniaczej reprezentacji urządzenia i wykrywa, czy wprowadzono zmiany podzestawu właściwości, które zostały zmienione w interwale sondowania.

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

Przykłady

Podstawowy sposób użycia

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

Parametry wymagane

--app-id -n

Identyfikator aplikacji usługi IoT Central, którą chcesz zarządzać. Identyfikator aplikacji można znaleźć na stronie "Informacje" dla aplikacji w menu pomocy.

--device-id -d

Identyfikator urządzenia docelowego. Identyfikator urządzenia można znaleźć, klikając przycisk Połączenie na stronie Szczegóły urządzenia.

Parametry opcjonalne

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

Sufiks DNS usługi IoT Central skojarzony z aplikacją.

wartość domyślna: azureiotcentral.com
--token

Jeśli wolisz przesłać żądanie bez uwierzytelniania w interfejsie wiersza polecenia platformy Azure, możesz określić prawidłowy token użytkownika w celu uwierzytelnienia żądania. Musisz określić typ klucza w ramach żądania. Dowiedz się więcej na https://aka.ms/iotcentraldocsapi.

Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

--output -o

Format danych wyjściowych.

akceptowane wartości: json, jsonc, none, table, tsv, yaml, yamlc
wartość domyślna: json
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

az iot central diagnostics registration-summary

Wersja zapoznawcza

Grupa poleceń "centralna diagnostyka systemu iot" jest w wersji zapoznawczej i jest opracowywana. Poziomy odwołań i pomocy technicznej: https://aka.ms/CLI_refstatus

Wyświetl podsumowanie rejestracji wszystkich urządzeń w aplikacji.

Uwaga: zwrócenie tego polecenia może zająć dużo czasu, jeśli aplikacja zawiera wiele urządzeń.

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

Przykłady

Podsumowanie rejestracji

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

Parametry wymagane

--app-id -n

Identyfikator aplikacji usługi IoT Central, którą chcesz zarządzać. Identyfikator aplikacji można znaleźć na stronie "Informacje" dla aplikacji w menu pomocy.

Parametry opcjonalne

--api-version --av
Przestarzałe

Argument "api_version" został wycofany i zostanie usunięty w przyszłej wersji.

Ten parametr polecenia został przestarzały i zostanie zignorowany. W przyszłej wersji będziemy obsługiwać tylko interfejsy API usługi IoT Central z najnowszej wersji ogólnie dostępnej. Jeśli jakikolwiek interfejs API nie jest jeszcze ogólnie dostępny, wywołamy najnowszą wersję zapoznawcza.

akceptowane wartości: 2022-06-30-preview, 2022-07-31
wartość domyślna: 2022-07-31
--central-api-uri --central-dns-suffix

Sufiks DNS usługi IoT Central skojarzony z aplikacją.

wartość domyślna: azureiotcentral.com
--token

Jeśli wolisz przesłać żądanie bez uwierzytelniania w interfejsie wiersza polecenia platformy Azure, możesz określić prawidłowy token użytkownika w celu uwierzytelnienia żądania. Musisz określić typ klucza w ramach żądania. Dowiedz się więcej na https://aka.ms/iotcentraldocsapi.

Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

--output -o

Format danych wyjściowych.

akceptowane wartości: json, jsonc, none, table, tsv, yaml, yamlc
wartość domyślna: json
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

az iot central diagnostics validate-messages

Wersja zapoznawcza

Grupa poleceń "centralna diagnostyka systemu iot" jest w wersji zapoznawczej i jest opracowywana. Poziomy odwołań i pomocy technicznej: https://aka.ms/CLI_refstatus

Zweryfikuj komunikaty wysyłane do usługi IoT Hub dla aplikacji usługi IoT Central.

Przeprowadza walidację komunikatów telemetrycznych i zgłasza dane wsteczne, które nie są modelowane w szablonie urządzenia lub danych, w których typ danych nie jest zgodny z definicją w szablonie urządzenia.

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

Przykłady

Podstawowy sposób użycia

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

Błędy wyjściowe wykryte

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

Podstawowe użycie podczas filtrowania na urządzeniu docelowym

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

Podstawowe użycie podczas filtrowania urządzeń docelowych za pomocą symbolu wieloznakowego w identyfikatorze

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

Podstawowe użycie podczas filtrowania modułu.

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

Podstawowe użycie podczas filtrowania modułów docelowych za pomocą symbolu wieloznakowego w identyfikatorze

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

Filtruj urządzenie i określ grupę odbiorców centrum zdarzeń, z która ma być powiązana.

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

Parametry wymagane

--app-id -n

Identyfikator aplikacji usługi IoT Central, którą chcesz zarządzać. Identyfikator aplikacji można znaleźć na stronie "Informacje" dla aplikacji w menu pomocy.

Parametry opcjonalne

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

Sufiks DNS usługi IoT Central skojarzony z aplikacją.

wartość domyślna: azureiotcentral.com
--cg --consumer-group -c

Określ grupę odbiorców, która ma być używana podczas nawiązywania połączenia z punktem końcowym centrum zdarzeń.

wartość domyślna: $Default
--device-id -d

Identyfikator urządzenia docelowego. Identyfikator urządzenia można znaleźć, klikając przycisk Połączenie na stronie Szczegóły urządzenia.

--dr --duration

Maksymalny czas trwania odbierania komunikatów z urządzenia docelowego przed zakończeniem połączenia. Użyj 0 dla nieskończoności.

wartość domyślna: 300
--enqueued-time --et -e

Wskazuje czas, który powinien być używany jako punkt wyjścia do odczytywania komunikatów z partycji. Jednostki są milisekundami od epoki unix. Jeśli nie zostanie wyświetlony komunikat "now", jest używany żaden czas.

--max-messages --mm

Maksymalna liczba komunikatów odbieranych z urządzenia docelowego przed zakończeniem połączenia. Użyj 0 dla nieskończoności.

wartość domyślna: 10
--minimum-severity

Minimalna ważność problemu wymagana do raportowania.

akceptowane wartości: error, info, warning
wartość domyślna: warning
--module-id -m

Identyfikator modułu usługi IoT Edge, jeśli typ urządzenia to IoT Edge.

--properties --props -p

Wskaż kluczowe właściwości komunikatu do danych wyjściowych. sys = właściwości systemu, aplikacja = właściwości aplikacji, adnotacja = adnotacje.

akceptowane wartości: all, anno, app, sys
--repair -r

Zainstaluj ponownie zależność uamqp zgodną z wersją rozszerzenia. Wartość domyślna: false.

akceptowane wartości: false, true
wartość domyślna: False
--style

Wskaż style danych wyjściowychcroll = dostarczaj błędy podczas ich nadejścia, json = summarize results as json, csv = summarize results as csv.

akceptowane wartości: csv, json, scroll
wartość domyślna: scroll
--timeout --to -t

Maksymalna liczba sekund do utrzymania połączenia bez odbierania komunikatu. Użyj 0 dla nieskończoności.

wartość domyślna: 300
--token

Jeśli wolisz przesłać żądanie bez uwierzytelniania w interfejsie wiersza polecenia platformy Azure, możesz określić prawidłowy token użytkownika w celu uwierzytelnienia żądania. Musisz określić typ klucza w ramach żądania. Dowiedz się więcej na https://aka.ms/iotcentraldocsapi.

--yes -y

Pomiń monity użytkownika. Wskazuje akceptację akcji. Używane głównie w scenariuszach automatyzacji. Wartość domyślna: false.

akceptowane wartości: false, true
wartość domyślna: False
Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

--output -o

Format danych wyjściowych.

akceptowane wartości: json, jsonc, none, table, tsv, yaml, yamlc
wartość domyślna: json
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

az iot central diagnostics validate-properties

Wersja zapoznawcza

Grupa poleceń "centralna diagnostyka systemu iot" jest w wersji zapoznawczej i jest opracowywana. Poziomy odwołań i pomocy technicznej: https://aka.ms/CLI_refstatus

Zweryfikuj zgłoszone właściwości wysłane do aplikacji usługi IoT Central.

Przeprowadza walidacje dotyczące raportowanych aktualizacji właściwości:

  1. Ostrzeżenie — właściwości wysyłane przez urządzenie, które nie są modelowane w centrum.
  2. Ostrzeżenie — właściwości o tej samej nazwie zadeklarowanej w wielu interfejsach powinny mieć nazwę interfejsu dołączona w ramach aktualizacji właściwości.
az iot central diagnostics validate-properties --app-id
                                               --device-id
                                               [--central-api-uri]
                                               [--minimum-severity {error, info, warning}]
                                               [--token]

Przykłady

Podstawowy sposób użycia

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

Parametry wymagane

--app-id -n

Identyfikator aplikacji usługi IoT Central, którą chcesz zarządzać. Identyfikator aplikacji można znaleźć na stronie "Informacje" dla aplikacji w menu pomocy.

--device-id -d

Identyfikator urządzenia docelowego. Identyfikator urządzenia można znaleźć, klikając przycisk Połączenie na stronie Szczegóły urządzenia.

Parametry opcjonalne

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

Sufiks DNS usługi IoT Central skojarzony z aplikacją.

wartość domyślna: azureiotcentral.com
--minimum-severity

Minimalna ważność problemu wymagana do raportowania.

akceptowane wartości: error, info, warning
wartość domyślna: warning
--token

Jeśli wolisz przesłać żądanie bez uwierzytelniania w interfejsie wiersza polecenia platformy Azure, możesz określić prawidłowy token użytkownika w celu uwierzytelnienia żądania. Musisz określić typ klucza w ramach żądania. Dowiedz się więcej na https://aka.ms/iotcentraldocsapi.

Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

--output -o

Format danych wyjściowych.

akceptowane wartości: json, jsonc, none, table, tsv, yaml, yamlc
wartość domyślna: json
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.