Condividi tramite

Runtime Registration - Register Device

  • Riferimento
Servizio:
IoT Hub Device Provisioning Service
Versione API:
2021-10-01

Registra i dispositivi.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
idScope
 path True

string

registrationId
 path True

string

L'ID di registrazione è alfanumerico, con caratteri minuscoli e può contenere trattini.
api-version
 query True

string

Versione dell'API da usare per la richiesta. Le versioni supportate includono: 2021-10-01

Corpo della richiesta

Nome Tipo Descrizione
payload

object

registrationId

string

L'ID registrazione è una stringa senza distinzione tra maiuscole e minuscole (fino a 128 caratteri lunghi) di caratteri alfanumerici e alcuni caratteri speciali: . _ -. Nessun carattere speciale consentito all'inizio o alla fine.
tpm

TpmAttestation

Attestazione tramite TPM.

Risposte

Nome Tipo Descrizione
200 OK

RegistrationOperationStatus

Operazione riuscita
202 Accepted

RegistrationOperationStatus

Accettato

Intestazioni

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

ProvisioningServiceErrorDetails

Risposta di errore

Intestazioni

x-ms-error-code: string

Definizioni

Nome Descrizione
DeviceRegistration

Registrazione di dispositivi.
DeviceRegistrationResult

Risultato della registrazione del dispositivo.
ProvisioningServiceErrorDetails

Contiene le proprietà di un errore restituito dal servizio di provisioning hub IoT di Azure.
RegistrationOperationStatus

Stato dell'operazione di registrazione.
SymmetricKeyRegistrationResult

Risultato della registrazione restituito quando si usa l'attestazione SymmetricKey.
TpmAttestation

Attestazione tramite TPM.
TpmRegistrationResult

Risultato della registrazione TPM.
X509CertificateInfo

Informazioni sul certificato X509.
X509RegistrationResult

Risultato della registrazione X509.

DeviceRegistration

Registrazione di dispositivi.

Nome Tipo Descrizione
payload

object

registrationId

string

L'ID registrazione è una stringa senza distinzione tra maiuscole e minuscole (fino a 128 caratteri lunghi) di caratteri alfanumerici e alcuni caratteri speciali: . _ -. Nessun carattere speciale consentito all'inizio o alla fine.
tpm

TpmAttestation

Attestazione tramite TPM.

DeviceRegistrationResult

Risultato della registrazione del dispositivo.

Nome Tipo Descrizione
assignedHub

string

Assegnato hub IoT di Azure.
createdDateTimeUtc

string

Data di creazione della registrazione (in FORMATO UTC).
deviceId

string

ID dispositivo.
errorCode

integer

Codice di errore.
errorMessage

string

Messaggio di errore.
etag

string

Tag di entità associato alla risorsa.
lastUpdatedDateTimeUtc

string

Ultima ora di data aggiornata (in UTC).
payload

object

registrationId

string

Questo ID viene usato per identificare in modo univoco una registrazione del dispositivo di una registrazione. Stringa senza distinzione tra maiuscole e minuscole (fino a 128 caratteri lunghi) di caratteri alfanumerici e determinati caratteri speciali: . _ -. Nessun carattere speciale consentito all'inizio o alla fine.
status enum:
  • assigned
  • assigning
  • disabled
  • failed
  • unassigned

Stato registrazione.
substatus enum:
  • deviceDataMigrated
  • deviceDataReset
  • initialAssignment
  • reprovisionedToInitialAssignment

Sottostatus per i dispositivi 'Assegnati'. I valori possibili includono : 'initialAssignment': il dispositivo è stato assegnato a un hub IoT per la prima volta, 'deviceDataMigrated': il dispositivo è stato assegnato a un hub IoT diverso e i relativi dati del dispositivo sono stati migrati dall'hub IoT assegnato in precedenza. I dati del dispositivo sono stati rimossi dall'hub IoT assegnato in precedenza, 'deviceDataReset': il dispositivo è stato assegnato a un hub IoT diverso e i relativi dati del dispositivo sono stati popolati dallo stato iniziale archiviato nella registrazione. I dati del dispositivo sono stati rimossi dall'hub IoT assegnato in precedenza, 'reprovisionedToInitialAssignment': il dispositivo è stato nuovamente effettuato il provisioning in un hub IoT assegnato in precedenza.
symmetricKey

SymmetricKeyRegistrationResult

Risultato della registrazione restituito quando si usa l'attestazione SymmetricKey.
tpm

TpmRegistrationResult

Risultato della registrazione TPM.
x509

X509RegistrationResult

Risultato della registrazione X509.

ProvisioningServiceErrorDetails

Contiene le proprietà di un errore restituito dal servizio di provisioning hub IoT di Azure.

Nome Tipo Descrizione
errorCode

integer

info

object

message

string

timestampUtc

string

trackingId

string

RegistrationOperationStatus

Stato dell'operazione di registrazione.

Nome Tipo Descrizione
operationId

string

ID operazione.
registrationState

DeviceRegistrationResult

Risultato della registrazione del dispositivo.
status enum:
  • assigned
  • assigning
  • disabled
  • failed
  • unassigned

Stato della registrazione del dispositivo.

SymmetricKeyRegistrationResult

Risultato della registrazione restituito quando si usa l'attestazione SymmetricKey.

Nome Tipo Descrizione
enrollmentGroupId

string

TpmAttestation

Attestazione tramite TPM.

Nome Tipo Descrizione
endorsementKey

string

storageRootKey

string

TpmRegistrationResult

Risultato della registrazione TPM.

Nome Tipo Descrizione
authenticationKey

string

Chiave di autenticazione crittografata.

X509CertificateInfo

Informazioni sul certificato X509.

Nome Tipo Descrizione
issuerName

string

notAfterUtc

string

notBeforeUtc

string

serialNumber

string

sha1Thumbprint

string

sha256Thumbprint

string

subjectName

string

version

integer

X509RegistrationResult

Risultato della registrazione X509.

Nome Tipo Descrizione
certificateInfo

X509CertificateInfo

Informazioni sul certificato X509.
enrollmentGroupId

string

signingCertificateInfo

X509CertificateInfo

Informazioni sul certificato X509.