az iot device c2d-message

Note

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

Perintah olahpesan cloud-ke-perangkat.

Perintah

Nama	Deskripsi	Jenis	Status
az iot device c2d-message abandon	Abaikan pesan cloud-ke-perangkat.	Extension	GA
az iot device c2d-message complete	Selesaikan pesan cloud-ke-perangkat.	Extension	GA
az iot device c2d-message purge	Hapus menyeluruh antrean pesan cloud-ke-perangkat untuk perangkat target.	Extension	GA
az iot device c2d-message receive	Menerima pesan cloud-ke-perangkat.	Extension	GA
az iot device c2d-message reject	Tolak atau matikan pesan cloud-ke-perangkat.	Extension	GA
az iot device c2d-message send	Kirim pesan cloud-ke-perangkat.	Extension	GA

az iot device c2d-message abandon

Abaikan pesan cloud-ke-perangkat.

az iot device c2d-message abandon --device-id
                                  [--acquire-policy-token]
                                  [--change-reference]
                                  [--etag]
                                  [--hub-name]
                                  [--login]
                                  [--resource-group]

Parameter yang Diperlukan

--device-id -d

Id Perangkat Target.

Parameter Opsional

Parameter berikut bersifat opsional, tetapi tergantung pada konteksnya, satu atau beberapa mungkin menjadi diperlukan agar perintah berhasil dijalankan.

--acquire-policy-token

Memperoleh token Azure Policy secara otomatis untuk operasi sumber daya ini.

Properti	Nilai
Grup parameter:	Global Policy Arguments

--change-reference

ID referensi perubahan terkait untuk operasi sumber daya ini.

Properti	Nilai
Grup parameter:	Global Policy Arguments

--etag -e

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

--hub-name -n

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

Properti	Nilai
Grup parameter:	IoT Hub Identifier Arguments

--login -l

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

Properti	Nilai
Grup parameter:	IoT Hub Identifier Arguments

--resource-group -g

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

Parameter Global

--debug

Tingkatkan verbositas pengelogan untuk menampilkan semua log debug.

Properti	Nilai
Nilai default:	False

--help -h

Tampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya tampilkan kesalahan, menekan peringatan.

Properti	Nilai
Nilai default:	False

--output -o

Format output.

Properti	Nilai
Nilai default:	json
Nilai yang diterima:	json, jsonc, none, table, tsv, yaml, yamlc

--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi dan contoh selengkapnya.

--subscription

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

--verbose

Tingkatkan verbositas pengelogan. Gunakan --debug untuk log debug penuh.

Properti	Nilai
Nilai default:	False

az iot device c2d-message complete

Selesaikan pesan cloud-ke-perangkat.

az iot device c2d-message complete --device-id
                                   [--acquire-policy-token]
                                   [--change-reference]
                                   [--etag]
                                   [--hub-name]
                                   [--login]
                                   [--resource-group]

Parameter yang Diperlukan

--device-id -d

Id Perangkat Target.

Parameter Opsional

Parameter berikut bersifat opsional, tetapi tergantung pada konteksnya, satu atau beberapa mungkin menjadi diperlukan agar perintah berhasil dijalankan.

--acquire-policy-token

Memperoleh token Azure Policy secara otomatis untuk operasi sumber daya ini.

Properti	Nilai
Grup parameter:	Global Policy Arguments

--change-reference

ID referensi perubahan terkait untuk operasi sumber daya ini.

Properti	Nilai
Grup parameter:	Global Policy Arguments

--etag -e

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

--hub-name -n

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

Properti	Nilai
Grup parameter:	IoT Hub Identifier Arguments

--login -l

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

Properti	Nilai
Grup parameter:	IoT Hub Identifier Arguments

--resource-group -g

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

Parameter Global

--debug

Tingkatkan verbositas pengelogan untuk menampilkan semua log debug.

Properti	Nilai
Nilai default:	False

--help -h

Tampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya tampilkan kesalahan, menekan peringatan.

Properti	Nilai
Nilai default:	False

--output -o

Format output.

Properti	Nilai
Nilai default:	json
Nilai yang diterima:	json, jsonc, none, table, tsv, yaml, yamlc

--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi dan contoh selengkapnya.

--subscription

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

--verbose

