Individual Enrollment - Get

Hizmet:

IoT Hub Device Provisioning Service

API Sürümü:

2021-10-01

Cihaz kayıt kaydı edinin.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
dpsName	path	True	string	DPS örneği ana adı.
id	path	True	string	Bu id, bir kayıt cihazının kayıt cihazını benzersiz şekilde tanımlamak için kullanılır. Alfanumerik karakterler ve belirli özel karakterlerden oluşan küçük harfi duyarsız (128 karaktere kadar uzunluğunda) bir dizi : . _ -. Başta veya sonunda özel karakterlere izin verilmez.
api-version	query	True	string minLength: 1	Bu işlem için kullanılacak API sürümü.

İstek Başlığı

Name	Gerekli	Tür	Description
Authorization	True	string

Yanıtlar

Name	Tür	Description
200 OK	IndividualEnrollment	İstek başarılı oldu.
Other Status Codes	ProvisioningServiceErrorDetails	Beklenmeyen bir hata yanıtı. Üst Bilgiler x-ms-error-code: string

Güvenlik

Authorization

Tür: apiKey
İçinde: header

Örnekler

IndividualEnrollment_Get_MaximumSet_Gen

IndividualEnrollment_Get_MinimumSet_Gen

IndividualEnrollment_Get_MaximumSet_Gen

Örnek isteği

HTTP

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

Örnek yanıt

Durum kodu:

200

