Bulk Registry - Update Registry
Membuat, memperbarui, atau menghapus identitas beberapa perangkat dari registri identitas IoT Hub. Identitas perangkat hanya dapat ditentukan sekali dalam daftar. Operasi yang berbeda (membuat, memperbarui, menghapus) pada perangkat yang berbeda diizinkan. Maksimal 100 perangkat dapat ditentukan per pemanggilan. Untuk operasi skala besar, gunakan fitur impor menggunakan penyimpanan blob (https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities).
POST https://fully-qualified-iothubname.azure-devices.net/devices?api-version=2021-04-12
Parameter URI
Nama | Dalam | Diperlukan | Jenis | Deskripsi |
---|---|---|---|---|
api-version
|
query | True |
string |
Versi Api. |
Isi Permintaan
Nama | Jenis | Deskripsi |
---|---|---|
devices |
Operasi registri yang akan dilakukan. |
Respons
Nama | Jenis | Deskripsi |
---|---|---|
200 OK |
OK. |
|
400 Bad Request |
Permintaan Buruk. |
Definisi
Nama | Deskripsi |
---|---|
Authentication |
|
Bulk |
Hasil operasi registri massal. |
Device |
Status kemampuan yang diaktifkan pada perangkat. |
Device |
Detail kesalahan operasi registri perangkat. |
Device |
Detail peringatan operasi registri perangkat. |
Export |
|
Property |
Properti kembar yang diinginkan dan dilaporkan. Kedalaman maksimum objek adalah 10. |
Symmetric |
|
X509Thumbprint |
AuthenticationMechanism
Nama | Jenis | Deskripsi |
---|---|---|
symmetricKey |
Kunci primer dan sekunder yang digunakan untuk autentikasi berbasis SAS. |
|
type |
enum:
|
Jenis autentikasi yang digunakan untuk menyambungkan ke layanan. |
x509Thumbprint |
Thumbprint x509 primer dan sekunder yang digunakan untuk autentikasi berbasis x509. |
BulkRegistryOperationResult
Hasil operasi registri massal.
Nama | Jenis | Deskripsi |
---|---|---|
errors |
Kesalahan operasi registri perangkat. |
|
isSuccessful |
boolean |
Hasil operasi. |
warnings |
Peringatan operasi registri perangkat. |
DeviceCapabilities
Status kemampuan yang diaktifkan pada perangkat.
Nama | Jenis | Deskripsi |
---|---|---|
iotEdge |
boolean |
Properti yang menentukan apakah perangkat adalah perangkat edge atau tidak. |
DeviceRegistryOperationError
Detail kesalahan operasi registri perangkat.
Nama | Jenis | Deskripsi |
---|---|---|
deviceId |
string |
Pengidentifikasi unik perangkat. |
errorCode |
enum:
|
Kode kesalahan. |
errorStatus |
string |
Detail kesalahan. |
moduleId |
string |
Pengidentifikasi unik modul, jika berlaku. |
operation |
string |
Jenis operasi yang gagal. |
DeviceRegistryOperationWarning
Detail peringatan operasi registri perangkat.
Nama | Jenis | Deskripsi |
---|---|---|
deviceId |
string |
Pengidentifikasi unik perangkat. |
warningCode |
enum:
Device |
Kode peringatan. |
warningStatus |
string |
Detail peringatan. |
ExportImportDevice
Nama | Jenis | Deskripsi |
---|---|---|
authentication |
Mekanisme autentikasi yang digunakan oleh modul. Parameter ini bersifat opsional dan default ke SAS jika tidak disediakan. Dalam hal ini, kunci akses primer/sekunder dibuat secara otomatis. |
|
capabilities |
Status kemampuan yang diaktifkan pada perangkat. |
|
deviceScope |
string |
Cakupan perangkat. |
eTag |
string |
String yang mewakili ETag lemah untuk perangkat RFC7232. Nilai hanya digunakan jika mode impor adalah updateIfMatchETag, dalam hal ini operasi impor dilakukan hanya jika ETag ini cocok dengan nilai yang dikelola oleh server. |
id |
string |
Pengidentifikasi unik perangkat. |
importMode |
enum:
|
Jenis operasi registri dan preferensi ETag. |
moduleId |
string |
Pengidentifikasi unik modul, jika berlaku. |
parentScopes |
string[] |
Cakupan perangkat tepi tingkat atas jika berlaku. Hanya tersedia untuk perangkat edge. |
properties |
Properti yang diinginkan dan dilaporkan untuk perangkat. |
|
status |
enum:
|
Status modul. Jika dinonaktifkan, modul tidak dapat tersambung ke layanan. |
statusReason |
string |
String sepanjang 128 karakter yang menyimpan alasan status identitas perangkat. Semua karakter UTF-8 diperbolehkan. |
tags |
object |
Dokumen JSON dibaca dan ditulis oleh back end solusi. Tag tidak terlihat oleh aplikasi perangkat. |
twinETag |
string |
String yang mewakili ETag lemah untuk perangkat kembar RFC7232. Nilai hanya digunakan jika mode impor adalah updateIfMatchETag, dalam hal ini operasi impor dilakukan hanya jika ETag ini cocok dengan nilai yang dikelola oleh server. |
PropertyContainer
Properti kembar yang diinginkan dan dilaporkan. Kedalaman maksimum objek adalah 10.
Nama | Jenis | Deskripsi |
---|---|---|
desired |
object |
Kumpulan pasangan kunci-nilai properti yang diinginkan. Kuncinya adalah UTF-8 yang dikodekan, peka huruf besar/kecil, dan panjangnya hingga 1KB. Karakter yang diizinkan mengecualikan karakter kontrol UNICODE (segmen C0 dan C1), '.', '$' dan spasi. Nilai porperty yang diinginkan adalah objek JSON, panjangnya hingga 4KB. |
reported |
object |
Kumpulan pasangan kunci-nilai properti yang dilaporkan. Kuncinya adalah UTF-8 yang dikodekan, peka huruf besar/kecil, dan panjangnya hingga 1KB. Karakter yang diizinkan mengecualikan karakter kontrol UNICODE (segmen C0 dan C1), '.', '$' dan spasi. Nilai properti yang dilaporkan adalah objek JSON, panjangnya hingga 4KB. |
SymmetricKey
Nama | Jenis | Deskripsi |
---|---|---|
primaryKey |
string |
Kunci primer perangkat yang dikodekan base64. |
secondaryKey |
string |
Kunci sekunder yang dikodekan base64 dari perangkat. |
X509Thumbprint
Nama | Jenis | Deskripsi |
---|---|---|
primaryThumbprint |
string |
Thumbprint utama sertifikat klien X509. |
secondaryThumbprint |
string |
Thumbprint sekunder sertifikat klien X509. |