Individual Enrollment - Get

Služba:

IoT Hub Device Provisioning Service

Verze rozhraní API:

2021-10-01

Získat záznam o registraci zařízení.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
dpsName	path	True	string	Hostitelské jméno instance DPS.
id	path	True	string	Toto ID se používá k jednoznačné identifikaci registrace zařízení. Řetězec bez velikosti (až 128 znaků dlouhý) alfanumerických znaků plus určitých speciálních znaků : . _ -. Na začátku ani na konci nejsou povoleny žádné speciální postavy.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
Authorization	True	string

Odpovědi

Name	Typ	Description
200 OK	IndividualEnrollment	Požadavek byl úspěšný.
Other Status Codes	ProvisioningServiceErrorDetails	Neočekávaná chybová odpověď Hlavičky x-ms-error-code: string

Zabezpečení

Authorization

Typ: apiKey
V: header

Příklady

IndividualEnrollment_Get_MaximumSet_Gen

IndividualEnrollment_Get_MinimumSet_Gen

IndividualEnrollment_Get_MaximumSet_Gen

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kó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

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:

200

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

Definice

Name	Description
AllocationPolicy	Politika alokace tohoto zdroje. Tato politika přebíjí politiku přidělování na úrovni nájemců pro tuto jednotlivou skupinu zápisů nebo zápisů. Možné hodnoty zahrnují 'hashed': Propojené IoT huby mají stejně pravděpodobně zařízení přidělená k nim, 'geoLatency': Zařízení jsou provisionována na IoT hub s nejnižší latencí zařízení. Pokud by více propojených IoT hubů poskytovalo stejnou nejnižší latenci, provisioning service hashuje zařízení napříč těmito huby, 'statické': Specifikace požadovaného IoT hubu v seznamu pro zápis má přednost před politikou alokace na úrovni služeb, 'custom': Zařízení jsou přiřazována k IoT hubu podle vaší vlastní logiky. Provisioning služba předává informace o zařízení logice, která vrací požadovaný IoT hub i požadovanou počáteční konfiguraci. Doporučujeme používat Azure Functions pro hostování vaší logiky.
AssignedDeviceSubstatus	Podstav pro 'přiřazená' zařízení. Možné hodnoty zahrnují - 'initialAssignment': Zařízení bylo poprvé přiřazeno k IoT hubu, 'deviceDataMigrated': Zařízení bylo přiřazeno k jinému IoT hubu a jeho data byla migrována z dříve přiděleného IoT hubu. Data zařízení byla odstraněna z dříve přiděleného IoT hubu, 'deviceDataReset': Zařízení bylo přiřazeno k jinému IoT hubu a jeho data byla načtena z původního stavu uloženého v registraci. Data zařízení byla odstraněna z dříve přiděleného IoT hubu, 'reprovisionedToInitialAssignment': Zařízení bylo znovu provisionováno do dříve přiděleného IoT hubu.
AttestationMechanism	Mechanismus potvrzování pro individuální zápis i pro skupinu zápisu.
AttestationType	Typ ověření.
CustomAllocationDefinition	To DPS říká, který webhook volat při použití vlastní alokace.
DeviceCapabilities	Schopnosti zařízení.
DeviceRegistrationState	Registrace zařízení ve státě.
EnrollmentStatus	Stav zápisu.
IndividualEnrollment	Záznam o registraci zařízení.
InitialTwin	Počáteční dvojčato zařízení. Obsahuje podmnožinu vlastností Twin.
InitialTwinProperties	Představuje počáteční vlastnosti, které budou nastaveny na dvojčeti zařízení.
Metadata	Metadata pro TwinCollection
ProvisioningServiceErrorDetails	Obsahuje vlastnosti chyby vrácené službou Azure IoT Hub Provisioning.
ProvisioningStatus	Stav provisioningu.
ReprovisionPolicy	Chování služby při opětovném připojení zařízení do IoT hubu.
SymmetricKeyAttestation	Ověření pomocí SymmetricKey.
TpmAttestation	Ověření přes TPM.
TwinCollection	Reprezentuje množinu vlastností uvnitř dvojčete
X509Attestation	Ověření přes X509.
X509CAReferences	Primární a sekundární CA reference.
X509CertificateInfo	Informace o certifikátu X509.
X509Certificates	Primární a sekundární certifikáty
X509CertificateWithInfo	Informace o certifikátu a certifikátu

