Individual Enrollment - Create Or Update

Service:

IoT Hub Device Provisioning Service

API Version:

2021-10-01

Létrehozás vagy frissítsen egy eszközregisztrációs rekordot.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
id	path	True	string	Ez az azonosító egy regisztráció eszközregisztrációjának egyedi azonosítására szolgál. Kis- és nagybetűk megkülönböztetése (legfeljebb 128 karakter hosszú) alfanumerikus karakterekből és bizonyos speciális karakterekből: . _ -. A kezdéskor és a végén nem engedélyezett speciális karakterek használata.
api-version	query	True	string	A kéréshez használni kívánt API-verzió. Támogatott verziók: 2021.10.01.

Kérelem fejléce

Name	Kötelező	Típus	Description
If-Match		string	A regisztrációs rekord ETagje.

Kérelem törzse

Name	Kötelező	Típus	Description
attestation	True	AttestationMechanism	Az individualEnrollment és a enrollmentGroup igazolási mechanizmusa.
registrationId	True	string	Ez az azonosító egy regisztráció eszközregisztrációjának egyedi azonosítására szolgál. Kis- és nagybetűk megkülönböztetése (legfeljebb 128 karakter hosszú) alfanumerikus karakterekből és bizonyos speciális karakterekből: . _ -. A kezdéskor és a végén nem engedélyezett speciális karakterek használata.
allocationPolicy		enum: hashed geoLatency static custom	Az erőforrás foglalási szabályzata. Ez a szabályzat felülbírálja az egyéni regisztrációs vagy regisztrációs csoport bérlői szintű foglalási szabályzatát. A lehetséges értékek közé tartozik a "kivonatolt" kifejezés: A csatolt IoT Hubok ugyanolyan valószínűséggel rendelkeznek az eszközök kiépítésével, mint a geolatenciával: Az eszközök egy olyan IoT Hubra vannak kiépítve, amely a legalacsonyabb késéssel rendelkezik az eszközön. Ha több csatolt IoT Hub is ugyanazt a legalacsonyabb késést nyújtaná, a kiépítési szolgáltatás az eszközöket az adott központokban "static" (statikus) kivonatokkal nyitja meg: A regisztrációs listában a kívánt IoT Hub specifikációja elsőbbséget élvez a szolgáltatásszintű kiosztási szabályzattal szemben( "egyéni": Az eszközök egy IoT Hubra vannak kiépítve a saját egyéni logikája alapján. A kiépítési szolgáltatás átadja az eszköz adatait a logikának, és a logika a kívánt IoT Hubot és a kívánt kezdeti konfigurációt adja vissza. Javasoljuk, hogy használja a Azure Functions a logika üzemeltetéséhez.
capabilities		DeviceCapabilities	Eszközképességek.
customAllocationDefinition		CustomAllocationDefinition	Ez jelzi a DPS-nek, hogy melyik webhookot kell meghívni egyéni foglalás használatakor.
deviceId		string	Kívánt IoT Hub eszközazonosító (nem kötelező).
etag		string	Az erőforráshoz társított entitáscímke.
initialTwin		InitialTwin	Kezdeti ikereszköz. A Twin tulajdonságainak egy részét tartalmazza.
iotHubHostName		string	Az Iot Hub állomásneve.
iotHubs		string[]	Az erőforrásban található eszköz(ek) IoT Hub gazdagépnevek listája lefoglalható. Az IoT Hubok bérlői szintű listájának részhalmazának kell lennie.
optionalDeviceInformation		TwinCollection	Tulajdonságok gyűjteményét jelöli az ikerpéldányon belül
provisioningStatus		enum: enabled disabled	A kiépítés állapota.
registrationState		DeviceRegistrationState	Eszközregisztrációs állapot.
reprovisionPolicy		ReprovisionPolicy	A szolgáltatás viselkedése, amikor egy eszköz újra ki van építve egy IoT Hubra.

Válaszok

Name	Típus	Description
200 OK	IndividualEnrollment	Siker
Other Status Codes	ProvisioningServiceErrorDetails	Hibaválasz Headers x-ms-error-code: string

Definíciók

Name	Description
AttestationMechanism	Az individualEnrollment és a enrollmentGroup igazolási mechanizmusa.
CustomAllocationDefinition	Ez jelzi a DPS-nek, hogy melyik webhookot kell meghívni egyéni foglalás használatakor.
DeviceCapabilities	Eszközképességek.
DeviceRegistrationState	Eszközregisztrációs állapot.
IndividualEnrollment	Az eszközregisztrációs rekord.
InitialTwin	Kezdeti ikereszköz. A Twin tulajdonságainak egy részét tartalmazza.
InitialTwinProperties	Az ikereszközön beállított kezdeti tulajdonságokat jelöli.
Metadata	A TwinCollection metaadatai
ProvisioningServiceErrorDetails	A Azure IoT Hub kiépítési szolgáltatás által visszaadott hiba tulajdonságait tartalmazza.
ReprovisionPolicy	A szolgáltatás viselkedése, amikor egy eszköz újra ki van építve egy IoT Hubra.
SymmetricKeyAttestation	Igazolás szimmetrikus kulcson keresztül.
TpmAttestation	Igazolás TPM-en keresztül.
TwinCollection	Tulajdonságok gyűjteményét jelöli az ikerpéldányon belül
X509Attestation	Igazolás X509-en keresztül.
X509CAReferences	Elsődleges és másodlagos hitelesítésszolgáltatói hivatkozások.
X509CertificateInfo	X509-tanúsítvány adatai.
X509Certificates	Elsődleges és másodlagos tanúsítványok
X509CertificateWithInfo	Tanúsítvány- és tanúsítványadatok

AttestationMechanism

Az individualEnrollment és a enrollmentGroup igazolási mechanizmusa.

Name	Típus	Description
symmetricKey	SymmetricKeyAttestation	Igazolás szimmetrikus kulcson keresztül.
tpm	TpmAttestation	Igazolás TPM-en keresztül.
type	enum: none symmetricKey tpm x509	Igazolás típusa.
x509	X509Attestation	Igazolás X509-en keresztül.

CustomAllocationDefinition

Ez jelzi a DPS-nek, hogy melyik webhookot kell meghívni egyéni foglalás használatakor.

Name	Típus	Description
apiVersion	string	Az egyéni foglalási kérelemben elküldött kiépítési szolgáltatástípusok (például IndividualEnrollment) API-verziója. Minimálisan támogatott verzió: "2018-09-01-preview".
webhookUrl	string	A foglalási kérelmekhez használt webhook URL-cím.

DeviceCapabilities

Eszközképességek.

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

DeviceRegistrationState

Eszközregisztrációs állapot.

Name	Típus	Description
assignedHub	string	Hozzárendelt Azure IoT Hub.
createdDateTimeUtc	string	A regisztráció dátum-létrehozási időpontja (UTC-ben).
deviceId	string	Eszközazonosító.
errorCode	integer	Hibakód.
errorMessage	string	Hibaüzenet.
etag	string	Az erőforráshoz társított entitáscímke.
lastUpdatedDateTimeUtc	string	Utolsó frissítés dátuma (UTC-ben).
payload	object
registrationId	string	Ez az azonosító egy regisztráció eszközregisztrációjának egyedi azonosítására szolgál. Kis- és nagybetűk megkülönböztetése (legfeljebb 128 karakter hosszú) alfanumerikus karakterekből és bizonyos speciális karakterekből: . _ -. A kezdéskor és a végén nem engedélyezett speciális karakterek használata.
status	enum: assigned assigning disabled failed unassigned	Regisztráció állapota.
substatus	enum: deviceDataMigrated deviceDataReset initialAssignment reprovisionedToInitialAssignment	"Hozzárendelt" eszközök alállapota. Lehetséges értékek: - 'initialAssignment': Az eszköz első alkalommal lett hozzárendelve egy IoT Hubhoz(deviceDataMigrated): Az eszköz egy másik IoT Hubhoz lett hozzárendelve, és az eszköz adatai át lettek migrálva a korábban hozzárendelt IoT Hubról. Az eszközadatok el lettek távolítva a korábban hozzárendelt IoT Hubból( deviceDataReset): Az eszköz egy másik IoT Hubhoz lett hozzárendelve, és az eszköz adatai a regisztrációban tárolt kezdeti állapotból lettek feltöltve. Az eszköz adatai el lettek távolítva a korábban hozzárendelt IoT Hubról, a "reprovisionedToInitialAssignment" szolgáltatásból: Az eszközt újra kiépítették egy korábban hozzárendelt IoT Hubra.

IndividualEnrollment

Az eszközregisztrációs rekord.

Name	Típus	Alapértelmezett érték	Description
allocationPolicy	enum: custom geoLatency hashed static		Az erőforrás foglalási szabályzata. Ez a szabályzat felülbírálja az egyéni regisztrációs vagy regisztrációs csoport bérlői szintű foglalási szabályzatát. A lehetséges értékek közé tartozik a "kivonatolt" kifejezés: A csatolt IoT Hubok ugyanolyan valószínűséggel rendelkeznek az eszközök kiépítésével, mint a geolatenciával: Az eszközök egy olyan IoT Hubra vannak kiépítve, amely a legalacsonyabb késéssel rendelkezik az eszközön. Ha több csatolt IoT Hub is ugyanazt a legalacsonyabb késést nyújtaná, a kiépítési szolgáltatás az eszközöket az adott központokban "static" (statikus) kivonatokkal nyitja meg: A regisztrációs listában a kívánt IoT Hub specifikációja elsőbbséget élvez a szolgáltatásszintű kiosztási szabályzattal szemben( "egyéni": Az eszközök egy IoT Hubra vannak kiépítve a saját egyéni logikája alapján. A kiépítési szolgáltatás átadja az eszköz adatait a logikának, és a logika a kívánt IoT Hubot és a kívánt kezdeti konfigurációt adja vissza. Javasoljuk, hogy használja a Azure Functions a logika üzemeltetéséhez.
attestation	AttestationMechanism		Az individualEnrollment és a enrollmentGroup igazolási mechanizmusa.
capabilities	DeviceCapabilities		Eszközképességek.
createdDateTimeUtc	string		Az erőforrás dateTime-jának létrehozása.
customAllocationDefinition	CustomAllocationDefinition		Ez jelzi a DPS-nek, hogy melyik webhookot kell meghívni egyéni foglalás használatakor.
deviceId	string		Kívánt IoT Hub eszközazonosító (nem kötelező).
etag	string		Az erőforráshoz társított entitáscímke.
initialTwin	InitialTwin		Kezdeti ikereszköz. A Twin tulajdonságainak egy részét tartalmazza.
iotHubHostName	string		Az Iot Hub állomásneve.
iotHubs	string[]		Az erőforrásban található eszköz(ek) IoT Hub gazdagépnevek listája lefoglalható. Az IoT Hubok bérlői szintű listájának részhalmazának kell lennie.
lastUpdatedDateTimeUtc	string		Az erőforrás DateTime-jának legutóbbi frissítése.
optionalDeviceInformation	TwinCollection		Tulajdonságok gyűjteményét jelöli az ikerpéldányon belül
provisioningStatus	enum: disabled enabled	enabled	A kiépítés állapota.
registrationId	string		Ez az azonosító egy regisztráció eszközregisztrációjának egyedi azonosítására szolgál. Kis- és nagybetűk megkülönböztetése (legfeljebb 128 karakter hosszú) alfanumerikus karakterekből és bizonyos speciális karakterekből: . _ -. A kezdéskor és a végén nem engedélyezett speciális karakterek használata.
registrationState	DeviceRegistrationState		Eszközregisztrációs állapot.
reprovisionPolicy	ReprovisionPolicy		A szolgáltatás viselkedése, amikor egy eszköz újra ki van építve egy IoT Hubra.

InitialTwin

Kezdeti ikereszköz. A Twin tulajdonságainak egy részét tartalmazza.

Name	Típus	Description
properties	InitialTwinProperties	Az ikereszközön beállított kezdeti tulajdonságokat jelöli.
tags	TwinCollection	Tulajdonságok gyűjteményét jelöli az ikerpéldányon belül

InitialTwinProperties

Az ikereszközön beállított kezdeti tulajdonságokat jelöli.

Name	Típus	Description
desired	TwinCollection	Tulajdonságok gyűjteményét jelöli az ikerpéldányon belül

Metadata

A TwinCollection metaadatai

Name	Típus	Description
lastUpdated	string	A TwinCollection legutóbbi frissítésének időpontja
lastUpdatedVersion	integer	Ez null értékű a jelentett tulajdonságok metaadatainál, és nem null a kívánt tulajdonságok metaadatainál.

ProvisioningServiceErrorDetails

A Azure IoT Hub kiépítési szolgáltatás által visszaadott hiba tulajdonságait tartalmazza.

Name	Típus	Description
errorCode	integer
info	object
message	string
timestampUtc	string
trackingId	string

ReprovisionPolicy

A szolgáltatás viselkedése, amikor egy eszköz újra ki van építve egy IoT Hubra.

Name	Típus	Alapértelmezett érték	Description
migrateDeviceData	boolean	True	Ha igaz (alapértelmezett) értékre van állítva, a Device Provisioning Service az IoT Hub-hozzárendelés frissítése során az eszköz adatait (ikerpéldányt, eszközképességeket és eszközazonosítót) migrálja egyik IoT Hubról a másikra. Ha false (hamis) értékre van állítva, a Device Provisioning Service alaphelyzetbe állítja az eszköz adatait a megfelelő regisztrációs listában tárolt kezdeti kívánt konfigurációra.
updateHubAssignment	boolean	True	Ha igaz (alapértelmezett) értékre van állítva, a Device Provisioning Service kiértékeli az eszköz IoT Hub hozzárendelését, és szükség esetén frissíti azt az adott eszközről az elsőn túli kiépítési kérésekhez. Ha false (hamis) értékre van állítva, az eszköz továbbra is hozzá lesz rendelve a jelenlegi IoT Hubhoz.

SymmetricKeyAttestation

Igazolás szimmetrikus kulcson keresztül.

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

TpmAttestation

Igazolás TPM-en keresztül.

Name	Típus	Description
endorsementKey	string
storageRootKey	string

TwinCollection

Tulajdonságok gyűjteményét jelöli az ikerpéldányon belül

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

X509Attestation

Igazolás X509-en keresztül.

Name	Típus	Description
caReferences	X509CAReferences	Elsődleges és másodlagos hitelesítésszolgáltatói hivatkozások.
clientCertificates	X509Certificates	Elsődleges és másodlagos tanúsítványok
signingCertificates	X509Certificates	Elsődleges és másodlagos tanúsítványok

X509CAReferences

Elsődleges és másodlagos hitelesítésszolgáltatói hivatkozások.

Name	Típus	Description
primary	string
secondary	string

X509CertificateInfo

X509-tanúsítvány adatai.

Name	Típus	Description
issuerName	string
notAfterUtc	string
notBeforeUtc	string
serialNumber	string
sha1Thumbprint	string
sha256Thumbprint	string
subjectName	string
version	integer

X509Certificates

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

Name	Típus	Description
primary	X509CertificateWithInfo	Tanúsítvány- és tanúsítványadatok
secondary	X509CertificateWithInfo	Tanúsítvány- és tanúsítványadatok

X509CertificateWithInfo

Tanúsítvány- és tanúsítványadatok

Name	Típus	Description
certificate	string
info	X509CertificateInfo	X509-tanúsítvány adatai.