Bulk Registry - Update Registry
IoT Hub kimlik kayıt defterinden birden çok cihazın kimliklerini oluşturur, güncelleştirir veya siler. Cihaz kimliği listede yalnızca bir kez belirtilebilir. Farklı cihazlarda farklı işlemlere (oluşturma, güncelleştirme, silme) izin verilir. Çağrı başına en fazla 100 cihaz belirtilebilir. Büyük ölçekli işlemler için blob depolama ()https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities kullanarak içeri aktarma özelliğini kullanın.
POST https://fully-qualified-iothubname.azure-devices.net/devices?api-version=2020-05-31-previewURI Parametreleri
| Name | İçinde | Gerekli | Tür | Description |
|---|---|---|---|---|
|
api-version
|
query | True |
string |
Api sürümü. |
İstek Gövdesi
| Name | Tür | Description |
|---|---|---|
| devices |
Gerçekleştirilecek kayıt defteri işlemleri. |
Yanıtlar
| Name | Tür | Description |
|---|---|---|
| 200 OK |
Tamam ögesini seçin. |
|
| 400 Bad Request |
Hatalı İstek. |
Tanımlar
| Name | Description |
|---|---|
|
Authentication |
|
|
Bulk |
Toplu kayıt defteri işleminin sonucu. |
|
Device |
Cihazda etkinleştirilen özelliklerin durumu. |
|
Device |
Cihaz kayıt defteri işlemi hata ayrıntıları. |
|
Device |
Cihaz kayıt defteri işlemi uyarı ayrıntıları. |
|
Export |
|
|
Property |
İkizin istenen ve bildirilen özellikleri. Nesnenin maksimum derinliği 10'dur. |
|
Symmetric |
|
| X509Thumbprint |
AuthenticationMechanism
| Name | Tür | Description |
|---|---|---|
| symmetricKey |
SAS tabanlı kimlik doğrulaması için kullanılan birincil ve ikincil anahtarlar. |
|
| type |
enum:
|
Hizmete bağlanmak için kullanılan kimlik doğrulama türü. |
| x509Thumbprint |
x509 tabanlı kimlik doğrulaması için kullanılan birincil ve ikincil x509 parmak izleri. |
BulkRegistryOperationResult
Toplu kayıt defteri işleminin sonucu.
| Name | Tür | Description |
|---|---|---|
| errors |
Cihaz kayıt defteri işlemi hataları. |
|
| isSuccessful |
boolean |
İşlem sonucu. |
| warnings |
Cihaz kayıt defteri işlemi uyarıları. |
DeviceCapabilities
Cihazda etkinleştirilen özelliklerin durumu.
| Name | Tür | Description |
|---|---|---|
| iotEdge |
boolean |
Cihazın bir uç cihaz olup olmadığını belirleyen özellik. |
DeviceRegistryOperationError
Cihaz kayıt defteri işlemi hata ayrıntıları.
| Name | Tür | Description |
|---|---|---|
| deviceId |
string |
Cihazın benzersiz tanımlayıcısı. |
| errorCode |
enum:
|
Hata kodu. |
| errorStatus |
string |
Hatanın ayrıntıları. |
| moduleId |
string |
Varsa, modülün benzersiz tanımlayıcısı. |
| operation |
string |
Başarısız olan işlemin türü. |
DeviceRegistryOperationWarning
Cihaz kayıt defteri işlemi uyarı ayrıntıları.
| Name | Tür | Description |
|---|---|---|
| deviceId |
string |
Cihazın benzersiz tanımlayıcısı. |
| warningCode |
enum:
Device |
Uyarı kodu. |
| warningStatus |
string |
Uyarının ayrıntıları. |
ExportImportDevice
| Name | Tür | Description |
|---|---|---|
| authentication |
Modül tarafından kullanılan kimlik doğrulama mekanizması. Bu parametre isteğe bağlıdır ve sağlanmazsa varsayılan olarak SAS olarak ayarlanır. Bu durumda birincil/ikincil erişim anahtarları otomatik olarak oluşturulur. |
|
| capabilities |
Cihazda etkinleştirilen özelliklerin durumu. |
|
| deviceScope |
string |
Cihazın kapsamı. |
| eTag |
string |
Cihaz için zayıf bir ETag'i temsil eden dize RFC7232. Değer yalnızca içeri aktarma modu updateIfMatchETag ise kullanılır, bu durumda içeri aktarma işlemi yalnızca bu ETag sunucu tarafından tutulan değerle eşleşiyorsa gerçekleştirilir. |
| id |
string |
Cihazın benzersiz tanımlayıcısı. |
| importMode |
enum:
|
Kayıt defteri işleminin türü ve ETag tercihleri. |
| moduleId |
string |
Varsa, modülün benzersiz tanımlayıcısı. |
| properties |
Cihaz için istenen ve bildirilen özellikler. |
|
| status |
enum:
|
Modülün durumu. Devre dışı bırakılırsa modül hizmete bağlanamaz. |
| statusReason |
string |
Cihaz kimliği durumunun nedenini depolayan 128 karakter uzunluğunda dize. Tüm UTF-8 karakterlerine izin verilir. |
| tags |
object |
Çözüm arka ucu tarafından okunan ve yazılan JSON belgesi. Etiketler cihaz uygulamalarına görünmez. |
| twinETag |
string |
Cihaz ikizi için zayıf bir ETag'i temsil eden dize RFC7232. Değer yalnızca içeri aktarma modu updateIfMatchETag ise kullanılır, bu durumda içeri aktarma işlemi yalnızca bu ETag sunucu tarafından tutulan değerle eşleşiyorsa gerçekleştirilir. |
PropertyContainer
İkizin istenen ve bildirilen özellikleri. Nesnenin maksimum derinliği 10'dur.
| Name | Tür | Description |
|---|---|---|
| desired |
object |
İstenen özellik anahtar-değer çiftlerinin koleksiyonu. Anahtarlar UTF-8 kodlu, büyük/küçük harfe duyarlı ve en fazla 1 KB uzunluğundadır. İzin verilen karakterler UNICODE denetim karakterlerini (C0 ve C1 kesimleri), '.', '$' ve boşluğu hariç tutar. İstenen porperty değerleri, uzunluğu 4 KB'a kadar olan JSON nesneleridir. |
| reported |
object |
Bildirilen özellik anahtar-değer çiftlerinin koleksiyonu. Anahtarlar UTF-8 kodlu, büyük/küçük harfe duyarlı ve en fazla 1 KB uzunluğundadır. İzin verilen karakterler UNICODE denetim karakterlerini (C0 ve C1 kesimleri), '.', '$' ve boşluğu hariç tutar. Bildirilen özellik değerleri, uzunluğu 4 KB'a kadar olan JSON nesneleridir. |
SymmetricKey
| Name | Tür | Description |
|---|---|---|
| primaryKey |
string |
Cihazın base64 ile kodlanmış birincil anahtarı. |
| secondaryKey |
string |
Cihazın base64 kodlanmış ikincil anahtarı. |
X509Thumbprint
| Name | Tür | Description |
|---|---|---|
| primaryThumbprint |
string |
X509 istemci sertifikası birincil parmak izi. |
| secondaryThumbprint |
string |
X509 istemci sertifikası ikincil parmak izi. |