Enrollment Group - Run Bulk Operation

Szolgáltatás:

IoT Hub Device Provisioning Service

API-verzió:

2021-10-01

Tömeges eszközregisztrációs csoportművelet legfeljebb 10 csoporttal.

POST https://your-dps.azure-devices-provisioning.net/enrollmentGroups?api-version=2021-10-01

URI-paraméterek

Name	In	Kötelező	Típus	Description
api-version	query	True	string	A kéréshez használandó API-verzió. Támogatott verziók: 2021-10-01

Kérelem törzse

Name	Kötelező	Típus	Description
enrollmentGroups	True	EnrollmentGroup[]	Regisztrációs elemek
mode	True	enum: create update updateIfMatchETag delete	Műveleti mód.

Válaszok

Name	Típus	Description
200 OK	BulkEnrollmentGroupOperationResult	Siker
Other Status Codes	ProvisioningServiceErrorDetails	Hibaválasz Fejlécek x-ms-error-code: string

Definíciók

Name	Description
AttestationMechanism	Az individualEnrollment és a enrollmentGroup igazolási mechanizmusa.
BulkEnrollmentGroupOperation	Tömeges regisztrálási művelet.
BulkEnrollmentGroupOperationError	Tömeges regisztrációs művelettel kapcsolatos hiba.
BulkEnrollmentGroupOperationResult	Tömeges regisztrációs csoportművelet eredményei.
CustomAllocationDefinition	Ez jelzi a DPS-nek, hogy melyik webhookot hívja meg egyéni foglalás használatakor.
DeviceCapabilities	Eszközképességek.
EnrollmentGroup	Regisztrációs csoport rekordja.
InitialTwin	Kezdeti ikereszköz. Az Ikerpéldány tulajdonságainak egy részhalmazát tartalmazza.
InitialTwinProperties	Az ikereszközön beállítandó kezdeti tulajdonságokat jelöli.
Metadata	A TwinCollection metaadatai
ProvisioningServiceErrorDetails	A Azure IoT Hub Provisioning Service által visszaadott hiba tulajdonságait tartalmazza.
ReprovisionPolicy	A szolgáltatás viselkedése, amikor egy eszköz újra ki van építve egy IoT Hubon.
SymmetricKeyAttestation	Igazolás a SymmetricKey használatával.
TpmAttestation	Igazolás TPM-en keresztül.
TwinCollection	Tulajdonságok gyűjteményét jelöli egy 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 a SymmetricKey használatával.
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.

BulkEnrollmentGroupOperation

Tömeges regisztrálási művelet.

Name	Típus	Description
enrollmentGroups	EnrollmentGroup[]	Regisztrációs elemek
mode	enum: create delete update updateIfMatchETag	Műveleti mód.

BulkEnrollmentGroupOperationError

Tömeges regisztrációs művelettel kapcsolatos hiba.

Name	Típus	Description
enrollmentGroupId	string	Regisztrációs csoport azonosítója.
errorCode	integer	Hibakód
errorStatus	string	Hibaállapot.

BulkEnrollmentGroupOperationResult

Tömeges regisztrációs csoportművelet eredményei.

Name	Típus	Description
errors	BulkEnrollmentGroupOperationError[]	Regisztrációs hibák
isSuccessful	boolean	Azt jelzi, hogy a művelet teljes egészében sikeres volt-e.

CustomAllocationDefinition

Ez jelzi a DPS-nek, hogy melyik webhookot hívja meg 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íme.

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.

EnrollmentGroup

Regisztrációs csoport rekordja.

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 a bérlői szintű foglalási szabályzatot ehhez az egyéni regisztrációhoz vagy regisztrációs csoporthoz. 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 "geoLatency" (geoLatency): Az eszközök egy olyan IoT Hubon 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 kivonatot készít az eszközökről az adott központokban: "statikus": 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 ki vannak építve egy IoT Hubra a saját egyéni logikája alapján. A kiépítési szolgáltatás átadja az eszközre vonatkozó információkat a logikának, és a logika visszaadja a kívánt IoT Hubot és a kívánt kezdeti konfigurációt. 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 hívja meg egyéni foglalás használatakor.
enrollmentGroupId	string		Regisztrációs csoport azonosítója.
etag	string		Az erőforráshoz társított entitáscímke.
initialTwin	InitialTwin		Kezdeti ikereszköz. Az Ikerpéldány tulajdonságainak egy részhalmazát tartalmazza.
iotHubHostName	string		Az Iot Hub-gazdagép neve.
iotHubs	string[]		Az erőforrásban lévő eszköz(ek) IoT Hub gazdagépneveinek 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át legutóbb frissítették.
provisioningStatus	enum: disabled enabled	enabled	A kiépítés állapota.
reprovisionPolicy	ReprovisionPolicy		A szolgáltatás viselkedése, amikor egy eszköz újra ki van építve egy IoT Hubon.

InitialTwin

Kezdeti ikereszköz. Az Ikerpéldány tulajdonságainak egy részhalmazát tartalmazza.

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

InitialTwinProperties

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

Name	Típus	Description
desired	TwinCollection	Tulajdonságok gyűjteményét jelöli egy 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 a jelentett tulajdonságok metaadatai esetében null értékű, a kívánt tulajdonságok metaadatainál pedig nem null értékű.

ProvisioningServiceErrorDetails

A Azure IoT Hub Provisioning Service á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 Hubon.

Name	Típus	Alapértelmezett érték	Description
migrateDeviceData	boolean	True	Ha true (alapértelmezett) értékre van állítva, a Device Provisioning Service az IoT Hub-hozzárendelés frissítése során áttelepíti az eszköz adatait (ikerpéldányát, eszközképességeit és eszközazonosítóját) az egyik IoT Hubról a másikra. Ha false (hamis) értékre van állítva, a Device Provisioning Service visszaá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 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 az aktuális IoT Hubhoz.

SymmetricKeyAttestation

Igazolás a SymmetricKey használatával.

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 egy 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.