Individual Enrollment - Query
Cihaz kayıt kayıtlarını sorgulayın.
POST https://your-dps.azure-devices-provisioning.net/enrollments/query?api-version=2021-10-01
URI Parametreleri
Name | İçinde | Gerekli | Tür | Description |
---|---|---|---|---|
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 |
Sayfa boyutu |
|
x-ms-continuation |
string |
Devamlılık belirteci |
İstek Gövdesi
Name | Gerekli | Tür | Description |
---|---|---|---|
query | True |
string |
Yanıtlar
Name | Tür | Description |
---|---|---|
200 OK |
Başarılı Headers
|
|
Other Status Codes |
Hata yanıtı Headers x-ms-error-code: string |
Tanımlar
Name | Description |
---|---|
Attestation |
individualEnrollment ve enrollmentGroup için kanıtlama mekanizması. |
Custom |
Bu, DPS'ye özel ayırma kullanılırken hangi web kancasının çağrılacaklarını bildirir. |
Device |
Cihaz özellikleri. |
Device |
Cihaz kayıt durumu. |
Individual |
Cihaz kayıt kaydı. |
Initial |
İlk cihaz ikizi. İkiz'in özelliklerinin bir alt kümesini içerir. |
Initial |
Cihaz ikizinde ayarlanacak ilk özellikleri temsil eder. |
Metadata |
TwinCollection meta verileri |
Provisioning |
Azure IoT Hub Sağlama Hizmeti tarafından döndürülen bir hatanın özelliklerini içerir. |
Query |
|
Reprovision |
IoT hub'ına bir cihaz yeniden sağlandığında hizmetin davranışı. |
Symmetric |
Simetrik Anahtar aracılığıyla kanıtlama. |
Tpm |
TPM aracılığıyla kanıtlama. |
Twin |
İkiz içindeki bir özellik koleksiyonunu temsil eder |
X509Attestation |
X509 aracılığıyla kanıtlama. |
X509CAReferences |
Birincil ve ikincil CA başvuruları. |
X509Certificate |
X509 sertifika bilgileri. |
X509Certificates |
Birincil ve ikincil sertifikalar |
X509Certificate |
Sertifika ve Sertifika bilgileri |
AttestationMechanism
individualEnrollment ve enrollmentGroup için kanıtlama mekanizması.
Name | Tür | Description |
---|---|---|
symmetricKey |
Simetrik Anahtar aracılığıyla kanıtlama. |
|
tpm |
TPM aracılığıyla kanıtlama. |
|
type |
enum:
|
Kanıtlama Türü. |
x509 |
X509 aracılığıyla kanıtlama. |
CustomAllocationDefinition
Bu, DPS'ye özel ayırma kullanılırken hangi web kancasının çağrılacaklarını bildirir.
Name | Tür | Description |
---|---|---|
apiVersion |
string |
Özel ayırma isteğinde gönderilen sağlama hizmeti türlerinin (IndividualEnrollment gibi) API sürümü. Desteklenen en düşük sürüm: "2018-09-01-preview". |
webhookUrl |
string |
Ayırma istekleri için kullanılan web kancası URL'si. |
DeviceCapabilities
Cihaz özellikleri.
Name | Tür | Varsayılan değer | Description |
---|---|---|---|
iotEdge |
boolean |
False |
True olarak ayarlanırsa bu cihaz bir IoTEdge cihazıdır. |
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 karakterlerin yanı sıra belirli özel karakterler içeren büyük/küçük harfe duyarsız bir dize (en fazla 128 karakter uzunluğunda). _ -. Başlangıçta veya sonunda ö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ı. |
IndividualEnrollment
Cihaz kayıt kaydı.
Name | Tür | Varsayılan değer | Description |
---|---|---|---|
allocationPolicy |
enum:
|
Bu kaynağın ayırma ilkesi. Bu ilke, bu bireysel kayıt veya kayıt grubu için kiracı düzeyi ayırma ilkesini geçersiz kılar. Olası değerler arasında 'karma' vardır: Bağlı IoT hub'larında cihazlara sağlanan cihazlara eşit oranda sahip olma olasılığı yüksektir, 'geoLatency': Cihazlar, cihazda en düşük gecikme süresine sahip bir IoT hub'ına sağlanır. Birden çok bağlı IoT hub'ı aynı en düşük gecikme süresini sağlayacaksa, sağlama hizmeti cihazları bu hub'lar arasında karma hale getirir, 'statik' : Kayıt listesindeki istenen IoT hub'ının belirtimi, hizmet düzeyi ayırma ilkesi olan 'özel' önceliklidir: Cihazlar kendi özel mantığınıza göre ioT hub'ına sağlanır. Sağlama hizmeti cihaz hakkındaki bilgileri mantığa geçirir ve mantık istenen IoT hub'ının yanı sıra istenen ilk yapılandırmayı döndürür. Mantığınızı barındırmak için Azure İşlevleri kullanmanızı öneririz. |
|
attestation |
individualEnrollment ve enrollmentGroup için kanıtlama mekanizması. |
||
capabilities |
Cihaz özellikleri. |
||
createdDateTimeUtc |
string |
Bu kaynağın oluşturulduğu DateTime. |
|
customAllocationDefinition |
Bu, DPS'ye özel ayırma kullanılırken hangi web kancasının çağrılacaklarını bildirir. |
||
deviceId |
string |
İstenen IoT Hub cihaz kimliği (isteğe bağlı). |
|
etag |
string |
Kaynakla ilişkili varlık etiketi. |
|
initialTwin |
İlk cihaz ikizi. İkiz'in özelliklerinin bir alt kümesini içerir. |
||
iotHubHostName |
string |
Iot Hub ana bilgisayar adı. |
|
iotHubs |
string[] |
Bu kaynaktaki cihazın ayrılabileceği IoT Hub konak adlarının listesi. IoT hub'larının kiracı düzeyi listesinin bir alt kümesi olmalıdır. |
|
lastUpdatedDateTimeUtc |
string |
Bu kaynağın son güncelleştirilen DateTime değeri. |
|
optionalDeviceInformation |
İkiz içindeki bir özellik koleksiyonunu temsil eder |
||
provisioningStatus |
enum:
|
enabled |
Sağlama durumu. |
registrationId |
string |
Bu kimlik, bir kaydın cihaz kaydını benzersiz olarak tanımlamak için kullanılır. Alfasayısal karakterlerin yanı sıra belirli özel karakterler içeren büyük/küçük harfe duyarsız bir dize (en fazla 128 karakter uzunluğunda). _ -. Başlangıçta veya sonunda özel karaktere izin verilmez. |
|
registrationState |
Cihaz kayıt durumu. |
||
reprovisionPolicy |
IoT hub'ına bir cihaz yeniden sağlandığında hizmetin davranışı. |
InitialTwin
İlk cihaz ikizi. İkiz'in özelliklerinin bir alt kümesini içerir.
Name | Tür | Description |
---|---|---|
properties |
Cihaz ikizinde ayarlanacak ilk özellikleri temsil eder. |
|
tags |
İkiz içindeki bir özellik koleksiyonunu temsil eder |
InitialTwinProperties
Cihaz ikizinde ayarlanacak ilk özellikleri temsil eder.
Name | Tür | Description |
---|---|---|
desired |
İkiz içindeki bir özellik koleksiyonunu temsil eder |
Metadata
TwinCollection meta verileri
Name | Tür | Description |
---|---|---|
lastUpdated |
string |
TwinCollection'ın son güncelleştirilme zamanı |
lastUpdatedVersion |
integer |
Bu, bildirilen özellikler meta verileri için null ve istenen özellikler meta verileri için null değildir. |
ProvisioningServiceErrorDetails
Azure IoT Hub Sağlama Hizmeti tarafından döndürülen bir hatanın özelliklerini içerir.
Name | Tür | Description |
---|---|---|
errorCode |
integer |
|
info |
object |
|
message |
string |
|
timestampUtc |
string |
|
trackingId |
string |
QuerySpecification
Name | Tür | Description |
---|---|---|
query |
string |
ReprovisionPolicy
IoT hub'ına bir cihaz yeniden sağlandığında hizmetin davranışı.
Name | Tür | Varsayılan değer | Description |
---|---|---|---|
migrateDeviceData |
boolean |
True |
True (varsayılan) olarak ayarlandığında, Cihaz Sağlama Hizmeti bir IoT hub atama güncelleştirmesi sırasında cihazın verilerini (ikiz, cihaz özellikleri ve cihaz kimliği) bir IoT hub'ından diğerine geçirir. False olarak ayarlanırsa, Cihaz Sağlama Hizmeti cihazın verilerini ilgili kayıt listesinde depolanan ilk istenen yapılandırmaya sıfırlar. |
updateHubAssignment |
boolean |
True |
True (varsayılan) olarak ayarlandığında, Cihaz Sağlama Hizmeti cihazın IoT Hub atamasını değerlendirir ve belirli bir cihazdan ilkinin ötesindeki sağlama istekleri için gerekirse cihazı güncelleştirir. False olarak ayarlanırsa cihaz geçerli IoT hub'ına atanmış olarak kalır. |
SymmetricKeyAttestation
Simetrik Anahtar aracılığıyla kanıtlama.
Name | Tür | Description |
---|---|---|
primaryKey |
string |
Birincil simetrik anahtar. |
secondaryKey |
string |
İkincil simetrik anahtar. |
TpmAttestation
TPM aracılığıyla kanıtlama.
Name | Tür | Description |
---|---|---|
endorsementKey |
string |
|
storageRootKey |
string |
TwinCollection
İkiz içindeki bir özellik koleksiyonunu temsil eder
Name | Tür | Description |
---|---|---|
count |
integer |
TwinCollection'daki özellik sayısı |
metadata |
TwinCollection meta verileri |
|
version |
integer |
TwinCollection sürümü |
X509Attestation
X509 aracılığıyla kanıtlama.
Name | Tür | Description |
---|---|---|
caReferences |
Birincil ve ikincil CA başvuruları. |
|
clientCertificates |
Birincil ve ikincil sertifikalar |
|
signingCertificates |
Birincil ve ikincil sertifikalar |
X509CAReferences
Birincil ve ikincil CA başvuruları.
Name | Tür | Description |
---|---|---|
primary |
string |
|
secondary |
string |
X509CertificateInfo
X509 sertifika bilgileri.
Name | Tür | Description |
---|---|---|
issuerName |
string |
|
notAfterUtc |
string |
|
notBeforeUtc |
string |
|
serialNumber |
string |
|
sha1Thumbprint |
string |
|
sha256Thumbprint |
string |
|
subjectName |
string |
|
version |
integer |
X509Certificates
Birincil ve ikincil sertifikalar
Name | Tür | Description |
---|---|---|
primary |
Sertifika ve Sertifika bilgileri |
|
secondary |
Sertifika ve Sertifika bilgileri |
X509CertificateWithInfo
Sertifika ve Sertifika bilgileri
Name | Tür | Description |
---|---|---|
certificate |
string |
|
info |
X509 sertifika bilgileri. |