Runtime Registration - Operation Status Lookup

Tjänst:: IoT Hub Device Provisioning Service

API-version:: 2021-10-01

Får statusen för registreringsoperation.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
idScope	path	True	string	Omfattningen av DPS-instansen.
operationId	path	True	string	Åtgärds-ID.
registrationId	path	True	string	Registrerings-ID.
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.

Svar

Name	Typ	Description
200 OK	RegistrationOperationStatus	Begäran har lyckats.
202 Accepted	RegistrationOperationStatus	Begäran har godkänts för bearbetning, men bearbetningen har ännu inte slutförts. Sidhuvuden Location: string retry-after: integer
Other Status Codes	ProvisioningServiceErrorDetails	Ett oväntat felsvar. Sidhuvuden x-ms-error-code: string

Name

Typ

Description

200 OK

RegistrationOperationStatus

Begäran har lyckats.

202 Accepted

RegistrationOperationStatus

Begäran har godkänts för bearbetning, men bearbetningen har ännu inte slutförts.

Sidhuvuden

Location: string
retry-after: integer

Other Status Codes

ProvisioningServiceErrorDetails

Ett oväntat felsvar.

Sidhuvuden

x-ms-error-code: string

Exempel

RuntimeRegistration_OperationStatusLookup_MaximumSet_Gen

RuntimeRegistration_OperationStatusLookup_MinimumSet_Gen

RuntimeRegistration_OperationStatusLookup_MaximumSet_Gen

Exempelbegäran

HTTP

GET https://global.azure-devices-provisioning.net/arjoldcjeedohmpuhenotyesppkgk/registrations/ojruvwccsgwnmscfwodrfjrecxuf/operations/fdjhztahuvcjjmutvihsmflepzvsfn?api-version=2021-10-01

Exempelsvar

Statuskod:: 200

{
  "operationId": "xosjboksmobnotwgqejpvxiwi",
  "registrationState": {
    "assignedHub": "ljexps",
    "createdDateTimeUtc": "2025-10-01T17:41:56.535Z",
    "deviceId": "hjvdlwpugzlk",
    "errorCode": 13,
    "errorMessage": "zpctqazbkbiqjkwosis",
    "etag": "hjtelksspyfzhmet",
    "lastUpdatedDateTimeUtc": "2025-10-01T17:41:56.535Z",
    "payload": {},
    "registrationId": "urejrffpkqneou",
    "status": "unassigned",
    "substatus": "initialAssignment",
    "symmetricKey": {
      "enrollmentGroupId": "w"
    },
    "tpm": {
      "authenticationKey": "sofbxakhjrxpiyysjjxkx"
    },
    "x509": {
      "certificateInfo": {
        "issuerName": "pvpbipnhcahytrcq",
        "notAfterUtc": "2025-10-01T17:41:56.534Z",
        "notBeforeUtc": "2025-10-01T17:41:56.534Z",
        "serialNumber": "jjvdijgwgpagrjdi",
        "sha1Thumbprint": "guqltcfgusf",
        "sha256Thumbprint": "ysryarleygpkejrjlwuxacvcwbxqw",
        "subjectName": "jtsfqnbcmmott",
        "version": 20
      },
      "enrollmentGroupId": "qbw",
      "signingCertificateInfo": {
        "issuerName": "pvpbipnhcahytrcq",
        "notAfterUtc": "2025-10-01T17:41:56.534Z",
        "notBeforeUtc": "2025-10-01T17:41:56.534Z",
        "serialNumber": "jjvdijgwgpagrjdi",
        "sha1Thumbprint": "guqltcfgusf",
        "sha256Thumbprint": "ysryarleygpkejrjlwuxacvcwbxqw",
        "subjectName": "jtsfqnbcmmott",
        "version": 20
      }
    }
  },
  "status": "unassigned"
}

Statuskod:: 202

