Individual Enrollment - Get

Szolgáltatás:

IoT Hub Device Provisioning Service

API-verzió:

2021-10-01

Az eszközregisztráció nyilvántartásának lekérése.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
dpsName	path	True	string	A DPS instance hosztnév.
id	path	True	string	Ezt az azonosítót egyediben arra használják, hogy egyediben azonosítsák a regisztrációs eszközregisztrációt. Egy kis- és nagybetűs láncsor, amely akár 128 karakter hosszú, alfanumerikus karakterekből és bizonyos speciális karakterekből áll: . _ -. A kezdő vagy a végén nem engedélyezett speciális karakterek.
api-version	query	True	string minLength: 1	A művelethez használandó API-verzió.

Kérelem fejléce

Name	Kötelező	Típus	Description
Authorization	True	string

Válaszok

Name	Típus	Description
200 OK	IndividualEnrollment	A kérés sikeres volt.
Other Status Codes	ProvisioningServiceErrorDetails	Váratlan hibaválasz. Fejlécek x-ms-error-code: string

Biztonság

Authorization

Típus: apiKey
In: header

Példák

IndividualEnrollment_Get_MaximumSet_Gen

IndividualEnrollment_Get_MinimumSet_Gen

IndividualEnrollment_Get_MaximumSet_Gen

Mintakérelem

HTTP

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

Mintaválasz

Állapotkód:

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

Mintakérelem

HTTP

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

Mintaválasz

Állapotkód:

200

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

Definíciók

Name	Description
AllocationPolicy	Az erőforrás elosztási politikája. Ez a szabályzat felülírja az egyéni beiratkozási vagy beiratkozási csoport bérlői szintű elosztási szabályzatát. Lehetséges értékek közé tartozik a 'hashed': a kapcsolt IoT hubokhoz ugyanolyan valószínűséggel vannak eszközök, mint a geoLatency': Az eszközöket egy IoT hubra állítják ki, amelynek legalacsonyabb késleltetése van az eszközhöz képest. Ha több összekapcsolt IoT hub ugyanazt a legalacsonyabb késleltetést biztosítaná, a provisioning szolgáltatás hasholja az eszközöket ezeken a hubokon keresztül, 'static': a kívánt IoT hub specifikációja a regisztrációs listában elsőbbséget élvez a szolgáltatási szintű allokációs politika felett, 'egyedi': Az eszközöket egy IoT hubra állítják ki a saját egyedi logika alapján. A provisioning service továbbítja az eszközről az információt a logikához, és a logika visszaadja a kívánt IoT hubot és a kívánt kezdeti konfigurációt. Javasoljuk, hogy Azure Functions segítségével hódolj a logikai rendszeredhez.
AssignedDeviceSubstatus	Alstátusz a 'Hozzárendelt' eszközökhöz. Lehetséges értékek a következők: 'initialAssignment': Az eszközt először rendelték IoT hubhoz, 'deviceDataMigrated': Az eszközt egy másik IoT hubhoz rendelték, és az eszköz adatait a korábban kijelölt IoT hubról migrálták. Az eszközadatokat eltávolították a korábban kijelölt IoT hubról, a 'deviceDataReset'-ről: Az eszközt egy másik IoT hubhoz rendelték, és az eszköz adatai a regisztrációban tárolt eredeti állapotból lettek feltöltve. Az eszköz adatait eltávolították a korábban kijelölt IoT hubról, a 'reprovisionedToInitialAssignment'-ről: Az eszközt újra felállították egy korábban kijelölt IoT hubra.
AttestationMechanism	Az egyéni regisztráció és a regisztráció hitelesítési mechanizmusa.
AttestationType	Hitelesítési típus.
CustomAllocationDefinition	Ez megmondja a DPS-nek, melyik webhookot kell hívni, ha egyedi allocation használ.
DeviceCapabilities	Eszköz képességei.
DeviceRegistrationState	Eszköz regisztrációs állapota.
EnrollmentStatus	Regisztrációs állapot.
IndividualEnrollment	Az eszköz regisztrációs nyilvántartása.
InitialTwin	Kezdeti eszköz iker. Tartalmazza a Twin tulajdonságainak egy részhalmazát.
InitialTwinProperties	A készülék ikertestén beállított kezdeti tulajdonságokat jelöli.
Metadata	A TwinCollection metaadatai
ProvisioningServiceErrorDetails	Tartalmazza az Azure IoT Hub Provisioning Service által visszaadott hiba tulajdonságait.
ProvisioningStatus	A provisioning állapot.
ReprovisionPolicy	A szolgáltatás viselkedése, amikor egy eszközt újra felbiztosítanak egy IoT hubra.
SymmetricKeyAttestation	Hitelesítés SymmetricKey-en keresztül.
TpmAttestation	Hitelesítés TPM-en keresztül.
TwinCollection	Egy ikertestvéren belüli tulajdonságok gyűjteményét képviseli
X509Attestation	Hitelesítés az X509-en keresztül.
X509CAReferences	Elsődleges és másodlagos CA hivatkozások.
X509CertificateInfo	X509 tanúsítvány információ.
X509Certificates	Elsődleges és másodvállalati tanúsítványok
X509CertificateWithInfo	Tanúsítvány és tanúsítvány információk

