Individual Enrollment - Query

Dienst:

IoT Hub Device Provisioning Service

API-Version:

2021-10-01

Fragen Sie die Geräteregistrierungsdatensätze ab.

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

URI-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	IndividualEnrollment[]	Erfolg Header x-ms-continuation: string x-ms-max-item-count: integer x-ms-item-type: string
Other Status Codes	ProvisioningServiceErrorDetails	Fehlerantwort Header x-ms-error-code: string

Definitionen

Name	Beschreibung
AttestationMechanism	Nachweismechanismus für individualEnrollment und enrollmentGroup.
CustomAllocationDefinition	Dadurch wird DPS mitgeteilt, welcher Webhook aufgerufen werden soll, wenn die benutzerdefinierte Zuordnung verwendet wird.
DeviceCapabilities	Gerätefunktionen.
DeviceRegistrationState	Geräteregistrierungsstatus.
IndividualEnrollment	Der Geräteregistrierungsdatensatz.
InitialTwin	Anfänglicher Gerätezwille. Enthält eine Teilmenge der Eigenschaften von Twin.
InitialTwinProperties	Stellt die anfänglichen Eigenschaften dar, die für den Gerätezwilligen festgelegt werden.
Metadata	Metadaten für die TwinCollection
ProvisioningServiceErrorDetails	Enthält die Eigenschaften eines Fehlers, der vom Azure IoT Hub Provisioning Service zurückgegeben wird.
QuerySpecification
ReprovisionPolicy	Das Verhalten des Diensts, wenn ein Gerät erneut für einen IoT Hub bereitgestellt wird.
SymmetricKeyAttestation	Nachweis über SymmetricKey.
TpmAttestation	Nachweis über TPM.
TwinCollection	Stellt eine Auflistung von Eigenschaften innerhalb eines Zwillings dar.
X509Attestation	Nachweis über X509.
X509CAReferences	Verweise auf die primäre und sekundäre Zertifizierungsstelle.
X509CertificateInfo	X509-Zertifikatinformationen.
X509Certificates	Primäre und sekundäre Zertifikate
X509CertificateWithInfo	Zertifikat- und Zertifikatinformationen

AttestationMechanism

Nachweismechanismus für individualEnrollment und enrollmentGroup.

Name	Typ	Beschreibung
symmetricKey	SymmetricKeyAttestation	Nachweis über SymmetricKey.
tpm	TpmAttestation	Nachweis über TPM.
type	enum: none symmetricKey tpm x509	Nachweistyp.
x509	X509Attestation	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.

DeviceRegistrationState

Geräteregistrierungsstatus.

Name	Typ	Beschreibung
assignedHub	string	Zugewiesene Azure IoT Hub.
createdDateTimeUtc	string	Erstellungsdatum der Registrierung (in UTC).
deviceId	string	Geräte-ID.
errorCode	integer	Fehlercode
errorMessage	string	Fehlermeldung.
etag	string	Das Entitätstag, das der Ressource zugeordnet ist.
lastUpdatedDateTimeUtc	string	Datum der letzten Aktualisierung (in UTC).
payload	object
registrationId	string	Diese ID wird verwendet, um eine Geräteregistrierung einer Registrierung eindeutig zu identifizieren. Eine Zeichenfolge ohne Berücksichtigung der Groß-/Kleinschreibung (bis zu 128 Zeichen) mit alphanumerischen Zeichen plus bestimmten Sonderzeichen : . _ -. Am Anfang oder Ende sind keine Sonderzeichen zulässig.
status	enum: assigned assigning disabled failed unassigned	Registrierungs-status.
substatus	enum: deviceDataMigrated deviceDataReset initialAssignment reprovisionedToInitialAssignment	Unterstatus für "Zugewiesene" Geräte. Mögliche Werte sind : "initialAssignment": Das Gerät wurde zum ersten Mal einem IoT-Hub zugewiesen, "deviceDataMigrated": Das Gerät wurde einem anderen IoT-Hub zugewiesen, und seine Gerätedaten wurden vom zuvor zugewiesenen IoT Hub migriert. Gerätedaten wurden aus dem zuvor zugewiesenen IoT-Hub "deviceDataReset" entfernt: Das Gerät wurde einem anderen IoT-Hub zugewiesen, und die Gerätedaten wurden aus dem ursprünglichen Zustand aufgefüllt, der in der Registrierung gespeichert wurde. Gerätedaten wurden aus dem zuvor zugewiesenen IoT-Hub "reprovisionedToInitialAssignment" entfernt: Das Gerät wurde für einen zuvor zugewiesenen IoT Hub erneut bereitgestellt.

IndividualEnrollment

Der Geräteregistrierungsdatensatz.

Name	Typ	Standardwert	Beschreibung
allocationPolicy	enum: custom geoLatency hashed static		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	AttestationMechanism		Nachweismechanismus für individualEnrollment und enrollmentGroup.
capabilities	DeviceCapabilities		Gerätefunktionen.
createdDateTimeUtc	string		Die DateTime, die diese Ressource erstellt wurde.
customAllocationDefinition	CustomAllocationDefinition		Dadurch wird DPS mitgeteilt, welcher Webhook aufgerufen werden soll, wenn die benutzerdefinierte Zuordnung verwendet wird.
deviceId	string		Gewünschte IoT Hub Geräte-ID (optional).
etag	string		Das Entitätstag, das der Ressource zugeordnet ist.
initialTwin	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.
optionalDeviceInformation	TwinCollection		Stellt eine Auflistung von Eigenschaften innerhalb eines Zwillings dar.
provisioningStatus	enum: disabled enabled	enabled	Die Bereitstellung status.
registrationId	string		Diese ID wird verwendet, um eine Geräteregistrierung einer Registrierung eindeutig zu identifizieren. Eine Zeichenfolge ohne Berücksichtigung der Groß-/Kleinschreibung (bis zu 128 Zeichen) mit alphanumerischen Zeichen plus bestimmten Sonderzeichen : . _ -. Am Anfang oder Ende sind keine Sonderzeichen zulässig.
registrationState	DeviceRegistrationState		Geräteregistrierungsstatus.
reprovisionPolicy	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	InitialTwinProperties	Stellt die anfänglichen Eigenschaften dar, die für den Gerätezwilligen festgelegt werden.
tags	TwinCollection	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	TwinCollection	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	Metadata	Metadaten für die TwinCollection
version	integer	Version der TwinCollection

X509Attestation

Nachweis über X509.

Name	Typ	Beschreibung
caReferences	X509CAReferences	Verweise auf die primäre und sekundäre Zertifizierungsstelle.
clientCertificates	X509Certificates	Primäre und sekundäre Zertifikate
signingCertificates	X509Certificates	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	X509CertificateWithInfo	Zertifikat- und Zertifikatinformationen
secondary	X509CertificateWithInfo	Zertifikat- und Zertifikatinformationen

X509CertificateWithInfo

Zertifikat- und Zertifikatinformationen

Name	Typ	Beschreibung
certificate	string
info	X509CertificateInfo	X509-Zertifikatinformationen.