Tingkatkan verbositas pengelogan. Gunakan --debug untuk log debug penuh.

Properti	Nilai
Nilai default:	False

az iot device c2d-message purge

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

az iot device c2d-message purge --device-id
                                [--acquire-policy-token]
                                [--change-reference]
                                [--hub-name]
                                [--login]
                                [--resource-group]

Parameter yang Diperlukan

--device-id -d

Id Perangkat Target.

Parameter Opsional

Parameter berikut bersifat opsional, tetapi tergantung pada konteksnya, satu atau beberapa mungkin menjadi diperlukan agar perintah berhasil dijalankan.

--acquire-policy-token

Memperoleh token Azure Policy secara otomatis untuk operasi sumber daya ini.

Properti	Nilai
Grup parameter:	Global Policy Arguments

--change-reference

ID referensi perubahan terkait untuk operasi sumber daya ini.

Properti	Nilai
Grup parameter:	Global Policy Arguments

--hub-name -n

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

Properti	Nilai
Grup parameter:	IoT Hub Identifier Arguments

--login -l

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

Properti	Nilai
Grup parameter:	IoT Hub Identifier Arguments

--resource-group -g

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

Parameter Global

--debug

Tingkatkan verbositas pengelogan untuk menampilkan semua log debug.

Properti	Nilai
Nilai default:	False

--help -h

Tampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya tampilkan kesalahan, menekan peringatan.

Properti	Nilai
Nilai default:	False

--output -o

Format output.

Properti	Nilai
Nilai default:	json
Nilai yang diterima:	json, jsonc, none, table, tsv, yaml, yamlc

--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi dan contoh selengkapnya.

--subscription

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

--verbose

Tingkatkan verbositas pengelogan. Gunakan --debug untuk log debug penuh.