AllocationPolicy

Felsorolás

Az erőforrás elosztási politikája. Ez a szabályzat felülírja az egyéni beiratkozási vagy beiratkozási csoport bérlői szintű elosztási szabályzatát. Lehetséges értékek közé tartozik a 'hashed': a kapcsolt IoT hubokhoz ugyanolyan valószínűséggel vannak eszközök, mint a geoLatency': Az eszközöket egy IoT hubra állítják ki, amelynek legalacsonyabb késleltetése van az eszközhöz képest. Ha több összekapcsolt IoT hub ugyanazt a legalacsonyabb késleltetést biztosítaná, a provisioning szolgáltatás hasholja az eszközöket ezeken a hubokon keresztül, 'static': a kívánt IoT hub specifikációja a regisztrációs listában elsőbbséget élvez a szolgáltatási szintű allokációs politika felett, 'egyedi': Az eszközöket egy IoT hubra állítják ki a saját egyedi logika alapján. A provisioning service továbbítja az eszközről az információt a logikához, és a logika visszaadja a kívánt IoT hubot és a kívánt kezdeti konfigurációt. Javasoljuk, hogy Azure Functions segítségével hódolj a logikai rendszeredhez.

Érték	Description
hashed	hash
geoLatency	geoLatency
static	statikus
custom	szokás

AssignedDeviceSubstatus

Felsorolás

Alstátusz a 'Hozzárendelt' eszközökhöz. Lehetséges értékek a következők: 'initialAssignment': Az eszközt először rendelték IoT hubhoz, 'deviceDataMigrated': Az eszközt egy másik IoT hubhoz rendelték, és az eszköz adatait a korábban kijelölt IoT hubról migrálták. Az eszközadatokat eltávolították a korábban kijelölt IoT hubról, a 'deviceDataReset'-ről: Az eszközt egy másik IoT hubhoz rendelték, és az eszköz adatai a regisztrációban tárolt eredeti állapotból lettek feltöltve. Az eszköz adatait eltávolították a korábban kijelölt IoT hubról, a 'reprovisionedToInitialAssignment'-ről: Az eszközt újra felállították egy korábban kijelölt IoT hubra.

Érték	Description
initialAssignment	kezdeti kiosztás
deviceDataMigrated	deviceDataMigrated
deviceDataReset	deviceDataReset
reprovisionedToInitialAssignment	reprovisionedToInitial Assignment

AttestationMechanism

Tárgy

Az egyéni regisztráció és a regisztráció hitelesítési mechanizmusa.

