Bagikan melalui

az iot device c2d-message

  • 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 device c2d-message . Pelajari lebih lanjut tentang ekstensi.

Perintah olahpesan cloud-ke-perangkat.

Perintah

Nama Deskripsi Jenis Status
az iot device c2d-message abandon

Abaikan pesan cloud-ke-perangkat.

 Ekstensi GA
az iot device c2d-message complete

Selesaikan pesan cloud-ke-perangkat.

 Ekstensi GA
az iot device c2d-message purge

Hapus menyeluruh antrean pesan cloud-ke-perangkat untuk perangkat target.

 Ekstensi GA
az iot device c2d-message receive

Menerima pesan cloud-ke-perangkat.

 Ekstensi GA
az iot device c2d-message reject

Tolak atau matikan pesan cloud-ke-perangkat.

 Ekstensi GA
az iot device c2d-message send

Kirim pesan cloud-ke-perangkat.

 Ekstensi GA

az iot device c2d-message abandon

Abaikan pesan cloud-ke-perangkat.

az iot device c2d-message abandon --device-id
                                  [--etag]
                                  [--hub-name]
                                  [--login]
                                  [--resource-group]

Parameter yang Diperlukan

--device-id -d

Id Perangkat Target.

Parameter Opsional

--etag -e

Tag Etag atau entitas yang sesuai dengan status terakhir sumber daya. Jika tidak ada etag yang disediakan, nilai '*' digunakan.

--hub-name -n

Nama IoT Hub atau nama host. Diperlukan jika --login tidak disediakan.

--login -l

Perintah ini mendukung entitas string koneksi dengan hak untuk melakukan tindakan. Gunakan untuk menghindari login sesi melalui "az login". Jika entitas string koneksi dan nama disediakan, string koneksi lebih diprioritaskan. Diperlukan jika --hub-name tidak disediakan.

--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 device c2d-message complete

Selesaikan pesan cloud-ke-perangkat.

az iot device c2d-message complete --device-id
                                   [--etag]
                                   [--hub-name]
                                   [--login]
                                   [--resource-group]

Parameter yang Diperlukan

--device-id -d

Id Perangkat Target.

Parameter Opsional

--etag -e

Tag Etag atau entitas yang sesuai dengan status terakhir sumber daya. Jika tidak ada etag yang disediakan, nilai '*' digunakan.

--hub-name -n

Nama IoT Hub atau nama host. Diperlukan jika --login tidak disediakan.

--login -l

Perintah ini mendukung entitas string koneksi dengan hak untuk melakukan tindakan. Gunakan untuk menghindari login sesi melalui "az login". Jika entitas string koneksi dan nama disediakan, string koneksi lebih diprioritaskan. Diperlukan jika --hub-name tidak disediakan.

--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 device c2d-message purge

Hapus menyeluruh antrean pesan cloud-ke-perangkat untuk perangkat target.

az iot device c2d-message purge --device-id
                                [--hub-name]
                                [--login]
                                [--resource-group]

Parameter yang Diperlukan

--device-id -d

Id Perangkat Target.

Parameter Opsional

--hub-name -n

Nama IoT Hub atau nama host. Diperlukan jika --login tidak disediakan.

--login -l

Perintah ini mendukung entitas string koneksi dengan hak untuk melakukan tindakan. Gunakan untuk menghindari login sesi melalui "az login". Jika entitas string koneksi dan nama disediakan, string koneksi lebih diprioritaskan. Diperlukan jika --hub-name tidak disediakan.

--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 device c2d-message receive

Menerima pesan cloud-ke-perangkat.

Isi pesan yang diterima hanya akan didekode ketika pengodean kontennya diatur ke 'utf-8', 'utf-16' atau 'utf-32'. Payload pesan akan ditampilkan sebagai {{payload yang tidak dapat didekode}} ketika pengodean konten tidak diatur ke salah satu hal di atas, atau gagal mendekode bahkan ketika pengodean konten diatur ke salah satu di atas.