{
  "allocationPolicy": "hashed",
  "attestation": {
    "type": "none",
    "symmetricKey": {
      "primaryKey": "tdoshkmlo",
      "secondaryKey": "lmajoyzuojahffcmdlcwjhntqzyqzk"
    },
    "tpm": {
      "endorsementKey": "naoofgjbxiulcitlysusxdvagyucgn",
      "storageRootKey": "tdgkgcvptrsw"
    },
    "x509": {
      "caReferences": {
        "primary": "efbkbboxkvrsdl",
        "secondary": "vckhuzqgbcinighxwyuyd"
      },
      "clientCertificates": {
        "primary": {
          "info": {
            "issuerName": "pkuinyhttjlozsbtvxuizzkjlakga",
            "notAfterUtc": "2025-10-01T17:42:04.760Z",
            "notBeforeUtc": "2025-10-01T17:42:04.760Z",
            "serialNumber": "mzoidcxayenpgyrek",
            "sha1Thumbprint": "fdmftjqllzvxcd",
            "sha256Thumbprint": "ei",
            "subjectName": "qqjdjgrkiqvtnshkisozut",
            "version": 12
          },
          "certificate": "gkozpt"
        },
        "secondary": {
          "info": {
            "issuerName": "pkuinyhttjlozsbtvxuizzkjlakga",
            "notAfterUtc": "2025-10-01T17:42:04.760Z",
            "notBeforeUtc": "2025-10-01T17:42:04.760Z",
            "serialNumber": "mzoidcxayenpgyrek",
            "sha1Thumbprint": "fdmftjqllzvxcd",
            "sha256Thumbprint": "ei",
            "subjectName": "qqjdjgrkiqvtnshkisozut",
            "version": 12
          },
          "certificate": "gkozpt"
        }
      },
      "signingCertificates": {
        "primary": {
          "info": {
            "issuerName": "pkuinyhttjlozsbtvxuizzkjlakga",
            "notAfterUtc": "2025-10-01T17:42:04.760Z",
            "notBeforeUtc": "2025-10-01T17:42:04.760Z",
            "serialNumber": "mzoidcxayenpgyrek",
            "sha1Thumbprint": "fdmftjqllzvxcd",
            "sha256Thumbprint": "ei",
            "subjectName": "qqjdjgrkiqvtnshkisozut",
            "version": 12
          },
          "certificate": "gkozpt"
        },
        "secondary": {
          "info": {
            "issuerName": "pkuinyhttjlozsbtvxuizzkjlakga",
            "notAfterUtc": "2025-10-01T17:42:04.760Z",
            "notBeforeUtc": "2025-10-01T17:42:04.760Z",
            "serialNumber": "mzoidcxayenpgyrek",
            "sha1Thumbprint": "fdmftjqllzvxcd",
            "sha256Thumbprint": "ei",
            "subjectName": "qqjdjgrkiqvtnshkisozut",
            "version": 12
          },
          "certificate": "gkozpt"
        }
      }
    }
  },
  "capabilities": {
    "iotEdge": true
  },
  "createdDateTimeUtc": "2025-10-01T17:42:04.760Z",
  "customAllocationDefinition": {
    "apiVersion": "gbannxdstouqrfonxdxfurv",
    "webhookUrl": "todqbubyxeumrtvhsscedwrkz"
  },
  "deviceId": "wfgzhrgpvmwddrknnmcggbae",
  "etag": "ngtrmhcikthymtknva",
  "initialTwin": {
    "properties": {
      "desired": {
        "count": 16,
        "key2428": {},
        "metadata": {
          "lastUpdated": "2025-10-01T17:42:04.760Z",
          "lastUpdatedVersion": 19
        },
        "version": 9
      }
    },
    "tags": {
      "count": 16,
      "key2428": {},
      "metadata": {
        "lastUpdated": "2025-10-01T17:42:04.760Z",
        "lastUpdatedVersion": 19
      },
      "version": 9
    }
  },
  "iotHubHostName": "vtewercilhukfboi",
  "iotHubs": [
    "lwgwrfdherfrbowfdbrdhvnragwrs"
  ],
  "lastUpdatedDateTimeUtc": "2025-10-01T17:42:04.760Z",
  "optionalDeviceInformation": {
    "count": 16,
    "key2428": {},
    "metadata": {
      "lastUpdated": "2025-10-01T17:42:04.760Z",
      "lastUpdatedVersion": 19
    },
    "version": 9
  },
  "provisioningStatus": "enabled",
  "registrationId": "kz",
  "registrationState": {
    "assignedHub": "oasugtinnefgfklhldjhibq",
    "createdDateTimeUtc": "2025-10-01T17:42:04.759Z",
    "deviceId": "ttnhaugyyh",
    "errorCode": 2,
    "errorMessage": "ufqpjjmbiphiynoijjbocvl",
    "etag": "ctquvtjyhnomcmtddscxwjk",
    "lastUpdatedDateTimeUtc": "2025-10-01T17:42:04.759Z",
    "payload": {},
    "registrationId": "czvnrxvbka",
    "status": "unassigned",
    "substatus": "initialAssignment"
  },
  "reprovisionPolicy": {
    "migrateDeviceData": true,
    "updateHubAssignment": true
  }
}

IndividualEnrollment_Get_MinimumSet_Gen

Örnek isteği

HTTP

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

Örnek yanıt

Durum kodu:

200

{
  "attestation": {
    "type": "none"
  },
  "registrationId": "kz"
}

Tanımlar

