Compartir a través de

Runtime Registration - Device Registration Status Lookup

  • Referencia
Servicio:
IoT Hub Device Provisioning Service
Versión de la API:
2021-10-01

Obtiene el estado de registro del dispositivo.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
idScope
 path True

string

registrationId
 path True

string

Id. de registro.
api-version
 query True

string

La versión de API que se usará para la solicitud. Las versiones admitidas incluyen: 2021-10-01

Cuerpo de la solicitud

Nombre Tipo Description
payload

object

registrationId

string

El identificador de registro es una cadena que no distingue mayúsculas de minúsculas (hasta 128 caracteres de longitud) de caracteres alfanuméricos más determinados caracteres especiales: . _ -. No se permiten caracteres especiales al principio o al final.
tpm

TpmAttestation

Atestación mediante TPM.

Respuestas

Nombre Tipo Description
200 OK

DeviceRegistrationResult

Correcto
Other Status Codes

ProvisioningServiceErrorDetails

Respuesta de error

Encabezados

x-ms-error-code: string

Definiciones

Nombre Description
DeviceRegistration

Registro de dispositivos.
DeviceRegistrationResult

Resultado del registro del dispositivo.
ProvisioningServiceErrorDetails

Contiene las propiedades de un error devuelto por el servicio de aprovisionamiento de Azure IoT Hub.
SymmetricKeyRegistrationResult

Resultado del registro devuelto al usar la atestación SymmetricKey.
TpmAttestation

Atestación mediante TPM.
TpmRegistrationResult

Resultado del registro de TPM.
X509CertificateInfo

Información del certificado X509.
X509RegistrationResult

Resultado del registro X509.

DeviceRegistration

Registro de dispositivos.

Nombre Tipo Description
payload

object

registrationId

string

El identificador de registro es una cadena que no distingue mayúsculas de minúsculas (hasta 128 caracteres de longitud) de caracteres alfanuméricos más determinados caracteres especiales: . _ -. No se permiten caracteres especiales al principio o al final.
tpm

TpmAttestation

Atestación mediante TPM.

DeviceRegistrationResult

Resultado del registro del dispositivo.

Nombre Tipo Description
assignedHub

string

Azure IoT Hub asignados.
createdDateTimeUtc

string

Fecha y hora de creación del registro (en UTC).
deviceId

string

Id. de dispositivo.
errorCode

integer

Código de error.
errorMessage

string

Mensaje de error.
etag

string

Etiqueta de entidad asociada al recurso.
lastUpdatedDateTimeUtc

string

Hora de fecha y hora de la última actualización (en UTC).
payload

object

registrationId

string

Este identificador se usa para identificar de forma única un registro de dispositivo de una inscripción. Cadena sin distinción entre mayúsculas y minúsculas (hasta 128 caracteres de longitud) de caracteres alfanuméricos más determinados caracteres especiales: . _ -. No se permiten caracteres especiales al principio o al final.
status enum:
  • assigned
  • assigning
  • disabled
  • failed
  • unassigned

Estado de inscripción.
substatus enum:
  • deviceDataMigrated
  • deviceDataReset
  • initialAssignment
  • reprovisionedToInitialAssignment

Subestado para dispositivos "Asignados". Entre los valores posibles se incluyen : "initialAssignment": el dispositivo se ha asignado a un centro de IoT por primera vez, "deviceDataMigrated": el dispositivo se ha asignado a un centro de IoT diferente y sus datos de dispositivo se migraron desde el centro de IoT asignado anteriormente. Los datos del dispositivo se quitaron del centro de IoT asignado anteriormente, "deviceDataReset": el dispositivo se ha asignado a un centro de IoT diferente y sus datos de dispositivo se rellenaron a partir del estado inicial almacenado en la inscripción. Los datos del dispositivo se quitaron del centro de IoT asignado anteriormente, "reprovisionedToInitialAssignment": el dispositivo se ha vuelto a aprovisionar en un centro de IoT asignado previamente.
symmetricKey

SymmetricKeyRegistrationResult

Resultado del registro devuelto al usar la atestación SymmetricKey.
tpm

TpmRegistrationResult

Resultado del registro de TPM.
x509

X509RegistrationResult

Resultado del registro X509.

ProvisioningServiceErrorDetails

Contiene las propiedades de un error devuelto por el servicio de aprovisionamiento de Azure IoT Hub.

Nombre Tipo Description
errorCode

integer

info

object

message

string

timestampUtc

string

trackingId

string

SymmetricKeyRegistrationResult

Resultado del registro devuelto al usar la atestación SymmetricKey.

Nombre Tipo Description
enrollmentGroupId

string

TpmAttestation

Atestación mediante TPM.

Nombre Tipo Description
endorsementKey

string

storageRootKey

string

TpmRegistrationResult

Resultado del registro de TPM.

Nombre Tipo Description
authenticationKey

string

Clave de autenticación cifrada.

X509CertificateInfo

Información del certificado X509.

Nombre Tipo Description
issuerName

string

notAfterUtc

string

notBeforeUtc

string

serialNumber

string

sha1Thumbprint

string

sha256Thumbprint

string

subjectName

string

version

integer

X509RegistrationResult

Resultado del registro X509.

Nombre Tipo Description
certificateInfo

X509CertificateInfo

Información del certificado X509.
enrollmentGroupId

string

signingCertificateInfo

X509CertificateInfo

Información del certificado X509.