Bulk Registry - Update Registry
Több eszköz identitásait hozza létre, frissíti vagy törli a IoT Hub identitásjegyzékből. Az eszközidentitás csak egyszer adható meg a listában. Különböző eszközökön különböző műveletek (létrehozás, frissítés, törlés) engedélyezettek. Hívásonként legfeljebb 100 eszköz adható meg. Nagy léptékű műveletek esetén használja az importálási funkciót a Blob Storage használatával (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=2020-05-31-previewURI-paraméterek
| Name | In | Kötelező | Típus | Description |
|---|---|---|---|---|
|
api-version
|
query | True |
string |
Az Api verziója. |
Kérelem törzse
| Name | Típus | Description |
|---|---|---|
| devices |
A végrehajtandó beállításjegyzék-műveletek. |
Válaszok
| Name | Típus | Description |
|---|---|---|
| 200 OK |
OK gombra. |
|
| 400 Bad Request |
Hibás kérés. |
Definíciók
| Name | Description |
|---|---|
|
Authentication |
|
|
Bulk |
A tömeges beállításjegyzék-művelet eredménye. |
|
Device |
Az eszközön engedélyezett képességek állapota. |
|
Device |
Az eszközregisztrációs adatbázis műveletének hibaadatai. |
|
Device |
Az eszközregisztrációs adatbázis műveletének figyelmeztetési részletei. |
|
Export |
|
|
Property |
Az ikerpéldány kívánt és jelentett tulajdonságai. Az objektum maximális mélysége 10. |
|
Symmetric |
|
| X509Thumbprint |
AuthenticationMechanism
| Name | Típus | Description |
|---|---|---|
| symmetricKey |
Az SAS-alapú hitelesítéshez használt elsődleges és másodlagos kulcsok. |
|
| type |
enum:
|
A szolgáltatáshoz való csatlakozáshoz használt hitelesítés típusa. |
| x509Thumbprint |
Az x509-alapú hitelesítéshez használt elsődleges és másodlagos x509 ujjlenyomatok. |
BulkRegistryOperationResult
A tömeges beállításjegyzék-művelet eredménye.
| Name | Típus | Description |
|---|---|---|
| errors |
Az eszközregisztrációs adatbázis működésével kapcsolatos hibák. |
|
| isSuccessful |
boolean |
A művelet eredménye. |
| warnings |
Az eszközregisztrációs adatbázis műveletére vonatkozó figyelmeztetések. |
DeviceCapabilities
Az eszközön engedélyezett képességek állapota.
| Name | Típus | Description |
|---|---|---|
| iotEdge |
boolean |
Az a tulajdonság, amely meghatározza, hogy az eszköz peremeszköz-e vagy sem. |
DeviceRegistryOperationError
Az eszközregisztrációs adatbázis műveletének hibaadatai.
| Name | Típus | Description |
|---|---|---|
| deviceId |
string |
Az eszköz egyedi azonosítója. |
| errorCode |
enum:
|
A hibakód. |
| errorStatus |
string |
A hiba részletei. |
| moduleId |
string |
A modul egyedi azonosítója, ha van. |
| operation |
string |
A sikertelen művelet típusa. |
DeviceRegistryOperationWarning
Az eszközregisztrációs adatbázis műveletének figyelmeztetési részletei.
| Name | Típus | Description |
|---|---|---|
| deviceId |
string |
Az eszköz egyedi azonosítója. |
| warningCode |
enum:
Device |
A figyelmeztető kód. |
| warningStatus |
string |
A figyelmeztetés részletei. |
ExportImportDevice
| Name | Típus | Description |
|---|---|---|
| authentication |
A modul által használt hitelesítési mechanizmus. Ez a paraméter nem kötelező, és ha nincs megadva az SAS alapértelmezett értéke. Ebben az esetben az elsődleges/másodlagos hozzáférési kulcsok automatikusan jönnek létre. |
|
| capabilities |
Az eszközön engedélyezett képességek állapota. |
|
| deviceScope |
string |
Az eszköz hatóköre. |
| eTag |
string |
Az eszköz gyenge ETag-jének megfelelő sztring RFC7232. Az érték csak akkor használatos, ha az importálási mód updateIfMatchETag, ebben az esetben az importálási művelet csak akkor lesz végrehajtva, ha ez az ETag megegyezik a kiszolgáló által fenntartott értékkel. |
| id |
string |
Az eszköz egyedi azonosítója. |
| importMode |
enum:
|
A beállításjegyzék-művelet típusa és az ETag beállításai. |
| moduleId |
string |
A modul egyedi azonosítója, ha van. |
| properties |
Az eszköz kívánt és jelentett tulajdonságai. |
|
| status |
enum:
|
A modul állapota. Ha le van tiltva, a modul nem tud csatlakozni a szolgáltatáshoz. |
| statusReason |
string |
Az eszközidentitás állapotának okát tároló 128 karakter hosszúságú sztring. Minden UTF-8 karakter megengedett. |
| tags |
object |
A megoldás háttérrendszere által olvasott és írt JSON-dokumentum. A címkék nem láthatók az eszközalkalmazások számára. |
| twinETag |
string |
Az ikereszköz gyenge ETag-jének megfelelő sztring RFC7232. Az érték csak akkor használatos, ha az importálási mód updateIfMatchETag, ebben az esetben az importálási művelet csak akkor lesz végrehajtva, ha ez az ETag megegyezik a kiszolgáló által fenntartott értékkel. |
PropertyContainer
Az ikerpéldány kívánt és jelentett tulajdonságai. Az objektum maximális mélysége 10.
| Name | Típus | Description |
|---|---|---|
| desired |
object |
A kívánt tulajdonságkulcs-érték párok gyűjteménye. A kulcsok UTF-8 kódolásúak, a kis- és nagybetűk megkülönböztetése és akár 1 KB hosszúak. Az engedélyezett karakterek nem tartalmazzák a UNICODE vezérlőkaraktereket (C0 és C1 szegmens), a ".", a "$" és a szóközt. A kívánt porperty értékek JSON-objektumok, legfeljebb 4 KB hosszúságúak. |
| reported |
object |
A jelentett tulajdonságkulcs-érték párok gyűjteménye. A kulcsok UTF-8 kódolásúak, a kis- és nagybetűk megkülönböztetése és akár 1 KB hosszúak. Az engedélyezett karakterek nem tartalmazzák a UNICODE vezérlőkaraktereket (C0 és C1 szegmens), a ".", a "$" és a szóközt. A jelentett tulajdonságértékek JSON-objektumok, legfeljebb 4 KB hosszúságúak. |
SymmetricKey
| Name | Típus | Description |
|---|---|---|
| primaryKey |
string |
Az eszköz base64 kódolású elsődleges kulcsa. |
| secondaryKey |
string |
Az eszköz base64 kódolású másodlagos kulcsa. |
X509Thumbprint
| Name | Típus | Description |
|---|---|---|
| primaryThumbprint |
string |
Az X509 ügyféltanúsítvány elsődleges ujjlenyomata. |
| secondaryThumbprint |
string |
Az X509 ügyféltanúsítvány másodlagos ujjlenyomata. |