Runtime Registration - Register Device

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	L'ambito dell'istanza DPS.
registrationId	path	True	string	L'ID di registrazione è alfanumerico, minuscolo, e può contenere trattini.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Corpo della richiesta

Nome	Tipo	Descrizione
payload		Qualsiasi oggetto
registrationId	string	L'ID di registrazione è una stringa insensibile alla maiuscola (fino a 128 caratteri) di caratteri alfanumerici più alcuni caratteri speciali: . _ -. Niente personaggi speciali ammessi all'inizio o alla fine.
tpm	TpmAttestation	Attestazione tramite TPM.

Risposte

Nome	Tipo	Descrizione
200 OK	RegistrationOperationStatus	La richiesta ha avuto esito positivo.
202 Accepted	RegistrationOperationStatus	La richiesta è stata accettata per l'elaborazione, ma l'elaborazione non è ancora stata completata. Intestazioni Location: string retry-after: integer
Other Status Codes	ProvisioningServiceErrorDetails	Risposta di errore imprevista. Intestazioni x-ms-error-code: string

Nome

Tipo

Descrizione

200 OK

RegistrationOperationStatus

La richiesta ha avuto esito positivo.

202 Accepted

RegistrationOperationStatus

La richiesta è stata accettata per l'elaborazione, ma l'elaborazione non è ancora stata completata.

Intestazioni

Location: string
retry-after: integer

Other Status Codes

ProvisioningServiceErrorDetails

Risposta di errore imprevista.

Intestazioni

x-ms-error-code: string

Esempio

RuntimeRegistration_RegisterDevice_MaximumSet_Gen

RuntimeRegistration_RegisterDevice_MinimumSet_Gen

RuntimeRegistration_RegisterDevice_MaximumSet_Gen

Esempio di richiesta

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

Risposta di esempio

Codice di stato:: 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"
}

Codice di stato:: 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

Esempio di richiesta

HTTP

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

{}

Risposta di esempio

Codice di stato:: 200

{
  "operationId": "xosjboksmobnotwgqejpvxiwi"
}

Codice di stato:: 202

{
  "operationId": "xosjboksmobnotwgqejpvxiwi"
}

Definizioni

Nome	Descrizione
AssignedDeviceSubstatus	Sottostato per dispositivi 'Assegnati'. I valori possibili includono - 'initialAssignment': Il dispositivo è stato assegnato per la prima volta a un hub IoT, 'deviceDataMigrated': Il dispositivo è stato assegnato a un diverso hub IoT e i dati del dispositivo sono stati migrati dall'hub IoT precedentemente assegnato. I dati del dispositivo sono stati rimossi dall'hub IoT precedentemente assegnato, 'deviceDataReset': il dispositivo è stato assegnato a un diverso hub IoT e i dati del dispositivo sono stati popolati dallo stato iniziale memorizzato nell'iscrizione. I dati del dispositivo sono stati rimossi dall'hub IoT precedentemente assegnato, 'reprovisionedToInitialAssignment': Il dispositivo è stato ri-provisionato su un hub IoT precedentemente assegnato.
DeviceRegistration	Registrazione del dispositivo.
DeviceRegistrationResult	Risultato della registrazione del dispositivo.
EnrollmentStatus	Stato di iscrizione.
ProvisioningServiceErrorDetails	Contiene le proprietà di un errore restituito dall'Azure IoT Hub Provisioning Service.
RegistrationOperationStatus	Stato operativo della registrazione.
SymmetricKeyRegistrationResult	Risultato della registrazione restituito quando si utilizza l'attestazione SymmetricKey.
TpmAttestation	Attestazione tramite TPM.
TpmRegistrationResult	Risultato della registrazione TPM.
X509CertificateInfo	Informazioni sul certificato X509.
X509RegistrationResult	Risultato della registrazione X509.

AssignedDeviceSubstatus

Enumerazione

Sottostato per dispositivi 'Assegnati'. I valori possibili includono - 'initialAssignment': Il dispositivo è stato assegnato per la prima volta a un hub IoT, 'deviceDataMigrated': Il dispositivo è stato assegnato a un diverso hub IoT e i dati del dispositivo sono stati migrati dall'hub IoT precedentemente assegnato. I dati del dispositivo sono stati rimossi dall'hub IoT precedentemente assegnato, 'deviceDataReset': il dispositivo è stato assegnato a un diverso hub IoT e i dati del dispositivo sono stati popolati dallo stato iniziale memorizzato nell'iscrizione. I dati del dispositivo sono stati rimossi dall'hub IoT precedentemente assegnato, 'reprovisionedToInitialAssignment': Il dispositivo è stato ri-provisionato su un hub IoT precedentemente assegnato.

Valore	Descrizione
initialAssignment	inizialeAssegnazione
deviceDataMigrated	deviceDataMigrato
deviceDataReset	deviceDataReset
reprovisionedToInitialAssignment	reprovisionedToInitialAssignment

DeviceRegistration

Oggetto

Registrazione del dispositivo.

