Runtime Registration - Register Device

Layanan:: IoT Hub Device Provisioning Service

Versi API:: 2021-10-01

Mendaftarkan perangkat.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
idScope	path	True	string	Cakupan instans DPS.
registrationId	path	True	string	ID pendaftaran adalah alfanumerik, huruf kecil, dan mungkin berisi tanda hubung.
api-version	query	True	string minLength: 1	Versi API yang digunakan untuk operasi ini.

Isi Permintaan

Nama	Jenis	Deskripsi
payload		Objek apa pun
registrationId	string	ID pendaftaran adalah string yang tidak peka huruf besar/kecil (hingga 128 karakter) karakter alfanumerik ditambah karakter khusus tertentu : . _ -. Tidak ada karakter khusus yang diperbolehkan di awal atau akhir.
tpm	TpmAttestation	Pengesahan melalui TPM.

Respons

Nama	Jenis	Deskripsi
200 OK	RegistrationOperationStatus	Permintaan telah berhasil.
202 Accepted	RegistrationOperationStatus	Permintaan telah diterima untuk diproses, tetapi pemrosesan belum selesai. Header Location: string retry-after: integer
Other Status Codes	ProvisioningServiceErrorDetails	Respons kesalahan tak terduga. Header x-ms-error-code: string

Nama

Jenis

Deskripsi

200 OK

RegistrationOperationStatus

Permintaan telah berhasil.

202 Accepted

RegistrationOperationStatus

Permintaan telah diterima untuk diproses, tetapi pemrosesan belum selesai.

Header

Location: string
retry-after: integer

Other Status Codes

ProvisioningServiceErrorDetails

Respons kesalahan tak terduga.

Header

x-ms-error-code: string

Contoh

RuntimeRegistration_RegisterDevice_MaximumSet_Gen

RuntimeRegistration_RegisterDevice_MinimumSet_Gen

RuntimeRegistration_RegisterDevice_MaximumSet_Gen

Permintaan sampel

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

Respon sampel

Kode status:: 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"
}

Kode status:: 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

Permintaan sampel

HTTP

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

{}

Respon sampel

Kode status:: 200

{
  "operationId": "xosjboksmobnotwgqejpvxiwi"
}

Kode status:: 202

{
  "operationId": "xosjboksmobnotwgqejpvxiwi"
}

Definisi

Nama	Deskripsi
AssignedDeviceSubstatus	Substatus untuk perangkat 'Ditetapkan'. Nilai yang mungkin termasuk - 'initialAssignment': Perangkat telah ditetapkan ke hub IoT untuk pertama kalinya, 'deviceDataMigrated': Perangkat telah ditetapkan ke hub IoT yang berbeda dan data perangkatnya dimigrasikan dari hub IoT yang ditetapkan sebelumnya. Data perangkat dihapus dari hub IoT yang ditetapkan sebelumnya, 'deviceDataReset': Perangkat telah ditetapkan ke hub IoT yang berbeda dan data perangkatnya diisi dari status awal yang disimpan dalam pendaftaran. Data perangkat dihapus dari hub IoT yang ditetapkan sebelumnya, 'reprovisionedToInitialAssignment': Perangkat telah disediakan ulang ke hub IoT yang ditetapkan sebelumnya.
DeviceRegistration	Pendaftaran perangkat.
DeviceRegistrationResult	Hasil pendaftaran perangkat.
EnrollmentStatus	Status pendaftaran.
ProvisioningServiceErrorDetails	Berisi properti kesalahan yang dikembalikan oleh Azure IoT Hub Provisioning Service.
RegistrationOperationStatus	Status operasi pendaftaran.
SymmetricKeyRegistrationResult	Hasil pendaftaran ditampilkan saat menggunakan pengesahan SymmetricKey.
TpmAttestation	Pengesahan melalui TPM.
TpmRegistrationResult	Hasil pendaftaran TPM.
X509CertificateInfo	Info sertifikat X509.
X509RegistrationResult	Hasil pendaftaran X509.

AssignedDeviceSubstatus

Enumerasi

Substatus untuk perangkat 'Ditetapkan'. Nilai yang mungkin termasuk - 'initialAssignment': Perangkat telah ditetapkan ke hub IoT untuk pertama kalinya, 'deviceDataMigrated': Perangkat telah ditetapkan ke hub IoT yang berbeda dan data perangkatnya dimigrasikan dari hub IoT yang ditetapkan sebelumnya. Data perangkat dihapus dari hub IoT yang ditetapkan sebelumnya, 'deviceDataReset': Perangkat telah ditetapkan ke hub IoT yang berbeda dan data perangkatnya diisi dari status awal yang disimpan dalam pendaftaran. Data perangkat dihapus dari hub IoT yang ditetapkan sebelumnya, 'reprovisionedToInitialAssignment': Perangkat telah disediakan ulang ke hub IoT yang ditetapkan sebelumnya.

Nilai	Deskripsi
initialAssignment	initialAssignment
deviceDataMigrated	deviceDataMigrated
deviceDataReset	perangkatDataReset
reprovisionedToInitialAssignment	reprovisionedToInitialAssignment

DeviceRegistration

Objek

Pendaftaran perangkat.

