Runtime Registration - Operation Status Lookup

Získá stav operace registrace.

GET https://global.azure-devices-provisioning.net/{idScope}/registrations/{registrationId}/operations/{operationId}?api-version=2021-10-01

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
idScope
path True

string

operationId
path True

string

ID operace.

registrationId
path True

string

ID registrace.

api-version
query True

string

Verze rozhraní API, která se má použít pro požadavek. Mezi podporované verze patří: 2021-10-01

Odpovědi

Name Typ Description
200 OK

RegistrationOperationStatus

Success

202 Accepted

RegistrationOperationStatus

Přijato

Headers

  • retry-after: integer
  • Location: string
Other Status Codes

ProvisioningServiceErrorDetails

Chybová odpověď

Headers

x-ms-error-code: string

Definice

Name Description
DeviceRegistrationResult

Výsledek registrace zařízení.

ProvisioningServiceErrorDetails

Obsahuje vlastnosti chyby vrácené službou Azure IoT Hub Provisioning Service.

RegistrationOperationStatus

Stav operace registrace.

SymmetricKeyRegistrationResult

Výsledek registrace vrácený při použití ověření identity SymmetricKey

TpmRegistrationResult

Výsledek registrace TPM.

X509CertificateInfo

Informace o certifikátu X509.

X509RegistrationResult

Výsledek registrace X509.

DeviceRegistrationResult

Výsledek registrace zařízení.

Name Typ Description
assignedHub

string

Přiřazeno Azure IoT Hub.

createdDateTimeUtc

string

Datum vytvoření registrace (v UTC)

deviceId

string

ID zařízení.

errorCode

integer

Kód chyby

errorMessage

string

Chybová zpráva.

etag

string

Značka entity přidružená k prostředku.

lastUpdatedDateTimeUtc

string

Datum a čas poslední aktualizace (v UTC)

payload

object

registrationId

string

Toto ID slouží k jednoznačné identifikaci registrace zařízení. Řetězec alfanumerických znaků nerozlišující velká a malá písmena (až 128 znaků dlouhý) plus určité speciální znaky: . _ -. Na začátku ani na konci nejsou povoleny žádné speciální znaky.

status enum:
  • assigned
  • assigning
  • disabled
  • failed
  • unassigned

Stav registrace.

substatus enum:
  • deviceDataMigrated
  • deviceDataReset
  • initialAssignment
  • reprovisionedToInitialAssignment

Dílčí stav přiřazených zařízení. Mezi možné hodnoty patří initialAssignment: Zařízení bylo poprvé přiřazeno ke službě IoT Hub, deviceDataMigrated: Zařízení bylo přiřazeno k jinému centru IoT a data zařízení se migrovala z dříve přiřazeného centra IoT. Data zařízení se odebrala z dříve přiřazeného centra IoT, deviceDataReset: Zařízení bylo přiřazeno k jinému centru IoT a data zařízení se naplnila od počátečního stavu uloženého v registraci. Data zařízení se odebrala z dříve přiřazeného centra IoT, reprovisionedToInitialAssignment: Zařízení bylo znovu zřízeno do dříve přiřazeného centra IoT.

symmetricKey

SymmetricKeyRegistrationResult

Výsledek registrace vrácený při použití ověření identity SymmetricKey

tpm

TpmRegistrationResult

Výsledek registrace TPM.

x509

X509RegistrationResult

Výsledek registrace X509.

ProvisioningServiceErrorDetails

Obsahuje vlastnosti chyby vrácené službou Azure IoT Hub Provisioning Service.

Name Typ Description
errorCode

integer

info

object

message

string

timestampUtc

string

trackingId

string

RegistrationOperationStatus

Stav operace registrace.

Name Typ Description
operationId

string

ID operace.

registrationState

DeviceRegistrationResult

Výsledek registrace zařízení.

status enum:
  • assigned
  • assigning
  • disabled
  • failed
  • unassigned

Stav registrace zařízení.

SymmetricKeyRegistrationResult

Výsledek registrace vrácený při použití ověření identity SymmetricKey

Name Typ Description
enrollmentGroupId

string

TpmRegistrationResult

Výsledek registrace TPM.

Name Typ Description
authenticationKey

string

Šifrovaný ověřovací klíč.

X509CertificateInfo

Informace o certifikátu X509.

Name Typ Description
issuerName

string

notAfterUtc

string

notBeforeUtc

string

serialNumber

string

sha1Thumbprint

string

sha256Thumbprint

string

subjectName

string

version

integer

X509RegistrationResult

Výsledek registrace X509.

Name Typ Description
certificateInfo

X509CertificateInfo

Informace o certifikátu X509.

enrollmentGroupId

string

signingCertificateInfo

X509CertificateInfo

Informace o certifikátu X509.