az iot dps enrollment
Catatan
Referensi ini adalah bagian dari ekstensi azure-iot untuk Azure CLI (versi 2.46.0 atau yang lebih tinggi). Ekstensi akan secara otomatis menginstal pertama kali Anda menjalankan perintah pendaftaran az iot dps. Pelajari lebih lanjut tentang ekstensi.
Mengelola pendaftaran perangkat individual di Azure IoT Hub Device Provisioning Service.
Perintah
Nama | Deskripsi | Jenis | Status |
---|---|---|---|
az iot dps enrollment create |
Buat pendaftaran perangkat individual di Azure IoT Hub Device Provisioning Service. |
Ekstensi | GA |
az iot dps enrollment delete |
Menghapus pendaftaran perangkat individual di Azure IoT Hub Device Provisioning Service. |
Ekstensi | GA |
az iot dps enrollment list |
Mencantumkan pendaftaran perangkat individual di Azure IoT Hub Device Provisioning Service. |
Ekstensi | GA |
az iot dps enrollment registration |
Mengelola pendaftaran perangkat sisi layanan untuk pendaftaran individu di Azure IoT Hub Device Provisioning Service. |
Ekstensi | GA |
az iot dps enrollment registration delete |
Menghapus pendaftaran perangkat untuk pendaftaran individual di Azure IoT Hub Device Provisioning Service. |
Ekstensi | GA |
az iot dps enrollment registration show |
Dapatkan pendaftaran perangkat untuk pendaftaran individu di Azure IoT Hub Device Provisioning Service. |
Ekstensi | GA |
az iot dps enrollment show |
Dapatkan detail pendaftaran perangkat individual di Azure IoT Hub Device Provisioning Service. |
Ekstensi | GA |
az iot dps enrollment update |
Perbarui pendaftaran perangkat individual di Azure IoT Hub Device Provisioning Service. |
Ekstensi | GA |
az iot dps enrollment create
Buat pendaftaran perangkat individual di Azure IoT Hub Device Provisioning Service.
Harap sediakan format sertifikat menggunakan pengodean Base64 ASCII dan sertifikat harus memiliki segmen BEGIN dan END yang cocok, misalnya: mulailah dengan '-----BEGIN CERTIFICATE-----' dan berakhir dengan '-----END CERTIFICATE-----'.
az iot dps enrollment create --at {symmetricKey, tpm, x509}
--eid
[--allocation-policy {custom, geoLatency, hashed, static}]
[--api-version]
[--auth-type {key, login}]
[--certificate-path]
[--device-id]
[--device-information]
[--dps-name]
[--edge-enabled {false, true}]
[--ek]
[--ih]
[--initial-twin-properties]
[--initial-twin-tags]
[--login]
[--pk]
[--provisioning-status {disabled, enabled}]
[--reprovision-policy {never, reprovisionandmigratedata, reprovisionandresetdata}]
[--resource-group]
[--scp]
[--secondary-key]
[--webhook-url]
Contoh
Buat pendaftaran '{enrollment_id}' dengan tipe pengesahan 'x509' di Azure IoT Device Provisioning Service '{dps_name}' di grup sumber daya '{resource_group_name}' dengan status provisi 'dinonaktifkan', id perangkat '{device_id}', properti kembar awal '{"location":{"region":"US"}}', tag kembar awal '{"version":"1"}', dan informasi perangkat '{"color":"red"}'.
az iot dps enrollment create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --attestation-type x509 --certificate-path /certificates/Certificate.pem --provisioning-status disabled --initial-twin-properties "{'location':{'region':'US'}}" --initial-twin-tags "{'version':'1'}" --device-info "{'color':'red'}" --device-id {device_id}
Buat pendaftaran 'MyEnrollment' dengan tipe pengesahan 'tpm' di Azure IoT Device Provisioning Service '{dps_name}' di grup sumber daya '{resource_group_name}'.
az iot dps enrollment create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --attestation-type tpm --endorsement-key 14963E8F3BA5B3984110B3C1CA8E8B89
Buat pendaftaran 'MyEnrollment' dengan jenis pengesahan 'symmetrickey' di layanan Provisi Perangkat Azure IoT '{dps_name}' di grup sumber daya '{resource_group_name}'.
az iot dps enrollment create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --attestation-type symmetrickey --primary-key {primary_key} --secondary-key {secondary_key}
Buat pendaftaran 'MyEnrollment' dengan provisi ulang di layanan Provisi Perangkat Azure IoT '{dps_name}' di grup sumber daya '{resource_group_name}'.
az iot dps enrollment create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --attestation-type tpm --reprovision-policy {reprovision_type} --endorsement-key 14963E8F3BA5B3984110B3C1CA8E8B89
Buat pendaftaran 'MyEnrollment' dengan kebijakan alokasi statis di layanan Provisi Perangkat Azure IoT '{dps_name}' di grup sumber daya '{resource_group_name}'.
az iot dps enrollment create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --attestation-type tpm --allocation-policy static --endorsement-key 14963E8F3BA5B3984110B3C1CA8E8B89 --iot-hubs {iot_hub_host_name}
Buat pendaftaran 'MyEnrollment' dengan kebijakan alokasi yang di-hash dan beberapa hub di layanan Provisi Perangkat Azure IoT '{dps_name}' di grup sumber daya '{resource_group_name}'.
az iot dps enrollment create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --attestation-type tpm --allocation-policy hashed --endorsement-key 14963E8F3BA5B3984110B3C1CA8E8B89 --iot-hubs {iot_hub_host_name1} {iot_hub_host_name2}
Buat pendaftaran 'MyEnrollment' dengan kebijakan alokasi kustom,
az iot dps enrollment create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --attestation-type symmetrickey --allocation-policy custom --webhook-url {webhook_url} --api-version {api_version}
Parameter yang Diperlukan
Mekanisme Pengesahan yang digunakan untuk autentikasi ke DPS.
ID pendaftaran perangkat individual.
Parameter Opsional
Jenis kebijakan alokasi untuk menentukan bagaimana perangkat ditetapkan ke IoT Hub. Jika tidak disediakan, kebijakan alokasi akan menjadi default kebijakan alokasi saat ini yang ditetapkan untuk instans Device Provisioning Service.
Versi API dari jenis layanan provisi yang dikirim dalam permintaan alokasi kustom. Versi minimum yang didukung: Pratinjau 2018-09-01.
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 iotdps-data-auth-type=<auth-type-value>
.
Jalur ke file yang berisi sertifikat utama. Diperlukan saat memilih x509 sebagai jenis pengesahan dan jalur sertifikat sekunder tidak disediakan.
ID perangkat yang terdaftar di IoT Hub.
Informasi perangkat opsional.
Nama atau nama host Azure IoT Hub Device Provisioning Service. Diperlukan jika --login tidak disediakan.
Bendera yang menunjukkan pengaktifan tepi.
Kunci dukungan TPM untuk perangkat TPM. Saat memilih tpm sebagai jenis pengesahan, kunci dukungan diperlukan.
Nama host IoT Hub target yang terkait dengan kebijakan alokasi. Gunakan daftar yang dipisahkan spasi untuk beberapa IoT Hub.
Properti kembar perangkat awal.
Tag kembar perangkat awal.
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 --dps-name tidak disediakan.
Kunci akses bersama simetris utama yang disimpan dalam format base64.
Mengaktifkan atau menonaktifkan entri pendaftaran.
Kebijakan untuk menentukan bagaimana data perangkat harus ditangani pada provisi ulang ke IoT Hub yang berbeda.
Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>
.
Jalur ke file yang berisi sertifikat sekunder. Diperlukan saat memilih x509 sebagai jenis pengesahan dan jalur sertifikat utama tidak disediakan.
Kunci akses bersama simetris sekunder yang disimpan dalam format base64.
URL webhook Azure Function yang digunakan untuk permintaan alokasi kustom.
Parameter Global
Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.
Menampilkan pesan bantuan ini dan keluar.
Hanya menampilkan kesalahan, menyembunyikan peringatan.
Format output.
String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.
Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID
.
Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.
az iot dps enrollment delete
Menghapus pendaftaran perangkat individual di Azure IoT Hub Device Provisioning Service.
az iot dps enrollment delete --eid
[--auth-type {key, login}]
[--dps-name]
[--etag]
[--login]
[--resource-group]
Parameter yang Diperlukan
ID pendaftaran perangkat individual.
Parameter Opsional
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 iotdps-data-auth-type=<auth-type-value>
.
Nama atau nama host Azure IoT Hub Device Provisioning Service. Diperlukan jika --login tidak disediakan.
Tag Etag atau entitas yang sesuai dengan status terakhir sumber daya. Jika tidak ada etag yang disediakan, nilai '*' digunakan.
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 --dps-name tidak disediakan.
Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>
.
Parameter Global
Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.
Menampilkan pesan bantuan ini dan keluar.
Hanya menampilkan kesalahan, menyembunyikan peringatan.
Format output.
String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.
Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID
.
Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.
az iot dps enrollment list
Mencantumkan pendaftaran perangkat individual di Azure IoT Hub Device Provisioning Service.
az iot dps enrollment list [--auth-type {key, login}]
[--dps-name]
[--login]
[--resource-group]
[--top]
Parameter Opsional
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 iotdps-data-auth-type=<auth-type-value>
.
Nama atau nama host Azure IoT Hub Device Provisioning Service. Diperlukan jika --login tidak disediakan.
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 --dps-name tidak disediakan.
Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>
.
Jumlah maksimum elemen yang akan dikembalikan. Gunakan -1 untuk tidak terbatas.
Parameter Global
Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.
Menampilkan pesan bantuan ini dan keluar.
Hanya menampilkan kesalahan, menyembunyikan peringatan.
Format output.
String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.
Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID
.
Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.
az iot dps enrollment show
Dapatkan detail pendaftaran perangkat individual di Azure IoT Hub Device Provisioning Service.
az iot dps enrollment show --eid
[--auth-type {key, login}]
[--dps-name]
[--keys {false, true}]
[--login]
[--resource-group]
Contoh
Penggunaan dasar
az iot dps enrollment show --dps-name {dps_name} -g {resource_group} --enrollment-id {enrollment_id}
Sertakan informasi pengesahan lengkap dalam hasil untuk pendaftaran kunci konten
az iot dps enrollment show --dps-name {dps_name} -g {resource_group} --enrollment-id {symmetric_key_enrollment_id} --show-keys
Parameter yang Diperlukan
ID pendaftaran perangkat individual.
Parameter Opsional
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 iotdps-data-auth-type=<auth-type-value>
.
Nama atau nama host Azure IoT Hub Device Provisioning Service. Diperlukan jika --login tidak disediakan.
Sertakan kunci pengesahan dan informasi dalam hasil pendaftaran.
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 --dps-name tidak disediakan.
Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>
.
Parameter Global
Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.
Menampilkan pesan bantuan ini dan keluar.
Hanya menampilkan kesalahan, menyembunyikan peringatan.
Format output.
String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.
Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID
.
Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.
az iot dps enrollment update
Perbarui pendaftaran perangkat individual di Azure IoT Hub Device Provisioning Service.
Harap sediakan format sertifikat menggunakan pengodean Base64 ASCII dan sertifikat harus memiliki segmen BEGIN dan END yang cocok, misalnya: mulailah dengan '-----BEGIN CERTIFICATE-----' dan berakhir dengan '-----END CERTIFICATE-----'.
az iot dps enrollment update --eid
[--allocation-policy {custom, geoLatency, hashed, static}]
[--api-version]
[--auth-type {key, login}]
[--certificate-path]
[--device-id]
[--device-information]
[--dps-name]
[--edge-enabled {false, true}]
[--ek]
[--etag]
[--ih]
[--initial-twin-properties]
[--initial-twin-tags]
[--login]
[--pk]
[--provisioning-status {disabled, enabled}]
[--rc {false, true}]
[--remove-secondary-certificate {false, true}]
[--reprovision-policy {never, reprovisionandmigratedata, reprovisionandresetdata}]
[--resource-group]
[--scp]
[--secondary-key]
[--webhook-url]
Contoh
Perbarui pendaftaran '{enrollment_id}' dengan sertifikat x509 baru di Azure IoT Device Provisioning Service '{dps_name}' di grup sumber daya '{resource_group_name}'.
az iot dps enrollment update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --certificate-path /certificates/NewCertificate.pem --etag AAAAAAAAAAA=
Perbarui pendaftaran '{enrollment_id}' dengan kunci dukungan baru di Azure IoT Device Provisioning Service '{dps_name}' di grup sumber daya '{resource_group_name}'.
az iot dps enrollment update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --endorsement-key 14963E8F3BA5B3984110B3C1CA8E8B89 --etag AAAAAAAAAAA=
Perbarui pendaftaran '{enrollment_id}' dengan kunci primer baru di Azure IoT Device Provisioning Service '{dps_name}' di grup sumber daya '{resource_group_name}'.
az iot dps enrollment update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --primary-key {new_primary_key} --etag AAAAAAAAAAA=
Perbarui pendaftaran '{enrollment_id}' dengan jenis provisi ulang baru di Azure IoT Device Provisioning Service '{dps_name}' di grup sumber daya '{resource_group_name}'.
az iot dps enrollment update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --reprovision-policy {reprovision_type} --etag AAAAAAAAAAA=
Perbarui pendaftaran '{enrollment_id}' dengan kebijakan alokasi baru di Azure IoT Device Provisioning Service '{dps_name}' di grup sumber daya '{resource_group_name}'.
az iot dps enrollment update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --allocation-policy geolatency --etag AAAAAAAAAAA= --iot-hubs {iot_hub_host_name1} {iot_hub_host_name2} {iot_hub_host_name3}
Perbarui pendaftaran '{enrollment_id}' di Azure IoT Device Provisioning Service '{dps_name}' di grup sumber daya '{resource_group_name}' dengan properti kembar awal '{"location":{"region":"USA"}}', tag kembar awal '{"version":"2"}', dan informasi perangkat '{"color":"red"}'.
az iot dps enrollment update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --initial-twin-properties "{'location':{'region':'USA'}}" --initial-twin-tags "{'version1':'2'}" --device-info "{'color':'red'}"
Parameter yang Diperlukan
ID pendaftaran perangkat individual.
Parameter Opsional
Jenis kebijakan alokasi untuk menentukan bagaimana perangkat ditetapkan ke IoT Hub. Jika tidak disediakan, kebijakan alokasi akan menjadi default kebijakan alokasi saat ini yang ditetapkan untuk instans Device Provisioning Service.
Versi API dari jenis layanan provisi yang dikirim dalam permintaan alokasi kustom. Versi minimum yang didukung: Pratinjau 2018-09-01.
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 iotdps-data-auth-type=<auth-type-value>
.
Jalur ke file yang berisi sertifikat utama.
ID perangkat yang terdaftar di IoT Hub.
Informasi perangkat opsional.
Nama atau nama host Azure IoT Hub Device Provisioning Service. Diperlukan jika --login tidak disediakan.
Bendera yang menunjukkan pengaktifan tepi.
Kunci dukungan TPM untuk perangkat TPM.
Tag Etag atau entitas yang sesuai dengan status terakhir sumber daya. Jika tidak ada etag yang disediakan, nilai '*' digunakan.
Nama host IoT Hub target yang terkait dengan kebijakan alokasi. Gunakan daftar yang dipisahkan spasi untuk beberapa IoT Hub.
Properti kembar perangkat awal.
Tag kembar perangkat awal.
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 --dps-name tidak disediakan.
Kunci akses bersama simetris utama yang disimpan dalam format base64.
Mengaktifkan atau menonaktifkan entri pendaftaran.
Bendera untuk menghapus sertifikat utama saat ini.
Bendera untuk menghapus sertifikat sekunder saat ini.
Kebijakan untuk menentukan bagaimana data perangkat harus ditangani pada provisi ulang ke IoT Hub yang berbeda.
Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>
.
Jalur ke file yang berisi sertifikat sekunder.
Kunci akses bersama simetris sekunder yang disimpan dalam format base64.
URL webhook Azure Function yang digunakan untuk permintaan alokasi kustom.
Parameter Global
Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.
Menampilkan pesan bantuan ini dan keluar.
Hanya menampilkan kesalahan, menyembunyikan peringatan.
Format output.
String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.
Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID
.
Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.