Delen via

az iot central diagnostics

  • Preview
  • Referentie

Notitie

Deze verwijzing maakt deel uit van de Azure-iot-extensie voor de Azure CLI (versie 2.46.0 of hoger). De extensie installeert automatisch de eerste keer dat u een az iot central diagnostics-opdracht uitvoert. Meer informatie over extensies.

Deze opdrachtgroep is in preview en in ontwikkeling. Referentie- en ondersteuningsniveaus: https://aka.ms/CLI_refstatus

Diagnostische gegevens op toepassings- en apparaatniveau uitvoeren.

Opdracht

Name Description Type Status
az iot central diagnostics monitor-events

Telemetrieberichten van apparaten weergeven die naar de IoT Central-app zijn verzonden.

 Toestel Preview uitvoeren
az iot central diagnostics monitor-properties

Bekijk de gewenste en gerapporteerde eigenschappen die zijn verzonden naar/van de IoT Central-app.

 Toestel Preview uitvoeren
az iot central diagnostics registration-summary

Bekijk het registratieoverzicht van alle apparaten in een app.

 Toestel Preview uitvoeren
az iot central diagnostics validate-messages

Valideer berichten die naar de IoT Hub zijn verzonden voor een IoT Central-app.

 Toestel Preview uitvoeren
az iot central diagnostics validate-properties

Controleer gerapporteerde eigenschappen die naar de IoT Central-toepassing zijn verzonden.

 Toestel Preview uitvoeren

az iot central diagnostics monitor-events

Preview

De opdrachtgroep 'Centrale diagnostische gegevens van iot' is in preview en in ontwikkeling. Referentie- en ondersteuningsniveaus: https://aka.ms/CLI_refstatus

Telemetrieberichten van apparaten weergeven die naar de IoT Central-app zijn verzonden.

Toont de telemetriegegevens die naar de IoT Central-toepassing worden verzonden. Standaard worden alle gegevens weergegeven die door alle apparaten worden verzonden. Gebruik de parameter --device-id om te filteren op een specifiek apparaat.

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

Voorbeelden

Basaal gebruik

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

Basisgebruik bij filteren op doelapparaat

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

Basisgebruik bij het filteren van doelapparaten met een jokerteken in de id

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

Basisgebruik bij het filteren op module.

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

Basisgebruik bij het filteren van doelmodules met een jokerteken in de id

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

Filter het apparaat en geef een Event Hub-consumentengroep op waarmee u verbinding wilt maken.

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

Berichtaantekeningen ontvangen (berichtkoppen)

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

Ontvang berichtaantekeningen + systeemeigenschappen. Geen time-out.

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

Alle berichtkenmerken ontvangen van alle apparaatberichten

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

Alle berichten ontvangen en nettolading van berichten parseren als JSON

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

Vereiste parameters

--app-id -n

De app-id van de IoT Central-app die u wilt beheren. U vindt de app-id op de pagina Info voor uw toepassing onder het menu Help.

Optionele parameters

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

Het DNS-achtervoegsel ioT Central dat is gekoppeld aan uw toepassing.

Default value: azureiotcentral.com
--cg --consumer-group -c

Geef de consumentengroep op die moet worden gebruikt bij het maken van verbinding met het Event Hub-eindpunt.

Default value: $Default
--device-id -d

De apparaat-id van het doelapparaat. U vindt de apparaat-id door op de knop Verbinding maken te klikken op de pagina Apparaatdetails.

--enqueued-time --et -e

Geeft de tijd aan die moet worden gebruikt als uitgangspunt om berichten van de partities te lezen. Eenheden zijn milliseconden sinds unix-epoch. Als er geen tijd wordt aangegeven dat 'nu' wordt gebruikt.

--module-id -m

De IoT Edge-module-id als het apparaattype IoT Edge is.

--properties --props -p

Geef de eigenschappen van het sleutelbericht op die moeten worden uitgevoerd. sys = systeemeigenschappen, app = toepassingseigenschappen, anno = aantekeningen.

Geaccepteerde waarden: all, anno, app, sys
--repair -r

Installeer de uamqp-afhankelijkheid opnieuw die compatibel is met de extensieversie. Standaard: onwaar.

Geaccepteerde waarden: false, true
Default value: False
--timeout --to -t

Maximum aantal seconden om verbinding te houden zonder bericht te ontvangen. Gebruik 0 voor oneindigheid.

Default value: 300
--token

Als u liever uw aanvraag indient zonder verificatie bij de Azure CLI, kunt u een geldig gebruikerstoken opgeven om uw aanvraag te verifiëren. U moet het type sleutel opgeven als onderdeel van de aanvraag. Meer informatie op https://aka.ms/iotcentraldocsapi.