Name	Description
AllocationPolicy	Bu kaynağın tahsis politikası. Bu politika, bu bireysel kayıt veya kayıt grubu için kiracı düzeyinde tahsis politikasını geçersiz kılar. Olası değerler arasında 'hashed' bulunur: Bağlı IoT hub'larına cihazların sağlanma olasılığı eşit derecede yüksektir, 'geoLatency': Cihazlar, cihaza en düşük gecikmeye sahip bir IoT hub'a sağlanır. Birden fazla bağlı IoT hub aynı en düşük gecikmeyi sağlıyorsa, tedarik hizmeti bu merkezler arasında cihazları hash eder, 'statik' : Kayıt listesinde istenen IoT hub'ın belirtilmesi, hizmet seviyesi tahsis politikasından önceliklidir, 'özel': Cihazlar, kendi özel mantığınıza göre bir IoT hub'a sağlanır. Provisioning servisi, cihazla ilgili bilgileri mantığa iletir ve mantık istenen IoT hub'ı ile istenen ilk yapılandırmayı geri getirir. Mantığınızı barındırmak için Azure Functions kullanmanızı öneririz.
AssignedDeviceSubstatus	'Atanan' cihazlar için alt durum. Olası değerler arasında - 'initialAssignment': Cihaz ilk kez bir IoT hub'a atanmıştır, 'deviceDataMigrated': Cihaz farklı bir IoT hub'a atanmış ve cihaz verisi önceden atanan IoT merkezinden taşınmıştır. Cihaz verileri, önceden atanan IoT merkezinden olan 'deviceDataReset'ten kaldırıldı: Cihaz farklı bir IoT hub'a atanmış ve cihaz verisi, kayıtta saklanan ilk durumdan itibaren doldurulmuştur. Cihaz verileri, önceden atanan IoT merkezinden çıkarıldı, 'reprovisionedToInitialAssignment': Cihaz, önceden atanan bir IoT hub'a yeniden sağlandı.
AttestationMechanism	Birey için doğrulama mekanizmasıKayıt ve kayıt grubu.
AttestationType	Doğrulama Türü.
CustomAllocationDefinition	Bu, özel tahsis kullanıldığında DPS'ye hangi webhook'u çağıracağını söyler.
DeviceCapabilities	Cihaz yetenekleri.
DeviceRegistrationState	Cihaz kayıt durumu.
EnrollmentStatus	Kayıt durumu.
IndividualEnrollment	Cihaz kayıt kaydı.
InitialTwin	İlk cihaz ikizi. Twin'in özelliklerinin bir alt kümesini içerir.
InitialTwinProperties	Cihaz ikizinde belirlenecek başlangıç özelliklerini temsil eder.
Metadata	TwinCollection için meta veriler
ProvisioningServiceErrorDetails	Azure IoT Hub Provisioning Service tarafından döndürülen bir hatanın özelliklerini içerir.
ProvisioningStatus	Tedarik durumu.
ReprovisionPolicy	Bir cihazın bir IoT hub'a yeniden sağlandığında hizmetin davranışı.
SymmetricKeyAttestation	SymmetricKey üzerinden doğrulama.
TpmAttestation	TPM üzerinden doğrulama.
TwinCollection	Bir İkiz içindeki özellikler koleksiyonunu temsil eder
X509Attestation	X509 üzerinden doğrulama.
X509CAReferences	Birincil ve ikincil CA referansları.
X509CertificateInfo	X509 sertifika bilgisi.
X509Certificates	İlköğretim ve ikincil sertifikalar
X509CertificateWithInfo	Sertifika ve Sertifika bilgileri

AllocationPolicy

Numaralandırma

Bu kaynağın tahsis politikası. Bu politika, bu bireysel kayıt veya kayıt grubu için kiracı düzeyinde tahsis politikasını geçersiz kılar. Olası değerler arasında 'hashed' bulunur: Bağlı IoT hub'larına cihazların sağlanma olasılığı eşit derecede yüksektir, 'geoLatency': Cihazlar, cihaza en düşük gecikmeye sahip bir IoT hub'a sağlanır. Birden fazla bağlı IoT hub aynı en düşük gecikmeyi sağlıyorsa, tedarik hizmeti bu merkezler arasında cihazları hash eder, 'statik' : Kayıt listesinde istenen IoT hub'ın belirtilmesi, hizmet seviyesi tahsis politikasından önceliklidir, 'özel': Cihazlar, kendi özel mantığınıza göre bir IoT hub'a sağlanır. Provisioning servisi, cihazla ilgili bilgileri mantığa iletir ve mantık istenen IoT hub'ı ile istenen ilk yapılandırmayı geri getirir. Mantığınızı barındırmak için Azure Functions kullanmanızı öneririz.

Değer	Description
hashed	Hashed
geoLatency	geoLatency
static	durağan
custom	custom

AssignedDeviceSubstatus

Numaralandırma