Properti	Nilai
Nilai default:	False

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}]
                                  [--acquire-policy-token]
                                  [--change-reference]
                                  [--complete {false, true}]
                                  [--hub-name]
                                  [--lock-timeout --lt]
                                  [--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

Parameter berikut bersifat opsional, tetapi tergantung pada konteksnya, satu atau beberapa mungkin menjadi diperlukan agar perintah berhasil dijalankan.

--abandon

Abaikan pesan cloud-ke-perangkat setelah tanda terima.

Properti	Nilai
Grup parameter:	Message Ack Arguments
Nilai default:	False
Nilai yang diterima:	false, true

--acquire-policy-token

Memperoleh token Azure Policy secara otomatis untuk operasi sumber daya ini.

Properti	Nilai
Grup parameter:	Global Policy Arguments

--change-reference

ID referensi perubahan terkait untuk operasi sumber daya ini.

Properti	Nilai
Grup parameter:	Global Policy Arguments

--complete

Selesaikan pesan cloud-ke-perangkat setelah tanda terima.

Properti	Nilai
Grup parameter:	Message Ack Arguments
Nilai default:	False
Nilai yang diterima:	false, true

--hub-name -n

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

Properti	Nilai
Grup parameter:	IoT Hub Identifier Arguments

--lock-timeout --lt

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

Properti	Nilai
Nilai default:	60

--login -l

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

Properti	Nilai
Grup parameter:	IoT Hub Identifier Arguments

--reject

Tolak pesan cloud-ke-perangkat setelah tanda terima.

Properti	Nilai
Grup parameter:	Message Ack Arguments
Nilai default:	False
Nilai yang diterima:	false, true

--resource-group -g

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

Parameter Global

--debug

Tingkatkan verbositas pengelogan untuk menampilkan semua log debug.

Properti	Nilai
Nilai default:	False

--help -h

Tampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya tampilkan kesalahan, menekan peringatan.

Properti	Nilai
Nilai default:	False

--output -o

Format output.

Properti	Nilai
Nilai default:	json
Nilai yang diterima:	json, jsonc, none, table, tsv, yaml, yamlc

--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi dan contoh selengkapnya.

--subscription

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

--verbose

Tingkatkan verbositas pengelogan. Gunakan --debug untuk log debug penuh.

Properti	Nilai
Nilai default:	False

az iot device c2d-message reject

Tolak atau matikan pesan cloud-ke-perangkat.

az iot device c2d-message reject --device-id
                                 [--acquire-policy-token]
                                 [--change-reference]
                                 [--etag]
                                 [--hub-name]
                                 [--login]
                                 [--resource-group]

Parameter yang Diperlukan

--device-id -d

Id Perangkat Target.

Parameter Opsional

Parameter berikut bersifat opsional, tetapi tergantung pada konteksnya, satu atau beberapa mungkin menjadi diperlukan agar perintah berhasil dijalankan.

--acquire-policy-token

Memperoleh token Azure Policy secara otomatis untuk operasi sumber daya ini.

Properti	Nilai
Grup parameter:	Global Policy Arguments

--change-reference

ID referensi perubahan terkait untuk operasi sumber daya ini.

Properti	Nilai
Grup parameter:	Global Policy Arguments

--etag -e

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

--hub-name -n

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

Properti	Nilai
Grup parameter:	IoT Hub Identifier Arguments

--login -l

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

Properti	Nilai
Grup parameter:	IoT Hub Identifier Arguments

--resource-group -g

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

Parameter Global

--debug

Tingkatkan verbositas pengelogan untuk menampilkan semua log debug.

Properti	Nilai
Nilai default:	False

--help -h

Tampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya tampilkan kesalahan, menekan peringatan.

Properti	Nilai
Nilai default:	False

--output -o

Format output.

Properti	Nilai
Nilai default:	json
Nilai yang diterima:	json, jsonc, none, table, tsv, yaml, yamlc

--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi dan contoh selengkapnya.

--subscription

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

--verbose

Tingkatkan verbositas pengelogan. Gunakan --debug untuk log debug penuh.

Properti	Nilai
Nilai default:	False

az iot device c2d-message send

Kirim pesan cloud-ke-perangkat.

Kirim pesan cloud-ke-perangkat melalui AMQP ke perangkat target.

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}]
                               [--acquire-policy-token]
                               [--auth-type {key, login}]
                               [--ce --content-encoding]
                               [--change-reference]
                               [--cid --correlation-id]
                               [--content-type --ct]
                               [--da --data]
                               [--data-file-path --dfp]
                               [--expiry --expiry-time-utc]
                               [--hub-name]
                               [--login]
                               [--message-id --mid]
                               [--properties --props]
                               [--resource-group]
                               [--uid --user-id]
                               [--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

Parameter berikut bersifat opsional, tetapi tergantung pada konteksnya, satu atau beberapa mungkin menjadi diperlukan agar perintah berhasil dijalankan.

--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.

Properti	Nilai
Nilai yang diterima:	full, negative, positive

--acquire-policy-token

Memperoleh token Azure Policy secara otomatis untuk operasi sumber daya ini.

Properti	Nilai
Grup parameter:	Global Policy Arguments

--auth-type

Menunjukkan apakah operasi harus secara otomatis mendapatkan kunci kebijakan atau menggunakan sesi Azure AD 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}.

Properti	Nilai
Grup parameter:	Access Control Arguments
Nilai default:	key
Nilai yang diterima:	key, login

--ce --content-encoding

Pengodean untuk isi pesan C2D.

Properti	Nilai
Nilai default:	utf-8

--change-reference

ID referensi perubahan terkait untuk operasi sumber daya ini.

Properti	Nilai
Grup parameter:	Global Policy Arguments

--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.

Properti	Nilai
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

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

Properti	Nilai
Grup parameter:	IoT Hub Identifier Arguments

--login -l

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

Properti	Nilai
Grup parameter:	IoT Hub Identifier Arguments

--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.

--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.

Properti	Nilai
Nilai default:	False
Nilai yang diterima:	false, true

--yes -y

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

Properti	Nilai
Nilai default:	False
Nilai yang diterima:	false, true

Parameter Global

--debug

Tingkatkan verbositas pengelogan untuk menampilkan semua log debug.

Properti	Nilai
Nilai default:	False

--help -h

Tampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya tampilkan kesalahan, menekan peringatan.

Properti	Nilai
Nilai default:	False

--output -o

Format output.

Properti	Nilai
Nilai default:	json
Nilai yang diterima:	json, jsonc, none, table, tsv, yaml, yamlc

--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi dan contoh selengkapnya.

--subscription

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

--verbose

Tingkatkan verbositas pengelogan. Gunakan --debug untuk log debug penuh.

Properti	Nilai
Nilai default:	False