Catatan: Hanya satu argumen ack pesan [--complete, --reject, --abandon] yang akan diterima.

az iot device c2d-message receive --device-id
                                  [--abandon {false, true}]
                                  [--complete {false, true}]
                                  [--hub-name]
                                  [--lock-timeout]
                                  [--login]
                                  [--reject {false, true}]
                                  [--resource-group]

Contoh

Penggunaan dasar

az iot device c2d-message receive -d {device_id} -n {hub_name} -g {resource_group}

Menerima pesan dan mengatur batas waktu penguncian 30 detik untuk pesan tersebut

az iot device c2d-message receive -d {device_id} -n {hub_name} -g {resource_group} --lt {30}

Terima pesan dan ack sebagai 'lengkap' setelah diterima

az iot device c2d-message receive -d {device_id} -n {hub_name} -g {resource_group} --complete

Menerima pesan dan menolaknya setelah diterima

az iot device c2d-message receive -d {device_id} -n {hub_name} -g {resource_group} --reject

Parameter yang Diperlukan

--device-id -d

Id Perangkat Target.

Parameter Opsional

--abandon

Abaikan pesan cloud-ke-perangkat setelah tanda terima.

Nilai yang diterima: false, true
Nilai default: False
--complete

Selesaikan pesan cloud-ke-perangkat setelah tanda terima.

Nilai yang diterima: false, true
Nilai default: False
--hub-name -n

Nama IoT Hub atau nama host. Diperlukan jika --login tidak disediakan.

--lock-timeout --lt

Menentukan jumlah waktu pesan tidak akan terlihat oleh panggilan penerima lainnya.

Nilai default: 60
--login -l

Perintah ini mendukung entitas string koneksi dengan hak untuk melakukan tindakan. Gunakan untuk menghindari login sesi melalui "az login". Jika entitas string koneksi dan nama disediakan, string koneksi lebih diprioritaskan. Diperlukan jika --hub-name tidak disediakan.

--reject

Tolak pesan cloud-ke-perangkat setelah tanda terima.

Nilai yang diterima: false, true
Nilai default: False
--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 device c2d-message reject

Tolak atau matikan pesan cloud-ke-perangkat.

az iot device c2d-message reject --device-id
                                 [--etag]
                                 [--hub-name]
                                 [--login]
                                 [--resource-group]

Parameter yang Diperlukan

--device-id -d

Id Perangkat Target.

Parameter Opsional

--etag -e

Tag Etag atau entitas yang sesuai dengan status terakhir sumber daya. Jika tidak ada etag yang disediakan, nilai '*' digunakan.

--hub-name -n

Nama IoT Hub atau nama host. Diperlukan jika --login tidak disediakan.

--login -l

Perintah ini mendukung entitas string koneksi dengan hak untuk melakukan tindakan. Gunakan untuk menghindari login sesi melalui "az login". Jika entitas string koneksi dan nama disediakan, string koneksi lebih diprioritaskan. Diperlukan jika --hub-name tidak disediakan.

--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 device c2d-message send

Kirim pesan cloud-ke-perangkat.

Perintah ini mengandalkan dan dapat menginstal paket Cython dependen (uamqp) setelah eksekusi pertama. https://github.com/Azure/azure-uamqp-python

Catatan: Pengodean konten default ke utf-8. Perintah akan mengirim isi pesan dengan tindakan pengodean ketika properti pengodean konten adalah utf-8, utf-16 atau utf-32. Jika nilai pengodean konten bukan salah satu dari ini, properti akan tetap dikirim tanpa tindakan pengodean yang diambil.

Saat mengirim isi pesan biner, konten harus disediakan dari file (melalui --data-file-path) dan jenis konten harus diatur ke application/octet-stream.

