az iot hub state

  • Eksperimental
  • 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 state . Pelajari lebih lanjut tentang ekstensi.

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

Mengelola status IoT Hub.

Untuk informasi selengkapnya, lihat aka.ms/aziotcli-iot-hub-state.

Perintah

Nama Deskripsi Jenis Status
az iot hub state export

Ekspor status IoT Hub ke file.

 Ekstensi Eksperimental
az iot hub state import

Impor status Hub dari file ke IoT Hub.

 Ekstensi Eksperimental
az iot hub state migrate

Migrasikan status satu hub ke hub lain tanpa menyimpan ke file.

 Ekstensi Eksperimental

az iot hub state export

Eksperimental

Grup perintah 'status hub iot' bersifat eksperimental dan sedang dikembangkan. Tingkat referensi dan dukungan: https://aka.ms/CLI_refstatus

Ekspor status IoT Hub ke file.

Secara default, status yang diekspor akan mencakup: templat arm untuk hub, konfigurasi hub (termasuk konfigurasi ADM dan penyebaran tepi), informasi perangkat (termasuk identitas perangkat, perangkat kembar, identitas modul, dan kembar modul).

Untuk informasi selengkapnya, lihat aka.ms/aziotcli-iot-hub-state.

az iot hub state export --state-file
                        [--aspects {arm, configurations, devices}]
                        [--auth-type {key, login}]
                        [--hub-name]
                        [--login]
                        [--replace]
                        [--resource-group]

Contoh

Ekspor status hub yang didukung ke file yang ditentukan.

az iot hub state export -n {iothub_name} -f {state_filename}

Ekspor status hub yang didukung ke file yang ditentukan, menimpa konten file.

az iot hub state export -n {iothub_name} -f {state_filename} -r

Ekspor hanya perangkat dan konfigurasi hub yang ditentukan ke file yang ditentukan.

az iot hub state export -n {iothub_name} -f {state_filename} --aspects devices configurations

Parameter yang Diperlukan

--state-file -f

Jalur ke file tempat informasi status akan disimpan.

Parameter Opsional

--aspects

Aspek Hub (dipisahkan spasi).

nilai yang diterima: arm, configurations, devices
--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.

--replace -r

Jika bendera ini diatur, maka perintah akan menimpa konten file output.

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 hub state import

Eksperimental

Grup perintah 'status hub iot' bersifat eksperimental dan sedang dikembangkan. Tingkat referensi dan dukungan: https://aka.ms/CLI_refstatus

Impor status Hub dari file ke IoT Hub.

Jika aspek arm ditentukan, hub akan dibuat jika tidak ada.

Secara default, status yang diimpor akan mencakup: templat arm untuk hub, konfigurasi hub (termasuk konfigurasi ADM dan penyebaran tepi), informasi perangkat (termasuk identitas perangkat, perangkat kembar, identitas modul, dan kembar modul).

Untuk titik akhir yang diimpor dengan autentikasi identitas yang ditetapkan sistem, hub yang ditentukan harus memiliki izin yang benar. Jika tidak, perintah akan gagal.

Titik akhir privat akan diabaikan dalam proses impor.

Untuk informasi selengkapnya, lihat aka.ms/aziotcli-iot-hub-state.

az iot hub state import --state-file
                        [--aspects {arm, configurations, devices}]
                        [--auth-type {key, login}]
                        [--hub-name]
                        [--login]
                        [--replace]
                        [--resource-group]

Contoh

Impor status yang didukung dari file yang ditentukan ke hub yang ditentukan.

az iot hub state import -n {iothub_name} -f {state_filename}

Impor status yang didukung dari file yang ditentukan ke hub yang ditentukan, menimpa status hub sebelumnya. Semua sertifikat, konfigurasi, dan perangkat akan dihapus sebelum status baru diunggah.

az iot hub state import -n {iothub_name} -f {state_filename} -r

Impor hanya templat arm dari file yang ditentukan ke hub yang ditentukan. Perhatikan bahwa ini akan membuat hub baru jika tidak ada. File mungkin berisi perangkat dan konfigurasi tetapi akan diabaikan.

az iot hub state import -n {iothub_name} -g {resource_group} -f {state_filename} --aspects arm

Impor hanya perangkat dan konfigurasi dari file yang ditentukan ke hub yang ditentukan. Perhatikan bahwa ini TIDAK akan membuat hub baru jika tidak ada dan perintah akan gagal. File mungkin berisi templat arm tetapi akan diabaikan.

az iot hub state import -n {iothub_name} -f {state_filename} --aspects devices configurations

Parameter yang Diperlukan

