Runtime Registration - Operation Status Lookup
Ruft den Registrierungsvorgang status ab.
GET https://global.azure-devices-provisioning.net/{idScope}/registrations/{registrationId}/operations/{operationId}?api-version=2021-06-01
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
id
|
path | True |
string |
|
operation
|
path | True |
string |
Vorgangs-ID |
registration
|
path | True |
string |
Registrierungs-ID. |
api-version
|
query | True |
string |
API-Version, die für die Anforderung verwendet werden soll. Unterstützte Versionen sind: 2021-06-01 |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Erfolgreich |
|
202 Accepted |
Erfolg Headers
|
|
Other Status Codes |
Fehlerantwort |
Definitionen
Name | Beschreibung |
---|---|
Device |
Ergebnis der Geräteregistrierung. |
Provisioning |
Enthält die Eigenschaften eines Fehlers, der vom Azure IoT Hub Provisioning Service zurückgegeben wird. |
Registration |
Registrierungsvorgang status. |
Symmetric |
Registrierungsergebnis, das bei Verwendung des SymmetricKey-Nachweises zurückgegeben wird. |
Tpm |
TPM-Registrierungsergebnis. |
X509Certificate |
X509-Zertifikatinformationen. |
X509Registration |
X509-Registrierungsergebnis. |
DeviceRegistrationResult
Ergebnis der Geräteregistrierung.
Name | Typ | Beschreibung |
---|---|---|
assignedHub |
string |
Zugewiesene Azure IoT Hub. |
createdDateTimeUtc |
string |
Erstellungsdatum der Registrierung (in UTC). |
deviceId |
string |
Geräte-ID. |
errorCode |
integer |
Fehlercode |
errorMessage |
string |
Fehlermeldung. |
etag |
string |
Das Entitätstag, das der Ressource zugeordnet ist. |
lastUpdatedDateTimeUtc |
string |
Datum der letzten Aktualisierung (in UTC). |
payload |
object |
Benutzerdefinierte Zuordnungsnutzlast, die vom Webhook an das Gerät zurückgegeben wird. |
registrationId |
string |
Die Registrierungs-ID ist alphanumerisch und besteht aus Kleinbuchstaben und ggf. Bindestrichen. |
status |
enum:
|
Registrierungs-status. |
substatus |
enum:
|
Unterstatus für "Zugewiesene" Geräte. Mögliche Werte sind : "initialAssignment": Das Gerät wurde zum ersten Mal einem IoT-Hub zugewiesen, "deviceDataMigrated": Das Gerät wurde einem anderen IoT-Hub zugewiesen, und seine Gerätedaten wurden vom zuvor zugewiesenen IoT Hub migriert. Gerätedaten wurden aus dem zuvor zugewiesenen IoT-Hub "deviceDataReset" entfernt: Das Gerät wurde einem anderen IoT-Hub zugewiesen, und die Gerätedaten wurden aus dem ursprünglichen Zustand aufgefüllt, der in der Registrierung gespeichert wurde. Gerätedaten wurden aus dem zuvor zugewiesenen IoT-Hub "reprovisionedToInitialAssignment" entfernt: Das Gerät wurde für einen zuvor zugewiesenen IoT Hub erneut bereitgestellt. |
symmetricKey |
Registrierungsergebnis, das bei Verwendung des SymmetricKey-Nachweises zurückgegeben wird. |
|
tpm |
Registrierungsergebnis, das bei Verwendung des TPM-Nachweises zurückgegeben wird. |
|
x509 |
Registrierungsergebnis, das bei Verwendung des X509-Nachweises zurückgegeben wird. |
ProvisioningServiceErrorDetails
Enthält die Eigenschaften eines Fehlers, der vom Azure IoT Hub Provisioning Service zurückgegeben wird.
Name | Typ | Beschreibung |
---|---|---|
errorCode |
integer |
|
info |
object |
|
message |
string |
|
timestampUtc |
string |
|
trackingId |
string |
RegistrationOperationStatus
Registrierungsvorgang status.
Name | Typ | Beschreibung |
---|---|---|
operationId |
string |
Vorgangs-ID |
registrationState |
Geräteregistrierung status. |
|
status |
enum:
|
Geräteregistrierung status. |
SymmetricKeyRegistrationResult
Registrierungsergebnis, das bei Verwendung des SymmetricKey-Nachweises zurückgegeben wird.
Name | Typ | Beschreibung |
---|---|---|
enrollmentGroupId |
string |
TpmRegistrationResult
TPM-Registrierungsergebnis.
Name | Typ | Beschreibung |
---|---|---|
authenticationKey |
string |
Verschlüsselter Authentifizierungsschlüssel. |
X509CertificateInfo
X509-Zertifikatinformationen.
Name | Typ | Beschreibung |
---|---|---|
issuerName |
string |
|
notAfterUtc |
string |
|
notBeforeUtc |
string |
|
serialNumber |
string |
|
sha1Thumbprint |
string |
|
sha256Thumbprint |
string |
|
subjectName |
string |
|
version |
integer |
X509RegistrationResult
X509-Registrierungsergebnis.
Name | Typ | Beschreibung |
---|---|---|
certificateInfo |
X509-Zertifikatinformationen. |
|
enrollmentGroupId |
string |
|
signingCertificateInfo |
X509-Zertifikatinformationen. |