Enrollment Group - Query
Fragen Sie die Geräteregistrierungsgruppen ab.
POST https://your-dps.azure-devices-provisioning.net/enrollmentGroups/query?api-version=2021-10-01URI-Parameter
| Name | In | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
api-version
|
query | True |
string |
API-Version, die für die Anforderung verwendet werden soll. Unterstützte Versionen: 2021-10-01 |
Anforderungsheader
| Name | Erforderlich | Typ | Beschreibung |
|---|---|---|---|
| x-ms-max-item-count |
integer int32 |
Page size (Seitengröße) |
|
| x-ms-continuation |
string |
Fortsetzungstoken |
Anforderungstext
| Name | Erforderlich | Typ | Beschreibung |
|---|---|---|---|
| query | True |
string |
Antworten
| Name | Typ | Beschreibung |
|---|---|---|
| 200 OK |
Erfolg Header
|
|
| Other Status Codes |
Fehlerantwort Header x-ms-error-code: string |
Definitionen
| Name | Beschreibung |
|---|---|
|
Attestation |
Nachweismechanismus für individualEnrollment und enrollmentGroup. |
|
Custom |
Dadurch wird DPS mitgeteilt, welcher Webhook aufgerufen werden soll, wenn die benutzerdefinierte Zuordnung verwendet wird. |
|
Device |
Gerätefunktionen. |
|
Enrollment |
Registrierungsgruppendatensatz. |
|
Initial |
Anfänglicher Gerätezwille. Enthält eine Teilmenge der Eigenschaften von Twin. |
|
Initial |
Stellt die anfänglichen Eigenschaften dar, die für den Gerätezwilligen festgelegt werden. |
| Metadata |
Metadaten für die TwinCollection |
|
Provisioning |
Enthält die Eigenschaften eines Fehlers, der vom Azure IoT Hub Provisioning Service zurückgegeben wird. |
|
Query |
|
|
Reprovision |
Das Verhalten des Diensts, wenn ein Gerät erneut für einen IoT Hub bereitgestellt wird. |
|
Symmetric |
Nachweis über SymmetricKey. |
|
Tpm |
Nachweis über TPM. |
|
Twin |
Stellt eine Auflistung von Eigenschaften innerhalb eines Zwillings dar. |
| X509Attestation |
Nachweis über X509. |
| X509CAReferences |
Verweise auf die primäre und sekundäre Zertifizierungsstelle. |
|
X509Certificate |
X509-Zertifikatinformationen. |
| X509Certificates |
Primäre und sekundäre Zertifikate |
|
X509Certificate |
Zertifikat- und Zertifikatinformationen |
AttestationMechanism
Nachweismechanismus für individualEnrollment und enrollmentGroup.
| Name | Typ | Beschreibung |
|---|---|---|
| symmetricKey |
Nachweis über SymmetricKey. |
|
| tpm |
Nachweis über TPM. |
|
| type |
enum:
|
Nachweistyp. |
| x509 |
Nachweis über X509. |
CustomAllocationDefinition
Dadurch wird DPS mitgeteilt, welcher Webhook aufgerufen werden soll, wenn die benutzerdefinierte Zuordnung verwendet wird.
| Name | Typ | Beschreibung |
|---|---|---|
| apiVersion |
string |
Die API-Version der Bereitstellungsdiensttypen (z. B. IndividualEnrollment), die in der benutzerdefinierten Zuordnungsanforderung gesendet werden. Unterstützte Mindestversion: "2018-09-01-preview". |
| webhookUrl |
string |
Die webhook-URL, die für Zuordnungsanforderungen verwendet wird. |
DeviceCapabilities
Gerätefunktionen.
| Name | Typ | Standardwert | Beschreibung |
|---|---|---|---|
| iotEdge |
boolean |
False |
Wenn dieser Wert auf true festgelegt ist, handelt es sich bei diesem Gerät um ein IoTEdge-Gerät. |
EnrollmentGroup
Registrierungsgruppendatensatz.
| Name | Typ | Standardwert | Beschreibung |
|---|---|---|---|
| allocationPolicy |
enum:
|
Die Zuordnungsrichtlinie dieser Ressource. Diese Richtlinie überschreibt die Zuordnungsrichtlinie auf Mandantenebene für diese einzelne Registrierung oder Registrierungsgruppe. Mögliche Werte sind "hashed": Bei verknüpften IoT-Hubs ist es ebenso wahrscheinlich, dass Geräte bereitgestellt werden, "geoLatency": Geräte werden in einem IoT Hub mit der niedrigsten Latenz für das Gerät bereitgestellt. Wenn mehrere verknüpfte IoT-Hubs die gleiche niedrigste Latenz aufweisen würden, hashet der Bereitstellungsdienst Geräte über diese Hubs hinweg, "statisch": Die Spezifikation des gewünschten IoT-Hubs in der Registrierungsliste hat Vorrang vor der Zuweisungsrichtlinie "benutzerdefiniert": Geräte werden auf Der Grundlage Ihrer eigenen benutzerdefinierten Logik in einem IoT-Hub bereitgestellt. Der Bereitstellungsdienst übergibt Informationen zum Gerät an die Logik, und die Logik gibt den gewünschten IoT Hub sowie die gewünschte Erstkonfiguration zurück. Es wird empfohlen, Azure Functions zum Hosten Ihrer Logik zu verwenden. |
|
| attestation |
Nachweismechanismus für individualEnrollment und enrollmentGroup. |
||
| capabilities |
Gerätefunktionen. |
||
| createdDateTimeUtc |
string |
Die DateTime, die diese Ressource erstellt wurde. |
|
| customAllocationDefinition |
Dadurch wird DPS mitgeteilt, welcher Webhook aufgerufen werden soll, wenn die benutzerdefinierte Zuordnung verwendet wird. |
||
| enrollmentGroupId |
string |
Registrierungsgruppen-ID. |
|
| etag |
string |
Das Entitätstag, das der Ressource zugeordnet ist. |
|
| initialTwin |
Anfänglicher Gerätezwille. Enthält eine Teilmenge der Eigenschaften von Twin. |
||
| iotHubHostName |
string |
Der Iot Hub-Hostname. |
|
| iotHubs |
string[] |
Die Liste der IoT Hub Hostnamen, den die Geräte in dieser Ressource zugeordnet werden können. Muss eine Teilmenge der Liste auf Mandantenebene von IoT Hubs sein. |
|
| lastUpdatedDateTimeUtc |
string |
DateTime diese Ressource wurde zuletzt aktualisiert. |
|
| provisioningStatus |
enum:
|
enabled |
Die Bereitstellung status. |
| reprovisionPolicy |
Das Verhalten des Diensts, wenn ein Gerät erneut für einen IoT Hub bereitgestellt wird. |
InitialTwin
Anfänglicher Gerätezwille. Enthält eine Teilmenge der Eigenschaften von Twin.
| Name | Typ | Beschreibung |
|---|---|---|
| properties |
Stellt die anfänglichen Eigenschaften dar, die für den Gerätezwilligen festgelegt werden. |
|
| tags |
Stellt eine Auflistung von Eigenschaften innerhalb eines Zwillings dar. |
InitialTwinProperties
Stellt die anfänglichen Eigenschaften dar, die für den Gerätezwilligen festgelegt werden.
| Name | Typ | Beschreibung |
|---|---|---|
| desired |
Stellt eine Auflistung von Eigenschaften innerhalb eines Zwillings dar. |
Metadata
Metadaten für die TwinCollection
| Name | Typ | Beschreibung |
|---|---|---|
| lastUpdated |
string |
Zeitpunkt der letzten Aktualisierung der TwinCollection |
| lastUpdatedVersion |
integer |
Dies ist null für gemeldete Eigenschaftenmetadaten und nicht NULL für metadaten der gewünschten Eigenschaften. |
ProvisioningServiceErrorDetails
Enthält die Eigenschaften eines Fehlers, der vom Azure IoT Hub Provisioning Service zurückgegeben wird.
| Name | Typ | Beschreibung |
|---|---|---|
| errorCode |
integer |
|
| info |
object |
|
| message |
string |
|
| timestampUtc |
string |
|
| trackingId |
string |
QuerySpecification
| Name | Typ | Beschreibung |
|---|---|---|
| query |
string |
ReprovisionPolicy
Das Verhalten des Diensts, wenn ein Gerät erneut für einen IoT Hub bereitgestellt wird.
| Name | Typ | Standardwert | Beschreibung |
|---|---|---|---|
| migrateDeviceData |
boolean |
True |
Bei Festlegung auf true (Standard) migriert der Device Provisioning-Dienst während eines IoT Hub-Zuweisungsupdates die Gerätedaten (Zwilling, Gerätefunktionen und Geräte-ID) von einem IoT-Hub zu einem anderen. Wenn dieser Wert auf false festgelegt ist, setzt der Device Provisioning-Dienst die Gerätedaten auf die anfängliche gewünschte Konfiguration zurück, die in der entsprechenden Registrierungsliste gespeichert ist. |
| updateHubAssignment |
boolean |
True |
Wenn diese Einstellung auf TRUE (Standard) festgelegt ist, wertet der Device Provisioning-Dienst die IoT Hub Zuweisung des Geräts aus und aktualisiert es bei Bedarf für Bereitstellungsanforderungen, die über die erste von einem bestimmten Gerät hinausgehen. Wenn dieser Wert auf false festgelegt ist, bleibt das Gerät seinem aktuellen IoT Hub zugewiesen. |
SymmetricKeyAttestation
Nachweis über SymmetricKey.
| Name | Typ | Beschreibung |
|---|---|---|
| primaryKey |
string |
Primärer symmetrischer Schlüssel. |
| secondaryKey |
string |
Sekundärer symmetrischer Schlüssel. |
TpmAttestation
Nachweis über TPM.
| Name | Typ | Beschreibung |
|---|---|---|
| endorsementKey |
string |
|
| storageRootKey |
string |
TwinCollection
Stellt eine Auflistung von Eigenschaften innerhalb eines Zwillings dar.
| Name | Typ | Beschreibung |
|---|---|---|
| count |
integer |
Anzahl der Eigenschaften in der TwinCollection |
| metadata |
Metadaten für die TwinCollection |
|
| version |
integer |
Version der TwinCollection |
X509Attestation
Nachweis über X509.
| Name | Typ | Beschreibung |
|---|---|---|
| caReferences |
Verweise auf die primäre und sekundäre Zertifizierungsstelle. |
|
| clientCertificates |
Primäre und sekundäre Zertifikate |
|
| signingCertificates |
Primäre und sekundäre Zertifikate |
X509CAReferences
Verweise auf die primäre und sekundäre Zertifizierungsstelle.
| Name | Typ | Beschreibung |
|---|---|---|
| primary |
string |
|
| secondary |
string |
X509CertificateInfo
X509-Zertifikatinformationen.
| Name | Typ | Beschreibung |
|---|---|---|
| issuerName |
string |
|
| notAfterUtc |
string |
|
| notBeforeUtc |
string |
|
| serialNumber |
string |
|
| sha1Thumbprint |
string |
|
| sha256Thumbprint |
string |
|
| subjectName |
string |
|
| version |
integer |
X509Certificates
Primäre und sekundäre Zertifikate
| Name | Typ | Beschreibung |
|---|---|---|
| primary |
Zertifikat- und Zertifikatinformationen |
|
| secondary |
Zertifikat- und Zertifikatinformationen |
X509CertificateWithInfo
Zertifikat- und Zertifikatinformationen
| Name | Typ | Beschreibung |
|---|---|---|
| certificate |
string |
|
| info |
X509-Zertifikatinformationen. |