Enrollment Group - Get
Eszközregisztrációs csoport lekérése.
GET https://your-dps.azure-devices-provisioning.net/enrollmentGroups/{id}?api-version=2021-10-01
URI-paraméterek
Name | In | Kötelező | Típus | Description |
---|---|---|---|---|
id
|
path | True |
string |
Regisztrációs csoport azonosítója. |
api-version
|
query | True |
string |
A kéréshez használni kívánt API-verzió. Támogatott verziók: 2021.10.01. |
Válaszok
Name | Típus | Description |
---|---|---|
200 OK |
Siker |
|
Other Status Codes |
Hibaválasz Fejlécek x-ms-error-code: string |
Definíciók
Name | Description |
---|---|
Attestation |
Az individualEnrollment és a enrollmentGroup igazolási mechanizmusa. |
Custom |
Ez jelzi a DPS-nek, hogy melyik webhookot kell meghívni egyéni foglalás használatakor. |
Device |
Eszközképességek. |
Enrollment |
Regisztrációs csoport rekordja. |
Initial |
Kezdeti ikereszköz. A Twin tulajdonságainak egy részét tartalmazza. |
Initial |
Az ikereszközön beállított kezdeti tulajdonságokat jelöli. |
Metadata |
A TwinCollection metaadatai |
Provisioning |
A Azure IoT Hub kiépítési szolgáltatás által visszaadott hiba tulajdonságait tartalmazza. |
Reprovision |
A szolgáltatás viselkedése, amikor egy eszköz újra ki van építve egy IoT Hubra. |
Symmetric |
Igazolás szimmetrikus kulcson keresztül. |
Tpm |
Igazolás TPM-en keresztül. |
Twin |
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. |
X509Certificate |
X509-tanúsítvány adatai. |
X509Certificates |
Elsődleges és másodlagos tanúsítványok |
X509Certificate |
Tanúsítvány- és tanúsítványadatok |
AttestationMechanism
Az individualEnrollment és a enrollmentGroup igazolási mechanizmusa.
Name | Típus | Description |
---|---|---|
symmetricKey |
Igazolás szimmetrikus kulcson keresztül. |
|
tpm |
Igazolás TPM-en keresztül. |
|
type |
enum:
|
Igazolás típusa. |
x509 |
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. |
EnrollmentGroup
Regisztrációs csoport rekordja.
Name | Típus | Alapértelmezett érték | Description |
---|---|---|---|
allocationPolicy |
enum:
|
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 |
Az individualEnrollment és a enrollmentGroup igazolási mechanizmusa. |
||
capabilities |
Eszközképességek. |
||
createdDateTimeUtc |
string |
Az erőforrás dateTime-jának létrehozása. |
|
customAllocationDefinition |
Ez jelzi a DPS-nek, hogy melyik webhookot kell meghívni 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 |
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. |
|
provisioningStatus |
enum:
|
enabled |
A kiépítés állapota. |
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 |
Az ikereszközön beállított kezdeti tulajdonságokat jelöli. |
|
tags |
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 |
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 |
A TwinCollection metaadatai |
|
version |
integer |
A TwinCollection verziója |
X509Attestation
Igazolás X509-en keresztül.
Name | Típus | Description |
---|---|---|
caReferences |
Elsődleges és másodlagos hitelesítésszolgáltatói hivatkozások. |
|
clientCertificates |
Elsődleges és másodlagos tanúsítványok |
|
signingCertificates |
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 |
Tanúsítvány- és tanúsítványadatok |
|
secondary |
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 |
X509-tanúsítvány adatai. |