az iot device

  • 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 perangkat az iot. Pelajari lebih lanjut tentang ekstensi.

Manfaatkan simulasi perangkat dan operasi yang ber sentris perangkat lainnya seperti kemampuan olahpesan perangkat-ke-cloud atau cloud-ke-perangkat.

Perintah

Nama Deskripsi Jenis Status
az iot device c2d-message

Perintah olahpesan cloud-ke-perangkat.

 Ekstensi GA
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 registration

Mengelola pendaftaran perangkat IoT untuk IoT Device Provisioning Service.

 Ekstensi Pratinjau
az iot device registration create

Daftarkan perangkat IoT dengan IoT Device Provisioning Service.

 Ekstensi Pratinjau
az iot device send-d2c-message

Kirim pesan perangkat-ke-cloud mqtt.

 Ekstensi GA
az iot device simulate

Mensimulasikan perangkat di Azure IoT Hub.

 Ekstensi Eksperimental
az iot device upload-file

Unggah file lokal sebagai perangkat ke kontainer penyimpanan blob yang telah dikonfigurasi sebelumnya.

 Ekstensi GA

az iot device send-d2c-message

Kirim pesan perangkat-ke-cloud mqtt.

Perintah ini mendukung pengiriman pesan dengan payload kustom dalam string unicode atau format biner. Saat berniat mengirim biner, data harus berasal dari file (melalui --data-file-path) dan jenis konten harus diatur ke application/octet-stream.

Catatan: Perintah hanya berfungsi untuk perangkat berbasis symmetric key auth (SAS). Untuk mengaktifkan kueri pada isi pesan dalam perutean pesan, properti sistem contentType harus aplikasi/JSON dan properti sistem contentEncoding harus menjadi salah satu nilai pengodean UTF yang didukung oleh properti sistem tersebut (UTF-8, UTF-16 atau UTF-32). Jika pengodean konten tidak diatur saat Azure Storage digunakan sebagai titik akhir perutean, maka IoT Hub menulis pesan dalam format berkode base 64. Jika menggunakan metode autentikasi x509, sertifikat dan file kunci (dan frasa sandi jika diperlukan) harus disediakan.

az iot device send-d2c-message --device-id
                               [--certificate-file-path]
                               [--da]
                               [--data-file-path]
                               [--dtmi]
                               [--hub-name]
                               [--key]
                               [--key-file-path]
                               [--login]
                               [--mc]
                               [--pass]
                               [--properties]
                               [--resource-group]

Contoh

Penggunaan dasar

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

Penggunaan dasar untuk perangkat yang mendaftarkan Id model 'dtmi:com:example:Thermostat; 1' setelah koneksi

az iot device send-d2c-message -n {iothub_name} -d {device_id} --model-id 'dtmi:com:example:Thermostat;1'

Penggunaan dasar untuk perangkat dengan autentikasi x509

az iot device send-d2c-message -n {iothub_name} -d {device_id} --cp {certificate_file_path} --kp {key_file_path}

Penggunaan dasar untuk perangkat dengan autentikasi x509 di mana file kunci memiliki frase sandi

az iot device send-d2c-message -n {iothub_name} -d {device_id} --cp {certificate_file_path} --kp {key_file_path} --pass {passphrase}

Penggunaan dasar dengan data kustom

az iot device send-d2c-message -n {iothub_name} -d {device_id} --data {message_body}

Mengirim properti aplikasi

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

Mengirim properti sistem (Id Pesan dan Id Korelasi)

az iot device send-d2c-message -n {iothub_name} -d {device_id} --props '$.mid=<id>;$.cid=<id>'

Mengirim data kustom dengan menentukan jenis konten dan pengodean konten di properti sistem

az iot device send-d2c-message -n {iothub_name} -d {device_id} --props '$.ct=<content-type>;$.ce=<content-encoding>' --data {message_body}

Mengirim data kustom dalam format biner dengan menentukan pengodean konten di properti sistem

az iot device send-d2c-message -n {iothub_name} -d {device_id} --props '$.ct=application/octet-stream' --data-file-path {file_path}

Mengirim data kustom dalam format JSON dengan menentukan jenis konten dan pengodean konten di properti sistem

az iot device send-d2c-message -n {iothub_name} -d {device_id} --props '$.ct=application/json;$.ce=utf-8' --data-file-path {file_path}

Parameter yang Diperlukan

--device-id -d

Id Perangkat Target.

