Bagikan melalui

az iot hub message-route

  • Pratinjau
  • Referensi

Catatan

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

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

Mengelola rute hub IoT.

Perintah

Nama Deskripsi Jenis Status
az iot hub message-route create

Tambahkan rute untuk IoT Hub.

 Ekstensi Pratinjau
az iot hub message-route delete

Hapus semua rute atau rute yang disebutkan di IoT Hub.

 Ekstensi Pratinjau
az iot hub message-route fallback

Mengelola rute fallback hub IoT.

 Ekstensi Pratinjau
az iot hub message-route fallback set

Mengaktifkan atau menonaktifkan rute fallback di IoT Hub.

 Ekstensi Pratinjau
az iot hub message-route fallback show

Tampilkan rute fallback IoT Hub.

 Ekstensi Pratinjau
az iot hub message-route list

Dapatkan semua rute di IoT Hub.

 Ekstensi Pratinjau
az iot hub message-route show

Dapatkan informasi tentang rute di IoT Hub.

 Ekstensi Pratinjau
az iot hub message-route test

Uji semua rute atau rute yang disebutkan di IoT Hub.

 Ekstensi Pratinjau
az iot hub message-route update

Memperbarui rute untuk IoT Hub.

 Ekstensi Pratinjau

az iot hub message-route create

Pratinjau

Grup perintah 'iot hub message-route' sedang dalam pratinjau dan sedang dalam pengembangan. Tingkat referensi dan dukungan: https://aka.ms/CLI_refstatus

Tambahkan rute untuk IoT Hub.

az iot hub message-route create --en
                                --hub-name
                                --rn
                                --source-type {deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents}
                                [--condition]
                                [--enabled {false, true}]
                                [--resource-group]

Contoh

Buat rute untuk IoT Hub dengan titik akhir dan jenis sumber yang diberikan "DeviceMessages".

az iot hub message-route create -n {iothub_name} --route-name {route_name} --endpoint-name {endpoint_name} --source DeviceMessages

Buat rute untuk IoT Hub dengan titik akhir bawaan dan jenis sumber "DeviceMessages".

az iot hub message-route create -n {iothub_name} --route-name {route_name} --endpoint-name events --source DeviceMessages

Buat rute yang dinonaktifkan untuk IoT Hub dengan titik akhir yang diberikan, jenis sumber "DigitalTwinChangeEvents" dan kondisi kustom.

az iot hub message-route create -n {iothub_name} --route-name {route_name} --endpoint-name {endpoint_name} --source DigitalTwinChangeEvents --condition {condition} --enabled false

Parameter yang Diperlukan

--en --endpoint --endpoint-name

Nama titik akhir perutean. Untuk titik akhir bawaan, gunakan nama titik akhir 'peristiwa'.

--hub-name -n

Nama IoT Hub.

--rn --route --route-name

Nama rute.

--source-type --type -t

Sumber rute.

Nilai yang diterima: deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents

Parameter Opsional

--condition -c

Kondisi yang dievaluasi untuk menerapkan aturan perutean.

Nilai default: true
--enabled -e

Boolean yang menunjukkan apakah akan mengaktifkan rute ke IoT Hub.

Nilai yang diterima: false, true
Nilai default: True
--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

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 hub message-route delete

Pratinjau

Grup perintah 'iot hub message-route' sedang dalam pratinjau dan sedang dalam pengembangan. Tingkat referensi dan dukungan: https://aka.ms/CLI_refstatus

Hapus semua rute atau rute yang disebutkan di IoT Hub.

az iot hub message-route delete --hub-name
                                [--resource-group]
                                [--rn]
                                [--source-type {deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents}]
                                [--yes {false, true}]

Contoh

Menghapus rute dari IoT Hub.

az iot hub message-route delete -n {iothub_name} --route-name {route_name}

Hapus semua rute jenis sumber "DeviceMessages" dari IoT Hub.

az iot hub message-route delete -n {iothub_name} --source DeviceMessages

Menghapus semua rute dari IoT Hub.

az iot hub message-route delete -n {iothub_name}

Parameter yang Diperlukan

--hub-name -n

Nama IoT Hub.

Parameter Opsional

--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

--rn --route --route-name

Nama rute.

--source-type --type -t

Sumber rute.

Nilai yang diterima: deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents
--yes -y

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

Nilai yang diterima: false, true
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 hub message-route list

Pratinjau

