Dela via

az iot central diagnostics

  • Förhandsgranskning
  • Referens

Kommentar

Den här referensen är en del av azure-iot-tillägget för Azure CLI (version 2.46.0 eller senare). Tillägget installeras automatiskt första gången du kör ett az iot central diagnostikkommando . Läs mer om tillägg.

Den här kommandogruppen är i förhandsversion och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Utför diagnostik på program- och enhetsnivå.

Kommandon

Name Description Typ Status
az iot central diagnostics monitor-events

Visa enhetstelemetrimeddelanden som skickas till IoT Central-appen.

 Anknytning Förhandsversion
az iot central diagnostics monitor-properties

Visa önskade och rapporterade egenskaper som skickas till/från IoT Central-appen.

 Anknytning Förhandsversion
az iot central diagnostics registration-summary

Visa registreringssammanfattningen för alla enheter i en app.

 Anknytning Förhandsversion
az iot central diagnostics validate-messages

Verifiera meddelanden som skickas till IoT Hub för en IoT Central-app.

 Anknytning Förhandsversion
az iot central diagnostics validate-properties

Verifiera rapporterade egenskaper som skickas till IoT Central-programmet.

 Anknytning Förhandsversion

az iot central diagnostics monitor-events

Förhandsgranskning

Kommandogruppen "iot central diagnostics" finns i förhandsversion och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Visa enhetstelemetrimeddelanden som skickas till IoT Central-appen.

Visar telemetridata som skickas till IoT Central-programmet. Som standard visas alla data som skickas av alla enheter. Använd parametern --device-id för att filtrera till en specifik enhet.

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}]

Exempel

Grundläggande användning

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

Grundläggande användning vid filtrering på målenhet

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

Grundläggande användning vid filtrering av målenheter med jokertecken i ID:t

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

Grundläggande användning vid filtrering av modul.

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

Grundläggande användning vid filtrering av målmoduler med jokertecken i ID:t

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

Filtrera enheten och ange en händelsehubbkonsumentgrupp som ska bindas till.

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

Ta emot meddelandeanteckningar (meddelandehuvuden)

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

Ta emot meddelandeanteckningar + systemegenskaper. Överskrid aldrig tidsgränsen.

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

Ta emot alla meddelandeattribut från alla enhetsmeddelanden

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

Ta emot alla meddelanden och parsa meddelandenyttolasten som JSON

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

Obligatoriska parametrar

--app-id -n

App-ID för den IoT Central-app som du vill hantera. Du hittar app-ID:t på sidan "Om" för ditt program under hjälpmenyn.

Valfria parametrar

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

IoT Central DNS-suffixet som är associerat med ditt program.

Standardvärde: azureiotcentral.com
--cg --consumer-group -c

Ange den konsumentgrupp som ska användas när du ansluter till händelsehubbens slutpunkt.

Standardvärde: $Default
--device-id -d

Målenhetens enhets-ID. Du hittar enhets-ID:t genom att klicka på knappen Anslut på sidan Enhetsinformation.

--enqueued-time --et -e

Anger den tid som ska användas som utgångspunkt för att läsa meddelanden från partitionerna. Enheterna är millisekunder sedan unix-epoken. Om ingen tid anges används "nu".

--module-id -m

IoT Edge-modul-ID:t om enhetstypen är IoT Edge.

--properties --props -p

Ange nyckelmeddelandeegenskaper för utdata. sys = systemegenskaper, app = programegenskaper, anno = anteckningar.

Godkända värden: all, anno, app, sys
--repair -r

Installera om uamqp-beroende som är kompatibelt med tilläggsversionen. Standard: falskt.

Godkända värden: false, true
Standardvärde: False
--timeout --to -t

Maximalt antal sekunder för att upprätthålla anslutningen utan att ta emot meddelandet. Använd 0 för oändlighet.

Standardvärde: 300
--token

Om du föredrar att skicka din begäran utan att autentisera mot Azure CLI kan du ange en giltig användartoken för att autentisera din begäran. Du måste ange typ av nyckel som en del av begäran. Läs mer på https://aka.ms/iotcentraldocsapi.