Parameter Opsional

--certificate-file-path --cp

Jalur ke file sertifikat.

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

--dtmi --model-id

Id Model Digital Twin yang akan dilaporkan perangkat saat menyambungkan ke hub. Lihat https://docs.microsoft.com/en-us/azure/iot-develop/overview-iot-plug-and-play untuk detail selengkapnya.

--hub-name -n

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

--key --symmetric-key

Kunci konten yang akan digunakan untuk perangkat. Jika kunci konten dan argumen autentikasi perangkat lainnya disediakan, kunci konten akan diprioritaskan.

--key-file-path --kp

Jalur ke file kunci.

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

--mc --msg-count

Jumlah pesan perangkat yang akan dikirim ke IoT Hub.

nilai default: 1
--pass --passphrase

Frase sandi untuk file kunci.

--properties --props -p

Tas properti pesan dalam pasangan kunci-nilai dengan format berikut: a=b; c=d. Untuk olahpesan mqtt - Anda dapat mengirim properti sistem menggunakan $.=value. Misalnya $.cid=12345 mengatur properti Id korelasi sistem. Contoh pengidentifikasi properti sistem lainnya termasuk $.ct untuk jenis konten, $.mid untuk Id pesan dan $.ce untuk pengodean konten.

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

Eksperimental

Perintah ini bersifat eksperimental dan sedang dikembangkan. Tingkat referensi dan dukungan: https://aka.ms/CLI_refstatus

Mensimulasikan perangkat di Azure IoT Hub.

Saat simulasi perangkat berjalan, perangkat akan secara otomatis menerima dan mengakui pesan cloud-to-device (c2d). Untuk simulasi mqtt, semua pesan c2d akan diakui dengan penyelesaian. Untuk pengakuan c2d simulasi http didasarkan pada pilihan pengguna yang dapat diselesaikan, ditolak, atau ditinggalkan. Simulasi mqtt juga mendukung pemanggilan metode langsung yang dapat diakui oleh kode status respons dan payload respons. Catatan: Perintah secara default akan mengatur jenis konten ke aplikasi/json dan pengodean konten ke utf-8. Ini bisa ditimpa. Catatan: Jika menggunakan metode autentikasi x509, sertifikat dan file kunci (dan frasa sandi jika diperlukan) harus disediakan.

az iot device simulate --device-id
                       [--certificate-file-path]
                       [--da]
                       [--dtmi]
                       [--hub-name]
                       [--init-reported-properties]
                       [--key]
                       [--key-file-path]
                       [--login]
                       [--mc]
                       [--method-response-code]
                       [--method-response-payload]
                       [--mi]
                       [--pass]
                       [--properties]
                       [--proto {http, mqtt}]
                       [--receive-settle {abandon, complete, reject}]
                       [--resource-group]

Contoh

Penggunaan dasar (mqtt)

az iot device simulate -n {iothub_name} -d {device_id}

Penggunaan dasar untuk perangkat yang mendaftarkan Id model 'dtmi:com:example:Thermostat; 1' setelah koneksi (mqtt)

az iot device simulate -n {iothub_name} -d {device_id} --model-id 'dtmi:com:example:Thermostat;1'

Penggunaan dasar untuk perangkat dengan autentikasi x509 (mqtt)

az iot device simulate -n {iothub_name} -d {device_id} --cp {certificate_file_path} --kp {key_file_path}

Penggunaan dasar untuk perangkat dengan autentikasi x509 (mqtt) di mana file kunci memiliki frase sandi

az iot device simulate -n {iothub_name} -d {device_id} --cp {certificate_file_path} --kp {key_file_path} --pass {passphrase}

Mengirim properti campuran (mqtt)

az iot device simulate -n {iothub_name} -d {device_id} --properties "myprop=myvalue;$.ct=application/json"

Kirim kode status respons metode langsung dan payload respons metode langsung sebagai json mentah (hanya mqtt)

az iot device simulate -n {iothub_name} -d {device_id} --method-response-code 201 --method-response-payload '{"result":"Direct method successful"}'

Kirim kode status respons metode langsung dan payload respons metode langsung sebagai jalur ke file lokal (hanya mqtt)

az iot device simulate -n {iothub_name} -d {device_id} --method-response-code 201 --method-response-payload '../my_direct_method_payload.json'

Kirim status awal properti yang dilaporkan kembar perangkat sebagai json mentah untuk perangkat target (hanya mqtt)