Nama	Jenis	Deskripsi
payload		Objek apa pun
registrationId	string	ID pendaftaran adalah string yang tidak peka huruf besar/kecil (hingga 128 karakter) karakter alfanumerik ditambah karakter khusus tertentu : . _ -. Tidak ada karakter khusus yang diperbolehkan di awal atau akhir.
tpm	TpmAttestation	Pengesahan melalui TPM.

DeviceRegistrationResult

Objek

Hasil pendaftaran perangkat.

Nama	Jenis	Deskripsi
assignedHub	string	Azure IoT Hub yang ditetapkan.
createdDateTimeUtc	string (date-time)	Pendaftaran membuat tanggal waktu (dalam UTC).
deviceId	string	ID perangkat.
errorCode	integer (int32)	Kode kesalahan.
errorMessage	string	Pesan kesalahan.
etag	string	Tag entitas yang terkait dengan sumber daya.
lastUpdatedDateTimeUtc	string (date-time)	Terakhir diperbarui tanggal waktu (dalam UTC).
payload		Objek apa pun
registrationId	string	ID ini digunakan untuk mengidentifikasi pendaftaran perangkat pendaftaran secara unik. String yang tidak peka huruf besar/kecil (hingga 128 karakter) karakter alfanumerik ditambah karakter khusus tertentu : . _ -. Tidak ada karakter khusus yang diperbolehkan di awal atau akhir.
status	EnrollmentStatus	Status pendaftaran.
substatus	AssignedDeviceSubstatus	Substatus untuk perangkat 'Ditetapkan'. Nilai yang mungkin termasuk - 'initialAssignment': Perangkat telah ditetapkan ke hub IoT untuk pertama kalinya, 'deviceDataMigrated': Perangkat telah ditetapkan ke hub IoT yang berbeda dan data perangkatnya dimigrasikan dari hub IoT yang ditetapkan sebelumnya. Data perangkat dihapus dari hub IoT yang ditetapkan sebelumnya, 'deviceDataReset': Perangkat telah ditetapkan ke hub IoT yang berbeda dan data perangkatnya diisi dari status awal yang disimpan dalam pendaftaran. Data perangkat dihapus dari hub IoT yang ditetapkan sebelumnya, 'reprovisionedToInitialAssignment': Perangkat telah disediakan ulang ke hub IoT yang ditetapkan sebelumnya.
symmetricKey	SymmetricKeyRegistrationResult	Hasil pendaftaran ditampilkan saat menggunakan pengesahan SymmetricKey.
tpm	TpmRegistrationResult	Hasil pendaftaran TPM.
x509	X509RegistrationResult	Hasil pendaftaran X509.

EnrollmentStatus

Enumerasi

Status pendaftaran.

Nilai	Deskripsi
unassigned	tidak ditetapkan
assigning	Penugasan
assigned	ditugaskan
failed	gagal
disabled	dinonaktifkan

ProvisioningServiceErrorDetails

Objek

Berisi properti kesalahan yang dikembalikan oleh Azure IoT Hub Provisioning Service.

Nama	Jenis	Deskripsi
errorCode	integer (int32)	Kode kesalahan numerik.
info	object	Kamus< string >
message	string	Pesan kesalahan.
timestampUtc	string (date-time)	Stempel waktu kesalahan (UTC).
trackingId	string	ID pelacakan kesalahan.

RegistrationOperationStatus

Objek

Status operasi pendaftaran.

Nama	Jenis	Deskripsi
operationId	string minLength: 1	Operasi ID.
registrationState	DeviceRegistrationResult	Hasil pendaftaran perangkat.
status	EnrollmentStatus	Status pendaftaran perangkat.

SymmetricKeyRegistrationResult

Objek

Hasil pendaftaran ditampilkan saat menggunakan pengesahan SymmetricKey.

Nama	Jenis	Deskripsi
enrollmentGroupId	string	ID grup pendaftaran.

TpmAttestation

Objek

Pengesahan melalui TPM.

Nama	Jenis	Deskripsi
endorsementKey	string	Kunci dukungan TPM.
storageRootKey	string	Kunci akar penyimpanan TPM.

TpmRegistrationResult

Objek

Hasil pendaftaran TPM.

Nama	Jenis	Deskripsi
authenticationKey	string	Kunci autentikasi terenkripsi.

X509CertificateInfo

Objek

Info sertifikat X509.

Nama	Jenis	Deskripsi
issuerName	string	Nama penerbit sertifikat.
notAfterUtc	string (date-time)	Tanggal kedaluwarsa sertifikat (UTC).
notBeforeUtc	string (date-time)	Tanggal mulai validitas sertifikat (UTC).
serialNumber	string	Nomor seri sertifikat.
sha1Thumbprint	string	Sidik jari SHA-1 sertifikat.
sha256Thumbprint	string	SHA-256 sidik jari sertifikat.
subjectName	string	Nama subjek sertifikat.
version	integer (int32)	Versi sertifikat.

X509RegistrationResult

Objek

Hasil pendaftaran X509.

Nama	Jenis	Deskripsi
certificateInfo	X509CertificateInfo	Info sertifikat X509.
enrollmentGroupId	string	ID grup pendaftaran.
signingCertificateInfo	X509CertificateInfo	Info sertifikat X509.