Bulk Registry - Update Registry
Erstellt, aktualisiert oder löscht die Identitäten mehrerer Geräte aus der IoT Hub-Identitätsregistrierung. Eine Geräteidentität kann nur einmal in der Liste angegeben werden. Unterschiedliche Vorgänge (Erstellen, Aktualisieren, Löschen) auf verschiedenen Geräten sind zulässig. Pro Aufruf können maximal 100 Geräte angegeben werden. Verwenden Sie für große Vorgänge das Importfeature mithilfe von BLOB-Speicher (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-Parameter
| Name | In | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
api-version
|
query | True |
string |
Version der API. |
Anforderungstext
| Name | Typ | Beschreibung |
|---|---|---|
| devices |
Die auszuführenden Registrierungsvorgänge. |
Antworten
| Name | Typ | Beschreibung |
|---|---|---|
| 200 OK |
OKAY. |
|
| 400 Bad Request |
Ungültige Anforderung; |
Definitionen
| Name | Beschreibung |
|---|---|
|
Authentication |
|
|
Bulk |
Das Ergebnis des Massenregistrierungsvorgangs. |
|
Device |
Der Status der auf dem Gerät aktivierten Funktionen. |
|
Device |
Fehlerdetails des Geräteregistrierungsvorgangs. |
|
Device |
Die Warnung des Geräteregistrierungsvorgangs. |
|
Export |
|
|
Property |
Die gewünschten und gemeldeten Eigenschaften des Zwillings. Die maximale Tiefe des Objekts beträgt 10. |
|
Symmetric |
|
| X509Thumbprint |
AuthenticationMechanism
| Name | Typ | Beschreibung |
|---|---|---|
| symmetricKey |
Die primären und sekundären Schlüssel, die für die SAS-basierte Authentifizierung verwendet werden. |
|
| type |
enum:
|
Der Typ der Authentifizierung, die zum Herstellen einer Verbindung mit dem Dienst verwendet wird. |
| x509Thumbprint |
Die primären und sekundären x509-Fingerabdrucke, die für die x509-basierte Authentifizierung verwendet werden. |
BulkRegistryOperationResult
Das Ergebnis des Massenregistrierungsvorgangs.
| Name | Typ | Beschreibung |
|---|---|---|
| errors |
Fehler beim Geräteregistrierungsvorgang. |
|
| isSuccessful |
boolean |
Das Vorgangsergebnis. |
| warnings |
Warnungen beim Geräteregistrierungsvorgang. |
DeviceCapabilities
Der Status der auf dem Gerät aktivierten Funktionen.
| Name | Typ | Beschreibung |
|---|---|---|
| iotEdge |
boolean |
Die Eigenschaft, die bestimmt, ob das Gerät ein Edgegerät ist oder nicht. |
DeviceRegistryOperationError
Fehlerdetails des Geräteregistrierungsvorgangs.
| Name | Typ | Beschreibung |
|---|---|---|
| deviceId |
string |
Der eindeutige Bezeichner des Geräts. |
| errorCode |
enum:
|
Der Fehlercode. |
| errorStatus |
string |
Die Details des Fehlers. |
| moduleId |
string |
Der eindeutige Bezeichner des Moduls, falls zutreffend. |
| operation |
string |
Der Typ des fehlgeschlagenen Vorgangs. |
DeviceRegistryOperationWarning
Die Warnung des Geräteregistrierungsvorgangs.
| Name | Typ | Beschreibung |
|---|---|---|
| deviceId |
string |
Der eindeutige Bezeichner des Geräts. |
| warningCode |
enum:
Device |
Der Warncode. |
| warningStatus |
string |
Die Details der Warnung. |
ExportImportDevice
| Name | Typ | Beschreibung |
|---|---|---|
| authentication |
Der vom Modul verwendete Authentifizierungsmechanismus. Dieser Parameter ist optional und wird standardmäßig auf SAS festgelegt, falls nicht angegeben. In diesem Fall werden primär/sekundäre Zugriffstasten automatisch generiert. |
|
| capabilities |
Der Status der auf dem Gerät aktivierten Funktionen. |
|
| deviceScope |
string |
Der Bereich des Geräts. |
| eTag |
string |
Die Zeichenfolge, die ein schwaches ETag für das Gerät RFC7232 darstellt. Der Wert wird nur verwendet, wenn der Importmodus updateIfMatchETag ist, in diesem Fall wird der Importvorgang nur ausgeführt, wenn dieses ETag mit dem vom Server verwalteten Wert übereinstimmt. |
| id |
string |
Der eindeutige Bezeichner des Geräts. |
| importMode |
enum:
|
Der Typ des Registrierungsvorgangs und der ETag-Einstellungen. |
| moduleId |
string |
Der eindeutige Bezeichner des Moduls, falls zutreffend. |
| parentScopes |
string[] |
Die Bereiche der Edgegeräte der oberen Ebene, falls zutreffend. Nur für Edgegeräte verfügbar. |
| properties |
Die gewünschten und gemeldeten Eigenschaften für das Gerät. |
|
| status |
enum:
|
Der Status des Moduls. Wenn sie deaktiviert ist, kann das Modul keine Verbindung mit dem Dienst herstellen. |
| statusReason |
string |
Die 128 zeichen lange Zeichenfolge, die den Grund für den Geräteidentitätsstatus speichert. Alle UTF-8-Zeichen sind zulässig. |
| tags |
object |
Das JSON-Dokument wird vom Back-End der Lösung gelesen und geschrieben. Die Tags sind für Geräte-Apps nicht sichtbar. |
| twinETag |
string |
Die Zeichenfolge, die ein schwaches ETag für das Gerät twin RFC7232 darstellt. Der Wert wird nur verwendet, wenn der Importmodus updateIfMatchETag ist, in diesem Fall wird der Importvorgang nur ausgeführt, wenn dieses ETag mit dem vom Server verwalteten Wert übereinstimmt. |
PropertyContainer
Die gewünschten und gemeldeten Eigenschaften des Zwillings. Die maximale Tiefe des Objekts beträgt 10.
| Name | Typ | Beschreibung |
|---|---|---|
| desired |
object |
Die Auflistung der gewünschten Eigenschaftsschlüssel-Wert-Paare. Die Schlüssel sind UTF-8-codiert, groß- und up-to 1 KB lang. Zulässige Zeichen schließen UNICODE-Steuerzeichen (Segmente C0 und C1), ".", "$" und Leerzeichen aus. Die gewünschten Porpertywerte sind JSON-Objekte, up-to 4 KB lang. |
| reported |
object |
Die Auflistung der gemeldeten Eigenschaftsschlüssel-Wert-Paare. Die Schlüssel sind UTF-8-codiert, groß- und up-to 1 KB lang. Zulässige Zeichen schließen UNICODE-Steuerzeichen (Segmente C0 und C1), ".", "$" und Leerzeichen aus. Die gemeldeten Eigenschaftswerte sind JSON-Objekte, up-to 4 KB länge. |
SymmetricKey
| Name | Typ | Beschreibung |
|---|---|---|
| primaryKey |
string |
Der base64-codierte Primärschlüssel des Geräts. |
| secondaryKey |
string |
Der base64-codierte Sekundärschlüssel des Geräts. |
X509Thumbprint
| Name | Typ | Beschreibung |
|---|---|---|
| primaryThumbprint |
string |
Der primäre Fingerabdruck des X509-Clientzertifikats. |
| secondaryThumbprint |
string |
Sekundärer Fingerabdruck des X509-Clientzertifikats. |