AllocationPolicy

Výčet

Politika alokace tohoto zdroje. Tato politika přebíjí politiku přidělování na úrovni nájemců pro tuto jednotlivou skupinu zápisů nebo zápisů. Možné hodnoty zahrnují 'hashed': Propojené IoT huby mají stejně pravděpodobně zařízení přidělená k nim, 'geoLatency': Zařízení jsou provisionována na IoT hub s nejnižší latencí zařízení. Pokud by více propojených IoT hubů poskytovalo stejnou nejnižší latenci, provisioning service hashuje zařízení napříč těmito huby, 'statické': Specifikace požadovaného IoT hubu v seznamu pro zápis má přednost před politikou alokace na úrovni služeb, 'custom': Zařízení jsou přiřazována k IoT hubu podle vaší vlastní logiky. Provisioning služba předává informace o zařízení logice, která vrací požadovaný IoT hub i požadovanou počáteční konfiguraci. Doporučujeme používat Azure Functions pro hostování vaší logiky.

Hodnota	Description
hashed	hashed
geoLatency	geoLatence
static	statický
custom	custom

AssignedDeviceSubstatus

Výčet

Podstav pro 'přiřazená' zařízení. Možné hodnoty zahrnují - 'initialAssignment': Zařízení bylo poprvé přiřazeno k IoT hubu, 'deviceDataMigrated': Zařízení bylo přiřazeno k jinému IoT hubu a jeho data byla migrována z dříve přiděleného IoT hubu. Data zařízení byla odstraněna z dříve přiděleného IoT hubu, 'deviceDataReset': Zařízení bylo přiřazeno k jinému IoT hubu a jeho data byla načtena z původního stavu uloženého v registraci. Data zařízení byla odstraněna z dříve přiděleného IoT hubu, 'reprovisionedToInitialAssignment': Zařízení bylo znovu provisionováno do dříve přiděleného IoT hubu.

Hodnota	Description
initialAssignment	initialAssignment
deviceDataMigrated	deviceDataMigrated
deviceDataReset	deviceDataReset
reprovisionedToInitialAssignment	reprovisionedToInitialAssignment

AttestationMechanism

Objekt

Mechanismus potvrzování pro individuální zápis i pro skupinu zápisu.

Name	Typ	Description
symmetricKey	SymmetricKeyAttestation	Metoda ověřování symetrického klíče.
tpm	TpmAttestation	Metoda TPM ověření.
type	AttestationType	Typ ověření.
x509	X509Attestation	Metoda ověření podle X509.

AttestationType

Výčet

Typ ověření.

Hodnota	Description
none	žádné
tpm	čip tpm
x509	x509
symmetricKey	symetrický klíč

CustomAllocationDefinition

Objekt

To DPS říká, který webhook volat při použití vlastní alokace.

Name	Typ	Description
apiVersion	string	API verze typů provisioning služeb (například IndividualEnrollment) zaslaná v žádosti o vlastní alokaci. Minimální podporovaná verze: "2018-09-01-preview".
webhookUrl	string	URL webhooku používaná pro požadavky na alokaci.

DeviceCapabilities

Objekt

Schopnosti zařízení.

Name	Typ	Default value	Description
iotEdge	boolean	False	Pokud je nastaveno na true, jedná se o IoTEdge zařízení.

DeviceRegistrationState

Objekt

Registrace zařízení ve státě.