'Atanan' cihazlar için alt durum. Olası değerler arasında - 'initialAssignment': Cihaz ilk kez bir IoT hub'a atanmıştır, 'deviceDataMigrated': Cihaz farklı bir IoT hub'a atanmış ve cihaz verisi önceden atanan IoT merkezinden taşınmıştır. Cihaz verileri, önceden atanan IoT merkezinden olan 'deviceDataReset'ten kaldırıldı: Cihaz farklı bir IoT hub'a atanmış ve cihaz verisi, kayıtta saklanan ilk durumdan itibaren doldurulmuştur. Cihaz verileri, önceden atanan IoT merkezinden çıkarıldı, 'reprovisionedToInitialAssignment': Cihaz, önceden atanan bir IoT hub'a yeniden sağlandı.

Değer	Description
initialAssignment	başlangıçAtama
deviceDataMigrated	deviceDataMigrated
deviceDataReset	deviceDataReset
reprovisionedToInitialAssignment	reprovisionedToInitial Assignment

AttestationMechanism

Nesne

Birey için doğrulama mekanizmasıKayıt ve kayıt grubu.

Name	Tür	Description
symmetricKey	SymmetricKeyAttestation	Simetrik Anahtar Doğrulama Yöntemi.
tpm	TpmAttestation	TPM doğrulama yöntemi.
type	AttestationType	Doğrulama Türü.
x509	X509Attestation	X509 doğrulama yöntemi.

AttestationType

Numaralandırma

Doğrulama Türü.

Değer	Description
none	none
tpm	Tpm
x509	x509
symmetricKey	simetrik anahtar

CustomAllocationDefinition

Nesne

Bu, özel tahsis kullanıldığında DPS'ye hangi webhook'u çağıracağını söyler.

Name	Tür	Description
apiVersion	string	Özel tahsis talebini gönderen tedarik servis türlerinin API versiyonu (örneğin IndividualEnrollment). Minimum desteklenen sürüm: "2018-09-01-önizleme".
webhookUrl	string	Tahsis talepleri için kullanılan webhook URL'si.

DeviceCapabilities

Nesne

Cihaz yetenekleri.

Name	Tür	Default value	Description
iotEdge	boolean	False	Doğru olarak ayarlanmışsa, bu cihaz bir IoTEdge cihazıdır.

DeviceRegistrationState

Nesne

Cihaz kayıt durumu.