--yes -y

Hoppa över användarprompter. Anger godkännande av åtgärd. Används främst för automatiseringsscenarier. Standard: falskt.

Godkända värden: false, true
Standardvärde: False
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az iot central diagnostics monitor-properties

Förhandsgranskning

Kommandogruppen "iot central diagnostics" finns i förhandsversion och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Visa önskade och rapporterade egenskaper som skickas till/från IoT Central-appen.

Avsöker enhetstvillingen från central och jämför den med den senaste enhetstvillingen Parsar ut egenskaper från enhetstvillingar och identifierar om ändringar har gjorts Utskrifter delmängd av egenskaper som har ändrats inom avsökningsintervallet.

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

Exempel

Grundläggande användning

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

Obligatoriska parametrar

--app-id -n

App-ID för den IoT Central-app som du vill hantera. Du hittar app-ID:t på sidan "Om" för ditt program under hjälpmenyn.

--device-id -d

Målenhetens enhets-ID. Du hittar enhets-ID:t genom att klicka på knappen Anslut på sidan Enhetsinformation.

Valfria parametrar

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

IoT Central DNS-suffixet som är associerat med ditt program.

Standardvärde: azureiotcentral.com
--token

Om du föredrar att skicka din begäran utan att autentisera mot Azure CLI kan du ange en giltig användartoken för att autentisera din begäran. Du måste ange typ av nyckel som en del av begäran. Läs mer på https://aka.ms/iotcentraldocsapi.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az iot central diagnostics registration-summary

Förhandsgranskning

Kommandogruppen "iot central diagnostics" finns i förhandsversion och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Visa registreringssammanfattningen för alla enheter i en app.

Obs! Det här kommandot kan ta lång tid att returnera om appen innehåller många enheter.

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

Exempel

Registreringssammanfattning

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

Obligatoriska parametrar

--app-id -n

App-ID för den IoT Central-app som du vill hantera. Du hittar app-ID:t på sidan "Om" för ditt program under hjälpmenyn.

Valfria parametrar

--api-version --av
Inaktuell

Argumentet "api_version" har blivit inaktuellt och tas bort i en framtida version.

Den här kommandoparametern är inaktuell och ignoreras. I den framtida versionen stöder vi endast IoT Central-API:er från den senaste GA-versionen. Om något API inte är GA ännu anropar vi den senaste förhandsversionen.

Godkända värden: 2022-06-30-preview, 2022-07-31
Standardvärde: 2022-07-31
--central-api-uri --central-dns-suffix

IoT Central DNS-suffixet som är associerat med ditt program.

Standardvärde: azureiotcentral.com
--token

Om du föredrar att skicka din begäran utan att autentisera mot Azure CLI kan du ange en giltig användartoken för att autentisera din begäran. Du måste ange typ av nyckel som en del av begäran. Läs mer på https://aka.ms/iotcentraldocsapi.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az iot central diagnostics validate-messages

Förhandsgranskning

Kommandogruppen "iot central diagnostics" finns i förhandsversion och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Verifiera meddelanden som skickas till IoT Hub för en IoT Central-app.

Utför valideringar på telemetrimeddelandena och rapporterar tillbaka data som inte är modellerade i enhetsmallen eller data där datatypen inte matchar det som definieras i enhetsmallen.

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}]

Exempel

Grundläggande användning

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

Utdatafel när de identifieras

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

Grundläggande användning vid filtrering på målenhet

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

Grundläggande användning vid filtrering av målenheter med jokertecken i ID:t

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

Grundläggande användning vid filtrering av modul.

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

Grundläggande användning vid filtrering av målmoduler med jokertecken i ID:t

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

Filtrera enheten och ange en händelsehubbkonsumentgrupp som ska bindas till.

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

Obligatoriska parametrar

--app-id -n

App-ID för den IoT Central-app som du vill hantera. Du hittar app-ID:t på sidan "Om" för ditt program under hjälpmenyn.

Valfria parametrar

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