Name	Typ	Description
assignedHub	string	Přiřazen Azure IoT Hub.
createdDateTimeUtc	string (date-time)	Registrace – datum vytvoření (v UTC).
deviceId	string	ID zařízení.
errorCode	integer (int32)	Kód chyby
errorMessage	string	Chybová zpráva.
etag	string	Tag entity přiřazený ke zdroji.
lastUpdatedDateTimeUtc	string (date-time)	Poslední aktualizace data a čas (v UTC).
payload		Vlastní alokační payload vrácený z webhooku do zařízení.
registrationId	string	Toto ID se používá k jednoznačné identifikaci registrace zařízení. Řetězec bez velikosti (až 128 znaků dlouhý) alfanumerických znaků plus určitých speciálních znaků : . _ -. Na začátku ani na konci nejsou povoleny žádné speciální postavy.
status	EnrollmentStatus	Stav zápisu.
substatus	AssignedDeviceSubstatus	Podstav pro 'přiřazená' zařízení. Možné hodnoty zahrnují - 'initialAssignment': Zařízení bylo poprvé přiřazeno k IoT hubu, 'deviceDataMigrated': Zařízení bylo přiřazeno k jinému IoT hubu a jeho data byla migrována z dříve přiděleného IoT hubu. Data zařízení byla odstraněna z dříve přiděleného IoT hubu, 'deviceDataReset': Zařízení bylo přiřazeno k jinému IoT hubu a jeho data byla načtena z původního stavu uloženého v registraci. Data zařízení byla odstraněna z dříve přiděleného IoT hubu, 'reprovisionedToInitialAssignment': Zařízení bylo znovu provisionováno do dříve přiděleného IoT hubu.

EnrollmentStatus

Výčet

Stav zápisu.

Hodnota	Description
unassigned	Nepřiřazené
assigning	Přiřazení
assigned	přiřazený
failed	selhalo
disabled	neaktivní

IndividualEnrollment

Objekt

Záznam o registraci zařízení.

Name	Typ	Default value	Description
allocationPolicy	AllocationPolicy		Politika alokace tohoto zdroje. Tato politika přebíjí politiku přidělování na úrovni nájemců pro tuto jednotlivou skupinu zápisů nebo zápisů. Možné hodnoty zahrnují 'hashed': Propojené IoT huby mají stejně pravděpodobně zařízení přidělená k nim, 'geoLatency': Zařízení jsou provisionována na IoT hub s nejnižší latencí zařízení. Pokud by více propojených IoT hubů poskytovalo stejnou nejnižší latenci, provisioning service hashuje zařízení napříč těmito huby, 'statické': Specifikace požadovaného IoT hubu v seznamu pro zápis má přednost před politikou alokace na úrovni služeb, 'custom': Zařízení jsou přiřazována k IoT hubu podle vaší vlastní logiky. Provisioning služba předává informace o zařízení logice, která vrací požadovaný IoT hub i požadovanou počáteční konfiguraci. Doporučujeme používat Azure Functions pro hostování vaší logiky.
attestation	AttestationMechanism		Metoda ověřování používaná zařízením.
capabilities	DeviceCapabilities		Schopnosti zařízení.
createdDateTimeUtc	string (date-time)		DateTime byl tento zdroj vytvořen.
customAllocationDefinition	CustomAllocationDefinition		To DPS říká, který webhook volat při použití vlastní alokace.
deviceId	string		Požadované ID zařízení IoT Hub (volitelné).
etag	string		Tag entity přiřazený ke zdroji.
initialTwin	InitialTwin		Počáteční dvojčato zařízení.
iotHubHostName	string		Název hostitele IoT Hubu.
iotHubs	string[]		Seznam názvů hostitelů IoT hubů, ke kterým lze zařízení v tomto zdroji přiřadit. Musí to být podmnožina seznamu IoT hubů na úrovni tenantů.
lastUpdatedDateTimeUtc	string (date-time)		DateČas tohoto zdroje byl naposledy aktualizován.
optionalDeviceInformation	TwinCollection		Volitelné informace o zařízeních.
provisioningStatus	ProvisioningStatus	enabled	Stav provisioningu.
registrationId	string		Toto ID se používá k jednoznačné identifikaci registrace zařízení. Řetězec bez velikosti (až 128 znaků dlouhý) alfanumerických znaků plus určitých speciálních znaků : . _ -. Na začátku ani na konci nejsou povoleny žádné speciální postavy.
registrationState	DeviceRegistrationState		Aktuální stav registrace.
reprovisionPolicy	ReprovisionPolicy		Chování při opětovném nastavení zařízení na IoT hub.

InitialTwin

Objekt

Počáteční dvojčato zařízení. Obsahuje podmnožinu vlastností Twin.

Name	Typ	Description
properties	InitialTwinProperties	Požadované vlastnosti dvojčete.
tags	TwinCollection	Značky dvojčat.

InitialTwinProperties

Objekt

Představuje počáteční vlastnosti, které budou nastaveny na dvojčeti zařízení.

