Bulk Registry - Update Registry
Hiermee worden de identiteiten van meerdere apparaten gemaakt, bijgewerkt of verwijderd uit het IoT Hub-identiteitsregister. Een apparaat-id kan slechts eenmaal in de lijst worden opgegeven. Verschillende bewerkingen (maken, bijwerken, verwijderen) op verschillende apparaten zijn toegestaan. Per aanroep kunnen maximaal 100 apparaten worden opgegeven. Gebruik voor grootschalige bewerkingen de importfunctie met blobopslag (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-parameters
| Name | In | Vereist | Type | Description |
|---|---|---|---|---|
|
api-version
|
query | True |
string |
Versie van de API. |
Aanvraagbody
| Name | Type | Description |
|---|---|---|
| devices |
De uit te voeren registerbewerkingen. |
Antwoorden
| Name | Type | Description |
|---|---|---|
| 200 OK |
OK. |
|
| 400 Bad Request |
Ongeldige aanvraag. |
Definities
| Name | Description |
|---|---|
|
Authentication |
|
|
Bulk |
Het resultaat van de bulkregisterbewerking. |
|
Device |
De status van de mogelijkheden die zijn ingeschakeld op het apparaat. |
|
Device |
De foutdetails van de registerbewerking van het apparaat. |
|
Device |
De waarschuwingsdetails van de apparaatregisterbewerking. |
|
Export |
|
|
Property |
De gewenste en gerapporteerde eigenschappen van de dubbel. De maximale diepte van het object is 10. |
|
Symmetric |
|
| X509Thumbprint |
AuthenticationMechanism
| Name | Type | Description |
|---|---|---|
| symmetricKey |
De primaire en secundaire sleutels die worden gebruikt voor verificatie op basis van SAS. |
|
| type |
enum:
|
Het type verificatie dat wordt gebruikt om verbinding te maken met de service. |
| x509Thumbprint |
De primaire en secundaire x509-vingerafdrukken die worden gebruikt voor verificatie op basis van x509. |
BulkRegistryOperationResult
Het resultaat van de bulkregisterbewerking.
| Name | Type | Description |
|---|---|---|
| errors |
De fouten bij de bewerking van het apparaatregister. |
|
| isSuccessful |
boolean |
Het resultaat van de bewerking. |
| warnings |
De waarschuwingen voor de registerbewerking van het apparaat. |
DeviceCapabilities
De status van de mogelijkheden die zijn ingeschakeld op het apparaat.
| Name | Type | Description |
|---|---|---|
| iotEdge |
boolean |
De eigenschap die bepaalt of het apparaat een edge-apparaat is of niet. |
DeviceRegistryOperationError
De foutdetails van de registerbewerking van het apparaat.
| Name | Type | Description |
|---|---|---|
| deviceId |
string |
De unieke id van het apparaat. |
| errorCode |
enum:
|
De foutcode. |
| errorStatus |
string |
De details van de fout. |
| moduleId |
string |
De unieke id van de module, indien van toepassing. |
| operation |
string |
Het type bewerking dat is mislukt. |
DeviceRegistryOperationWarning
De waarschuwingsdetails van de apparaatregisterbewerking.
| Name | Type | Description |
|---|---|---|
| deviceId |
string |
De unieke id van het apparaat. |
| warningCode |
enum:
Device |
De waarschuwingscode. |
| warningStatus |
string |
De details van de waarschuwing. |
ExportImportDevice
| Name | Type | Description |
|---|---|---|
| authentication |
Het verificatiemechanisme dat door de module wordt gebruikt. Deze parameter is optioneel en standaard ingesteld op SAS als deze niet is opgegeven. In dat geval worden primaire/secundaire toegangssleutels automatisch gegenereerd. |
|
| capabilities |
De status van de mogelijkheden die zijn ingeschakeld op het apparaat. |
|
| deviceScope |
string |
Het bereik van het apparaat. |
| eTag |
string |
De tekenreeks die een zwakke ETag voor het apparaat vertegenwoordigt, RFC7232. De waarde wordt alleen gebruikt als de importmodus updateIfMatchETag is. In dat geval wordt de importbewerking alleen uitgevoerd als deze ETag overeenkomt met de waarde die door de server wordt onderhouden. |
| id |
string |
De unieke id van het apparaat. |
| importMode |
enum:
|
Het type registerbewerking en ETag-voorkeuren. |
| moduleId |
string |
De unieke id van de module, indien van toepassing. |
| parentScopes |
string[] |
De bereiken van de randapparaten op het hoogste niveau, indien van toepassing. Alleen beschikbaar voor edge-apparaten. |
| properties |
De gewenste en gerapporteerde eigenschappen voor het apparaat. |
|
| status |
enum:
|
De status van de module. Als deze optie is uitgeschakeld, kan de module geen verbinding maken met de service. |
| statusReason |
string |
De tekenreeks van 128 tekens lang waarin de reden voor de status van de apparaatidentiteit wordt opgeslagen. Alle UTF-8-tekens zijn toegestaan. |
| tags |
object |
Het JSON-document dat wordt gelezen en geschreven door de back-end van de oplossing. De tags zijn niet zichtbaar voor apparaat-apps. |
| twinETag |
string |
De tekenreeks die een zwakke ETag voor de apparaatdubbel vertegenwoordigt, RFC7232. De waarde wordt alleen gebruikt als de importmodus updateIfMatchETag is. In dat geval wordt de importbewerking alleen uitgevoerd als deze ETag overeenkomt met de waarde die door de server wordt onderhouden. |
PropertyContainer
De gewenste en gerapporteerde eigenschappen van de dubbel. De maximale diepte van het object is 10.
| Name | Type | Description |
|---|---|---|
| desired |
object |
De verzameling van gewenste eigenschapssleutel-waardeparen. De sleutels zijn met UTF-8 gecodeerd, hoofdlettergevoelig en maximaal 1 kB lang. Toegestane tekens zijn geen UNICODE-besturingstekens (segmenten C0 en C1), '.', '$' en spatie. De gewenste porperty-waarden zijn JSON-objecten met een lengte van maximaal 4 kB. |
| reported |
object |
De verzameling gerapporteerde eigenschapssleutel-waardeparen. De sleutels zijn met UTF-8 gecodeerd, hoofdlettergevoelig en maximaal 1 kB lang. Toegestane tekens zijn geen UNICODE-besturingstekens (segmenten C0 en C1), '.', '$' en spatie. De gerapporteerde eigenschapswaarden zijn JSON-objecten met een lengte van maximaal 4 kB. |
SymmetricKey
| Name | Type | Description |
|---|---|---|
| primaryKey |
string |
De met base64 gecodeerde primaire sleutel van het apparaat. |
| secondaryKey |
string |
De met base64 gecodeerde secundaire sleutel van het apparaat. |
X509Thumbprint
| Name | Type | Description |
|---|---|---|
| primaryThumbprint |
string |
De primaire vingerafdruk van het X509-clientcertificaat. |
| secondaryThumbprint |
string |
De secundaire vingerafdruk van het X509-clientcertificaat. |