az iot device c2d-message send --device-id
                               [--ack {full, negative, positive}]
                               [--auth-type {key, login}]
                               [--ce]
                               [--cid]
                               [--content-type]
                               [--da]
                               [--data-file-path]
                               [--expiry]
                               [--hub-name]
                               [--login]
                               [--message-id]
                               [--properties]
                               [--repair {false, true}]
                               [--resource-group]
                               [--uid]
                               [--wait {false, true}]
                               [--yes {false, true}]

Contoh

Penggunaan dasar dengan isi pesan default

az iot device c2d-message send -d {device_id} -n {iothub_name}

Kirim pesan cloud-ke-perangkat dengan data dan properti kustom.

az iot device c2d-message send -d {device_id} -n {iothub_name} --data 'Hello World' --props 'key0=value0;key1=value1'

Mengirim pesan C2D dan menunggu pengakuan perangkat

az iot device c2d-message send -d {device_id} -n {iothub_name} --ack full --wait

Kirim pesan C2D dalam format biner dari file.

az iot device c2d-message send -d {device_id} -n {iothub_name} --data-file-path {file_path} --content-type 'application/octet-stream'

Kirim pesan C2D dalam format JSON dari file.

az iot device c2d-message send -d {device_id} -n {iothub_name} --data-file-path {file_path} --content-type 'application/json'

Parameter yang Diperlukan

--device-id -d

Id Perangkat Target.

Parameter Opsional

--ack

Minta pengiriman umpan balik per pesan mengenai status akhir pesan tersebut. Deskripsi nilai ack adalah sebagai berikut. Positif: Jika pesan c2d mencapai status Selesai, IoT Hub menghasilkan pesan umpan balik. Negatif: Jika pesan c2d mencapai status Surat mati, IoT Hub menghasilkan pesan umpan balik. Penuh: IoT Hub menghasilkan pesan umpan balik dalam kedua kasus. Secara default, tidak ada ack yang diminta.

Nilai yang diterima: full, negative, positive
--auth-type

Menunjukkan apakah operasi harus memperoleh kunci kebijakan secara otomatis atau menggunakan sesi Azure ACTIVE Directory saat ini. Jika jenis autentikasi masuk dan nama host sumber daya disediakan, pencarian sumber daya akan dilewati kecuali diperlukan. Anda dapat mengonfigurasi default menggunakan az configure --defaults iothub-data-auth-type=<auth-type-value>.

Nilai yang diterima: key, login
Nilai default: key
--ce --content-encoding

Pengodean untuk isi pesan C2D.

Nilai default: utf-8
--cid --correlation-id

Id korelasi yang terkait dengan pesan C2D.

--content-type --ct

Jenis konten untuk isi pesan C2D.

--da --data

Isi pesan. Berikan teks atau json mentah.

Nilai default: Ping from Az CLI IoT Extension
--data-file-path --dfp
Pratinjau

Berikan jalur ke file untuk payload isi pesan. Harap dicatat ketika payload perlu dikirim dalam format biner, atur jenis konten ke application/octet-stream.

--expiry --expiry-time-utc

Unit adalah milidetik sejak zaman unix. Jika tidak ada waktu yang menunjukkan TTL pesan IoT Hub C2D default digunakan.

--hub-name -n

Nama IoT Hub atau nama host. Diperlukan jika --login tidak disediakan.

--login -l

Perintah ini mendukung entitas string koneksi dengan hak untuk melakukan tindakan. Gunakan untuk menghindari login sesi melalui "az login". Jika entitas string koneksi dan nama disediakan, string koneksi lebih diprioritaskan. Diperlukan jika --hub-name tidak disediakan.

--message-id --mid

Id pesan C2D. Jika tidak ada ID pesan yang disediakan, UUID akan dihasilkan.

--properties --props -p

Tas properti pesan dalam pasangan kunci-nilai dengan format berikut: a=b; c=d.

--repair -r

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

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

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

--uid --user-id

Pesan C2D, properti Id pengguna.

--wait -w

Jika mengatur operasi pengiriman c2d akan memblokir hingga umpan balik perangkat diterima.

Nilai yang diterima: false, true
Nilai default: False
--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.