az iot hub device-identity

Catatan

Referensi ini adalah bagian dari ekstensi azure-iot untuk Azure CLI (versi 2.30.0 atau yang lebih tinggi). Ekstensi akan secara otomatis menginstal saat pertama kali Anda menjalankan perintah az iot hub device-identity . Pelajari lebih lanjut tentang ekstensi.

Mengelola perangkat IoT.

Perintah

az iot hub device-identity children

Mengelola hubungan perangkat anak-anak untuk perangkat IoT edge.

az iot hub device-identity children add

Tambahkan perangkat sebagai anak-anak ke perangkat edge target.

az iot hub device-identity children list

Menghasilkan kumpulan perangkat anak yang ditetapkan.

az iot hub device-identity children remove

Hapus perangkat anak dari perangkat edge target.

az iot hub device-identity connection-string

Mengelola string koneksi perangkat IoT.

az iot hub device-identity connection-string show

Tampilkan string koneksi perangkat IoT Hub tertentu.

az iot hub device-identity create

Membuat perangkat dalam IoT Hub.

az iot hub device-identity delete

Menghapus perangkat IoT Hub.

az iot hub device-identity export

Ekspor semua identitas perangkat dari IoT Hub ke kontainer blob Azure Storage. Untuk input uri SAS kontainer blob sebaris, harap tinjau aturan input lingkungan Anda.

az iot hub device-identity import

Impor identitas perangkat ke IoT Hub dari blob. Untuk input uri SAS kontainer blob sebaris, harap tinjau aturan input lingkungan Anda.

az iot hub device-identity list

Mencantumkan perangkat dalam IoT Hub.

az iot hub device-identity parent

Mengelola hubungan perangkat induk untuk perangkat IoT.

az iot hub device-identity parent set

Atur perangkat induk perangkat target.

az iot hub device-identity parent show

Dapatkan perangkat induk dari perangkat target.

az iot hub device-identity renew-key

Perbarui kunci target perangkat IoT Hub dengan autentikasi sas.

az iot hub device-identity show

Dapatkan detail perangkat IoT Hub.

az iot hub device-identity update

Memperbarui perangkat IoT Hub.

az iot hub device-identity create

Membuat perangkat dalam IoT Hub.

Saat menggunakan metode autentikasi shared_private_key (juga dikenal sebagai kunci konten), jika tidak ada kunci kustom yang disediakan, layanan akan menghasilkannya untuk perangkat.

Jika cakupan perangkat disediakan untuk perangkat edge, nilai akan secara otomatis dikonversi ke cakupan induk.

az iot hub device-identity create --device-id
                                  [--am {shared_private_key, x509_ca, x509_thumbprint}]
                                  [--auth-type {key, login}]
                                  [--device-scope]
                                  [--edge-enabled {false, true}]
                                  [--hub-name]
                                  [--login]
                                  [--od]
                                  [--pk]
                                  [--primary-thumbprint]
                                  [--resource-group]
                                  [--secondary-key]
                                  [--secondary-thumbprint]
                                  [--sta {disabled, enabled}]
                                  [--star]
                                  [--valid-days]

Contoh

Buat perangkat IoT berkemampuan edge dengan otorisasi default (kunci privat bersama).

az iot hub device-identity create -n {iothub_name} -d {device_id} --ee

Buat perangkat IoT dengan otorisasi sertifikat yang ditandatangani sendiri, hasilkan sertifikat yang valid selama 10 hari lalu gunakan thumbprint-nya.

az iot hub device-identity create -n {iothub_name} -d {device_id} --am x509_thumbprint --valid-days 10

Buat perangkat IoT dengan otorisasi sertifikat yang ditandatangani sendiri, hasilkan sertifikasi kedaluwarsa default (365 hari) dan output ke direktori target.

az iot hub device-identity create -n {iothub_name} -d {device_id} --am x509_thumbprint --output-dir /path/to/output

Buat perangkat IoT dengan otorisasi sertifikat yang ditandatangani sendiri dan secara eksplisit menyediakan thumbprint primer dan sekunder.

az iot hub device-identity create -n {iothub_name} -d {device_id} --am x509_thumbprint --ptp {thumbprint_1} --stp {thumbprint_2}

Buat perangkat IoT dengan otorisasi OS root dengan status dan alasan yang dinonaktifkan.

az iot hub device-identity create -n {iothub_name} -d {device_id} --am x509_ca --status disabled --status-reason 'for reasons'

Membuat perangkat IoT dengan cakupan perangkat.

az iot hub device-identity create -n {iothub_name} -d {device_id} --device-scope 'ms-azure-iot-edge://edge0-123456789123456789'

Parameter yang Diperlukan

--device-id -d

Perangkat Target.

Parameter Opsional

--am --auth-method

Metode otorisasi yang akan dibuat entitas.

