Runtime Registration - Register Device
Regista os dispositivos.
PUT https://global.azure-devices-provisioning.net/{idScope}/registrations/{registrationId}/register?api-version=2021-06-01
Parâmetros do URI
Name | Em | Necessário | Tipo | Description |
---|---|---|---|---|
id
|
path | True |
string |
|
registration
|
path | True |
string |
O ID de registo é alfanumérico, em minúsculas e pode conter hífenes. |
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 |
Tpm. |
Respostas
Name | Tipo | Description |
---|---|---|
200 OK |
Com êxito |
|
202 Accepted |
Com êxito Headers
|
|
Other Status Codes |
Resposta a erros |
Definições
Name | Description |
---|---|
Device |
Registo do dispositivo. |
Device |
Resultado do registo do dispositivo. |
Provisioning |
Contém as propriedades de um erro devolvido pelo Serviço de Aprovisionamento Hub IoT do Azure. |
Registration |
Estado da operação de registo. |
Symmetric |
Resultado do registo devolvido ao utilizar o atestado SymmetricKey. |
Tpm |
Atestado através de TPM. |
Tpm |
Resultado do registo do TPM. |
X509Certificate |
Informações do certificado X509. |
X509Registration |
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 |
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:
|
Estado da inscrição. |
substatus |
enum:
|
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 |
Resultado do registo devolvido ao utilizar o atestado SymmetricKey. |
|
tpm |
Resultado do registo devolvido ao utilizar o atestado TPM. |
|
x509 |
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 |
RegistrationOperationStatus
Estado da operação de registo.
Name | Tipo | Description |
---|---|---|
operationId |
string |
ID da Operação. |
registrationState |
Estado de registo do dispositivo. |
|
status |
enum:
|
Estado da inscrição de dispositivos. |
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 |
Informações do certificado X509. |
|
enrollmentGroupId |
string |
|
signingCertificateInfo |
Informações do certificado X509. |