az iot hub device-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 device-twin . Pelajari lebih lanjut tentang ekstensi.

Mengelola konfigurasi device twin IoT.

Perintah

Nama Deskripsi Jenis Status
az iot hub device-twin list

Mencantumkan kembar perangkat di IoT Hub.

 Ekstensi GA
az iot hub device-twin replace

Ganti definisi kembar perangkat dengan target json.

 Ekstensi GA
az iot hub device-twin show

Dapatkan definisi kembar perangkat.

 Ekstensi GA
az iot hub device-twin update

Perbarui properti dan tag yang diinginkan kembar perangkat.

 Ekstensi GA

az iot hub device-twin list

Mencantumkan kembar perangkat di IoT Hub.

Perintah ini sama dengan kueri hub iot dengan kueri "pilih * dari perangkat" untuk semua perangkat dan "pilih * dari perangkat di mana capabilities.iotEdge = true" untuk perangkat edge.

az iot hub device-twin list [--auth-type {key, login}]
                            [--edge-enabled {false, true}]
                            [--hub-name]
                            [--login]
                            [--resource-group]
                            [--top]

Parameter Opsional

--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
--edge-enabled --ee

Bendera yang menunjukkan pengaktifan tepi.

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

--top

Jumlah maksimum elemen yang akan dikembalikan. Gunakan -1 untuk tidak terbatas.

nilai default: 1000
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 device-twin replace

Ganti definisi kembar perangkat dengan target json.

Masukkan json secara langsung atau gunakan jalur file.

az iot hub device-twin replace --device-id
                               --json
                               [--auth-type {key, login}]
                               [--etag]
                               [--hub-name]
                               [--login]
                               [--resource-group]

Contoh

Ganti perangkat kembar dengan konten file.

az iot hub device-twin replace -d {device_id} -n {iothub_name} -j ../mydevicetwin.json

Parameter yang Diperlukan

--device-id -d

Id Perangkat Target.

--json -j

Json untuk mengganti kembar yang ada dengan. Berikan jalur file atau json mentah.

Parameter Opsional

--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
--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 hub device-twin show

Dapatkan definisi kembar perangkat.

az iot hub device-twin show --device-id
                            [--auth-type {key, login}]
                            [--hub-name]
                            [--login]
                            [--resource-group]

Parameter yang Diperlukan

--device-id -d

Id Perangkat Target.

Parameter Opsional

--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
--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 device-twin update

Perbarui properti dan tag yang diinginkan kembar perangkat.

Berikan argumen --desired atau --tags untuk perilaku PATCH. Kedua parameter mendukung json sebaris atau jalur file ke konten json. Penggunaan arg pembaruan generik (yaitu --set) akan mencerminkan perilaku PUT dan tidak digunakan lagi.

az iot hub device-twin update --device-id
                              [--add]
                              [--auth-type {key, login}]
                              [--desired]
                              [--etag]
                              [--force-string]
                              [--hub-name]
                              [--login]
                              [--remove]
                              [--resource-group]
                              [--set]
                              [--tags]

Contoh

Patch perangkat kembar properti yang diinginkan.

az iot hub device-twin update -n {iothub_name} -d {device_id} --desired '{"conditions":{"temperature":{"warning":70, "critical":100}}}'

Tag kembar perangkat patch.

az iot hub device-twin update -n {iothub_name} -d {device_id} --tags '{"country": "USA"}'

Patch tag perangkat kembar dengan konten file json.

az iot hub device-twin update -n {iothub_name} -d {device_id} --tags /path/to/file

Penghapusan patch properti 'kritis' yang diinginkan dari 'suhu' induk

az iot hub device-twin update -n {iothub_name} -d {device_id} --desired '{"condition":{"temperature":{"critical": null}}}'

Parameter yang Diperlukan

--device-id -d

Id Perangkat Target.

Parameter Opsional

--add

Tambahkan objek ke daftar objek dengan menentukan jalur dan pasangan nilai kunci. Contoh: --add property.listProperty <key=value, string or JSON string>.

nilai default: []
--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
--desired

Properti yang diinginkan kembar.

--etag -e

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

--force-string

Saat menggunakan 'set' atau 'add', pertahankan literal string alih-alih mencoba mengonversi ke JSON.

nilai default: False
--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.

--remove

Menghapus properti atau elemen dari daftar. Contoh: --remove property.list <indexToRemove> ATAU --remove propertyToRemove.

nilai default: []
--resource-group -g

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

--set

Perbarui objek dengan menentukan jalur properti dan nilai yang akan diatur. Contoh: --set property1.property2=<value>.

nilai default: []
--tags

Tag kembar.

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.