az iot central diagnostics

  • Pratinjau
  • Referensi

Catatan

Referensi ini adalah bagian dari ekstensi azure-iot untuk Azure CLI (versi 2.37.0 atau yang lebih tinggi). Ekstensi akan secara otomatis menginstal pertama kali Anda menjalankan perintah az iot central diagnostics . Pelajari lebih lanjut tentang ekstensi.

Grup perintah ini dalam pratinjau dan sedang dalam pengembangan. Tingkat referensi dan dukungan: https://aka.ms/CLI_refstatus

Lakukan diagnostik tingkat aplikasi dan perangkat.

Perintah

Nama Deskripsi Jenis Status
az iot central diagnostics monitor-events

Lihat pesan telemetri perangkat yang dikirim ke aplikasi IoT Central.

 Ekstensi Pratinjau
az iot central diagnostics monitor-properties

Lihat properti yang diinginkan dan dilaporkan yang dikirim ke/dari aplikasi IoT Central.

 Ekstensi Pratinjau
az iot central diagnostics registration-summary

Lihat ringkasan pendaftaran semua perangkat dalam aplikasi.

 Ekstensi Pratinjau
az iot central diagnostics validate-messages

Validasi pesan yang dikirim ke IoT Hub untuk aplikasi IoT Central.

 Ekstensi Pratinjau
az iot central diagnostics validate-properties

Validasi properti yang dilaporkan yang dikirim ke aplikasi IoT Central.

 Ekstensi Pratinjau

az iot central diagnostics monitor-events

Pratinjau

Grup perintah 'iot central diagnostics' sedang dalam pratinjau dan sedang dalam pengembangan. Tingkat referensi dan dukungan: https://aka.ms/CLI_refstatus

Lihat pesan telemetri perangkat yang dikirim ke aplikasi IoT Central.

Memperlihatkan data telemetri yang dikirim ke aplikasi IoT Central. Secara default, ini menunjukkan semua data yang dikirim oleh semua perangkat. Gunakan parameter --device-id untuk memfilter ke perangkat tertentu.

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

Contoh

Penggunaan dasar

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

Penggunaan dasar saat memfilter pada perangkat target

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

Penggunaan dasar saat memfilter perangkat yang ditargetkan dengan kartubebas dalam ID

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

Penggunaan dasar saat memfilter pada modul.

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

Penggunaan dasar saat memfilter modul yang ditargetkan dengan kartubebas dalam ID

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

Filter perangkat dan tentukan grup konsumen Event Hub yang akan diikat.

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

Menerima anotasi pesan (header pesan)

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

Menerima anotasi pesan + properti sistem. Jangan pernah kehabisan waktu.

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

Menerima semua atribut pesan dari semua pesan perangkat

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

Menerima semua pesan dan mengurai payload pesan sebagai JSON

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

Parameter yang Diperlukan

--app-id -n

ID Aplikasi aplikasi IoT Central yang ingin Anda kelola. Anda dapat menemukan ID Aplikasi di halaman "Tentang" untuk aplikasi Anda di bawah menu bantuan.

Parameter Opsional

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

Akhiran DNS IoT Central yang terkait dengan aplikasi Anda.

nilai default: azureiotcentral.com
--cg --consumer-group -c

Tentukan grup konsumen yang akan digunakan saat menyambungkan ke titik akhir pusat aktivitas.

nilai default: $Default
--device-id -d

ID perangkat perangkat target. Anda dapat menemukan ID perangkat dengan, mengklik tombol Koneksi di halaman Detail Perangkat.

--enqueued-time --et -e

Menunjukkan waktu yang harus digunakan sebagai titik awal untuk membaca pesan dari partisi. Unit adalah milidetik sejak zaman unix. Jika tidak ada waktu yang ditunjukkan "sekarang" digunakan.

--module-id -m

ID Modul IoT Edge jika jenis perangkat adalah IoT Edge.

--properties --props -p

Menunjukkan properti pesan kunci ke output. sys = properti sistem, aplikasi = properti aplikasi, ano = anotasi.

nilai yang diterima: all, anno, app, sys
--repair -r

Instal ulang dependensi uamqp yang kompatibel dengan versi ekstensi. Default: false.

nilai yang diterima: false, true
nilai default: False
--timeout --to -t

Detik maksimum untuk mempertahankan koneksi tanpa menerima pesan. Gunakan 0 untuk tak terbatas.

nilai default: 300
--token

Jika Anda lebih suka mengirimkan permintaan tanpa mengautentikasi terhadap Azure CLI, Anda dapat menentukan token pengguna yang valid untuk mengautentikasi permintaan Anda. Anda harus menentukan jenis kunci sebagai bagian dari permintaan. Pelajari lebih lanjut di https://aka.ms/iotcentraldocsapi.

--yes -y

Lewati permintaan pengguna. Menunjukkan penerimaan tindakan. Digunakan terutama untuk skenario otomatisasi. Default: false.

