Runtime Registration - Register Device

Serviço:: IoT Hub Device Provisioning Service

Versão da API:: 2021-10-01

Regista os dispositivos.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
idScope	path	True	string	O âmbito da instância DPS.
registrationId	path	True	string	O ID de registo é alfanumérico, minúsculo, e pode conter hífens.
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.

Corpo do Pedido

Name	Tipo	Description
payload		Qualquer objeto
registrationId	string	O ID de registo é 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 permitidas personagens especiais no início ou no fim.
tpm	TpmAttestation	Atestação via TPM.

Respostas

Name	Tipo	Description
200 OK	RegistrationOperationStatus	O pedido foi bem-sucedido.
202 Accepted	RegistrationOperationStatus	O pedido foi aceite 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

Name

Tipo

Description

200 OK

RegistrationOperationStatus

O pedido foi bem-sucedido.

202 Accepted

RegistrationOperationStatus

O pedido foi aceite 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

Pedido de amostra

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"
  }
}

Resposta da amostra

Código de estado:: 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 estado:: 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

Pedido de amostra

HTTP

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

{}

Resposta da amostra

Código de estado:: 200

{
  "operationId": "xosjboksmobnotwgqejpvxiwi"
}

Código de estado:: 202

{
  "operationId": "xosjboksmobnotwgqejpvxiwi"
}

Definições

Name	Description
AssignedDeviceSubstatus	Subestado para dispositivos 'Atribuídos'. Os valores possíveis incluem - 'initialAssignment': O dispositivo foi atribuído a um hub IoT pela primeira vez, 'deviceDataMigrated': O dispositivo foi atribuído a um hub IoT diferente e os dados do seu dispositivo foram migrados do hub IoT previamente atribuído. Os dados do dispositivo foram removidos do hub IoT previamente atribuído, 'deviceDataReset': O dispositivo foi atribuído a um hub IoT diferente e os seus dados do dispositivo foram preenchidos a partir do estado inicial armazenado na inscrição. Os dados do dispositivo foram removidos do hub IoT anteriormente atribuído, 'reprovisionedToInitialAssignment': O dispositivo foi re-provisionado para um hub IoT previamente atribuído.
DeviceRegistration	Registo do dispositivo.
DeviceRegistrationResult	Resultado do registo do dispositivo.
EnrollmentStatus	Estado de matrícula.
ProvisioningServiceErrorDetails	Contém as propriedades de um erro devolvido pelo Azure IoT Hub Provisioning Service.
RegistrationOperationStatus	Estado operacional do registo.
SymmetricKeyRegistrationResult	Resultado de registo devolvido ao utilizar a atestação SymmetricKey.
TpmAttestation	Atestação via TPM.
TpmRegistrationResult	Resultado do registo do TPM.
X509CertificateInfo	Informações do certificado X509.
X509RegistrationResult	Resultado do registo X509.

AssignedDeviceSubstatus

Enumeração

Subestado para dispositivos 'Atribuídos'. Os valores possíveis incluem - 'initialAssignment': O dispositivo foi atribuído a um hub IoT pela primeira vez, 'deviceDataMigrated': O dispositivo foi atribuído a um hub IoT diferente e os dados do seu dispositivo foram migrados do hub IoT previamente atribuído. Os dados do dispositivo foram removidos do hub IoT previamente atribuído, 'deviceDataReset': O dispositivo foi atribuído a um hub IoT diferente e os seus dados do dispositivo foram preenchidos a partir do estado inicial armazenado na inscrição. Os dados do dispositivo foram removidos do hub IoT anteriormente atribuído, 'reprovisionedToInitialAssignment': O dispositivo foi re-provisionado para um hub IoT previamente atribuído.

Valor	Description
initialAssignment	inicialAtribuição
deviceDataMigrated	deviceDataMigrated
deviceDataReset	deviceDataReset
reprovisionedToInitialAssignment	reprovisionadoParaInicialAtribuição

DeviceRegistration

