Runtime Registration - Register Device

Serviço:
IoT Hub Device Provisioning Service
Versão da API:
2021-10-01

Registra os dispositivos.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
idScope
 path True

string

O escopo da instância de DPS.
registrationId
 path True

string

O ID de registro é alfanumérico, minúsculo, e pode conter hífens.
api-version
 query True

string

minLength: 1

A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome Tipo Description
payload

Qualquer objeto
registrationId

string

O ID de registro é uma cadeia insensível a maiúsculas minúsculas (com até 128 caracteres) de caracteres alfanuméricos mais certos caracteres especiais : . _ -. Não são permitidos personagens especiais no início ou no final.
tpm

TpmAttestation

Atestação via TPM.

Respostas

Nome Tipo Description
200 OK

RegistrationOperationStatus

A solicitação foi bem-sucedida.
202 Accepted

RegistrationOperationStatus

A solicitação foi aceita para processamento, mas o processamento ainda não foi concluído.

Cabeçalhos

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

ProvisioningServiceErrorDetails

Uma resposta de erro inesperada.

Cabeçalhos

x-ms-error-code: string

Exemplos

RuntimeRegistration_RegisterDevice_MaximumSet_Gen
RuntimeRegistration_RegisterDevice_MinimumSet_Gen

RuntimeRegistration_RegisterDevice_MaximumSet_Gen

Solicitação de exemplo

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

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

Resposta de exemplo

Código de status:
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"
}
Código de status:
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

Solicitação de exemplo

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

{}

Resposta de exemplo

Código de status:
200 
{
  "operationId": "xosjboksmobnotwgqejpvxiwi"
}
Código de status:
202 
{
  "operationId": "xosjboksmobnotwgqejpvxiwi"
}

Definições

Nome Description
AssignedDeviceSubstatus

Substatus para dispositivos 'Designados'. Valores possíveis incluem - 'initialAssignment': Dispositivo foi atribuído a um hub IoT pela primeira vez, 'deviceDataMigrated': Dispositivo foi atribuído a um hub IoT diferente e seus dados foram migrados do hub IoT previamente atribuído. Os dados do dispositivo foram removidos do hub IoT previamente designado, 'deviceDataReset': O dispositivo foi atribuído a um hub IoT diferente e seus dados foram preenchidos a partir do estado inicial armazenado na inscrição. Os dados do dispositivo foram removidos do hub IoT previamente atribuído, 'reprovisionadoToInitialAssignment': O dispositivo foi reprovisionado para um hub IoT previamente atribuído.
DeviceRegistration

Registro de dispositivo.
DeviceRegistrationResult

Resultado do registro do dispositivo.
EnrollmentStatus

Status de matrícula.
ProvisioningServiceErrorDetails

Contém as propriedades de um erro retornado pelo Azure IoT Hub Provisioning Service.
RegistrationOperationStatus

Status da operação de registro.
SymmetricKeyRegistrationResult

Resultado de registro retornado ao usar a atestação SymmetricKey.
TpmAttestation

Atestação via TPM.
TpmRegistrationResult

Resultado do registro do TPM.
X509CertificateInfo

Informações do certificado X509.
X509RegistrationResult

Resultado do registro X509.

AssignedDeviceSubstatus

Enumeração

Substatus para dispositivos 'Designados'. Valores possíveis incluem - 'initialAssignment': Dispositivo foi atribuído a um hub IoT pela primeira vez, 'deviceDataMigrated': Dispositivo foi atribuído a um hub IoT diferente e seus dados foram migrados do hub IoT previamente atribuído. Os dados do dispositivo foram removidos do hub IoT previamente designado, 'deviceDataReset': O dispositivo foi atribuído a um hub IoT diferente e seus dados foram preenchidos a partir do estado inicial armazenado na inscrição. Os dados do dispositivo foram removidos do hub IoT previamente atribuído, 'reprovisionadoToInitialAssignment': O dispositivo foi reprovisionado para um hub IoT previamente atribuído.

Valor Description
initialAssignment

inicialAtribuição
deviceDataMigrated

deviceDataMigrado
deviceDataReset

deviceDataReset
reprovisionedToInitialAssignment

reprovisionadoParaParaInicialAtribuição

DeviceRegistration

Objeto

Registro de dispositivo.

Nome Tipo Description
payload

Qualquer objeto
registrationId

string

O ID de registro é uma cadeia insensível a maiúsculas minúsculas (com até 128 caracteres) de caracteres alfanuméricos mais certos caracteres especiais : . _ -. Não são permitidos personagens especiais no início ou no final.
tpm