Name	Típus	Description
symmetricKey	SymmetricKeyAttestation	Szimmetrikus kulcs hitelesítési módszer.
tpm	TpmAttestation	TPM hitelesítési módszer.
type	AttestationType	Hitelesítési típus.
x509	X509Attestation	X509 hitelesítési módszer.

AttestationType

Felsorolás

Hitelesítési típus.

Érték	Description
none	none
tpm	Tpm
x509	x509
symmetricKey	szimmetrikus kulcs

CustomAllocationDefinition

Tárgy

Ez megmondja a DPS-nek, melyik webhookot kell hívni, ha egyedi allocation használ.

Name	Típus	Description
apiVersion	string	A provisioning szolgáltatástípusok API verziója (például IndividualEnrollment) küldte be az egyedi allokációs kérelmet. Minimum támogatott verzió: "2018-09-01-preview".
webhookUrl	string	A webhook URL, amelyet allokációs kérésekhez használnak.

DeviceCapabilities

Tárgy

Eszköz képességei.

Name	Típus	Alapértelmezett érték	Description
iotEdge	boolean	False	Ha true-ra állítva, ez az eszköz egy IoTEdge eszköz.

DeviceRegistrationState

Tárgy

Eszköz regisztrációs állapota.

Name	Típus	Description
assignedHub	string	Assigned Azure IoT Hub.
createdDateTimeUtc	string (date-time)	Regisztráció dátum létrehozása időpont (UTC-ben).
deviceId	string	Eszközazonosító.
errorCode	integer (int32)	Hibakód.
errorMessage	string	Hibaüzenet.
etag	string	Az erőforráshoz tartozó entitáscímké.
lastUpdatedDateTimeUtc	string (date-time)	Utoljára frissített dátum (UTC-ben).
payload		A webhookból visszakerült egyedi allokációs hasznos raher az eszközre.
registrationId	string	Ezt az azonosítót egyediben arra használják, hogy egyediben azonosítsák a regisztrációs eszközregisztrációt. Egy kis- és nagybetűs láncsor, amely akár 128 karakter hosszú, alfanumerikus karakterekből és bizonyos speciális karakterekből áll: . _ -. A kezdő vagy a végén nem engedélyezett speciális karakterek.
status	EnrollmentStatus	Regisztrációs állapot.
substatus	AssignedDeviceSubstatus	Alstátusz a 'Hozzárendelt' eszközökhöz. Lehetséges értékek a következők: 'initialAssignment': Az eszközt először rendelték IoT hubhoz, 'deviceDataMigrated': Az eszközt egy másik IoT hubhoz rendelték, és az eszköz adatait a korábban kijelölt IoT hubról migrálták. Az eszközadatokat eltávolították a korábban kijelölt IoT hubról, a 'deviceDataReset'-ről: Az eszközt egy másik IoT hubhoz rendelték, és az eszköz adatai a regisztrációban tárolt eredeti állapotból lettek feltöltve. Az eszköz adatait eltávolították a korábban kijelölt IoT hubról, a 'reprovisionedToInitialAssignment'-ről: Az eszközt újra felállították egy korábban kijelölt IoT hubra.

EnrollmentStatus

Felsorolás

Regisztrációs állapot.

Érték	Description
unassigned	nincs hozzárendelve
assigning	Hozzárendelés
assigned	Hozzárendelt
failed	sikertelen
disabled	halványított

IndividualEnrollment

Tárgy

Az eszköz regisztrációs nyilvántartása.

