Runtime Registration - Register Device

Servicio:: IoT Hub Device Provisioning Service

Versión de la API:: 2021-10-01

Registra los dispositivos.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
idScope	path	True	string	El alcance de la instancia DPS.
registrationId	path	True	string	El ID de registro es alfanumérico, en minúscula, y puede contener guiones.
api-version	query	True	string minLength: 1	Versión de API que se va a usar para esta operación.

Cuerpo de la solicitud

Nombre	Tipo	Description
payload		Cualquier objeto
registrationId	string	El ID de registro es una cadena insensible a mayúsculas minúsculas (de hasta 128 caracteres) de caracteres alfanuméricos más ciertos caracteres especiales : . _ -. No se permiten personajes especiales ni al principio ni al final.
tpm	TpmAttestation	Atestación mediante TPM.

Respuestas

Nombre	Tipo	Description
200 OK	RegistrationOperationStatus	La solicitud se ha realizado correctamente.
202 Accepted	RegistrationOperationStatus	La solicitud se ha aceptado para su procesamiento, pero el procesamiento aún no se ha completado. Encabezados Location: string retry-after: integer
Other Status Codes	ProvisioningServiceErrorDetails	Una respuesta de error inesperada. Encabezados x-ms-error-code: string

Nombre

Tipo

Description

200 OK

RegistrationOperationStatus

La solicitud se ha realizado correctamente.

202 Accepted

RegistrationOperationStatus

La solicitud se ha aceptado para su procesamiento, pero el procesamiento aún no se ha completado.

Encabezados

Location: string
retry-after: integer

Other Status Codes

ProvisioningServiceErrorDetails

Una respuesta de error inesperada.

Encabezados

x-ms-error-code: string

Ejemplos

RuntimeRegistration_RegisterDevice_MaximumSet_Gen

RuntimeRegistration_RegisterDevice_MinimumSet_Gen

RuntimeRegistration_RegisterDevice_MaximumSet_Gen

Solicitud de ejemplo

HTTP

PUT https://global.azure-devices-provisioning.net/ofvgihmgllfsmm/registrations/macgmlbhpb/register?api-version=2021-10-01

{
  "payload": {},
  "registrationId": "qypnuerjeunzogqdezhjgisfr",
  "tpm": {
    "endorsementKey": "sbvvzftylrpsetexcmnijtdezppq",
    "storageRootKey": "juohyrayid"
  }
}

Respuesta de muestra

status code:: 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"
}

status code:: 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_RegisterDevice_MinimumSet_Gen

Solicitud de ejemplo

HTTP

PUT https://global.azure-devices-provisioning.net/gwgyqmyyzzzjpjmxml/registrations/tuodrxicixbbekaajxfiyvoxsbe/register?api-version=2021-10-01

{}

Respuesta de muestra

status code:: 200

{
  "operationId": "xosjboksmobnotwgqejpvxiwi"
}

status code:: 202

{
  "operationId": "xosjboksmobnotwgqejpvxiwi"
}

Definiciones

Nombre	Description
AssignedDeviceSubstatus	Subestado para dispositivos 'Asignados'. Los valores posibles incluyen: 'initialAssignment': El dispositivo ha sido asignado por primera vez a un hub IoT, 'deviceDataMigrated': El dispositivo ha sido asignado a otro hub IoT y los datos de su dispositivo se han migrado desde el hub IoT previamente asignado. Los datos de los dispositivos fueron eliminados del hub IoT previamente asignado, 'deviceDataReset': El dispositivo ha sido asignado a otro hub IoT y sus datos de dispositivos se llenaron desde el estado inicial almacenado en la inscripción. Los datos del dispositivo fueron eliminados del hub IoT previamente asignado, 'reprovisionadoToInitialAssignment': El dispositivo ha sido reaprovisionado en un hub IoT previamente asignado.
DeviceRegistration	Registro de dispositivos.
DeviceRegistrationResult	Resultado del registro del dispositivo.
EnrollmentStatus	Estado de matrícula.
ProvisioningServiceErrorDetails	Contiene las propiedades de un error devuelto por el Azure IoT Hub Provisioning Service.
RegistrationOperationStatus	Estado de operación de registro.
SymmetricKeyRegistrationResult	Resultado de 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.

AssignedDeviceSubstatus

Enumeración

Subestado para dispositivos 'Asignados'. Los valores posibles incluyen: 'initialAssignment': El dispositivo ha sido asignado por primera vez a un hub IoT, 'deviceDataMigrated': El dispositivo ha sido asignado a otro hub IoT y los datos de su dispositivo se han migrado desde el hub IoT previamente asignado. Los datos de los dispositivos fueron eliminados del hub IoT previamente asignado, 'deviceDataReset': El dispositivo ha sido asignado a otro hub IoT y sus datos de dispositivos se llenaron desde el estado inicial almacenado en la inscripción. Los datos del dispositivo fueron eliminados del hub IoT previamente asignado, 'reprovisionadoToInitialAssignment': El dispositivo ha sido reaprovisionado en un hub IoT previamente asignado.

