Bulk Registry - Update Registry
Tworzy, aktualizuje lub usuwa tożsamości wielu urządzeń z rejestru tożsamości IoT Hub. Tożsamość urządzenia można określić tylko raz na liście. Różne operacje (tworzenie, aktualizowanie, usuwanie) na różnych urządzeniach są dozwolone. Maksymalnie 100 urządzeń można określić na wywołanie. W przypadku operacji na dużą skalę użyj funkcji importowania przy użyciu magazynu obiektów 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-12Parametry identyfikatora URI
| Nazwa | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
api-version
|
query | True |
string |
Wersja interfejsu API. |
Treść żądania
| Nazwa | Typ | Opis |
|---|---|---|
| devices |
Operacje rejestru do wykonania. |
Odpowiedzi
| Nazwa | Typ | Opis |
|---|---|---|
| 200 OK |
OK. |
|
| 400 Bad Request |
Nieprawidłowe żądanie. |
Definicje
| Nazwa | Opis |
|---|---|
|
Authentication |
|
|
Bulk |
Wynik operacji rejestru zbiorczego. |
|
Device |
Stan możliwości włączonych na urządzeniu. |
|
Device |
Szczegóły błędu operacji rejestru urządzeń. |
|
Device |
Szczegóły ostrzeżenia dotyczące operacji rejestru urządzeń. |
|
Export |
|
|
Property |
Żądane i zgłoszone właściwości bliźniaczej reprezentacji bliźniaczej. Maksymalna głębokość obiektu wynosi 10. |
|
Symmetric |
|
| X509Thumbprint |
AuthenticationMechanism
| Nazwa | Typ | Opis |
|---|---|---|
| symmetricKey |
Podstawowe i pomocnicze klucze używane do uwierzytelniania opartego na sygnaturze dostępu współdzielonego. |
|
| type |
enum:
|
Typ uwierzytelniania używanego do nawiązywania połączenia z usługą. |
| x509Thumbprint |
Podstawowe i pomocnicze odciski palca x509 używane do uwierzytelniania opartego na architekturze x509. |
BulkRegistryOperationResult
Wynik operacji rejestru zbiorczego.
| Nazwa | Typ | Opis |
|---|---|---|
| errors |
Błędy operacji rejestru urządzeń. |
|
| isSuccessful |
boolean |
Wynik operacji. |
| warnings |
Ostrzeżenia dotyczące operacji rejestru urządzeń. |
DeviceCapabilities
Stan możliwości włączonych na urządzeniu.
| Nazwa | Typ | Opis |
|---|---|---|
| iotEdge |
boolean |
Właściwość określająca, czy urządzenie jest urządzeniem brzegowym, czy nie. |
DeviceRegistryOperationError
Szczegóły błędu operacji rejestru urządzeń.
| Nazwa | Typ | Opis |
|---|---|---|
| deviceId |
string |
Unikatowy identyfikator urządzenia. |
| errorCode |
enum:
|
Kod błędu. |
| errorStatus |
string |
Szczegóły błędu. |
| moduleId |
string |
Unikatowy identyfikator modułu, jeśli ma to zastosowanie. |
| operation |
string |
Typ operacji, która nie powiodła się. |
DeviceRegistryOperationWarning
Szczegóły ostrzeżenia dotyczące operacji rejestru urządzeń.
| Nazwa | Typ | Opis |
|---|---|---|
| deviceId |
string |
Unikatowy identyfikator urządzenia. |
| warningCode |
enum:
Device |
Kod ostrzegawczy. |
| warningStatus |
string |
Szczegóły ostrzeżenia. |
ExportImportDevice
| Nazwa | Typ | Opis |
|---|---|---|
| authentication |
Mechanizm uwierzytelniania używany przez moduł. Ten parametr jest opcjonalny i domyślnie jest domyślnie ustawiony na sygnaturę dostępu współdzielonego, jeśli nie zostanie podany. W takim przypadku klucze dostępu podstawowego/pomocniczego są generowane automatycznie. |
|
| capabilities |
Stan możliwości włączonych na urządzeniu. |
|
| deviceScope |
string |
Zakres urządzenia. |
| eTag |
string |
Ciąg reprezentujący słaby element ETag dla urządzenia RFC7232. Wartość jest używana tylko wtedy, gdy tryb importu to updateIfMatchETag, w takim przypadku operacja importowania jest wykonywana tylko wtedy, gdy ten element ETag jest zgodny z wartością obsługiwaną przez serwer. |
| id |
string |
Unikatowy identyfikator urządzenia. |
| importMode |
enum:
|
Typ operacji rejestru i preferencje ETag. |
| moduleId |
string |
Unikatowy identyfikator modułu, jeśli ma to zastosowanie. |
| parentScopes |
string[] |
Zakresy urządzeń brzegowych wyższego poziomu, jeśli ma to zastosowanie. Dostępne tylko dla urządzeń brzegowych. |
| properties |
Żądane i zgłoszone właściwości urządzenia. |
|
| status |
enum:
|
Stan modułu. Jeśli to ustawienie jest wyłączone, moduł nie może nawiązać połączenia z usługą. |
| statusReason |
string |
128-znakowy ciąg, który przechowuje przyczynę stanu tożsamości urządzenia. Dozwolone są wszystkie znaki UTF-8. |
| tags |
object |
Dokument JSON odczytany i zapisany przez zaplecze rozwiązania. Tagi nie są widoczne dla aplikacji urządzeń. |
| twinETag |
string |
Ciąg reprezentujący słaby element ETag dla bliźniaczej reprezentacji urządzenia RFC7232. Wartość jest używana tylko wtedy, gdy tryb importu to updateIfMatchETag, w takim przypadku operacja importowania jest wykonywana tylko wtedy, gdy ten element ETag jest zgodny z wartością obsługiwaną przez serwer. |
PropertyContainer
Żądane i zgłoszone właściwości bliźniaczej reprezentacji bliźniaczej. Maksymalna głębokość obiektu wynosi 10.
| Nazwa | Typ | Opis |
|---|---|---|
| desired |
object |
Kolekcja par klucz-wartość żądanej właściwości. Klucze są zakodowane w formacie UTF-8, z uwzględnieniem wielkości liter i długości do 1 KB. Dozwolone znaki wykluczają znaki sterujące UNICODE (segmenty C0 i C1), ".", "$" i spację. Żądane wartości porperty to obiekty JSON o długości do 4 KB. |
| reported |
object |
Kolekcja zgłoszonych par klucz-wartość właściwości. Klucze są zakodowane w formacie UTF-8, z uwzględnieniem wielkości liter i długości do 1 KB. Dozwolone znaki wykluczają znaki sterujące UNICODE (segmenty C0 i C1), ".", "$" i spację. Zgłoszone wartości właściwości to obiekty JSON o długości do 4 KB. |
SymmetricKey
| Nazwa | Typ | Opis |
|---|---|---|
| primaryKey |
string |
Zakodowany w formacie base64 klucz podstawowy urządzenia. |
| secondaryKey |
string |
Zakodowany w formacie base64 klucz pomocniczy urządzenia. |
X509Thumbprint
| Nazwa | Typ | Opis |
|---|---|---|
| primaryThumbprint |
string |
Podstawowy odcisk palca certyfikatu klienta X509. |
| secondaryThumbprint |
string |
Pomocniczy odcisk palca certyfikatu klienta X509. |