Nome	Tipo	Descrizione
payload		Qualsiasi oggetto
registrationId	string	L'ID di registrazione è una stringa insensibile alla maiuscola (fino a 128 caratteri) di caratteri alfanumerici più alcuni caratteri speciali: . _ -. Niente personaggi speciali ammessi all'inizio o alla fine.
tpm	TpmAttestation	Attestazione tramite TPM.

DeviceRegistrationResult

Oggetto

Risultato della registrazione del dispositivo.

Nome	Tipo	Descrizione
assignedHub	string	Assegnato Azure IoT Hub.
createdDateTimeUtc	string (date-time)	Registrazione crea data e ora (in UTC).
deviceId	string	ID dispositivo.
errorCode	integer (int32)	Codice di errore.
errorMessage	string	Messaggio di errore.
etag	string	Il tag dell'entità associato alla risorsa.
lastUpdatedDateTimeUtc	string (date-time)	Ultima data aggiornata, ora (in UTC).
payload		Qualsiasi oggetto
registrationId	string	Questo id viene utilizzato per identificare in modo unico la registrazione di un dispositivo di un'iscrizione. Una stringa insensibile alla maiuscoscrizione (fino a 128 caratteri) di caratteri alfanumerici più alcuni caratteri speciali: . _ -. Niente personaggi speciali ammessi all'inizio o alla fine.
status	EnrollmentStatus	Stato di iscrizione.
substatus	AssignedDeviceSubstatus	Sottostato per dispositivi 'Assegnati'. I valori possibili includono - 'initialAssignment': Il dispositivo è stato assegnato per la prima volta a un hub IoT, 'deviceDataMigrated': Il dispositivo è stato assegnato a un diverso hub IoT e i dati del dispositivo sono stati migrati dall'hub IoT precedentemente assegnato. I dati del dispositivo sono stati rimossi dall'hub IoT precedentemente assegnato, 'deviceDataReset': il dispositivo è stato assegnato a un diverso hub IoT e i dati del dispositivo sono stati popolati dallo stato iniziale memorizzato nell'iscrizione. I dati del dispositivo sono stati rimossi dall'hub IoT precedentemente assegnato, 'reprovisionedToInitialAssignment': Il dispositivo è stato ri-provisionato su un hub IoT precedentemente assegnato.
symmetricKey	SymmetricKeyRegistrationResult	Risultato della registrazione restituito quando si utilizza l'attestazione SymmetricKey.
tpm	TpmRegistrationResult	Risultato della registrazione TPM.
x509	X509RegistrationResult	Risultato della registrazione X509.

EnrollmentStatus

Enumerazione

Stato di iscrizione.

Valore	Descrizione
unassigned	Nessuno
assigning	Assegnazione
assigned	assegnato
failed	fallito
disabled	disattivato

ProvisioningServiceErrorDetails

Oggetto

Contiene le proprietà di un errore restituito dall'Azure IoT Hub Provisioning Service.

Nome	Tipo	Descrizione
errorCode	integer (int32)	Codice di errore numerico.
info	object	Dizionario di <stringa>
message	string	Messaggio di errore.
timestampUtc	string (date-time)	Timestamp di errore (UTC).
trackingId	string	ID di tracciamento errore.

RegistrationOperationStatus

Oggetto

Stato operativo della registrazione.

Nome	Tipo	Descrizione
operationId	string minLength: 1	ID operazione.
registrationState	DeviceRegistrationResult	Risultato della registrazione del dispositivo.
status	EnrollmentStatus	Stato di registrazione del dispositivo.

SymmetricKeyRegistrationResult

Oggetto

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

Nome	Tipo	Descrizione
enrollmentGroupId	string	ID gruppo di registrazione.

TpmAttestation

Oggetto

Attestazione tramite TPM.

Nome	Tipo	Descrizione
endorsementKey	string	Chiave per l'endorsement di TPM.
storageRootKey	string	Chiave radice di archiviazione TPM.

TpmRegistrationResult

Oggetto

Risultato della registrazione TPM.

Nome	Tipo	Descrizione
authenticationKey	string	Chiave di autenticazione criptata.

X509CertificateInfo

Oggetto

Informazioni sul certificato X509.

Nome	Tipo	Descrizione
issuerName	string	Nome dell'autorità di certificazione.
notAfterUtc	string (date-time)	Data di scadenza del certificato (UTC).
notBeforeUtc	string (date-time)	Data di inizio della validità del certificato (UTC).
serialNumber	string	Numero di serie del certificato.
sha1Thumbprint	string	Impronta digitale SHA-1 del certificato.
sha256Thumbprint	string	Impronta digitale SHA-256 del certificato.
subjectName	string	Nome dell'oggetto del certificato.
version	integer (int32)	Versione del certificato.

X509RegistrationResult

Oggetto

Risultato della registrazione X509.

Nome	Tipo	Descrizione
certificateInfo	X509CertificateInfo	Informazioni sul certificato X509.
enrollmentGroupId	string	ID gruppo di registrazione.
signingCertificateInfo	X509CertificateInfo	Informazioni sul certificato X509.