Device Registration State - Query
Bu enrollmentGroup'taki cihazların kayıt durumunu alır.
POST https://your-dps.azure-devices-provisioning.net/registrations/{id}/query?api-version=2021-10-01
URI Parametreleri
Name | İçinde | Gerekli | Tür | Description |
---|---|---|---|---|
id
|
path | True |
string |
Kayıt grubu kimliği. |
api-version
|
query | True |
string |
İstek için kullanılacak API sürümü. Desteklenen sürümler şunlardır: 2021-10-01 |
İstek Başlığı
Name | Gerekli | Tür | Description |
---|---|---|---|
x-ms-max-item-count |
integer int32 |
Pagesize |
|
x-ms-continuation |
string |
devamlılık belirteci |
Yanıtlar
Name | Tür | Description |
---|---|---|
200 OK |
Başarılı Üst Bilgiler
|
|
Other Status Codes |
Hata yanıtı Üst Bilgiler x-ms-error-code: string |
Tanımlar
Name | Description |
---|---|
Device |
Cihaz kayıt durumu. |
Provisioning |
Azure IoT Hub Sağlama Hizmeti tarafından döndürülen hatanın özelliklerini içerir. |
DeviceRegistrationState
Cihaz kayıt durumu.
Name | Tür | Description |
---|---|---|
assignedHub |
string |
Atanan Azure IoT Hub. |
createdDateTimeUtc |
string |
Kayıt oluşturma tarihi saati (UTC olarak). |
deviceId |
string |
Cihaz kimliği. |
errorCode |
integer |
Hata kodu. |
errorMessage |
string |
Hata iletisi. |
etag |
string |
Kaynakla ilişkili varlık etiketi. |
lastUpdatedDateTimeUtc |
string |
Son güncelleştirme tarihi saati (UTC olarak). |
payload |
object |
|
registrationId |
string |
Bu kimlik, bir kaydın cihaz kaydını benzersiz olarak tanımlamak için kullanılır. Alfasayısal karakterlerden oluşan büyük/küçük harfe duyarlı olmayan dize (en fazla 128 karakter uzunluğunda) ve belirli özel karakterler : . _ -. Başlangıç veya bitişte özel karaktere izin verilmez. |
status |
enum:
|
Kayıt durumu. |
substatus |
enum:
|
'Atanan' cihazlar için alt durum. Olası değerler şunlardır: 'initialAssignment': Cihaz ilk kez bir IoT hub'ına atandı, 'deviceDataMigrated': Cihaz farklı bir IoT hub'ına atandı ve cihaz verileri daha önce atanan IoT hub'ından geçirildi. Cihaz verileri daha önce atanmış olan 'deviceDataReset' IoT hub'ından kaldırıldı: Cihaz farklı bir IoT hub'ına atandı ve cihaz verileri kayıtta depolanan ilk durumdan dolduruldu. Cihaz verileri daha önce atanan 'reprovisionedToInitialAssignment' IoT hub'ından kaldırıldı: Cihaz daha önce atanmış bir IoT hub'ına yeniden sağlandı. |
ProvisioningServiceErrorDetails
Azure IoT Hub Sağlama Hizmeti tarafından döndürülen hatanın özelliklerini içerir.
Name | Tür | Description |
---|---|---|
errorCode |
integer |
|
info |
object |
|
message |
string |
|
timestampUtc |
string |
|
trackingId |
string |