nilai yang diterima: shared_private_key, x509_ca, x509_thumbprint
nilai default: shared_private_key
--auth-type

Menunjukkan apakah operasi harus memperoleh kunci kebijakan secara otomatis atau menggunakan sesi Azure AD saat ini. Anda dapat mengonfigurasi default menggunakan az configure --defaults iothub-data-auth-type=<auth-type-value>.

nilai yang diterima: key, login
nilai default: key
--device-scope

Cakupan perangkat. Untuk perangkat edge, ini dibuat secara otomatis dan tidak dapat diubah. Untuk perangkat daun, atur ini untuk membuat hubungan anak/induk.

--edge-enabled --ee

Bendera yang menunjukkan pengaktifan tepi.

nilai yang diterima: false, true
--hub-name -n

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

--login -l

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

--od --output-dir

Hasilkan sertifikasi yang ditandatangani sendiri dan gunakan thumbprint-nya. Output ke direktori target yang ditentukan.

--pk --primary-key

Kunci akses bersama simetris utama yang disimpan dalam format base64.

--primary-thumbprint --ptp

Thumbprint sertifikat yang ditandatangani sendiri untuk digunakan untuk thumbprint utama.

--resource-group -g

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

--secondary-key --sk

Kunci akses bersama simetris sekunder yang disimpan dalam format base64.

--secondary-thumbprint --stp

Thumbprint sertifikat yang ditandatangani sendiri untuk digunakan untuk thumbprint sekunder.

--sta --status

Atur status perangkat saat pembuatan.

nilai yang diterima: disabled, enabled
nilai default: enabled
--star --status-reason

Deskripsi untuk status perangkat.

--valid-days --vd

Hasilkan sertifikasi yang ditandatangani sendiri dan gunakan thumbprint-nya. Berlaku untuk jumlah hari yang ditentukan. Default: 365.

az iot hub device-identity delete

Menghapus perangkat IoT Hub.

az iot hub device-identity delete --device-id
                                  [--auth-type {key, login}]
                                  [--etag]
                                  [--hub-name]
                                  [--login]
                                  [--resource-group]

Parameter yang Diperlukan

--device-id -d

Perangkat Target.

Parameter Opsional

--auth-type

Menunjukkan apakah operasi harus memperoleh kunci kebijakan secara otomatis atau menggunakan sesi Azure AD saat ini. 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. Diperlukan jika --login tidak disediakan.

--login -l

Perintah ini mendukung string koneksi entitas dengan hak untuk melakukan tindakan. Gunakan untuk menghindari login sesi melalui "az login". Jika string dan nama koneksi entitas disediakan, string koneksi akan 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>.

az iot hub device-identity export

Ekspor semua identitas perangkat dari IoT Hub ke kontainer blob Azure Storage. Untuk input uri SAS kontainer blob sebaris, harap tinjau aturan input lingkungan Anda.

Untuk informasi selengkapnya, lihat https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.

az iot hub device-identity export --bcu
                                  --hub-name
                                  [--auth-type {identity, key}]
                                  [--identity]
                                  [--ik {false, true}]
                                  [--resource-group]

Contoh

Ekspor semua identitas perangkat ke kontainer blob yang dikonfigurasi dan sertakan kunci perangkat. Menggunakan contoh uri SAS sebaris.

az iot hub device-identity export -n {iothub_name} --ik --bcu 'https://mystorageaccount.blob.core.windows.net/devices?sv=2019-02-02&st=2020-08-23T22%3A35%3A00Z&se=2020-08-24T22%3A35%3A00Z&sr=c&sp=rwd&sig=VrmJ5sQtW3kLzYg10VqmALGCp4vtYKSLNjZDDJBSh9s%3D'

Ekspor semua identitas perangkat ke kontainer blob yang dikonfigurasi menggunakan jalur file yang berisi uri SAS.

az iot hub device-identity export -n {iothub_name} --bcu {sas_uri_filepath}

Ekspor semua identitas perangkat ke kontainer blob yang dikonfigurasi dan sertakan kunci perangkat. Menggunakan identitas yang ditetapkan sistem yang memiliki peran Kontributor Data Blob Penyimpanan untuk akun penyimpanan. Uri kontainer blob tidak memerlukan token SAS blob.

az iot hub device-identity export -n {iothub_name} --ik --bcu 'https://mystorageaccount.blob.core.windows.net/devices' --auth-type identity --identity [system]

Ekspor semua identitas perangkat ke kontainer blob yang dikonfigurasi dan sertakan kunci perangkat. Menggunakan identitas terkelola yang ditetapkan pengguna yang memiliki peran Kontributor Data Blob Penyimpanan untuk akun penyimpanan dan kontributor untuk hub IoT. Uri kontainer blob tidak memerlukan token SAS blob.