nilai yang diterima: false, true
nilai default: False
Parameter Global
--debug

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.

az iot central diagnostics monitor-properties

Pratinjau

Grup perintah 'iot central diagnostics' sedang dalam pratinjau dan sedang dalam pengembangan. Tingkat referensi dan dukungan: https://aka.ms/CLI_refstatus

Lihat properti yang diinginkan dan dilaporkan yang dikirim ke/dari aplikasi IoT Central.

Polling perangkat-kembar dari pusat dan membandingkannya dengan perangkat-kembar terakhir Parses properti dari perangkat-kembar, dan mendeteksi apakah perubahan dilakukan Cetak subset properti yang diubah dalam interval polling.

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

Contoh

Penggunaan dasar

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

Parameter yang Diperlukan

--app-id -n

ID Aplikasi aplikasi IoT Central yang ingin Anda kelola. Anda dapat menemukan ID Aplikasi di halaman "Tentang" untuk aplikasi Anda di bawah menu bantuan.

--device-id -d

ID perangkat perangkat target. Anda dapat menemukan ID perangkat dengan, mengklik tombol Koneksi di halaman Detail Perangkat.

Parameter Opsional

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

Akhiran DNS IoT Central yang terkait dengan aplikasi Anda.

nilai default: azureiotcentral.com
--token

Jika Anda lebih suka mengirimkan permintaan tanpa mengautentikasi terhadap Azure CLI, Anda dapat menentukan token pengguna yang valid untuk mengautentikasi permintaan Anda. Anda harus menentukan jenis kunci sebagai bagian dari permintaan. Pelajari lebih lanjut di https://aka.ms/iotcentraldocsapi.

Parameter Global
--debug

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.

az iot central diagnostics registration-summary

Pratinjau

Grup perintah 'iot central diagnostics' sedang dalam pratinjau dan sedang dalam pengembangan. Tingkat referensi dan dukungan: https://aka.ms/CLI_refstatus

Lihat ringkasan pendaftaran semua perangkat dalam aplikasi.

Catatan: Perintah ini dapat memakan waktu yang signifikan untuk dikembalikan jika aplikasi Anda berisi banyak perangkat.

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

Contoh

Ringkasan pendaftaran

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

Parameter yang Diperlukan

--app-id -n

ID Aplikasi aplikasi IoT Central yang ingin Anda kelola. Anda dapat menemukan ID Aplikasi di halaman "Tentang" untuk aplikasi Anda di bawah menu bantuan.

Parameter Opsional

--api-version --av
Tidak digunakan lagi

Argumen 'api_version' telah tidak digunakan lagi dan akan dihapus dalam rilis mendatang.

Parameter perintah ini tidak digunakan lagi dan akan diabaikan. Dalam rilis mendatang, kami hanya akan mendukung API IoT Central dari versi GA terbaru. Jika ada API yang belum GA, kami akan memanggil versi pratinjau terbaru.

nilai yang diterima: 2022-06-30-preview, 2022-07-31
nilai default: 2022-07-31
--central-api-uri --central-dns-suffix

Akhiran DNS IoT Central yang terkait dengan aplikasi Anda.

nilai default: azureiotcentral.com
--token

Jika Anda lebih suka mengirimkan permintaan tanpa mengautentikasi terhadap Azure CLI, Anda dapat menentukan token pengguna yang valid untuk mengautentikasi permintaan Anda. Anda harus menentukan jenis kunci sebagai bagian dari permintaan. Pelajari lebih lanjut di https://aka.ms/iotcentraldocsapi.

Parameter Global
--debug

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.

az iot central diagnostics validate-messages

Pratinjau

Grup perintah 'iot central diagnostics' sedang dalam pratinjau dan sedang dalam pengembangan. Tingkat referensi dan dukungan: https://aka.ms/CLI_refstatus

Validasi pesan yang dikirim ke IoT Hub untuk aplikasi IoT Central.

Melakukan validasi pada pesan telemetri dan melaporkan kembali data yang tidak dimodelkan dalam templat perangkat atau data di mana jenis data tidak cocok dengan apa yang ditentukan dalam templat perangkat.

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

Contoh

Penggunaan dasar

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

Kesalahan output saat terdeteksi

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

Penggunaan dasar saat memfilter pada perangkat target

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

Penggunaan dasar saat memfilter perangkat yang ditargetkan dengan kartubebas dalam ID

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

Penggunaan dasar saat memfilter pada modul.

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

Penggunaan dasar saat memfilter modul yang ditargetkan dengan kartubebas dalam ID

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

Filter perangkat dan tentukan grup konsumen Event Hub yang akan diikat.

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

Parameter yang Diperlukan

--app-id -n

ID Aplikasi aplikasi IoT Central yang ingin Anda kelola. Anda dapat menemukan ID Aplikasi di halaman "Tentang" untuk aplikasi Anda di bawah menu bantuan.

