az iot hub digital-twin

  • 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 hub digital-twin . Pelajari lebih lanjut tentang ekstensi.

Memanipulasi dan berinteraksi dengan kembar digital perangkat IoT Hub.

Perintah

Nama Deskripsi Jenis Status
az iot hub digital-twin invoke-command

Panggil perintah tingkat akar atau komponen dari perangkat kembar digital.

 Ekstensi GA
az iot hub digital-twin show

Tampilkan kembar digital perangkat IoT Hub.

 Ekstensi GA
az iot hub digital-twin update

Perbarui properti baca-tulis perangkat kembar digital melalui spesifikasi patch JSON.

 Ekstensi GA

az iot hub digital-twin invoke-command

Panggil perintah tingkat akar atau komponen dari perangkat kembar digital.

az iot hub digital-twin invoke-command --cn
                                       --device-id
                                       [--component-path]
                                       [--connect-timeout]
                                       [--hub-name]
                                       [--login]
                                       [--payload]
                                       [--resource-group]
                                       [--response-timeout]

Contoh

Secara umum, panggil perintah yang mengambil payload yang mencakup properti tertentu menggunakan JSON sebaris.

az iot hub digital-twin invoke-command --command-name {command_name} -n {iothub_name} -d {device_id} --payload '{"property_name": "property_value"}'

Panggil perintah tingkat akar "reboot" yang mengambil payload bernama "delay" sesuai dengan model DTDL https://github.com/Azure/opendigitaltwins-dtdl/blob/master/DTDL/v2/samples/TemperatureController.json.

az iot hub digital-twin invoke-command --command-name reboot -n {iothub_name} -d {device_id} --payload 5

Panggil perintah "getMaxMinReport" pada komponen "thermostat1" yang tidak mengambil input.

az iot hub digital-twin invoke-command --cn getMaxMinReport -n {iothub_name} -d {device_id} --component-path thermostat1

Parameter yang Diperlukan

--cn --command-name

Nama perintah digital twin.

--device-id -d

Id Perangkat Target.

Parameter Opsional

--component-path

Jalur komponen kembar digital. Misalnya: termostat1.

--connect-timeout --cto

Interval waktu maksimum, dalam detik, bahwa IoT Hub akan mencoba menyambungkan ke perangkat.

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

--payload

Input payload JSON untuk perintah. Sediakan jalur file atau JSON sebaris.

nilai default: {}
--resource-group -g

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

--response-timeout --rto

Interval waktu maksimum, dalam detik, bahwa perintah kembar digital akan menunggu hasilnya.

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 digital-twin show

Tampilkan kembar digital perangkat IoT Hub.

az iot hub digital-twin show --device-id
                             [--hub-name]
                             [--login]
                             [--resource-group]

Contoh

Tampilkan perangkat target kembar digital.

az iot hub digital-twin show -n {iothub_name} -d {device_id}

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 hub digital-twin update

Perbarui properti baca-tulis perangkat kembar digital melalui spesifikasi patch JSON.

Saat ini operasi terbatas pada penambahan, penggantian, dan penghapusan.

az iot hub digital-twin update --device-id
                               --json-patch
                               [--etag]
                               [--hub-name]
                               [--login]
                               [--resource-group]

Contoh

Perbarui kembar digital melalui spesifikasi patch JSON.

az iot hub digital-twin update --hub-name {iothub_name} --device-id {device_id} --json-patch '{"op":"add", "path":"/thermostat1/targetTemperature", "value": 54}'

Perbarui kembar digital melalui spesifikasi patch JSON.

az iot hub digital-twin update -n {iothub_name} -d {device_id} --json-patch '[
  {"op":"remove", "path":"/thermostat1/targetTemperature"},
  {"op":"add", "path":"/thermostat2/targetTemperature", "value": 22}
]'

Perbarui properti kembar digital melalui spesifikasi patch JSON yang ditentukan dalam file.

az iot hub digital-twin update -n {iothub_name} -d {device_id} --json-patch ./my/patch/document.json

Parameter yang Diperlukan

--device-id -d

Id Perangkat Target.

--json-patch --patch

Spesifikasi pembaruan yang dijelaskan oleh JSON-patch. Operasi dibatasi untuk menambahkan, mengganti, dan menghapus. Sediakan jalur file atau JSON sebaris.

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.