Name	Typ	Description
desired	TwinCollection	Získá a nastaví požadované vlastnosti InitialTwin.

Metadata

Objekt

Metadata pro TwinCollection

Name	Typ	Description
lastUpdated	string (date-time)	Minule byla TwinCollection aktualizována
lastUpdatedVersion	integer (int32)	To je null pro metadata hlášených vlastností a není null pro metadata požadovaných vlastností.

ProvisioningServiceErrorDetails

Objekt

Obsahuje vlastnosti chyby vrácené službou Azure IoT Hub Provisioning.

Name	Typ	Description
errorCode	integer (int32)	Chybový kód pro operaci.
info	object	Slovník řetězce <>
message	string	Chybová zpráva čitelná pro člověka.
timestampUtc	string (date-time)	UTC časové razítko chyby.
trackingId	string	Sledovací ID chyby.

ProvisioningStatus

Výčet

Stav provisioningu.

Hodnota	Description
enabled	enabled
disabled	neaktivní

ReprovisionPolicy

Objekt

Chování služby při opětovném připojení zařízení do IoT hubu.

Name	Typ	Default value	Description
migrateDeviceData	boolean	True	Pokud je nastaveno na true (výchozí), Device Provisioning Service migruje data zařízení (dvojče, schopnosti zařízení a ID zařízení) z jednoho IoT hubu do druhého během aktualizace přiřazení IoT hubu. Pokud je nastaveno na false, Device Provisioning Service resetuje data zařízení na požadovanou konfiguraci uloženou v příslušném seznamu registrace.
updateHubAssignment	boolean	True	Pokud je nastavena na true (výchozí), Device Provisioning Service vyhodnotí přiřazení IoT hubu zařízení a v případě potřeby jej aktualizuje pro jakékoli požadavky na provisioning z daného zařízení nad rámec prvního. Pokud je nastaveno na false, zařízení zůstane přiřazeno ke svému aktuálnímu IoT uzlu.

SymmetricKeyAttestation

Objekt

Ověření pomocí SymmetricKey.

Name	Typ	Description
primaryKey	string	Primární symetrický klíč.
secondaryKey	string	Sekundární symetrický klíč.

TpmAttestation

Objekt

Ověření přes TPM.

Name	Typ	Description
endorsementKey	string	TPM klíč k schválení.
storageRootKey	string	TPM úložiště root klíč.

TwinCollection

Objekt

Reprezentuje množinu vlastností uvnitř dvojčete

Name	Typ	Description
count	integer (int32)	Počet vlastností v TwinCollection
metadata	Metadata	Metadata pro TwinCollection
version	integer (int32)	Verze TwinCollection

X509Attestation

Objekt

Ověření přes X509.

Name	Typ	Description
caReferences	X509CAReferences	Primární a sekundární CA reference.
clientCertificates	X509Certificates	Primární a sekundární certifikáty
signingCertificates	X509Certificates	Primární a sekundární certifikáty

X509CAReferences

Objekt

Primární a sekundární CA reference.

Name	Typ	Description
primary	string	Hlavní reference v Kalifornii.
secondary	string	Sekundární CA reference.

X509CertificateInfo

Objekt

Informace o certifikátu X509.

Name	Typ	Description
issuerName	string	Název vydavatele certifikátu.
notAfterUtc	string (date-time)	Platnost certifikátu končí (UTC).
notBeforeUtc	string (date-time)	Platnost certifikátu začíná (UTC).
serialNumber	string	Sériové číslo certifikátu.
sha1Thumbprint	string	Otisk palce SHA-1 certifikátu.
sha256Thumbprint	string	Otisk palce SHA-256 na certifikátu.
subjectName	string	Název subjektu certifikátu.
version	integer (int32)	Verze certifikátu.

X509Certificates

Objekt

Primární a sekundární certifikáty

Name	Typ	Description
primary	X509CertificateWithInfo	Informace o certifikátu a certifikátu
secondary	X509CertificateWithInfo	Informace o certifikátu a certifikátu

X509CertificateWithInfo

Objekt

Informace o certifikátu a certifikátu

Name	Typ	Description
certificate	string	Certifikátový řetězec formátovaný PEM.
info	X509CertificateInfo	Informace o certifikátu X509.