TpmAttestation

Atestação via TPM.

DeviceRegistrationResult

Objeto

Resultado do registro do dispositivo.

Nome Tipo Description
assignedHub

string

Assigned Azure IoT Hub.
createdDateTimeUtc

string (date-time)

Registro criar data, hora (em UTC).
deviceId

string

ID do Dispositivo.
errorCode

integer (int32)

Código de erro.
errorMessage

string

Mensagem de erro.
etag

string

A tag da entidade associada ao recurso.
lastUpdatedDateTimeUtc

string (date-time)

Data de última atualização (em UTC).
payload

Qualquer objeto
registrationId

string

Esse id é usado para identificar de forma única o registro de um dispositivo de uma inscrição. Uma cadeia insensível a maiúsculas minúsculas (com até 128 caracteres) de caracteres alfanuméricos mais certos caracteres especiais : . _ -. Não são permitidos personagens especiais no início ou no final.
status

EnrollmentStatus

Status de matrícula.
substatus

AssignedDeviceSubstatus

Substatus para dispositivos 'Designados'. Valores possíveis incluem - 'initialAssignment': Dispositivo foi atribuído a um hub IoT pela primeira vez, 'deviceDataMigrated': Dispositivo foi atribuído a um hub IoT diferente e seus dados foram migrados do hub IoT previamente atribuído. Os dados do dispositivo foram removidos do hub IoT previamente designado, 'deviceDataReset': O dispositivo foi atribuído a um hub IoT diferente e seus dados foram preenchidos a partir do estado inicial armazenado na inscrição. Os dados do dispositivo foram removidos do hub IoT previamente atribuído, 'reprovisionadoToInitialAssignment': O dispositivo foi reprovisionado para um hub IoT previamente atribuído.
symmetricKey

SymmetricKeyRegistrationResult

Resultado de registro retornado ao usar a atestação SymmetricKey.
tpm

TpmRegistrationResult

Resultado do registro do TPM.
x509

X509RegistrationResult

Resultado do registro X509.

EnrollmentStatus

Enumeração

Status de matrícula.

Valor Description
unassigned

não atribuído
assigning

Atribuição
assigned

atribuído
failed

falha
disabled

desabilitado

ProvisioningServiceErrorDetails

Objeto

Contém as propriedades de um erro retornado pelo Azure IoT Hub Provisioning Service.

Nome Tipo Description
errorCode

integer (int32)

Código de erro numérico.
info

object

Dicionário de< de cadeia de caracteres >
message

string

Mensagem de erro.
timestampUtc

string (date-time)

Carimbo de tempo de erro (UTC).
trackingId

string

ID de rastreamento de erros.

RegistrationOperationStatus

Objeto

Status da operação de registro.

Nome Tipo Description
operationId

string

minLength: 1

ID da operação.
registrationState

DeviceRegistrationResult

Resultado do registro do dispositivo.
status

EnrollmentStatus

Status do registro do dispositivo.

SymmetricKeyRegistrationResult

Objeto

Resultado de registro retornado ao usar a atestação SymmetricKey.

Nome Tipo Description
enrollmentGroupId

string

ID do grupo de registro.

TpmAttestation

Objeto

Atestação via TPM.

Nome Tipo Description
endorsementKey

string

Chave de endosso do TPM.
storageRootKey

string

Chave raiz de armazenamento TPM.

TpmRegistrationResult

Objeto

Resultado do registro do TPM.

Nome Tipo Description
authenticationKey

string

Chave de autenticação criptografada.

X509CertificateInfo

Objeto

Informações do certificado X509.

Nome Tipo Description
issuerName

string

Nome do emissor do certificado.
notAfterUtc

string (date-time)

Data de validade do certificado (UTC).
notBeforeUtc

string (date-time)

Data de início da validade do certificado (UTC).
serialNumber

string

Número de série do certificado.
sha1Thumbprint

string

Impressão digital SHA-1 do certificado.
sha256Thumbprint

string

Impressão digital SHA-256 do certificado.
subjectName

string

Nome do assunto do certificado.
version

integer (int32)

Versão do certificado.

X509RegistrationResult

Objeto

Resultado do registro X509.

Nome Tipo Description
certificateInfo

X509CertificateInfo

Informações do certificado X509.
enrollmentGroupId

string

ID do grupo de registro.
signingCertificateInfo

X509CertificateInfo

Informações do certificado X509.