IoT Central DNS-suffixet som är associerat med ditt program.

Standardvärde: azureiotcentral.com
--cg --consumer-group -c

Ange den konsumentgrupp som ska användas när du ansluter till händelsehubbens slutpunkt.

Standardvärde: $Default
--device-id -d

Målenhetens enhets-ID. Du hittar enhets-ID:t genom att klicka på knappen Anslut på sidan Enhetsinformation.

--dr --duration

Maximal varaktighet för att ta emot meddelanden från målenheten innan anslutningen avslutas. Använd 0 för oändlighet.

Standardvärde: 300
--enqueued-time --et -e

Anger den tid som ska användas som utgångspunkt för att läsa meddelanden från partitionerna. Enheterna är millisekunder sedan unix-epoken. Om ingen tid anges används "nu".

--max-messages --mm

Maximalt antal meddelanden som ska tas emot från målenheten innan anslutningen avslutas. Använd 0 för oändlighet.

Standardvärde: 10
--minimum-severity

Minsta allvarlighetsgrad för problem som krävs för rapportering.

Godkända värden: error, info, warning
Standardvärde: warning
--module-id -m

IoT Edge-modul-ID:t om enhetstypen är IoT Edge.

--properties --props -p

Ange nyckelmeddelandeegenskaper för utdata. sys = systemegenskaper, app = programegenskaper, anno = anteckningar.

Godkända värden: all, anno, app, sys
--repair -r

Installera om uamqp-beroende som är kompatibelt med tilläggsversionen. Standard: falskt.

Godkända värden: false, true
Standardvärde: False
--style

Ange utdata stylescroll = leverera fel när de tas emot, json = sammanfatta resultat som json, csv = sammanfatta resultat som csv.

Godkända värden: csv, json, scroll
Standardvärde: scroll
--timeout --to -t

Maximalt antal sekunder för att upprätthålla anslutningen utan att ta emot meddelandet. Använd 0 för oändlighet.

Standardvärde: 300
--token

Om du föredrar att skicka din begäran utan att autentisera mot Azure CLI kan du ange en giltig användartoken för att autentisera din begäran. Du måste ange typ av nyckel som en del av begäran. Läs mer på https://aka.ms/iotcentraldocsapi.

--yes -y

Hoppa över användarprompter. Anger godkännande av åtgärd. Används främst för automatiseringsscenarier. Standard: falskt.

Godkända värden: false, true
Standardvärde: False
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az iot central diagnostics validate-properties

Förhandsgranskning

Kommandogruppen "iot central diagnostics" finns i förhandsversion och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Verifiera rapporterade egenskaper som skickas till IoT Central-programmet.

Utför valideringar på rapporterade egenskapsuppdateringar:

  1. Varning – Egenskaper som skickas av en enhet som inte är modellerad i mitten.
  2. Varning – Egenskaper med samma namn deklarerade i flera gränssnitt bör ha gränssnittsnamnet inkluderat som en del av egenskapsuppdateringen.
az iot central diagnostics validate-properties --app-id
                                               --device-id
                                               [--central-api-uri]
                                               [--minimum-severity {error, info, warning}]
                                               [--token]

Exempel

Grundläggande användning

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

Obligatoriska parametrar

--app-id -n

App-ID för den IoT Central-app som du vill hantera. Du hittar app-ID:t på sidan "Om" för ditt program under hjälpmenyn.

--device-id -d

Målenhetens enhets-ID. Du hittar enhets-ID:t genom att klicka på knappen Anslut på sidan Enhetsinformation.

Valfria parametrar

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

IoT Central DNS-suffixet som är associerat med ditt program.

Standardvärde: azureiotcentral.com
--minimum-severity

Minsta allvarlighetsgrad för problem som krävs för rapportering.

Godkända värden: error, info, warning
Standardvärde: warning
--token

Om du föredrar att skicka din begäran utan att autentisera mot Azure CLI kan du ange en giltig användartoken för att autentisera din begäran. Du måste ange typ av nyckel som en del av begäran. Läs mer på https://aka.ms/iotcentraldocsapi.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.