az iot hub device-identity export -n {iothub_name} --ik --bcu 'https://mystorageaccount.blob.core.windows.net/devices' --auth-type identity --identity {managed_identity_resource_id}

Parameter yang Diperlukan

--bcu --blob-container-uri

URI Tanda Tangan Akses Bersama Blob dengan akses tulis, baca, dan hapus ke kontainer blob. Ini digunakan untuk menghasilkan status pekerjaan dan hasilnya. Catatan: saat menggunakan autentikasi berbasis identitas, URI https:// masih diperlukan - tetapi tidak ada token SAS yang diperlukan. Input untuk argumen ini bisa sebaris atau dari jalur file.

--hub-name -n

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

Parameter Opsional

--auth-type --storage-authentication-type

Jenis autentikasi untuk berkomunikasi dengan kontainer penyimpanan.

nilai yang diterima: identity, key
--identity

Jenis identitas terkelola untuk menentukan apakah identitas terkelola yang ditetapkan sistem atau identitas terkelola yang ditetapkan pengguna digunakan. Untuk identitas terkelola yang ditetapkan sistem, gunakan [sistem]. Untuk identitas terkelola yang ditetapkan pengguna, berikan id sumber daya identitas terkelola yang ditetapkan pengguna. Identitas ini memerlukan peran Kontributor Data Blob Penyimpanan untuk Akun Penyimpanan.

--ik --include-keys

Jika diatur, kunci diekspor secara normal. Jika tidak, kunci diatur ke null dalam output ekspor.

nilai yang diterima: false, true
--resource-group -g

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

az iot hub device-identity import

Impor identitas perangkat ke IoT Hub dari blob. Untuk input uri SAS kontainer blob sebaris, harap tinjau aturan input lingkungan Anda.

Untuk informasi selengkapnya, lihat https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.

az iot hub device-identity import --hub-name
                                  --ibcu
                                  --obcu
                                  [--auth-type {identity, key}]
                                  [--identity]
                                  [--resource-group]

Contoh

Impor semua identitas perangkat dari blob menggunakan uri SAS sebaris.

az iot hub device-identity import -n {iothub_name} --ibcu {input_sas_uri} --obcu {output_sas_uri}

Impor semua identitas perangkat dari blob menggunakan jalur file yang berisi SAS uri.

az iot hub device-identity import -n {iothub_name} --ibcu {input_sas_uri_filepath} --obcu {output_sas_uri_filepath}

Impor semua identitas perangkat dari blob menggunakan identitas yang ditetapkan sistem yang memiliki peran Kontributor Data Blob Penyimpanan untuk kedua akun penyimpanan. Uri kontainer blob tidak memerlukan token SAS blob.

az iot hub device-identity import -n {iothub_name} --ibcu {input_sas_uri} --obcu {output_sas_uri} --auth-type identity --identity [system]

Impor semua identitas perangkat dari blob menggunakan identitas terkelola yang ditetapkan pengguna yang memiliki peran Kontributor Data Blob Penyimpanan untuk akun penyimpanan dan kontributor untuk hub IoT. Uri kontainer blob tidak memerlukan token SAS blob.

az iot hub device-identity import -n {iothub_name} --ibcu {input_sas_uri} --obcu {output_sas_uri} --auth-type identity --identity {managed_identity_resource_id}

Parameter yang Diperlukan

--hub-name -n

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

--ibcu --input-blob-container-uri

URI Tanda Tangan Akses Bersama Blob dengan akses baca ke kontainer blob. Blob ini berisi operasi yang akan dilakukan pada registri identitas. Catatan: saat menggunakan autentikasi berbasis identitas, URI https:// masih diperlukan - tetapi tidak ada token SAS yang diperlukan. Input untuk argumen ini bisa sebaris atau dari jalur file.

--obcu --output-blob-container-uri

URI Tanda Tangan Akses Bersama Blob dengan akses tulis ke kontainer blob. Ini digunakan untuk menghasilkan status pekerjaan dan hasilnya. Catatan: saat menggunakan autentikasi berbasis identitas, URI https:// tanpa token SAS masih diperlukan. Input untuk argumen ini bisa sebaris atau dari jalur file.

Parameter Opsional

--auth-type --storage-authentication-type

Jenis autentikasi untuk berkomunikasi dengan kontainer penyimpanan.

nilai yang diterima: identity, key
--identity

Jenis identitas terkelola untuk menentukan apakah identitas terkelola yang ditetapkan sistem atau identitas terkelola yang ditetapkan pengguna digunakan. Untuk identitas terkelola yang ditetapkan sistem, gunakan [sistem]. Untuk identitas terkelola yang ditetapkan pengguna, berikan id sumber daya identitas terkelola yang ditetapkan pengguna. Identitas ini memerlukan peran Kontributor Data Blob Penyimpanan untuk peran Akun Penyimpanan dan Kontributor target untuk IoT Hub.

