Individual Enrollment - Get

Hizmet:

IoT Hub Device Provisioning Service

API Sürümü:

2021-10-01

Cihaz kayıt kaydı alın.

GET https://your-dps.azure-devices-provisioning.net/enrollments/{id}?api-version=2021-10-01

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
id	path	True	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.
api-version	query	True	string	İstek için kullanılacak API sürümü. Desteklenen sürümler şunlardır: 2021-10-01

Yanıtlar

Name	Tür	Description
200 OK	IndividualEnrollment	Başarılı
Other Status Codes	ProvisioningServiceErrorDetails	Hata yanıtı Üst Bilgiler x-ms-error-code: string

Tanımlar

Name	Description
AttestationMechanism	bireysel Kayıt ve enrollmentGroup için kanıtlama mekanizması.
CustomAllocationDefinition	Bu, DPS'ye özel ayırma kullanılırken hangi web kancasının çağrılacaklarını bildirir.
DeviceCapabilities	Cihaz özellikleri.
DeviceRegistrationState	Cihaz kayıt durumu.
IndividualEnrollment	Cihaz kayıt kaydı.
InitialTwin	İlk cihaz ikizi. twin özelliklerinin bir alt kümesini içerir.
InitialTwinProperties	Cihaz ikizinde ayarlanacak ilk özellikleri temsil eder.
Metadata	TwinCollection için meta veriler
ProvisioningServiceErrorDetails	Azure IoT Hub Sağlama Hizmeti tarafından döndürülen hatanın özelliklerini içerir.
ReprovisionPolicy	IoT hub'ına bir cihaz yeniden sağlandığında hizmetin davranışı.
SymmetricKeyAttestation	Simetrik Anahtar aracılığıyla kanıtlama.
TpmAttestation	TPM aracılığıyla kanıtlama.
TwinCollection	İkiz içindeki bir özellik koleksiyonunu temsil eder
X509Attestation	X509 aracılığıyla kanıtlama.
X509CAReferences	Birincil ve ikincil CA başvuruları.
X509CertificateInfo	X509 sertifika bilgileri.
X509Certificates	Birincil ve ikincil sertifikalar
X509CertificateWithInfo	Sertifika ve Sertifika bilgileri

AttestationMechanism

bireysel Kayıt ve enrollmentGroup için kanıtlama mekanizması.

Name	Tür	Description
symmetricKey	SymmetricKeyAttestation	Simetrik Anahtar aracılığıyla kanıtlama.
tpm	TpmAttestation	TPM aracılığıyla kanıtlama.
type	enum: none symmetricKey tpm x509	Kanıtlama Türü.
x509	X509Attestation	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	Default value	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 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: assigned assigning disabled failed unassigned	Kayıt durumu.
substatus	enum: deviceDataMigrated deviceDataReset initialAssignment reprovisionedToInitialAssignment	'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	Default value	Description
allocationPolicy	enum: custom geoLatency hashed static		Bu kaynağın ayırma ilkesi. Bu ilke, bu bireysel kayıt veya kayıt grubu için kiracı düzeyinde ayırma ilkesini geçersiz kılar. Olası değerler arasında 'karmalı' yer alır: Bağlantılı IoT hub'larında cihazlara sağlanma olasılığı aynı derecede yüksektir, 'geoLatency': Cihazlar, cihaz için 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 bu hub'lar genelinde cihazları karma hale getirir: 'static' : Kayıt listesindeki istenen IoT hub'ının belirtimi, hizmet düzeyi ayırma ilkesi olan 'özel' yerine öncelik alır: 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	AttestationMechanism		bireysel Kayıt ve enrollmentGroup için kanıtlama mekanizması.
capabilities	DeviceCapabilities		Cihaz özellikleri.
createdDateTimeUtc	string		Bu kaynağın oluşturulduğu DateTime.
customAllocationDefinition	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	InitialTwin		İlk cihaz ikizi. twin ö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 ana bilgisayar 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	TwinCollection		İkiz içindeki bir özellik koleksiyonunu temsil eder
provisioningStatus	enum: disabled enabled	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 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.
registrationState	DeviceRegistrationState		Cihaz kayıt durumu.
reprovisionPolicy	ReprovisionPolicy		IoT hub'ına bir cihaz yeniden sağlandığında hizmetin davranışı.

InitialTwin

İlk cihaz ikizi. twin özelliklerinin bir alt kümesini içerir.

Name	Tür	Description
properties	InitialTwinProperties	Cihaz ikizinde ayarlanacak ilk özellikleri temsil eder.
tags	TwinCollection	İkiz içindeki bir özellik koleksiyonunu temsil eder

InitialTwinProperties

Cihaz ikizinde ayarlanacak ilk özellikleri temsil eder.

Name	Tür	Description
desired	TwinCollection	İkiz içindeki bir özellik koleksiyonunu temsil eder

Metadata

TwinCollection için meta veriler

Name	Tür	Description
lastUpdated	string	TwinCollection'ın en son güncelleştirilme zamanı
lastUpdatedVersion	integer	Bu, bildirilen özellikler meta verileri için null, istenen özellikler meta verileri için ise null değildir.

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

ReprovisionPolicy

IoT hub'ına bir cihaz yeniden sağlandığında hizmetin davranışı.

Name	Tür	Default value	Description
migrateDeviceData	boolean	True	True (varsayılan) olarak ayarlandığında, Cihaz Sağlama Hizmeti 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	Metadata	TwinCollection için meta veriler
version	integer	TwinCollection sürümü

X509Attestation

X509 aracılığıyla kanıtlama.

Name	Tür	Description
caReferences	X509CAReferences	Birincil ve ikincil CA başvuruları.
clientCertificates	X509Certificates	Birincil ve ikincil sertifikalar
signingCertificates	X509Certificates	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	X509CertificateWithInfo	Sertifika ve Sertifika bilgileri
secondary	X509CertificateWithInfo	Sertifika ve Sertifika bilgileri

X509CertificateWithInfo

Sertifika ve Sertifika bilgileri

Name	Tür	Description
certificate	string
info	X509CertificateInfo	X509 sertifika bilgileri.