Object

Registo do dispositivo.

Name	Tipo	Description
payload		Qualquer objeto
registrationId	string	O ID de registo é 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 permitidas personagens especiais no início ou no fim.
tpm	TpmAttestation	Atestação via TPM.

DeviceRegistrationResult

Object

Resultado do registo do dispositivo.

Name	Tipo	Description
assignedHub	string	Atribuído Azure IoT Hub.
createdDateTimeUtc	string (date-time)	Registo para 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 etiqueta de entidade associada ao recurso.
lastUpdatedDateTimeUtc	string (date-time)	Última data atualizada e hora (em UTC).
payload		Qualquer objeto
registrationId	string	Este id é usado para identificar de forma única o registo de um dispositivo numa inscrição. Uma cadeia insensível a maiúsculas minúsculas (até 128 caracteres) de caracteres alfanuméricos mais certos caracteres especiais : . _ -. Não são permitidas personagens especiais no início ou no fim.
status	EnrollmentStatus	Estado de matrícula.
substatus	AssignedDeviceSubstatus	Subestado para dispositivos 'Atribuídos'. Os valores possíveis incluem - 'initialAssignment': O dispositivo foi atribuído a um hub IoT pela primeira vez, 'deviceDataMigrated': O dispositivo foi atribuído a um hub IoT diferente e os dados do seu dispositivo foram migrados do hub IoT previamente atribuído. Os dados do dispositivo foram removidos do hub IoT previamente atribuído, 'deviceDataReset': O dispositivo foi atribuído a um hub IoT diferente e os seus dados do dispositivo foram preenchidos a partir do estado inicial armazenado na inscrição. Os dados do dispositivo foram removidos do hub IoT anteriormente atribuído, 'reprovisionedToInitialAssignment': O dispositivo foi re-provisionado para um hub IoT previamente atribuído.
symmetricKey	SymmetricKeyRegistrationResult	Resultado de registo devolvido ao utilizar a atestação SymmetricKey.
tpm	TpmRegistrationResult	Resultado do registo do TPM.
x509	X509RegistrationResult	Resultado do registo X509.

EnrollmentStatus

Enumeração

Estado de matrícula.

Valor	Description
unassigned	não atribuído
assigning	Atribuição
assigned	atribuído
failed	com falhas
disabled	desactivado

ProvisioningServiceErrorDetails

Object

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

Name	Tipo	Description
errorCode	integer (int32)	Código de erro numérico.
info	object	Dicionário de <string>
message	string	Mensagem de erro.
timestampUtc	string (date-time)	Carimbo temporal de erro (UTC).
trackingId	string	ID de rastreamento de erros.

RegistrationOperationStatus

Object

Estado operacional do registo.

Name	Tipo	Description
operationId	string minLength: 1	ID da operação.
registrationState	DeviceRegistrationResult	Resultado do registo do dispositivo.
status	EnrollmentStatus	Estado da inscrição do dispositivo.

SymmetricKeyRegistrationResult

Object

Resultado de registo devolvido ao utilizar a atestação SymmetricKey.

Name	Tipo	Description
enrollmentGroupId	string	ID do grupo de inscrição.

TpmAttestation

Object

Atestação via TPM.

Name	Tipo	Description
endorsementKey	string	Chave para o endosso do TPM.
storageRootKey	string	Chave raiz de armazenamento TPM.

TpmRegistrationResult

Object

Resultado do registo do TPM.

Name	Tipo	Description
authenticationKey	string	Chave de autenticação encriptada.

X509CertificateInfo

Object

Informações do certificado X509.

Name	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 sujeito do certificado.
version	integer (int32)	Versão do certificado.

X509RegistrationResult

Object

Resultado do registo X509.

Name	Tipo	Description
certificateInfo	X509CertificateInfo	Informações do certificado X509.
enrollmentGroupId	string	ID do grupo de inscrição.
signingCertificateInfo	X509CertificateInfo	Informações do certificado X509.