{
  "operationId": "xosjboksmobnotwgqejpvxiwi",
  "registrationState": {
    "assignedHub": "ljexps",
    "createdDateTimeUtc": "2025-10-01T17:41:56.535Z",
    "deviceId": "hjvdlwpugzlk",
    "errorCode": 13,
    "errorMessage": "zpctqazbkbiqjkwosis",
    "etag": "hjtelksspyfzhmet",
    "lastUpdatedDateTimeUtc": "2025-10-01T17:41:56.535Z",
    "payload": {},
    "registrationId": "urejrffpkqneou",
    "status": "unassigned",
    "substatus": "initialAssignment",
    "symmetricKey": {
      "enrollmentGroupId": "w"
    },
    "tpm": {
      "authenticationKey": "sofbxakhjrxpiyysjjxkx"
    },
    "x509": {
      "certificateInfo": {
        "issuerName": "pvpbipnhcahytrcq",
        "notAfterUtc": "2025-10-01T17:41:56.534Z",
        "notBeforeUtc": "2025-10-01T17:41:56.534Z",
        "serialNumber": "jjvdijgwgpagrjdi",
        "sha1Thumbprint": "guqltcfgusf",
        "sha256Thumbprint": "ysryarleygpkejrjlwuxacvcwbxqw",
        "subjectName": "jtsfqnbcmmott",
        "version": 20
      },
      "enrollmentGroupId": "qbw",
      "signingCertificateInfo": {
        "issuerName": "pvpbipnhcahytrcq",
        "notAfterUtc": "2025-10-01T17:41:56.534Z",
        "notBeforeUtc": "2025-10-01T17:41:56.534Z",
        "serialNumber": "jjvdijgwgpagrjdi",
        "sha1Thumbprint": "guqltcfgusf",
        "sha256Thumbprint": "ysryarleygpkejrjlwuxacvcwbxqw",
        "subjectName": "jtsfqnbcmmott",
        "version": 20
      }
    }
  },
  "status": "unassigned"
}

RuntimeRegistration_OperationStatusLookup_MinimumSet_Gen

Exempelbegäran

HTTP

GET https://global.azure-devices-provisioning.net/cxcukjqvjopedcgnhtggfdt/registrations/pzgoamgarcmcwvapl/operations/wacw?api-version=2021-10-01

Exempelsvar

Statuskod:: 200

{
  "operationId": "xosjboksmobnotwgqejpvxiwi"
}

Statuskod:: 202

{
  "operationId": "xosjboksmobnotwgqejpvxiwi"
}

Definitioner

Name	Description
AssignedDeviceSubstatus	Substatus för 'Tilldelade' enheter. Möjliga värden inkluderar - 'initialAssignment': Enheten har tilldelats en IoT-hubb för första gången, 'deviceDataMigrated': Enheten har tilldelats en annan IoT-hubb och dess enhetsdata migrerades från den tidigare tilldelade IoT-hubben. Enhetsdata togs bort från den tidigare tilldelade IoT-hubben, 'deviceDataReset': Enheten har tilldelats en annan IoT-hubb och dess enhetsdata fylldes i från det ursprungliga tillståndet som lagrats vid registreringen. Enhetsdata togs bort från den tidigare tilldelade IoT-hubben, 'reprovisionedToInitialAssignment': Enheten har reprovisionerats till en tidigare tilldelad IoT-hubb.
DeviceRegistrationResult	Resultat för enhetsregistrering.
EnrollmentStatus	Registreringsstatus.
ProvisioningServiceErrorDetails	Innehåller egenskaperna för ett fel som returneras av Azure IoT Hub Provisioning Service.
RegistrationOperationStatus	Status för registreringsoperation.
SymmetricKeyRegistrationResult	Registreringsresultatet returnerades vid användning av SymmetricKey-attestering.
TpmRegistrationResult	TPM-registreringsresultat.
X509CertificateInfo	X509-certifikatinformation.
X509RegistrationResult	Resultat på X509-registreringen.

AssignedDeviceSubstatus

Uppräkning

Substatus för 'Tilldelade' enheter. Möjliga värden inkluderar - 'initialAssignment': Enheten har tilldelats en IoT-hubb för första gången, 'deviceDataMigrated': Enheten har tilldelats en annan IoT-hubb och dess enhetsdata migrerades från den tidigare tilldelade IoT-hubben. Enhetsdata togs bort från den tidigare tilldelade IoT-hubben, 'deviceDataReset': Enheten har tilldelats en annan IoT-hubb och dess enhetsdata fylldes i från det ursprungliga tillståndet som lagrats vid registreringen. Enhetsdata togs bort från den tidigare tilldelade IoT-hubben, 'reprovisionedToInitialAssignment': Enheten har reprovisionerats till en tidigare tilldelad IoT-hubb.

Värde	Description
initialAssignment	Initialt Tilldelning
deviceDataMigrated	deviceDataMigrated
deviceDataReset	deviceDataReset
reprovisionedToInitialAssignment	reprovisionedToInitialAssignment

