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
registrationId	path	True	string	A ID do registro é alfanumérica, com letras minúsculas e pode conter hifens.
api-version	query	True	string	A versão da API a ser usada para a solicitação. As versões com suporte incluem: 2021-10-01

Corpo da solicitação

Nome	Tipo	Description
payload	object
registrationId	string	A ID de registro é uma cadeia de caracteres que não diferencia maiúsculas de minúsculas (até 128 caracteres) de caracteres alfanuméricos mais determinados caracteres especiais: . _ -. Nenhum caractere especial permitido no início ou no final.
tpm	TpmAttestation	Atestado via TPM.

Respostas

Nome	Tipo	Description
200 OK	RegistrationOperationStatus	Êxito
202 Accepted	RegistrationOperationStatus	Aceito Cabeçalhos Location: string retry-after: integer
Other Status Codes	ProvisioningServiceErrorDetails	Resposta de erro Cabeçalhos x-ms-error-code: string

Definições

Nome	Description
DeviceRegistration	Registro de dispositivos.
DeviceRegistrationResult	Resultado do registro do dispositivo.
ProvisioningServiceErrorDetails	Contém as propriedades de um erro retornado pelo Serviço de Provisionamento do Hub IoT do Azure.
RegistrationOperationStatus	Operação de registro status.
SymmetricKeyRegistrationResult	Resultado do registro retornado ao usar o atestado SymmetricKey.
TpmAttestation	Atestado via TPM.
TpmRegistrationResult	Resultado do registro do TPM.
X509CertificateInfo	Informações do certificado X509.
X509RegistrationResult	Resultado do registro X509.

DeviceRegistration

Registro de dispositivos.

Nome	Tipo	Description
payload	object
registrationId	string	A ID de registro é uma cadeia de caracteres que não diferencia maiúsculas de minúsculas (até 128 caracteres) de caracteres alfanuméricos mais determinados caracteres especiais: . _ -. Nenhum caractere especial permitido no início ou no final.
tpm	TpmAttestation	Atestado via TPM.

DeviceRegistrationResult

Resultado do registro do dispositivo.

Nome	Tipo	Description
assignedHub	string	Atribuído Hub IoT do Azure.
createdDateTimeUtc	string	Data e hora de criação do registro (em UTC).
deviceId	string	ID do Dispositivo.
errorCode	integer	Código do erro.
errorMessage	string	Mensagem de erro.
etag	string	A marca de entidade associada ao recurso.
lastUpdatedDateTimeUtc	string	Data e hora da última atualização (em UTC).
payload	object
registrationId	string	Essa ID é usada para identificar exclusivamente um registro de dispositivo de um registro. Uma cadeia de caracteres que não diferencia maiúsculas de minúsculas (até 128 caracteres de comprimento) de caracteres alfanuméricos mais determinados caracteres especiais: . _ -. Nenhum caractere especial permitido no início ou no final.
status	enum: assigned assigning disabled failed unassigned	Status de registro.
substatus	enum: deviceDataMigrated deviceDataReset initialAssignment reprovisionedToInitialAssignment	Substatus 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 seus dados de dispositivo foram migrados do hub IoT atribuído anteriormente. Os dados do dispositivo foram removidos do hub IoT atribuído anteriormente, 'deviceDataReset': o dispositivo foi atribuído a um hub IoT diferente e seus dados de dispositivo foram preenchidos do estado inicial armazenado no registro. Os dados do dispositivo foram removidos do hub IoT atribuído anteriormente, 'reprovisionedToInitialAssignment': o dispositivo foi provisionado novamente para um hub IoT atribuído anteriormente.
symmetricKey	SymmetricKeyRegistrationResult	Resultado do registro retornado ao usar o atestado SymmetricKey.
tpm	TpmRegistrationResult	Resultado do registro do TPM.
x509	X509RegistrationResult	Resultado do registro X509.

ProvisioningServiceErrorDetails

Contém as propriedades de um erro retornado pelo Serviço de Provisionamento do Hub IoT do Azure.

Nome	Tipo	Description
errorCode	integer
info	object
message	string
timestampUtc	string
trackingId	string

RegistrationOperationStatus

Operação de registro status.

Nome	Tipo	Description
operationId	string	ID da operação.
registrationState	DeviceRegistrationResult	Resultado do registro do dispositivo.
status	enum: assigned assigning disabled failed unassigned	Status de registro de dispositivo.

SymmetricKeyRegistrationResult

Resultado do registro retornado ao usar o atestado SymmetricKey.

Nome	Tipo	Description
enrollmentGroupId	string

TpmAttestation

Atestado via TPM.

Nome	Tipo	Description
endorsementKey	string
storageRootKey	string

TpmRegistrationResult

Resultado do registro do TPM.

Nome	Tipo	Description
authenticationKey	string	Chave de autenticação criptografada.

X509CertificateInfo

Informações do certificado X509.

Nome	Tipo	Description
issuerName	string
notAfterUtc	string
notBeforeUtc	string
serialNumber	string
sha1Thumbprint	string
sha256Thumbprint	string
subjectName	string
version	integer

X509RegistrationResult

Resultado do registro X509.

Nome	Tipo	Description
certificateInfo	X509CertificateInfo	Informações do certificado X509.
enrollmentGroupId	string
signingCertificateInfo	X509CertificateInfo	Informações do certificado X509.