Bulk Registry - Update Registry
Skapar, uppdaterar eller tar bort identiteterna för flera enheter från IoT Hub identitetsregistret. En enhetsidentitet kan bara anges en gång i listan. Olika åtgärder (skapa, uppdatera, ta bort) på olika enheter tillåts. Högst 100 enheter kan anges per anrop. För storskaliga åtgärder använder du importfunktionen med bloblagring (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-12URI-parametrar
| Name | I | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
api-version
|
query | True |
string |
Version av API:et. |
Begärandetext
| Name | Typ | Description |
|---|---|---|
| devices |
De registeråtgärder som ska utföras. |
Svar
| Name | Typ | Description |
|---|---|---|
| 200 OK |
OK. |
|
| 400 Bad Request |
Felaktig begäran. |
Definitioner
| Name | Description |
|---|---|
|
Authentication |
|
|
Bulk |
Resultatet av massregisteråtgärden. |
|
Device |
Status för funktioner som är aktiverade på enheten. |
|
Device |
Information om enhetsregistrets åtgärdsfel. |
|
Device |
Varningsinformation om enhetsregistrets åtgärd. |
|
Export |
|
|
Property |
Önskade och rapporterade egenskaper för tvillingen. Objektets maximala djup är 10. |
|
Symmetric |
|
| X509Thumbprint |
AuthenticationMechanism
| Name | Typ | Description |
|---|---|---|
| symmetricKey |
De primära och sekundära nycklar som används för SAS-baserad autentisering. |
|
| type |
enum:
|
Den typ av autentisering som används för att ansluta till tjänsten. |
| x509Thumbprint |
De primära och sekundära x509-tumavtrycken som används för x509-baserad autentisering. |
BulkRegistryOperationResult
Resultatet av massregisteråtgärden.
| Name | Typ | Description |
|---|---|---|
| errors |
Enhetsregistrets åtgärdsfel. |
|
| isSuccessful |
boolean |
Åtgärdsresultatet. |
| warnings |
Varningar för enhetsregistrets åtgärd. |
DeviceCapabilities
Status för funktioner som är aktiverade på enheten.
| Name | Typ | Description |
|---|---|---|
| iotEdge |
boolean |
Egenskapen som avgör om enheten är en gränsenhet eller inte. |
DeviceRegistryOperationError
Information om enhetsregistrets åtgärdsfel.
| Name | Typ | Description |
|---|---|---|
| deviceId |
string |
Enhetens unika identifierare. |
| errorCode |
enum:
|
Felkoden. |
| errorStatus |
string |
Information om felet. |
| moduleId |
string |
Den unika identifieraren för modulen, om tillämpligt. |
| operation |
string |
Typen av åtgärd som misslyckades. |
DeviceRegistryOperationWarning
Varningsinformation om enhetsregistrets åtgärd.
| Name | Typ | Description |
|---|---|---|
| deviceId |
string |
Enhetens unika identifierare. |
| warningCode |
enum:
Device |
Varningskoden. |
| warningStatus |
string |
Information om varningen. |
ExportImportDevice
| Name | Typ | Description |
|---|---|---|
| authentication |
Autentiseringsmekanismen som används av modulen. Den här parametern är valfri och standardinställningen är SAS om den inte tillhandahålls. I så fall genereras primära/sekundära åtkomstnycklar automatiskt. |
|
| capabilities |
Status för funktioner som är aktiverade på enheten. |
|
| deviceScope |
string |
Enhetens omfång. |
| eTag |
string |
Strängen som representerar en svag ETag för enheten RFC7232. Värdet används endast om importläget är updateIfMatchETag, i så fall utförs importåtgärden endast om denna ETag matchar det värde som upprätthålls av servern. |
| id |
string |
Enhetens unika identifierare. |
| importMode |
enum:
|
Typ av registeråtgärd och ETag-inställningar. |
| moduleId |
string |
Den unika identifieraren för modulen, om tillämpligt. |
| parentScopes |
string[] |
Omfången för de övre gränsenheterna om tillämpligt. Endast tillgängligt för gränsenheter. |
| properties |
Önskade och rapporterade egenskaper för enheten. |
|
| status |
enum:
|
Status för modulen. Om modulen är inaktiverad kan den inte ansluta till tjänsten. |
| statusReason |
string |
Den 128 tecken långa strängen som lagrar orsaken till enhetens identitetsstatus. Alla UTF-8 tecken är tillåtna. |
| tags |
object |
JSON-dokumentet lästes och skrevs av lösningens serverdel. Taggarna är inte synliga för enhetsappar. |
| twinETag |
string |
Strängen som representerar en svag ETag för enhetstvillingen RFC7232. Värdet används endast om importläget är updateIfMatchETag, i så fall utförs importåtgärden endast om denna ETag matchar det värde som upprätthålls av servern. |
PropertyContainer
Önskade och rapporterade egenskaper för tvillingen. Objektets maximala djup är 10.
| Name | Typ | Description |
|---|---|---|
| desired |
object |
Samlingen av nyckel/värde-par för önskad egenskap. Nycklarna är UTF-8-kodade, skiftlägeskänsliga och upp till 1 KB långa. Tillåtna tecken exkluderar UNICODE-kontrolltecken (segmenten C0 och C1), '.', '$' och blanksteg. Önskade porperty-värden är JSON-objekt med en längd på upp till 4 KB. |
| reported |
object |
Samlingen av nyckel/värde-par för rapporterad egenskap. Nycklarna är UTF-8-kodade, skiftlägeskänsliga och upp till 1 KB långa. Tillåtna tecken exkluderar UNICODE-kontrolltecken (segmenten C0 och C1), '.', '$' och blanksteg. De rapporterade egenskapsvärdena är JSON-objekt med en längd på upp till 4 KB. |
SymmetricKey
| Name | Typ | Description |
|---|---|---|
| primaryKey |
string |
Den base64-kodade primärnyckeln för enheten. |
| secondaryKey |
string |
Enhetens base64-kodade sekundära nyckel. |
X509Thumbprint
| Name | Typ | Description |
|---|---|---|
| primaryThumbprint |
string |
X509-klientcertifikatets primära tumavtryck. |
| secondaryThumbprint |
string |
X509-klientcertifikatets sekundära tumavtryck. |