DeviceRegistrationResult

Objekt

Resultat för enhetsregistrering.

Name	Typ	Description
assignedHub	string	Assigned Azure IoT Hub.
createdDateTimeUtc	string (date-time)	Registrering, skapa datum, tid (i UTC).
deviceId	string	Enhets-ID.
errorCode	integer (int32)	Felkod.
errorMessage	string	Felmeddelande.
etag	string	Entitetstaggen som är kopplad till resursen.
lastUpdatedDateTimeUtc	string (date-time)	Senast uppdaterat datum, tid (i UTC).
payload		Alla objekt
registrationId	string	Detta id används för att unikt identifiera en enhetsregistrering av en registrering. En mellanlägesinsensitiv sträng (upp till 128 tecken lång) av alfanumeriska tecken plus vissa specialtecken : . _ -. Inga specialtecken tillåtna i början eller slutet.
status	EnrollmentStatus	Registreringsstatus.
substatus	AssignedDeviceSubstatus	Substatus för 'Tilldelade' enheter. Möjliga värden inkluderar - 'initialAssignment': Enheten har tilldelats en IoT-hubb för första gången, 'deviceDataMigrated': Enheten har tilldelats en annan IoT-hubb och dess enhetsdata migrerades från den tidigare tilldelade IoT-hubben. Enhetsdata togs bort från den tidigare tilldelade IoT-hubben, 'deviceDataReset': Enheten har tilldelats en annan IoT-hubb och dess enhetsdata fylldes i från det ursprungliga tillståndet som lagrats vid registreringen. Enhetsdata togs bort från den tidigare tilldelade IoT-hubben, 'reprovisionedToInitialAssignment': Enheten har reprovisionerats till en tidigare tilldelad IoT-hubb.
symmetricKey	SymmetricKeyRegistrationResult	Registreringsresultatet returnerades vid användning av SymmetricKey-attestering.
tpm	TpmRegistrationResult	TPM-registreringsresultat.
x509	X509RegistrationResult	Resultat på X509-registreringen.

EnrollmentStatus

Uppräkning

Registreringsstatus.

Värde	Description
unassigned	Otilldelade
assigning	Tilldelning
assigned	tilldelad
failed	Misslyckades
disabled	funktionshindrad

ProvisioningServiceErrorDetails

Objekt

Innehåller egenskaperna för ett fel som returneras av Azure IoT Hub Provisioning Service.

Name	Typ	Description
errorCode	integer (int32)	Numerisk felkod.
info	object	Ordlista för <sträng>
message	string	Felmeddelande.
timestampUtc	string (date-time)	Feltidsstämpel (UTC).
trackingId	string	Felspårnings-ID.

RegistrationOperationStatus

Objekt

Status för registreringsoperation.

Name	Typ	Description
operationId	string minLength: 1	Åtgärds-ID.
registrationState	DeviceRegistrationResult	Resultat för enhetsregistrering.
status	EnrollmentStatus	Status för enhetens registrering.

SymmetricKeyRegistrationResult

Objekt

Registreringsresultatet returnerades vid användning av SymmetricKey-attestering.

Name	Typ	Description
enrollmentGroupId	string	Registreringsgrupp-ID.

TpmRegistrationResult

Objekt

TPM-registreringsresultat.

Name	Typ	Description
authenticationKey	string	Krypterad autentiseringsnyckel.

X509CertificateInfo

Objekt

X509-certifikatinformation.

Name	Typ	Description
issuerName	string	Certifikatutfärdarnamn.
notAfterUtc	string (date-time)	Certifikatets utgångsdatum (UTC).
notBeforeUtc	string (date-time)	Giltighetsdatum för certifikatets gäldlingsdatum (UTC).
serialNumber	string	Certifikatets serienummer.
sha1Thumbprint	string	SHA-1 tumavtryck av certifikatet.
sha256Thumbprint	string	SHA-256 tumavtryck av certifikatet.
subjectName	string	Ämnesnamn på certifikatet.
version	integer (int32)	Certifikatversion.

X509RegistrationResult

Objekt

Resultat på X509-registreringen.

Name	Typ	Description
certificateInfo	X509CertificateInfo	X509-certifikatinformation.
enrollmentGroupId	string	Registreringsgrupp-ID.
signingCertificateInfo	X509CertificateInfo	X509-certifikatinformation.