Sdílet prostřednictvím

Enrollment Group - Query

  • Reference
Služba:
IoT Hub Device Provisioning Service
Verze rozhraní API:
2021-10-01

Zadejte dotaz na skupiny registrace zařízení.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
api-version
 query True

string

Verze rozhraní API, která se má použít pro požadavek. Mezi podporované verze patří: 10. 10. 2021

Hlavička požadavku

Name Vyžadováno Typ Description
x-ms-max-item-count

integer (int32)

Velikost stránky
x-ms-continuation

string

Token pokračování

Text požadavku

Name Vyžadováno Typ Description
query True

string

Odpovědi

Name Typ Description
200 OK

EnrollmentGroup[]

Úspěch

Hlavičky

  • x-ms-continuation: string
  • x-ms-max-item-count: integer
  • x-ms-item-type: string
Other Status Codes

ProvisioningServiceErrorDetails

Chybová odpověď

Hlavičky

x-ms-error-code: string

Definice

Name Description
AttestationMechanism

Mechanismus ověření identity pro individualEnrollment i enrollmentGroup.
CustomAllocationDefinition

To službě DPS řekne, který webhook má volat při použití vlastního přidělení.
DeviceCapabilities

Možnosti zařízení.
EnrollmentGroup

Záznam skupiny registrací
InitialTwin

Počáteční dvojče zařízení Obsahuje podmnožinu vlastností dvojčete.
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.
QuerySpecification
ReprovisionPolicy

Chování služby při opětovném zřízení zařízení v centru IoT.
SymmetricKeyAttestation

Ověření identity prostřednictvím symetrického klíče.
TpmAttestation

Ověření identity prostřednictvím čipu TPM.
TwinCollection

Představuje kolekci vlastností v rámci dvojčete.
X509Attestation

Ověření identity prostřednictvím X509.
X509CAReferences

Odkazy na primární a sekundární certifikační autoritu.
X509CertificateInfo

Informace o certifikátu X509
X509Certificates

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

Informace o certifikátu a certifikátu

AttestationMechanism

Objekt

Mechanismus ověření identity pro individualEnrollment i enrollmentGroup.

Name Typ Description
symmetricKey

SymmetricKeyAttestation

Ověření identity prostřednictvím symetrického klíče.
tpm

TpmAttestation

Ověření identity prostřednictvím čipu TPM.
type enum:
  • none
  • symmetricKey
  • tpm
  • x509

Typ ověření identity.
x509

X509Attestation

Ověření identity prostřednictvím X509.

CustomAllocationDefinition

Objekt

To službě DPS řekne, který webhook má volat při použití vlastního přidělení.

Name Typ Description
apiVersion

string

minLength: 1

Verze rozhraní API pro typy služeb zřizování (například IndividualEnrollment) odeslaná v požadavku na vlastní přidělení. Minimální podporovaná verze: 2018-09-01-preview
webhookUrl

string

minLength: 1

Adresa URL webhooku používaná pro žádosti o přidělení.

DeviceCapabilities

Objekt

Možnosti zařízení.

Name Typ Default value Description
iotEdge

boolean

False

Pokud je nastavená hodnota true, jedná se o zařízení IoTEdge.

EnrollmentGroup

Objekt

Záznam skupiny registrací

Name Typ Default value Description
allocationPolicy enum:
  • custom
  • geoLatency
  • hashed
  • static

Zásady přidělování tohoto prostředku. Tato zásada přepíše zásady přidělování na úrovni tenanta pro tuto jednotlivou registraci nebo skupinu registrací. Mezi možné hodnoty patří hashované: Propojené ioT huby mají stejnou pravděpodobnost, že se jim zařízení zřídí, "geoLatency": Zařízení se zřídí pro centrum IoT s nejnižší latencí zařízení. Pokud by několik propojených center IoT poskytovalo stejnou nejnižší latenci, zřizovací služba hashuje zařízení v těchto centrech statická: Specifikace požadovaného centra IoT v seznamu registrací má přednost před zásadami přidělování na úrovni služby, vlastní: Zařízení se zřídí pro centrum IoT na základě vlastní logiky. Služba zřizování předává informace o zařízení do logiky a logika vrátí požadované centrum IoT a požadovanou počáteční konfiguraci. K hostování logiky doporučujeme použít Azure Functions.
attestation

