Runtime Registration - Device Registration Status Lookup

Layanan:

IoT Hub Device Provisioning Service

Versi API:

2021-10-01

Mendapatkan status pendaftaran perangkat.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
idScope	path	True	string
registrationId	path	True	string	ID pendaftaran.
api-version	query	True	string	Versi API yang digunakan untuk permintaan. Versi yang didukung meliputi: 2021-10-01

Isi Permintaan

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

Respons

Nama	Jenis	Deskripsi
200 OK	DeviceRegistrationResult	Berhasil
Other Status Codes	ProvisioningServiceErrorDetails	Respons kesalahan Header x-ms-error-code: string

Definisi

Nama	Deskripsi
DeviceRegistration	Pendaftaran perangkat.
DeviceRegistrationResult	Hasil pendaftaran perangkat.
ProvisioningServiceErrorDetails	Berisi properti kesalahan yang dikembalikan oleh Layanan Provisi Azure IoT Hub.
SymmetricKeyRegistrationResult	Hasil pendaftaran dikembalikan saat menggunakan pengesahan SymmetricKey.
TpmAttestation	Pengesahan melalui TPM.
TpmRegistrationResult	Hasil pendaftaran TPM.
X509CertificateInfo	Info sertifikat X509.
X509RegistrationResult	Hasil pendaftaran X509.

DeviceRegistration

Pendaftaran perangkat.

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

DeviceRegistrationResult

Hasil pendaftaran perangkat.

Nama	Jenis	Deskripsi
assignedHub	string	Ditugaskan Azure IoT Hub.
createdDateTimeUtc	string	Waktu tanggal pembuatan pendaftaran (dalam UTC).
deviceId	string	ID perangkat.
errorCode	integer	Kode Kesalahan.
errorMessage	string	Pesan kesalahan.
etag	string	Tag entitas yang terkait dengan sumber daya.
lastUpdatedDateTimeUtc	string	Waktu tanggal terakhir diperbarui (dalam UTC).
payload	object
registrationId	string	Id ini digunakan untuk mengidentifikasi pendaftaran pendaftaran perangkat secara unik. String yang tidak peka huruf besar/kecil (panjangnya hingga 128 karakter) karakter alfanumerik ditambah karakter khusus tertentu : . _ -. Tidak ada karakter khusus yang diperbolehkan pada awal atau akhir.
status	enum: assigned assigning disabled failed unassigned	Status pendaftaran.
substatus	enum: deviceDataMigrated deviceDataReset initialAssignment reprovisionedToInitialAssignment	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 diprovisikan ulang ke hub IoT yang ditetapkan sebelumnya.
symmetricKey	SymmetricKeyRegistrationResult	Hasil pendaftaran dikembalikan saat menggunakan pengesahan SymmetricKey.
tpm	TpmRegistrationResult	Hasil pendaftaran TPM.
x509	X509RegistrationResult	Hasil pendaftaran X509.

ProvisioningServiceErrorDetails

Berisi properti kesalahan yang dikembalikan oleh Layanan Provisi Azure IoT Hub.

Nama	Jenis	Deskripsi
errorCode	integer
info	object
message	string
timestampUtc	string
trackingId	string

SymmetricKeyRegistrationResult

Hasil pendaftaran dikembalikan saat menggunakan pengesahan SymmetricKey.

Nama	Jenis	Deskripsi
enrollmentGroupId	string

TpmAttestation

Pengesahan melalui TPM.

Nama	Jenis	Deskripsi
endorsementKey	string
storageRootKey	string

TpmRegistrationResult

Hasil pendaftaran TPM.

Nama	Jenis	Deskripsi
authenticationKey	string	Kunci autentikasi terenkripsi.

X509CertificateInfo

Info sertifikat X509.

Nama	Jenis	Deskripsi
issuerName	string
notAfterUtc	string
notBeforeUtc	string
serialNumber	string
sha1Thumbprint	string
sha256Thumbprint	string
subjectName	string
version	integer

X509RegistrationResult

Hasil pendaftaran X509.

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