Megosztás a következőn keresztül:

Enrollment Group - Query

  • Referencia
Szolgáltatás:
IoT Hub Device Provisioning Service
API-verzió:
2021-10-01

Az eszközregisztrációs csoportok lekérdezése.

POST https://your-dps.azure-devices-provisioning.net/enrollmentGroups/query?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álni kívánt API-verzió. Támogatott verziók: 2021-10-01

Kérelem fejléce

Name Kötelező Típus Description
x-ms-max-item-count

integer (int32)

Oldalméret
x-ms-continuation

string

Folytatási jogkivonat

Kérelem törzse

Name Kötelező Típus Description
query True

string

Válaszok

Name Típus Description
200 OK

EnrollmentGroup[]

Siker

Fejlécek

  • x-ms-continuation: string
  • x-ms-max-item-count: integer
  • x-ms-item-type: string
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.
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észét tartalmazza.
InitialTwinProperties

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

A TwinCollection metaadatai
ProvisioningServiceErrorDetails

Az Azure IoT Hub Provisioning Service által visszaadott hiba tulajdonságait tartalmazza.
QuerySpecification
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 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

Objektum

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.

CustomAllocationDefinition

Objektum

Ez jelzi a DPS-nek, hogy melyik webhookot hívja meg egyéni foglalás használatakor.

Name Típus Description
apiVersion

string

minLength: 1

Az egyéni foglalási kérelemben küldött kiépítési szolgáltatástípusok (például IndividualEnrollment) API-verziója. Minimális támogatott verzió: "2018-09-01-preview".
webhookUrl

string

minLength: 1

A foglalási kérelmekhez használt webhook URL-címe.

DeviceCapabilities

Objektum

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

Objektum

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 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": A csatolt IoT Hubok ugyanolyan valószínűséggel rendelkeznek az eszközök kiépítésével, "geoLatency" (geoLatency): Az eszközök egy IoT Hubra vannak kiépítve, amely a legkisebb késéssel rendelkezik az eszköz számára. Ha több társított 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özpontok között kivonatolva (statikus): A regisztrációs listában szereplő kívánt IoT Hub specifikációja elsőbbséget élvez a szolgáltatásszintű foglalási szabályzattal szemben, amely "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ö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 az Azure Functions használatával üzemeltetje a logikát.
attestation

AttestationMechanism

Az individualEnrollment és a enrollmentGroup igazolási mechanizmusa.
capabilities

DeviceCapabilities

Eszközképességek.
createdDateTimeUtc

string (date-time)

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

minLength: 1

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észét tartalmazza.
iotHubHostName

string

Az Iot Hub állomásneve.
iotHubs

string[]

Az erőforrásban lévő eszköz(ek) IoT Hub-gazdagépeinek listája lefoglalható. Az IoT Hubok bérlői szintű listájának egy részhalmazának kell lennie.
lastUpdatedDateTimeUtc

string (date-time)

Az erőforrás DateTime-jának legutóbbi frissítése.
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

Objektum

Kezdeti ikereszköz. Az Ikerpéldány 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

Objektum

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

Objektum

A TwinCollection metaadatai

Name Típus Description
lastUpdated

string (date-time)

A TwinCollection legutóbbi frissítésének időpontja
lastUpdatedVersion

integer (int64)

Ez null értékű a jelentett tulajdonságok metaadatainál, és nem null a kívánt tulajdonságok metaadatainál.

ProvisioningServiceErrorDetails

Objektum

Az Azure IoT Hub Provisioning Service által visszaadott hiba tulajdonságait tartalmazza.

Name Típus Description
errorCode

integer (int32)

info

object

message

string

timestampUtc

string (date-time)

trackingId

string

QuerySpecification

Objektum
Name Típus Description
query

string

ReprovisionPolicy

Objektum

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 igaz (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, eszközképességek és eszközazonosító) az egyik IoT Hubról a másikra. Ha 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 azt az adott eszközről az elsőn túli kiépítési kérelmekhez. Ha hamis értékre van állítva, az eszköz a jelenlegi IoT Hubhoz lesz rendelve.

SymmetricKeyAttestation

Objektum

Igazolás a SymmetricKey használatával.

Name Típus Description
primaryKey

string

Elsődleges szimmetrikus kulcs.
secondaryKey

string

Másodlagos szimmetrikus kulcs.

TpmAttestation

Objektum

Igazolás TPM-en keresztül.

Name Típus Description
endorsementKey

string

storageRootKey

string

TwinCollection

Objektum

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 (int64)

A TwinCollection verziója

X509Attestation

Objektum

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

Objektum

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

Name Típus Description
primary

string

secondary

string

X509CertificateInfo

Objektum

X509-tanúsítvány adatai.

Name Típus Description
issuerName

string

notAfterUtc

string (date-time)

notBeforeUtc

string (date-time)

serialNumber

string

sha1Thumbprint

string

sha256Thumbprint

string

subjectName

string

version

integer (int32)

X509Certificates

Objektum

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

Objektum

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

Name Típus Description
certificate

string

info

X509CertificateInfo

X509-tanúsítvány adatai.