Runtime Registration - Device Registration Status Lookup

Service:

IoT Hub Device Provisioning Service

API Version:

2021-06-01

Obtém o estado de registo do dispositivo.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
idScope	path	True	string
registrationId	path	True	string	ID de registo.
api-version	query	True	string	A versão da API a utilizar para o pedido. As versões suportadas incluem: 2021-06-01

Corpo do Pedido

Name	Tipo	Description
payload	object	Payload de alocação personalizado.
registrationId	string	O ID de registo é uma cadeia não sensível a maiúsculas e minúsculas (até 128 carateres) de carateres alfanuméricos e alguns carateres especiais: . _ -. Não são permitidos carateres especiais no início ou no fim.
tpm	TpmAttestation	Tpm.

Respostas

Name	Tipo	Description
200 OK	DeviceRegistrationResult	Com êxito
Other Status Codes	ProvisioningServiceErrorDetails	Resposta a erros

Definições

Name	Description
DeviceRegistration	Registo do dispositivo.
DeviceRegistrationResult	Resultado do registo do dispositivo.
ProvisioningServiceErrorDetails	Contém as propriedades de um erro devolvido pelo Serviço de Aprovisionamento Hub IoT do Azure.
SymmetricKeyRegistrationResult	Resultado do registo devolvido ao utilizar o atestado SymmetricKey.
TpmAttestation	Atestado através de TPM.
TpmRegistrationResult	Resultado do registo do TPM.
X509CertificateInfo	Informações do certificado X509.
X509RegistrationResult	Resultado do registo X509.

DeviceRegistration

Registo do dispositivo.

Name	Tipo	Description
payload	object	Payload de alocação personalizado.
registrationId	string	O ID de registo é uma cadeia não sensível a maiúsculas e minúsculas (até 128 carateres) de carateres alfanuméricos e alguns carateres especiais: . _ -. Não são permitidos carateres especiais no início ou no fim.
tpm	TpmAttestation	Tpm.

DeviceRegistrationResult

Resultado do registo do dispositivo.

Name	Tipo	Description
assignedHub	string	Atribuído Hub IoT do Azure.
createdDateTimeUtc	string	Data de criação do registo (em UTC).
deviceId	string	ID do dispositivo.
errorCode	integer	Código de erro.
errorMessage	string	Mensagem de erro.
etag	string	A etiqueta de entidade associada ao recurso.
lastUpdatedDateTimeUtc	string	Hora da data da última atualização (em UTC).
payload	object	Payload de alocação personalizado devolvido do webhook para o dispositivo.
registrationId	string	O ID de registo é alfanumérico, em minúsculas e pode conter hífenes.
status	enum: assigned assigning disabled failed unassigned	Estado da inscrição.
substatus	enum: deviceDataMigrated deviceDataReset initialAssignment reprovisionedToInitialAssignment	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 dispositivo foram migrados do hub IoT atribuído anteriormente. Os dados do dispositivo foram removidos do hub IoT anteriormente atribuído, "deviceDataReset": o dispositivo foi atribuído a um hub IoT diferente e os dados do dispositivo foram preenchidos a partir do estado inicial armazenado na inscrição. Os dados do dispositivo foram removidos do hub IoT atribuído anteriormente, "reprovisionedToInitialAssignment": O dispositivo foi aprovisionado novamente num hub IoT atribuído anteriormente.
symmetricKey	SymmetricKeyRegistrationResult	Resultado do registo devolvido ao utilizar o atestado SymmetricKey.
tpm	TpmRegistrationResult	Resultado do registo devolvido ao utilizar o atestado TPM.
x509	X509RegistrationResult	Resultado do registo devolvido ao utilizar o atestado X509.

ProvisioningServiceErrorDetails

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

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

SymmetricKeyRegistrationResult

Resultado do registo devolvido ao utilizar o atestado SymmetricKey.

Name	Tipo	Description
enrollmentGroupId	string

TpmAttestation

Atestado através de TPM.

Name	Tipo	Description
endorsementKey	string
storageRootKey	string

TpmRegistrationResult

Resultado do registo do TPM.

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

X509CertificateInfo

Informações do certificado X509.

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

X509RegistrationResult

Resultado do registo X509.

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