--resource-group -g

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

az iot hub device-identity list

Mencantumkan perangkat dalam IoT Hub.

az iot hub device-identity 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 AD saat ini. 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
--hub-name -n

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

--login -l

Perintah ini mendukung string koneksi entitas dengan hak untuk melakukan tindakan. Gunakan untuk menghindari login sesi melalui "az login". Jika string koneksi entitas dan nama disediakan, string koneksi akan 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

az iot hub device-identity renew-key

Perbarui kunci target perangkat IoT Hub dengan autentikasi sas.

az iot hub device-identity renew-key --device-id
                                     --hub-name
                                     --key-type {primary, secondary, swap}
                                     [--auth-type {key, login}]
                                     [--etag]
                                     [--login]
                                     [--resource-group]

Contoh

Perbarui kunci primer.

az iot hub device-identity renew-key -d {device_id} -n {iothub_name} --kt primary

Tukar kunci primer dan sekunder.

az iot hub device-identity renew-key -d {device_id} -n {iothub_name} --kt swap

Parameter yang Diperlukan

--device-id -d

Perangkat Target.

--hub-name -n

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

--key-type --kt

Jenis kunci target untuk diregenerasi.

nilai yang diterima: primary, secondary, swap

Parameter Opsional

--auth-type

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

--login -l

Perintah ini mendukung string koneksi entitas dengan hak untuk melakukan tindakan. Gunakan untuk menghindari login sesi melalui "az login". Jika string koneksi entitas dan nama disediakan, string koneksi akan 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>.

az iot hub device-identity show

Dapatkan detail perangkat IoT Hub.

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

Parameter yang Diperlukan

--device-id -d

Perangkat Target.

Parameter Opsional

--auth-type

Menunjukkan apakah operasi harus memperoleh kunci kebijakan secara otomatis atau menggunakan sesi Azure AD saat ini. 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. Diperlukan jika --login tidak disediakan.

--login -l

Perintah ini mendukung string koneksi entitas dengan hak untuk melakukan tindakan. Gunakan untuk menghindari login sesi melalui "az login". Jika string koneksi entitas dan nama disediakan, string koneksi akan 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>.

az iot hub device-identity update

Memperbarui perangkat IoT Hub.

Gunakan --set diikuti oleh penetapan properti untuk memperbarui perangkat. Manfaatkan parameter yang dikembalikan dari 'iot hub device-identity show'.

az iot hub device-identity update --device-id
                                  [--add]
                                  [--am {shared_private_key, x509_ca, x509_thumbprint}]
                                  [--auth-type {key, login}]
                                  [--edge-enabled {false, true}]
                                  [--etag]
                                  [--force-string]
                                  [--hub-name]
                                  [--login]
                                  [--pk]
                                  [--primary-thumbprint]
                                  [--remove]
                                  [--resource-group]
                                  [--secondary-key]
                                  [--secondary-thumbprint]
                                  [--set]
                                  [--sta {disabled, enabled}]
                                  [--star]

Contoh

Mengaktifkan kapabilitas edge untuk perangkat

az iot hub device-identity update -d {device_id} -n {iothub_name} --set capabilities.iotEdge=true

Aktifkan kemampuan edge untuk perangkat menggunakan argumen kenyamanan.

az iot hub device-identity update -d {device_id} -n {iothub_name} --ee

Menonaktifkan status perangkat

az iot hub device-identity update -d {device_id} -n {iothub_name} --set status=disabled

Nonaktifkan status perangkat menggunakan argumen kenyamanan.

az iot hub device-identity update -d {device_id} -n {iothub_name} --status disabled

Dalam satu perintah

az iot hub device-identity update -d {device_id} -n {iothub_name} --set status=disabled capabilities.iotEdge=true

Parameter yang Diperlukan

--device-id -d

Perangkat Target.

Parameter Opsional

--add

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

--am --auth-method

Metode otorisasi yang akan dibuat entitas.

nilai yang diterima: shared_private_key, x509_ca, x509_thumbprint
--auth-type

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

--hub-name -n

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

--login -l

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

--pk --primary-key

Kunci akses bersama simetris utama yang disimpan dalam format base64.

--primary-thumbprint --ptp

Thumbprint sertifikat yang ditandatangani sendiri untuk digunakan untuk thumbprint utama.

--remove

Hapus properti atau elemen dari daftar. Contoh: --remove property.list OR --remove propertyToRemove.

--resource-group -g

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

--secondary-key --sk

Kunci akses bersama simetris sekunder yang disimpan dalam format base64.

--secondary-thumbprint --stp

Thumbprint sertifikat yang ditandatangani sendiri untuk digunakan untuk thumbprint sekunder.

--set

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

--sta --status

Atur status perangkat saat pembuatan.

nilai yang diterima: disabled, enabled
--star --status-reason

Deskripsi untuk status perangkat.