Name	Típus	Alapértelmezett érték	Description
allocationPolicy	AllocationPolicy		Az erőforrás elosztási politikája. Ez a szabályzat felülírja az egyéni beiratkozási vagy beiratkozási csoport bérlői szintű elosztási szabályzatát. Lehetséges értékek közé tartozik a 'hashed': a kapcsolt IoT hubokhoz ugyanolyan valószínűséggel vannak eszközök, mint a geoLatency': Az eszközöket egy IoT hubra állítják ki, amelynek legalacsonyabb késleltetése van az eszközhöz képest. Ha több összekapcsolt IoT hub ugyanazt a legalacsonyabb késleltetést biztosítaná, a provisioning szolgáltatás hasholja az eszközöket ezeken a hubokon keresztül, 'static': a kívánt IoT hub specifikációja a regisztrációs listában elsőbbséget élvez a szolgáltatási szintű allokációs politika felett, 'egyedi': Az eszközöket egy IoT hubra állítják ki a saját egyedi logika alapján. A provisioning service továbbítja az eszközről az információt a logikához, és a logika visszaadja a kívánt IoT hubot és a kívánt kezdeti konfigurációt. Javasoljuk, hogy Azure Functions segítségével hódolj a logikai rendszeredhez.
attestation	AttestationMechanism		Az eszköz által használt hitelesítési módszer.
capabilities	DeviceCapabilities		Az eszköz képességei.
createdDateTimeUtc	string (date-time)		A DateTime (DateTime) ezt az erőforrást hozták létre.
customAllocationDefinition	CustomAllocationDefinition		Ez megmondja a DPS-nek, melyik webhookot kell hívni, ha egyedi allocation használ.
deviceId	string		Kívánt IoT Hub eszköz azonosító (opcionális).
etag	string		Az erőforráshoz tartozó entitáscímké.
initialTwin	InitialTwin		Kezdeti eszköz iker.
iotHubHostName	string		Az Iot Hub hosztenév.
iotHubs	string[]		Az IoT Hub hosztneveinek listája, amelyekhez az erőforrásban lévő eszköz(ek) hozzá lehet rendelni. Biztosan az IoT hubok bérlői szintű listájának egy részhalmaza.
lastUpdatedDateTimeUtc	string (date-time)		A DateTime ezt a forrást utoljára frissítették.
optionalDeviceInformation	TwinCollection		Opcionális eszközinformációk.
provisioningStatus	ProvisioningStatus	enabled	A provisioning állapot.
registrationId	string		Ezt az azonosítót egyediben arra használják, hogy egyediben azonosítsák a regisztrációs eszközregisztrációt. Egy kis- és nagybetűs láncsor, amely akár 128 karakter hosszú, alfanumerikus karakterekből és bizonyos speciális karakterekből áll: . _ -. A kezdő vagy a végén nem engedélyezett speciális karakterek.
registrationState	DeviceRegistrationState		Jelenlegi regisztrációs állapot.
reprovisionPolicy	ReprovisionPolicy		A viselkedés, amikor egy eszközt újra felállítanak egy IoT hubra.

InitialTwin

Tárgy

Kezdeti eszköz iker. Tartalmazza a Twin tulajdonságainak egy részhalmazát.

Name	Típus	Description
properties	InitialTwinProperties	Iker kívánt tulajdonságok.
tags	TwinCollection	Ikercímkék.

InitialTwinProperties

Tárgy

A készülék ikertestén beállított kezdeti tulajdonságokat jelöli.

Name	Típus	Description
desired	TwinCollection	Megkapja és beállítja az InitialTwin kívánt tulajdonságait.

Metadata

Tárgy

A TwinCollection metaadatai

Name	Típus	Description
lastUpdated	string (date-time)	Legutóbb, amikor a TwinCollection frissült
lastUpdatedVersion	integer (int32)	Ez null a jelentett tulajdonságok metaadatára, nem null a kívánt tulajdonságok metaadataihoz.

ProvisioningServiceErrorDetails

Tárgy

Tartalmazza az Azure IoT Hub Provisioning Service által visszaadott hiba tulajdonságait.

Name	Típus	Description
errorCode	integer (int32)	Hibakód a művelethez.
info	object	<sztring> szótára
message	string	Ember által olvasható hibaüzenet.
timestampUtc	string (date-time)	UTC időbélyeg a hiba miatt.
trackingId	string	A hiba követési azonosítója.