--yes -y

Gebruikersprompts overslaan. Geeft de acceptatie van de actie aan. Wordt voornamelijk gebruikt voor automatiseringsscenario's. Standaard: onwaar.

Geaccepteerde waarden: false, true
Default value: False
Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az iot central diagnostics monitor-properties

Preview

De opdrachtgroep 'Centrale diagnostische gegevens van iot' is in preview en in ontwikkeling. Referentie- en ondersteuningsniveaus: https://aka.ms/CLI_refstatus

Bekijk de gewenste en gerapporteerde eigenschappen die zijn verzonden naar/van de IoT Central-app.

Peilt apparaatdubbel van centraal en vergelijkt deze met de laatste eigenschappen van de apparaatdubbel parseert de eigenschappen van de apparaatdubbel en detecteert of er wijzigingen zijn aangebracht in de subset Afdrukken van eigenschappen die zijn gewijzigd binnen het polling-interval.

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

Voorbeelden

Basaal gebruik

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

Vereiste parameters

--app-id -n

De app-id van de IoT Central-app die u wilt beheren. U vindt de app-id op de pagina Info voor uw toepassing onder het menu Help.

--device-id -d

De apparaat-id van het doelapparaat. U vindt de apparaat-id door op de knop Verbinding maken te klikken op de pagina Apparaatdetails.

Optionele parameters

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

Het DNS-achtervoegsel ioT Central dat is gekoppeld aan uw toepassing.

Default value: azureiotcentral.com
--token

Als u liever uw aanvraag indient zonder verificatie bij de Azure CLI, kunt u een geldig gebruikerstoken opgeven om uw aanvraag te verifiëren. U moet het type sleutel opgeven als onderdeel van de aanvraag. Meer informatie op https://aka.ms/iotcentraldocsapi.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az iot central diagnostics registration-summary

Preview

De opdrachtgroep 'Centrale diagnostische gegevens van iot' is in preview en in ontwikkeling. Referentie- en ondersteuningsniveaus: https://aka.ms/CLI_refstatus

Bekijk het registratieoverzicht van alle apparaten in een app.

Opmerking: deze opdracht kan veel tijd in beslag nemen om terug te keren als uw app veel apparaten bevat.

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

Voorbeelden

Registratieoverzicht

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

Vereiste parameters

--app-id -n

De app-id van de IoT Central-app die u wilt beheren. U vindt de app-id op de pagina Info voor uw toepassing onder het menu Help.

Optionele parameters

--api-version --av
Afgeschaft

Het argument 'api_version' is afgeschaft en wordt in een toekomstige release verwijderd.

Deze opdrachtparameter is afgeschaft en wordt genegeerd. In de toekomstige release ondersteunen we alleen IoT Central-API's van de nieuwste GA-versie. Als er nog geen API beschikbaar is, roepen we de nieuwste preview-versie aan.

Geaccepteerde waarden: 2022-06-30-preview, 2022-07-31
Default value: 2022-07-31
--central-api-uri --central-dns-suffix

Het DNS-achtervoegsel ioT Central dat is gekoppeld aan uw toepassing.

Default value: azureiotcentral.com
--token

Als u liever uw aanvraag indient zonder verificatie bij de Azure CLI, kunt u een geldig gebruikerstoken opgeven om uw aanvraag te verifiëren. U moet het type sleutel opgeven als onderdeel van de aanvraag. Meer informatie op https://aka.ms/iotcentraldocsapi.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az iot central diagnostics validate-messages

Preview

De opdrachtgroep 'Centrale diagnostische gegevens van iot' is in preview en in ontwikkeling. Referentie- en ondersteuningsniveaus: https://aka.ms/CLI_refstatus

Valideer berichten die naar de IoT Hub zijn verzonden voor een IoT Central-app.

Voert validaties uit op de telemetrieberichten en rapporteert back-gegevens die niet zijn gemodelleerd in de apparaatsjabloon of gegevens waarvan het gegevenstype niet overeenkomt met wat is gedefinieerd in de apparaatsjabloon.

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

Voorbeelden

Basaal gebruik

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

Uitvoerfouten wanneer ze worden gedetecteerd

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

Basisgebruik bij filteren op doelapparaat

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

Basisgebruik bij het filteren van doelapparaten met een jokerteken in de id

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

Basisgebruik bij het filteren op module.

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

Basisgebruik bij het filteren van doelmodules met een jokerteken in de id

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

Filter het apparaat en geef een Event Hub-consumentengroep op waarmee u verbinding wilt maken.

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

Vereiste parameters

--app-id -n

De app-id van de IoT Central-app die u wilt beheren. U vindt de app-id op de pagina Info voor uw toepassing onder het menu Help.