Parameter Opsional

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

Akhiran DNS IoT Central yang terkait dengan aplikasi Anda.

nilai default: azureiotcentral.com
--cg --consumer-group -c

Tentukan grup konsumen yang akan digunakan saat menyambungkan ke titik akhir pusat aktivitas.

nilai default: $Default
--device-id -d

ID perangkat perangkat target. Anda dapat menemukan ID perangkat dengan, mengklik tombol Koneksi di halaman Detail Perangkat.

--dr --duration

Durasi maksimum untuk menerima pesan dari perangkat target sebelum mengakhiri koneksi. Gunakan 0 untuk tak terbatas.

nilai default: 300
--enqueued-time --et -e

Menunjukkan waktu yang harus digunakan sebagai titik awal untuk membaca pesan dari partisi. Unit adalah milidetik sejak zaman unix. Jika tidak ada waktu yang ditunjukkan "sekarang" digunakan.

--max-messages --mm

Jumlah maksimum pesan yang akan diterima dari perangkat target sebelum mengakhiri koneksi. Gunakan 0 untuk tak terbatas.

nilai default: 10
--minimum-severity

Tingkat keparahan minimum masalah yang diperlukan untuk pelaporan.

nilai yang diterima: error, info, warning
nilai default: warning
--module-id -m

ID Modul IoT Edge jika jenis perangkat adalah IoT Edge.

--properties --props -p

Menunjukkan properti pesan kunci ke output. sys = properti sistem, aplikasi = properti aplikasi, ano = anotasi.

nilai yang diterima: all, anno, app, sys
--repair -r

Instal ulang dependensi uamqp yang kompatibel dengan versi ekstensi. Default: false.

nilai yang diterima: false, true
nilai default: False
--style

Menunjukkan stylescroll output = memberikan kesalahan saat tiba, json = meringkas hasil sebagai json, csv = meringkas hasil sebagai csv.

nilai yang diterima: csv, json, scroll
nilai default: scroll
--timeout --to -t

Detik maksimum untuk mempertahankan koneksi tanpa menerima pesan. Gunakan 0 untuk tak terbatas.

nilai default: 300
--token

Jika Anda lebih suka mengirimkan permintaan tanpa mengautentikasi terhadap Azure CLI, Anda dapat menentukan token pengguna yang valid untuk mengautentikasi permintaan Anda. Anda harus menentukan jenis kunci sebagai bagian dari permintaan. Pelajari lebih lanjut di https://aka.ms/iotcentraldocsapi.

--yes -y

Lewati permintaan pengguna. Menunjukkan penerimaan tindakan. Digunakan terutama untuk skenario otomatisasi. Default: false.

nilai yang diterima: false, true
nilai default: False
Parameter Global
--debug

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.

az iot central diagnostics validate-properties

Pratinjau

Grup perintah 'iot central diagnostics' sedang dalam pratinjau dan sedang dalam pengembangan. Tingkat referensi dan dukungan: https://aka.ms/CLI_refstatus

Validasi properti yang dilaporkan yang dikirim ke aplikasi IoT Central.

Melakukan validasi pada pembaruan properti yang dilaporkan:

  1. Peringatan - Properti yang dikirim oleh perangkat yang tidak dimodelkan di pusat.
  2. Peringatan - Properti dengan nama yang sama yang dideklarasikan dalam beberapa antarmuka harus memiliki nama antarmuka yang disertakan sebagai bagian dari pembaruan properti.
az iot central diagnostics validate-properties --app-id
                                               --device-id
                                               [--central-api-uri]
                                               [--minimum-severity {error, info, warning}]
                                               [--token]

Contoh

Penggunaan dasar

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

Parameter yang Diperlukan

--app-id -n

ID Aplikasi aplikasi IoT Central yang ingin Anda kelola. Anda dapat menemukan ID Aplikasi di halaman "Tentang" untuk aplikasi Anda di bawah menu bantuan.

--device-id -d

ID perangkat perangkat target. Anda dapat menemukan ID perangkat dengan, mengklik tombol Koneksi di halaman Detail Perangkat.

Parameter Opsional

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

Akhiran DNS IoT Central yang terkait dengan aplikasi Anda.

nilai default: azureiotcentral.com
--minimum-severity

Tingkat keparahan minimum masalah yang diperlukan untuk pelaporan.

nilai yang diterima: error, info, warning
nilai default: warning
--token

Jika Anda lebih suka mengirimkan permintaan tanpa mengautentikasi terhadap Azure CLI, Anda dapat menentukan token pengguna yang valid untuk mengautentikasi permintaan Anda. Anda harus menentukan jenis kunci sebagai bagian dari permintaan. Pelajari lebih lanjut di https://aka.ms/iotcentraldocsapi.

Parameter Global
--debug

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.