--state-file -f

Jalur ke file tempat informasi status akan disimpan.

Parameter Opsional

--aspects

Aspek Hub (dipisahkan spasi).

nilai yang diterima: arm, configurations, devices
--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.

--replace -r

Jika bendera ini diatur, maka perintah akan menghapus perangkat, konfigurasi, dan sertifikat hub tujuan saat ini.

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 hub state migrate

Eksperimental

Grup perintah 'status hub iot' bersifat eksperimental dan sedang dikembangkan. Tingkat referensi dan dukungan: https://aka.ms/CLI_refstatus

Migrasikan status satu hub ke hub lain tanpa menyimpan ke file.

Jika aspek arm ditentukan, hub akan dibuat jika tidak ada.

Secara default, status yang dimigrasikan akan mencakup: templat arm untuk hub, konfigurasi hub (termasuk konfigurasi ADM dan penyebaran tepi), informasi perangkat (termasuk identitas perangkat, kembar perangkat, identitas modul, dan kembar modul).

Untuk titik akhir yang dimigrasikan dengan autentikasi identitas yang ditetapkan sistem, hub yang ditentukan harus memiliki izin yang benar. Jika tidak, perintah akan gagal.

Titik akhir privat akan diabaikan dalam proses migrasi.

Jika Anda mengalami masalah saat bermigrasi, gunakan perintah ekspor dan impor untuk memiliki file sebagai cadangan.

Untuk informasi selengkapnya, lihat aka.ms/aziotcli-iot-hub-state.

az iot hub state migrate [--aspects {arm, configurations, devices}]
                         [--auth-type {key, login}]
                         [--destination-hub]
                         [--destination-hub-login]
                         [--destination-resource-group]
                         [--og]
                         [--oh]
                         [--ol]
                         [--replace]

Contoh

Migrasikan status hub asal yang didukung ke hub tujuan.

az iot hub state migrate --destination-hub {dest_hub_name} --origin-hub {orig_hub_name}

Migrasikan status hub asal yang didukung ke hub tujuan, menimpa status hub sebelumnya. Semua sertifikat, konfigurasi, dan perangkat di hub tujuan akan dihapus sebelum status baru diunggah.

az iot hub state migrate --destination-hub {dest_hub_name} --origin-hub {orig_hub_name} -r

Migrasikan hanya templat arm dari hub asal ke hub tujuan. Perhatikan bahwa ini akan membuat hub baru jika hub tujuan tidak ada. Hub asal mungkin berisi perangkat dan konfigurasi tetapi akan diabaikan.

az iot hub state migrate --destination-hub {dest_hub_name} --destination-resource-group {dest_hub_resource_group} --origin-hub {orig_hub_name} --aspects arm

Migrasikan hanya perangkat dan konfigurasi dari hub asal ke hub tujuan. Perhatikan bahwa ini TIDAK akan membuat hub baru jika hub tujuan tidak ada dan perintah akan gagal. Templat arm untuk hub asal akan diabaikan.

az iot hub state migrate --destination-hub {dest_hub_name} --origin-hub {orig_hub_name} --aspects devices configurations

Parameter Opsional

--aspects

Aspek Hub (dipisahkan spasi).

nilai yang diterima: arm, configurations, devices
--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
--destination-hub --dh

Nama IoT Hub tempat status hub asal akan disalin.

--destination-hub-login --dl

Perintah ini mendukung entitas string koneksi dengan hak untuk melakukan tindakan di hub tujuan. Gunakan untuk menghindari masuk sesi melalui az login untuk instans IoT Hub ini. Jika entitas string koneksi dan nama disediakan, string koneksi lebih diprioritaskan. Diperlukan jika --destination-hub tidak disediakan.

--destination-resource-group --dg

Nama grup sumber daya IoT Hub tempat status hub asal akan disalin. Jika tidak disediakan, akan menggunakan grup sumber daya IoT Hub asal.

--og --origin-resource-group

Nama grup sumber daya IoT Hub yang akan disalin.

--oh --origin-hub

Nama IoT Hub yang akan disalin.

--ol --origin-hub-login

Perintah ini mendukung entitas string koneksi dengan hak untuk melakukan tindakan pada hub asal. Gunakan untuk menghindari masuk sesi melalui az login untuk instans IoT Hub ini. Jika entitas string koneksi dan nama disediakan, string koneksi lebih diprioritaskan. Diperlukan jika --origin-hub tidak disediakan.

--replace -r

Jika bendera ini diatur, maka perintah akan menghapus perangkat, konfigurasi, dan sertifikat hub tujuan saat ini.

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.