Optionele parameters

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

Het DNS-achtervoegsel ioT Central dat is gekoppeld aan uw toepassing.

Default value: azureiotcentral.com
--cg --consumer-group -c

Geef de consumentengroep op die moet worden gebruikt bij het maken van verbinding met het Event Hub-eindpunt.

Default value: $Default
--device-id -d

De apparaat-id van het doelapparaat. U vindt de apparaat-id door op de knop Verbinding maken te klikken op de pagina Apparaatdetails.

--dr --duration

Maximale duur voor het ontvangen van berichten van het doelapparaat voordat de verbinding wordt beëindigd. Gebruik 0 voor oneindigheid.

Default value: 300
--enqueued-time --et -e

Geeft de tijd aan die moet worden gebruikt als uitgangspunt om berichten van de partities te lezen. Eenheden zijn milliseconden sinds unix-epoch. Als er geen tijd wordt aangegeven dat 'nu' wordt gebruikt.

--max-messages --mm

Maximum aantal berichten dat moet worden ontvangen van het doelapparaat voordat de verbinding wordt beëindigd. Gebruik 0 voor oneindigheid.

Default value: 10
--minimum-severity

Minimale ernst van het probleem dat is vereist voor rapportage.

Geaccepteerde waarden: error, info, warning
Default value: warning
--module-id -m

De IoT Edge-module-id als het apparaattype IoT Edge is.

--properties --props -p

Geef de eigenschappen van het sleutelbericht op die moeten worden uitgevoerd. sys = systeemeigenschappen, app = toepassingseigenschappen, anno = aantekeningen.

Geaccepteerde waarden: all, anno, app, sys
--repair -r

Installeer de uamqp-afhankelijkheid opnieuw die compatibel is met de extensieversie. Standaard: onwaar.

Geaccepteerde waarden: false, true
Default value: False
--style

Geef uitvoerstijlencroll = leveren fouten wanneer ze binnenkomen, json = samenvattingsresultaten als json, csv = resultaten samenvatten als CSV.

Geaccepteerde waarden: csv, json, scroll
Default value: scroll
--timeout --to -t

Maximum aantal seconden om verbinding te houden zonder bericht te ontvangen. Gebruik 0 voor oneindigheid.

Default value: 300
--token

Als u liever uw aanvraag indient zonder verificatie bij de Azure CLI, kunt u een geldig gebruikerstoken opgeven om uw aanvraag te verifiëren. U moet het type sleutel opgeven als onderdeel van de aanvraag. Meer informatie op https://aka.ms/iotcentraldocsapi.

--yes -y

Gebruikersprompts overslaan. Geeft de acceptatie van de actie aan. Wordt voornamelijk gebruikt voor automatiseringsscenario's. Standaard: onwaar.

Geaccepteerde waarden: false, true
Default value: False
Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az iot central diagnostics validate-properties

Preview

De opdrachtgroep 'Centrale diagnostische gegevens van iot' is in preview en in ontwikkeling. Referentie- en ondersteuningsniveaus: https://aka.ms/CLI_refstatus

Controleer gerapporteerde eigenschappen die naar de IoT Central-toepassing zijn verzonden.

Voert validaties uit voor gerapporteerde eigenschapsupdates:

  1. Waarschuwing: eigenschappen die worden verzonden door een apparaat dat niet centraal is gemodelleerd.
  2. Waarschuwing: eigenschappen met dezelfde naam die in meerdere interfaces zijn gedeclareerd, moeten interfacenaam bevatten als onderdeel van de eigenschapsupdate.
az iot central diagnostics validate-properties --app-id
                                               --device-id
                                               [--central-api-uri]
                                               [--minimum-severity {error, info, warning}]
                                               [--token]

Voorbeelden

Basaal gebruik

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

Vereiste parameters

--app-id -n

De app-id van de IoT Central-app die u wilt beheren. U vindt de app-id op de pagina Info voor uw toepassing onder het menu Help.

--device-id -d

De apparaat-id van het doelapparaat. U vindt de apparaat-id door op de knop Verbinding maken te klikken op de pagina Apparaatdetails.

Optionele parameters

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

Het DNS-achtervoegsel ioT Central dat is gekoppeld aan uw toepassing.

Default value: azureiotcentral.com
--minimum-severity

Minimale ernst van het probleem dat is vereist voor rapportage.

Geaccepteerde waarden: error, info, warning
Default value: warning
--token

Als u liever uw aanvraag indient zonder verificatie bij de Azure CLI, kunt u een geldig gebruikerstoken opgeven om uw aanvraag te verifiëren. U moet het type sleutel opgeven als onderdeel van de aanvraag. Meer informatie op https://aka.ms/iotcentraldocsapi.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.