az iot device simulate -n {iothub_name} -d {device_id} --init-reported-properties '{"reported_prop_1":"val_1", "reported_prop_2":val_2}'

Kirim status awal properti yang dilaporkan kembar perangkat sebagai jalur ke file lokal untuk perangkat target (hanya mqtt)

az iot device simulate -n {iothub_name} -d {device_id} --init-reported-properties '../my_device_twin_reported_properties.json'

Penggunaan dasar (http)

az iot device simulate -n {iothub_name} -d {device_id} --protocol http

Mengirim properti campuran (http)

az iot device simulate -n {iothub_name} -d {device_id} --protocol http --properties "iothub-app-myprop=myvalue;content-type=application/json;iothub-correlationid=12345"

Pilih jumlah pesan total dan interval antar pesan

az iot device simulate -n {iothub_name} -d {device_id} --msg-count 1000 --msg-interval 5

Tolak pesan c2d (hanya http)

az iot device simulate -n {iothub_name} -d {device_id} --rs reject --protocol http

Abaikan pesan c2d (hanya http)

az iot device simulate -n {iothub_name} -d {device_id} --rs abandon --protocol http

Parameter yang Diperlukan

--device-id -d

Id Perangkat Target.

Parameter Opsional

--certificate-file-path --cp

Jalur ke file sertifikat.

--da --data

Isi pesan. Berikan teks atau json mentah.

nilai default: Ping from Az CLI IoT Extension
--dtmi --model-id

Id Model Digital Twin yang akan dilaporkan perangkat saat menyambungkan ke hub. Lihat https://docs.microsoft.com/en-us/azure/iot-develop/overview-iot-plug-and-play untuk detail selengkapnya.

--hub-name -n

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

--init-reported-properties --irp

Status awal properti yang dilaporkan kembar untuk perangkat target saat simulator dijalankan. Param opsional, hanya didukung untuk mqtt.

--key --symmetric-key

Kunci konten yang akan digunakan untuk perangkat. Jika kunci konten dan argumen autentikasi perangkat lainnya disediakan, kunci konten akan diprioritaskan.

--key-file-path --kp

Jalur ke file kunci.

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

--mc --msg-count

Jumlah pesan perangkat yang akan dikirim ke IoT Hub.

nilai default: 100
--method-response-code --mrc

Kode status yang akan dikembalikan ketika metode langsung dijalankan pada perangkat. Param opsional, hanya didukung untuk mqtt.

--method-response-payload --mrp

Payload yang akan dikembalikan ketika metode langsung dijalankan pada perangkat. Berikan jalur file atau json mentah. Param opsional, hanya didukung untuk mqtt.

--mi --msg-interval

Penundaan dalam detik antara pesan perangkat-ke-cloud.

nilai default: 3
--pass --passphrase

Frase sandi untuk file kunci.

--properties --props -p

Tas properti pesan dalam pasangan kunci-nilai dengan format berikut: a=b; c=d. Untuk olahpesan mqtt - Anda dapat mengirim properti sistem menggunakan $.=value. Misalnya $.cid=12345 mengatur properti Id korelasi sistem. Contoh pengidentifikasi properti sistem lainnya termasuk $.ct untuk jenis konten, $.mid untuk Id pesan dan $.ce untuk pengodean konten. Untuk pesan http - properti aplikasi dikirim menggunakan iothub-app-=value, misalnya iothub-app-myprop=myvalue. Properti sistem umumnya diawali dengan iothub- seperti iothub-correlationid tetapi ada pengecualian seperti jenis konten dan pengodean konten.

--proto --protocol

Menunjukkan protokol pesan perangkat ke cloud.

nilai yang diterima: http, mqtt
nilai default: mqtt
--receive-settle --rs

Menunjukkan cara menyelesaikan pesan cloud-ke-perangkat yang diterima. Didukung hanya dengan HTTP.

nilai yang diterima: abandon, complete, reject
nilai default: complete
--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 upload-file

Unggah file lokal sebagai perangkat ke kontainer penyimpanan blob yang telah dikonfigurasi sebelumnya.

az iot device upload-file --content-type
                          --device-id
                          --file-path
                          [--hub-name]
                          [--login]
                          [--resource-group]

Parameter yang Diperlukan

--content-type --ct

Jenis file MIME.

--device-id -d

Id Perangkat Target.

--file-path --fp

Jalur ke file untuk diunggah.

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.