Valor	Description
initialAssignment	inicialAsignación
deviceDataMigrated	deviceDataMigrado
deviceDataReset	deviceDataReset
reprovisionedToInitialAssignment	reprovisionadoToInicialAsignación

DeviceRegistration

Objeto

Registro de dispositivos.

Nombre	Tipo	Description
payload		Cualquier objeto
registrationId	string	El ID de registro es una cadena insensible a mayúsculas minúsculas (de hasta 128 caracteres) de caracteres alfanuméricos más ciertos caracteres especiales : . _ -. No se permiten personajes especiales ni al principio ni al final.
tpm	TpmAttestation	Atestación mediante TPM.

DeviceRegistrationResult

Objeto

Resultado del registro del dispositivo.

Nombre	Tipo	Description
assignedHub	string	Asignado Azure IoT Hub.
createdDateTimeUtc	string (date-time)	Registro crea fecha y hora (en UTC).
deviceId	string	Id. de dispositivo.
errorCode	integer (int32)	Código de error.
errorMessage	string	Mensaje de error.
etag	string	La etiqueta de entidad asociada al recurso.
lastUpdatedDateTimeUtc	string (date-time)	Última fecha de actualización y hora (en UTC).
payload		Cualquier objeto
registrationId	string	Este id se utiliza para identificar de forma única el registro de un dispositivo en una inscripción. Una cadena insensible a mayúsculas minúsculas (de hasta 128 caracteres) de caracteres alfanuméricos más ciertos caracteres especiales : . _ -. No se permiten personajes especiales ni al principio ni al final.
status	EnrollmentStatus	Estado de matrícula.
substatus	AssignedDeviceSubstatus	Subestado para dispositivos 'Asignados'. Los valores posibles incluyen: 'initialAssignment': El dispositivo ha sido asignado por primera vez a un hub IoT, 'deviceDataMigrated': El dispositivo ha sido asignado a otro hub IoT y los datos de su dispositivo se han migrado desde el hub IoT previamente asignado. Los datos de los dispositivos fueron eliminados del hub IoT previamente asignado, 'deviceDataReset': El dispositivo ha sido asignado a otro hub IoT y sus datos de dispositivos se llenaron desde el estado inicial almacenado en la inscripción. Los datos del dispositivo fueron eliminados del hub IoT previamente asignado, 'reprovisionadoToInitialAssignment': El dispositivo ha sido reaprovisionado en un hub IoT previamente asignado.
symmetricKey	SymmetricKeyRegistrationResult	Resultado de registro devuelto al usar la atestación SymmetricKey.
tpm	TpmRegistrationResult	Resultado del registro de TPM.
x509	X509RegistrationResult	Resultado del registro X509.

EnrollmentStatus

Enumeración

Estado de matrícula.

Valor	Description
unassigned	sin asignar
assigning	Asignación
assigned	asignado
failed	fallido
disabled	disabled

ProvisioningServiceErrorDetails

Objeto

Contiene las propiedades de un error devuelto por el Azure IoT Hub Provisioning Service.

Nombre	Tipo	Description
errorCode	integer (int32)	Código de error numérico.
info	object	Diccionario de <cadenas>
message	string	Mensaje de error.
timestampUtc	string (date-time)	Marca de tiempo de error (UTC).
trackingId	string	ID de seguimiento de errores.

RegistrationOperationStatus

Objeto

Estado de operación de registro.

Nombre	Tipo	Description
operationId	string minLength: 1	Identificador de la operación.
registrationState	DeviceRegistrationResult	Resultado del registro del dispositivo.
status	EnrollmentStatus	Estado de inscripción de dispositivos.

SymmetricKeyRegistrationResult

Objeto

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

Nombre	Tipo	Description
enrollmentGroupId	string	Identificador del grupo de inscripción.

TpmAttestation

Objeto

Atestación mediante TPM.

Nombre	Tipo	Description
endorsementKey	string	Clave de respaldo de TPM.
storageRootKey	string	Clave raíz de almacenamiento TPM.

TpmRegistrationResult

Objeto

Resultado del registro de TPM.

Nombre	Tipo	Description
authenticationKey	string	Clave de autenticación cifrada.

X509CertificateInfo

Objeto

Información del certificado X509.

Nombre	Tipo	Description
issuerName	string	Nombre del emisor del certificado.
notAfterUtc	string (date-time)	Fecha de caducidad del certificado (UTC).
notBeforeUtc	string (date-time)	Fecha de inicio de la validez del certificado (UTC).
serialNumber	string	Número de serie del certificado.
sha1Thumbprint	string	Huella digital SHA-1 del certificado.
sha256Thumbprint	string	Huella digital SHA-256 del certificado.
subjectName	string	Nombre del sujeto del certificado.
version	integer (int32)	Versión del certificado.

X509RegistrationResult

Objeto

Resultado del registro X509.

Nombre	Tipo	Description
certificateInfo	X509CertificateInfo	Información del certificado X509.
enrollmentGroupId	string	Identificador del grupo de inscripción.
signingCertificateInfo	X509CertificateInfo	Información del certificado X509.