Grup perintah 'iot hub message-route' sedang dalam pratinjau dan sedang dalam pengembangan. Tingkat referensi dan dukungan: https://aka.ms/CLI_refstatus

Dapatkan semua rute di IoT Hub.

az iot hub message-route list --hub-name
                              [--resource-group]
                              [--source-type {deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents}]

Contoh

Dapatkan semua rute dari IoT Hub.

az iot hub message-route list -n {iothub_name}

Dapatkan semua rute jenis sumber "DeviceMessages" dari IoT Hub.

az iot hub message-route list -n {iothub_name} --source DeviceMessages

Parameter yang Diperlukan

--hub-name -n

Nama IoT Hub.

Parameter Opsional

--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

--source-type --type -t

Sumber rute.

Nilai yang diterima: deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents
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 hub message-route show

Pratinjau

Grup perintah 'iot hub message-route' sedang dalam pratinjau dan sedang dalam pengembangan. Tingkat referensi dan dukungan: https://aka.ms/CLI_refstatus

Dapatkan informasi tentang rute di IoT Hub.

az iot hub message-route show --hub-name
                              --rn
                              [--resource-group]

Contoh

Dapatkan informasi rute dari IoT Hub.

az iot hub message-route show -n {iothub_name} --route-name {route_name}

Parameter yang Diperlukan

--hub-name -n

Nama IoT Hub.

--rn --route --route-name

Nama rute.

Parameter Opsional

--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

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 hub message-route test

Pratinjau

Grup perintah 'iot hub message-route' sedang dalam pratinjau dan sedang dalam pengembangan. Tingkat referensi dan dukungan: https://aka.ms/CLI_refstatus

Uji semua rute atau rute yang disebutkan di IoT Hub.

Anda dapat memberikan contoh pesan untuk menguji rute Anda.

az iot hub message-route test --hub-name
                              [--ap]
                              [--body]
                              [--resource-group]
                              [--rn]
                              [--source-type {deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents}]
                              [--sp]

Contoh

Uji rute dari IoT Hub.

az iot hub message-route test -n {iothub_name} --route-name {route_name}

Uji semua rute jenis sumber "DeviceMessages" dari IoT Hub.

az iot hub message-route test -n {iothub_name} --source DeviceMessages

Uji semua rute dari IoT Hub dengan pesan kustom, termasuk isi, properti aplikasi, dan properti sistem.

az iot hub message-route test -n {iothub_name} -b {body} --ap {app_properties} --sp {system_properties}

Parameter yang Diperlukan

--hub-name -n

Nama IoT Hub.

Parameter Opsional

--ap --app-properties

Properti aplikasi pesan rute.

--body -b

Isi pesan rute.

--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

--rn --route --route-name

Nama rute.

--source-type --type -t

Sumber rute.

Nilai yang diterima: deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents
--sp --system-properties

Properti sistem pesan rute.

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 hub message-route update

Pratinjau

Grup perintah 'iot hub message-route' sedang dalam pratinjau dan sedang dalam pengembangan. Tingkat referensi dan dukungan: https://aka.ms/CLI_refstatus

Memperbarui rute untuk IoT Hub.

Anda dapat mengubah sumber, titik akhir, kondisi, atau status diaktifkan pada rute.

az iot hub message-route update --hub-name
                                --rn
                                [--condition]
                                [--en]
                                [--enabled {false, true}]
                                [--resource-group]
                                [--source-type {deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents}]

Contoh

Perbarui rute ke titik akhir dan jenis sumber tertentu "DeviceMessages".

az iot hub message-route update -n {iothub_name} --route-name {route_name} --endpoint-name {endpoint_name} --source DeviceMessages

Menonaktifkan rute.

az iot hub message-route update -n {iothub_name} --route-name {route_name} --enabled false

Mengubah kondisi rute.

az iot hub message-route update -n {iothub_name} --route-name {route_name} --condition {condition}

Parameter yang Diperlukan

--hub-name -n

Nama IoT Hub.

--rn --route --route-name

Nama rute.

Parameter Opsional

--condition -c

Kondisi yang dievaluasi untuk menerapkan aturan perutean.

--en --endpoint --endpoint-name

Nama titik akhir perutean. Untuk titik akhir bawaan, gunakan nama titik akhir 'peristiwa'.

--enabled -e

Boolean yang menunjukkan apakah akan mengaktifkan rute ke IoT Hub.

Nilai yang diterima: false, true
--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

--source-type --type -t

Sumber rute.

Nilai yang diterima: deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents
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.