Name	Tür	Description
assignedHub	string	Azure IoT Hub atandı.
createdDateTimeUtc	string (date-time)	Kayıt, tarih saatini oluştur (UTC'de).
deviceId	string	Cihaz kimliği.
errorCode	integer (int32)	Hata kodu.
errorMessage	string	Hata mesajı.
etag	string	Kaynakla ilişkili varlık etiketi.
lastUpdatedDateTimeUtc	string (date-time)	Son güncellenen tarih saati (UTC'de).
payload		Webhook'tan cihaza geri dönen özel tahsis yükü.
registrationId	string	Bu id, bir kayıt cihazının kayıt cihazını benzersiz şekilde tanımlamak için kullanılır. Alfanumerik karakterler ve belirli özel karakterlerden oluşan küçük harfi duyarsız (128 karaktere kadar uzunluğunda) bir dizi : . _ -. Başta veya sonunda özel karakterlere izin verilmez.
status	EnrollmentStatus	Kayıt durumu.
substatus	AssignedDeviceSubstatus	'Atanan' cihazlar için alt durum. Olası değerler arasında - 'initialAssignment': Cihaz ilk kez bir IoT hub'a atanmıştır, 'deviceDataMigrated': Cihaz farklı bir IoT hub'a atanmış ve cihaz verisi önceden atanan IoT merkezinden taşınmıştır. Cihaz verileri, önceden atanan IoT merkezinden olan 'deviceDataReset'ten kaldırıldı: Cihaz farklı bir IoT hub'a atanmış ve cihaz verisi, kayıtta saklanan ilk durumdan itibaren doldurulmuştur. Cihaz verileri, önceden atanan IoT merkezinden çıkarıldı, 'reprovisionedToInitialAssignment': Cihaz, önceden atanan bir IoT hub'a yeniden sağlandı.

EnrollmentStatus

Numaralandırma

Kayıt durumu.

Değer	Description
unassigned	Atanma -mış
assigning	Atama
assigned	Atanmış
failed	başarısız
disabled	engelli

IndividualEnrollment

Nesne

Cihaz kayıt kaydı.

Name	Tür	Default value	Description
allocationPolicy	AllocationPolicy		Bu kaynağın tahsis politikası. Bu politika, bu bireysel kayıt veya kayıt grubu için kiracı düzeyinde tahsis politikasını geçersiz kılar. Olası değerler arasında 'hashed' bulunur: Bağlı IoT hub'larına cihazların sağlanma olasılığı eşit derecede yüksektir, 'geoLatency': Cihazlar, cihaza en düşük gecikmeye sahip bir IoT hub'a sağlanır. Birden fazla bağlı IoT hub aynı en düşük gecikmeyi sağlıyorsa, tedarik hizmeti bu merkezler arasında cihazları hash eder, 'statik' : Kayıt listesinde istenen IoT hub'ın belirtilmesi, hizmet seviyesi tahsis politikasından önceliklidir, 'özel': Cihazlar, kendi özel mantığınıza göre bir IoT hub'a sağlanır. Provisioning servisi, cihazla ilgili bilgileri mantığa iletir ve mantık istenen IoT hub'ı ile istenen ilk yapılandırmayı geri getirir. Mantığınızı barındırmak için Azure Functions kullanmanızı öneririz.
attestation	AttestationMechanism		Cihazın kullandığı doğrulama yöntemi.
capabilities	DeviceCapabilities		Cihazın yetenekleri.
createdDateTimeUtc	string (date-time)		Bu kaynağın oluşturulduğu DateTime.
customAllocationDefinition	CustomAllocationDefinition		Bu, özel tahsis kullanıldığında DPS'ye hangi webhook'u çağıracağını söyler.
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.
iotHubHostName	string		Iot Hub ana adı.
iotHubs	string[]		Bu kaynaktaki cihaz(lar)ın tahsis edilebileceği IoT Hub ana isimlerinin listesi. Kiracı düzeyindeki IoT merkezlerinin bir alt kümesi olmalı.
lastUpdatedDateTimeUtc	string (date-time)		DateTime bu kaynak en son güncellendi.
optionalDeviceInformation	TwinCollection		İsteğe Bağlı Cihaz Bilgisi.
provisioningStatus	ProvisioningStatus	enabled	Tedarik durumu.
registrationId	string		Bu id, bir kayıt cihazının kayıt cihazını benzersiz şekilde tanımlamak için kullanılır. Alfanumerik karakterler ve belirli özel karakterlerden oluşan küçük harfi duyarsız (128 karaktere kadar uzunluğunda) bir dizi : . _ -. Başta veya sonunda özel karakterlere izin verilmez.
registrationState	DeviceRegistrationState		Mevcut kayıt durumu.
reprovisionPolicy	ReprovisionPolicy		Bir cihazın bir IoT hub'a yeniden sağlandığı davranış.

InitialTwin

Nesne

İlk cihaz ikizi. Twin'in özelliklerinin bir alt kümesini içerir.

Name	Tür	Description
properties	InitialTwinProperties	İkiz istenen özellikler.
tags	TwinCollection	İkiz etiketleri.

InitialTwinProperties

Nesne

Cihaz ikizinde belirlenecek başlangıç özelliklerini temsil eder.

Name	Tür	Description
desired	TwinCollection	İstenen InitialTwin özelliklerini alır ve ayarlar.

Metadata

Nesne

TwinCollection için meta veriler

Name	Tür	Description
lastUpdated	string (date-time)	TwinCollection en son güncellendiğinde
lastUpdatedVersion	integer (int32)	Bu, bildirilen özellikler meta verileri için null ve istenen özellikler metaverisi için null değildir.

ProvisioningServiceErrorDetails

Nesne

Azure IoT Hub Provisioning Service tarafından döndürülen bir hatanın özelliklerini içerir.

Name	Tür	Description
errorCode	integer (int32)	İşlem için hata kodu.
info	object	<dize> sözlüğü
message	string	İnsan tarafından okunabilir hata mesajı.
timestampUtc	string (date-time)	Hatanın UTC zaman damgası.
trackingId	string	Hata için takip kimliği.

ProvisioningStatus

Numaralandırma

Tedarik durumu.

Değer	Description
enabled	enabled
disabled	engelli

ReprovisionPolicy

Nesne

Bir cihazın bir IoT hub'a 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 cihazın verilerini (ikiz, cihaz yetenekleri ve cihaz kimliği) bir IoT hub'dan diğerine IoT hub atama güncellemesi sırasında taşır. Yanlış olarak ayarlanırsa, Cihaz Tedarik Hizmeti cihazın verilerini ilgili kayıt listesinde saklanan ilk istenen yapılandırmaya sıfırlar.
updateHubAssignment	boolean	True	True (varsayılan) olarak ayarlandığında, Cihaz Sağlama Servisi cihazın IoT Hub atamasını değerlendirir ve gerekirse belirli bir cihazdan gelen ilk prodakt istekleri için günceller. Yanlış olarak ayarlanırsa, cihaz mevcut IoT hub'ına atamış kalacaktır.

SymmetricKeyAttestation

Nesne

SymmetricKey üzerinden doğrulama.

Name	Tür	Description
primaryKey	string	Birincil simetrik anahtar.
secondaryKey	string	İkincil simetrik anahtar.

TpmAttestation

Nesne

TPM üzerinden doğrulama.

Name	Tür	Description
endorsementKey	string	TPM onay anahtarı.
storageRootKey	string	TPM depolama kök anahtarı.

TwinCollection

Nesne

Bir İkiz içindeki özellikler koleksiyonunu temsil eder

Name	Tür	Description
count	integer (int32)	TwinCollection'daki mülk sayısı
metadata	Metadata	TwinCollection için meta veriler
version	integer (int32)	TwinCollection Versiyonu

X509Attestation

Nesne

X509 üzerinden doğrulama.

Name	Tür	Description
caReferences	X509CAReferences	Birincil ve ikincil CA referansları.
clientCertificates	X509Certificates	İlköğretim ve ikincil sertifikalar
signingCertificates	X509Certificates	İlköğretim ve ikincil sertifikalar

X509CAReferences

Nesne

Birincil ve ikincil CA referansları.

Name	Tür	Description
primary	string	Birincil CA referansı.
secondary	string	İkincil CA referansı.

X509CertificateInfo

Nesne

X509 sertifika bilgisi.

Name	Tür	Description
issuerName	string	Sertifikanın vericisinin adı.
notAfterUtc	string (date-time)	Sertifika geçerlilik sonu (UTC).
notBeforeUtc	string (date-time)	Sertifika geçerliliği başlangıcıdır (UTC).
serialNumber	string	Sertifikanın seri numarası.
sha1Thumbprint	string	Sertifikanın SHA-1 parmak izi.
sha256Thumbprint	string	Sertifikanın SHA-256 parmak izi.
subjectName	string	Sertifikanın konu adı.
version	integer (int32)	Sertifikanın versiyonu.

X509Certificates

Nesne

İlköğretim ve ikincil sertifikalar

Name	Tür	Description
primary	X509CertificateWithInfo	Sertifika ve Sertifika bilgileri
secondary	X509CertificateWithInfo	Sertifika ve Sertifika bilgileri

X509CertificateWithInfo

Nesne

Sertifika ve Sertifika bilgileri

Name	Tür	Description
certificate	string	PEM formatlı sertifika dizisi.
info	X509CertificateInfo	X509 sertifika bilgisi.