AttestationMechanism

Mechanismus ověření identity pro individualEnrollment i enrollmentGroup.
capabilities

DeviceCapabilities

Možnosti zařízení.
createdDateTimeUtc

string (date-time)

Datum a čas vytvoření tohoto prostředku.
customAllocationDefinition

CustomAllocationDefinition

To službě DPS řekne, který webhook má volat při použití vlastního přidělení.
enrollmentGroupId

string

minLength: 1

ID skupiny registrací.
etag

string

Značka entity přidružená k prostředku.
initialTwin

InitialTwin

Počáteční dvojče zařízení Obsahuje podmnožinu vlastností dvojčete.
iotHubHostName

string

Název hostitele iot Hubu.
iotHubs

string[]

Seznam názvů hostitelů služby IoT Hub, ke které se zařízení v tomto prostředku přidělují. Musí se jednat o podmnožinu seznamu úrovní tenanta center IoT.
lastUpdatedDateTimeUtc

string (date-time)

Datum a čas, kdy byl tento prostředek naposledy aktualizován.
provisioningStatus enum:
  • disabled
  • enabled
enabled

Stav zřizování.
reprovisionPolicy

ReprovisionPolicy

Chování služby při opětovném zřízení zařízení v centru IoT.

InitialTwin

Objekt

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

Name Typ Description
properties

InitialTwinProperties

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

TwinCollection

Představuje kolekci vlastností v rámci dvojčete.

InitialTwinProperties

Objekt

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

Name Typ Description
desired

TwinCollection

Představuje kolekci vlastností v rámci dvojčete.

Metadata

Objekt

Metadata pro TwinCollection

Name Typ Description
lastUpdated

string (date-time)

Čas poslední aktualizace TwinCollection
lastUpdatedVersion

integer (int64)

Tato hodnota je null pro metadata ohláš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)

info

object

message

string

timestampUtc

string (date-time)

trackingId

string

QuerySpecification

Objekt
Name Typ Description
query

string

ReprovisionPolicy

Objekt

Chování služby při opětovném zřízení zařízení v centru IoT.

Name Typ Default value Description
migrateDeviceData

boolean

True

Když nastavíte hodnotu true (výchozí), služba Device Provisioning migruje data zařízení (dvojče, možnosti zařízení a ID zařízení) z jednoho centra IoT do jiného během aktualizace přiřazení centra IoT. Pokud je nastavená hodnota false, služba Device Provisioning obnoví data zařízení na počáteční požadovanou konfiguraci uloženou v odpovídajícím seznamu registrací.
updateHubAssignment

boolean

True

Pokud je nastavená hodnota true (výchozí), služba Device Provisioning vyhodnotí přiřazení ioT Hubu zařízení a v případě potřeby ho aktualizuje pro všechny požadavky zřizování nad rámec prvního zařízení. Pokud je nastavená hodnota false, zařízení zůstane přiřazené k aktuálnímu centru IoT.

SymmetricKeyAttestation

Objekt

Ověření identity prostřednictvím symetrického klíče.

Name Typ Description
primaryKey

string

Primární symetrický klíč.
secondaryKey

string

Sekundární symetrický klíč.

TpmAttestation

Objekt

Ověření identity prostřednictvím čipu TPM.

Name Typ Description
endorsementKey

string

storageRootKey

string

TwinCollection

Objekt

Představuje kolekci vlastností v rámci dvojčete.

Name Typ Description
count

integer

Počet vlastností v TwinCollection
metadata

Metadata

Metadata pro TwinCollection
version

integer (int64)

Verze TwinCollection

X509Attestation

Objekt

Ověření identity prostřednictvím X509.

Name Typ Description
caReferences

X509CAReferences

Odkazy na primární a sekundární certifikační autoritu.
clientCertificates

X509Certificates

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

X509Certificates

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

X509CAReferences

Objekt

Odkazy na primární a sekundární certifikační autoritu.

Name Typ Description
primary

string

secondary

string

X509CertificateInfo

Objekt

Informace o certifikátu X509

Name Typ Description
issuerName

string

notAfterUtc

string (date-time)

notBeforeUtc

string (date-time)

serialNumber

string

sha1Thumbprint

string

sha256Thumbprint

string

subjectName

string

version

integer (int32)

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

info

X509CertificateInfo

Informace o certifikátu X509