ProvisioningStatus

Felsorolás

A provisioning állapot.

Érték	Description
enabled	enabled
disabled	halványított

ReprovisionPolicy

Tárgy

A szolgáltatás viselkedése, amikor egy eszközt újra felbiztosítanak egy IoT hubra.

Name	Típus	Alapértelmezett érték	Description
migrateDeviceData	boolean	True	Ha true-ra állítva (alapértelmezett), az Eszköz Biztosító Szolgáltatás áthelyezi az eszköz adatait (ikertest, eszközfunkciók és eszközazonosító) egyik IoT hubról a másikra az IoT hub hozzárendelési frissítése során. Ha hamisnak állítva állítják be, az Eszköz Provisioning Service visszaállítja az eszköz adatait az eredeti kívánt konfigurációra, amelyet a megfelelő regisztrációs listában tárolnak.
updateHubAssignment	boolean	True	Ha true-ra állítják (alapértelmezett), az Eszköz Provisioning Service értékeli az eszköz IoT Hub kiosztását, és szükség esetén frissíti azt az adott eszközről érkező első utáni igények esetén. Ha hamisra állítva, az eszköz a jelenlegi IoT hubjához marad.

SymmetricKeyAttestation

Tárgy

Hitelesítés SymmetricKey-en keresztül.

Name	Típus	Description
primaryKey	string	Elsődleges szimmetrikus kulcs.
secondaryKey	string	Másodlagos szimmetrikus kulcs.

TpmAttestation

Tárgy

Hitelesítés TPM-en keresztül.

Name	Típus	Description
endorsementKey	string	TPM támogatási kulcs.
storageRootKey	string	TPM tároló gyökérkulcs.

TwinCollection

Tárgy

Egy ikertestvéren belüli tulajdonságok gyűjteményét képviseli

Name	Típus	Description
count	integer (int32)	A TwinCollection tulajdonságainak száma
metadata	Metadata	A TwinCollection metaadatai
version	integer (int32)	A TwinCollection verziója

X509Attestation

Tárgy

Hitelesítés az X509-en keresztül.

Name	Típus	Description
caReferences	X509CAReferences	Elsődleges és másodlagos CA hivatkozások.
clientCertificates	X509Certificates	Elsődleges és másodvállalati tanúsítványok
signingCertificates	X509Certificates	Elsődleges és másodvállalati tanúsítványok

X509CAReferences

Tárgy

Elsődleges és másodlagos CA hivatkozások.

Name	Típus	Description
primary	string	Elsődleges CA hivatkozás.
secondary	string	Másodlagos CA hivatkozás.

X509CertificateInfo

Tárgy

X509 tanúsítvány információ.

Name	Típus	Description
issuerName	string	A tanúsítvány kibocsátó neve.
notAfterUtc	string (date-time)	Tanúsítvány érvényességi vége (UTC).
notBeforeUtc	string (date-time)	Tanúsítvány érvényességi kezdete (UTC).
serialNumber	string	A tanúsítvány sorozatszáma.
sha1Thumbprint	string	SHA-1 ujjlenyomatot a tanúsítványról.
sha256Thumbprint	string	SHA-256 ujjlenyomatot a bizonyítványról.
subjectName	string	A tanúsítvány tulajdonosának neve.
version	integer (int32)	A tanúsítvány verziója.

X509Certificates

Tárgy

Elsődleges és másodvállalati tanúsítványok

Name	Típus	Description
primary	X509CertificateWithInfo	Tanúsítvány és tanúsítvány információk
secondary	X509CertificateWithInfo	Tanúsítvány és tanúsítvány információk

X509CertificateWithInfo

Tárgy

Tanúsítvány és tanúsítvány információk

Name	Típus	Description
certificate	string	PEM-formátumú tanúsítvány string.
info	X509CertificateInfo	X509 tanúsítvány információ.