Individual Enrollment - Create Or Update

Dienst:

IoT Hub Device Provisioning Service

API-Version:

2021-10-01

Dient zum Erstellen oder Aktualisieren eines Geräteregistrierungsdatensatzes.

PUT https://your-dps.azure-devices-provisioning.net/enrollments/{id}?api-version=2021-10-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
id	path	True	string	Diese ID wird verwendet, um eine Geräteregistrierung einer Registrierung eindeutig zu identifizieren. Eine Zeichenfolge ohne Groß-/Kleinschreibung (bis zu 128 Zeichen) alphanumerischer Zeichen sowie bestimmte Sonderzeichen : . _ -. Am Anfang oder Ende sind keine Sonderzeichen zulässig.
api-version	query	True	string	Die API-Version, die für die Anforderung verwendet werden soll. Unterstützte Versionen sind: 2021-10-01

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
If-Match		string	Das ETag des Registrierungsdatensatzes.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
attestation	True	AttestationMechanism	Nachweismechanismus für individualEnrollment sowie enrollmentGroup.
registrationId	True	string minLength: 1	Diese ID wird verwendet, um eine Geräteregistrierung einer Registrierung eindeutig zu identifizieren. Eine Zeichenfolge ohne Groß-/Kleinschreibung (bis zu 128 Zeichen) alphanumerischer Zeichen sowie bestimmte Sonderzeichen : . _ -. Am Anfang oder Ende sind keine Sonderzeichen zulässig.
allocationPolicy		enum: hashed geoLatency static custom	Die Zuordnungsrichtlinie dieser Ressource. Diese Richtlinie setzt die Zuordnungsrichtlinie auf Mandantenebene für diese einzelne Registrierung oder Registrierungsgruppe außer Kraft. Mögliche Werte sind "Hashed": Verknüpfte IoT-Hubs sind wahrscheinlich auch Geräte bereitgestellt, "geoLatency": Geräte werden an einem IoT-Hub mit der niedrigsten Latenz für das Gerät bereitgestellt. Wenn mehrere verknüpfte IoT-Hubs die gleiche niedrigste Latenz bereitstellen würden, hasht der Bereitstellungsdienst Geräte über diese Hubs hinweg, "statisch": Die Spezifikation des gewünschten IoT-Hubs in der Registrierungsliste hat Vorrang vor der Richtlinie für die Zuweisung auf Dienstebene, "benutzerdefiniert": Geräte werden basierend auf Ihrer eigenen benutzerdefinierten Logik auf einem IoT-Hub bereitgestellt. Der Bereitstellungsdienst übergibt Informationen über das Gerät an die Logik, und die Logik gibt den gewünschten IoT-Hub sowie die gewünschte Anfangskonfiguration zurück. Wir empfehlen die Verwendung von Azure Functions zum Hosten Ihrer Logik.
capabilities		DeviceCapabilities	Gerätefunktionen.
customAllocationDefinition		CustomAllocationDefinition	Dadurch wird DPS mitgeteilt, welcher Webhook aufgerufen werden soll, wenn 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ängliches Gerät Twin. Enthält eine Teilmenge der Eigenschaften von Twin.
iotHubHostName		string	Der Iot Hub-Hostname.
iotHubs		string[]	Die Liste der IoT Hub-Hostnamen, die die Geräte in dieser Ressource zugeordnet werden können. Muss eine Teilmenge der Mandantenebenenliste von IoT-Hubs sein.
optionalDeviceInformation		TwinCollection	Stellt eine Auflistung von Eigenschaften innerhalb eines Twin dar.
provisioningStatus		enum: enabled disabled	Der Bereitstellungsstatus.
registrationState		DeviceRegistrationState	Geräteregistrierungsstatus
reprovisionPolicy		ReprovisionPolicy	Das Verhalten des Diensts, wenn ein Gerät auf einem IoT-Hub erneut bereitgestellt wird.

Antworten

Name	Typ	Beschreibung
200 OK	IndividualEnrollment	Erfolg
Other Status Codes	ProvisioningServiceErrorDetails	Fehlerantwort Header x-ms-error-code: string

Definitionen

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

AttestationMechanism

Objekt

Nachweismechanismus für individualEnrollment sowie 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

Objekt

Dadurch wird DPS mitgeteilt, welcher Webhook aufgerufen werden soll, wenn benutzerdefinierte Zuordnung verwendet wird.

Name	Typ	Beschreibung
apiVersion	string minLength: 1	Die API-Version der Bereitstellungsdiensttypen (z. B. IndividualEnrollment), die in der benutzerdefinierten Zuordnungsanforderung gesendet werden. Mindestens unterstützte Version: "2018-09-01-preview".
webhookUrl	string minLength: 1	Die webhook-URL, die für Zuordnungsanforderungen verwendet wird.

DeviceCapabilities

Objekt

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

Objekt

Geräteregistrierungsstatus

Name	Typ	Beschreibung
assignedHub	string	Zugewiesener Azure IoT Hub.
createdDateTimeUtc	string (date-time)	Die Registrierung erstellt Datumszeit (in UTC).
deviceId	string	Geräte-ID.
errorCode	integer (int32)	Fehlercode.
errorMessage	string	Fehlermeldung.
etag	string	Das Entitätstag, das der Ressource zugeordnet ist.
lastUpdatedDateTimeUtc	string (date-time)	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 Groß-/Kleinschreibung (bis zu 128 Zeichen) alphanumerischer Zeichen sowie bestimmte Sonderzeichen : . _ -. Am Anfang oder Ende sind keine Sonderzeichen zulässig.
status	enum: assigned assigning disabled failed unassigned	Registrierungsstatus.
substatus	enum: deviceDataMigrated deviceDataReset initialAssignment reprovisionedToInitialAssignment	Unterstatus für "Zugewiesene" Geräte. Mögliche Werte sind : "initialAssignment": Das Gerät wurde einem IoT-Hub zum ersten Mal "deviceDataMigrated" zugewiesen: 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 ist. Gerätedaten wurden aus dem zuvor zugewiesenen IoT-Hub "reprovisionedToInitialAssignment" entfernt: Das Gerät wurde einem zuvor zugewiesenen IoT-Hub neu bereitgestellt.

IndividualEnrollment

Objekt

Der Geräteregistrierungseintrag.

Name	Typ	Standardwert	Beschreibung
allocationPolicy	enum: custom geoLatency hashed static		Die Zuordnungsrichtlinie dieser Ressource. Diese Richtlinie setzt die Zuordnungsrichtlinie auf Mandantenebene für diese einzelne Registrierung oder Registrierungsgruppe außer Kraft. Mögliche Werte sind "Hashed": Verknüpfte IoT-Hubs sind wahrscheinlich auch Geräte bereitgestellt, "geoLatency": Geräte werden an einem IoT-Hub mit der niedrigsten Latenz für das Gerät bereitgestellt. Wenn mehrere verknüpfte IoT-Hubs die gleiche niedrigste Latenz bereitstellen würden, hasht der Bereitstellungsdienst Geräte über diese Hubs hinweg, "statisch": Die Spezifikation des gewünschten IoT-Hubs in der Registrierungsliste hat Vorrang vor der Richtlinie für die Zuweisung auf Dienstebene, "benutzerdefiniert": Geräte werden basierend auf Ihrer eigenen benutzerdefinierten Logik auf einem IoT-Hub bereitgestellt. Der Bereitstellungsdienst übergibt Informationen über das Gerät an die Logik, und die Logik gibt den gewünschten IoT-Hub sowie die gewünschte Anfangskonfiguration zurück. Wir empfehlen die Verwendung von Azure Functions zum Hosten Ihrer Logik.
attestation	AttestationMechanism		Nachweismechanismus für individualEnrollment sowie enrollmentGroup.
capabilities	DeviceCapabilities		Gerätefunktionen.
createdDateTimeUtc	string (date-time)		Die DateTime-Ressource wurde erstellt.
customAllocationDefinition	CustomAllocationDefinition		Dadurch wird DPS mitgeteilt, welcher Webhook aufgerufen werden soll, wenn 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ängliches Gerät Twin. Enthält eine Teilmenge der Eigenschaften von Twin.
iotHubHostName	string		Der Iot Hub-Hostname.
iotHubs	string[]		Die Liste der IoT Hub-Hostnamen, die die Geräte in dieser Ressource zugeordnet werden können. Muss eine Teilmenge der Mandantenebenenliste von IoT-Hubs sein.
lastUpdatedDateTimeUtc	string (date-time)		Die DateTime-Ressource wurde zuletzt aktualisiert.
optionalDeviceInformation	TwinCollection		Stellt eine Auflistung von Eigenschaften innerhalb eines Twin dar.
provisioningStatus	enum: disabled enabled	enabled	Der Bereitstellungsstatus.
registrationId	string minLength: 1		Diese ID wird verwendet, um eine Geräteregistrierung einer Registrierung eindeutig zu identifizieren. Eine Zeichenfolge ohne Groß-/Kleinschreibung (bis zu 128 Zeichen) alphanumerischer Zeichen sowie bestimmte Sonderzeichen : . _ -. Am Anfang oder Ende sind keine Sonderzeichen zulässig.
registrationState	DeviceRegistrationState		Geräteregistrierungsstatus
reprovisionPolicy	ReprovisionPolicy		Das Verhalten des Diensts, wenn ein Gerät auf einem IoT-Hub erneut bereitgestellt wird.

InitialTwin

Objekt

Anfängliches Gerät Twin. Enthält eine Teilmenge der Eigenschaften von Twin.

Name	Typ	Beschreibung
properties	InitialTwinProperties	Stellt die anfänglichen Eigenschaften dar, die auf dem Gerät Twin festgelegt werden.
tags	TwinCollection	Stellt eine Auflistung von Eigenschaften innerhalb eines Twin dar.

InitialTwinProperties

Objekt

Stellt die anfänglichen Eigenschaften dar, die auf dem Gerät Twin festgelegt werden.

Name	Typ	Beschreibung
desired	TwinCollection	Stellt eine Auflistung von Eigenschaften innerhalb eines Twin dar.

Metadata

Objekt

Metadaten für TwinCollection

Name	Typ	Beschreibung
lastUpdated	string (date-time)	Zeitpunkt der letzten Aktualisierung der TwinCollection
lastUpdatedVersion	integer (int64)	Dies ist null für gemeldete Eigenschaftenmetadaten und ist nicht NULL für die gewünschten Eigenschaftenmetadaten.

ProvisioningServiceErrorDetails

Objekt

Enthält die Eigenschaften eines Fehlers, der vom Azure IoT Hub-Bereitstellungsdienst zurückgegeben wird.

Name	Typ	Beschreibung
errorCode	integer (int32)
info	object
message	string
timestampUtc	string (date-time)
trackingId	string

ReprovisionPolicy

Objekt

Das Verhalten des Diensts, wenn ein Gerät auf einem IoT-Hub erneut bereitgestellt wird.

Name	Typ	Standardwert	Beschreibung
migrateDeviceData	boolean	True	Bei Festlegung auf "true" (Standard) migriert der Gerätebereitstellungsdienst die Daten des Geräts (Twin, Gerätefunktionen und Geräte-ID) von einem IoT-Hub zu einem anderen während eines IoT-Hub-Zuweisungsupdates. Bei Festlegung auf "false" setzt der Gerätebereitstellungsdienst die Gerätedaten auf die ursprüngliche gewünschte Konfiguration zurück, die in der entsprechenden Registrierungsliste gespeichert ist.
updateHubAssignment	boolean	True	Bei Festlegung auf "true" (Standard) wertet der Gerätebereitstellungsdienst die IoT Hub-Zuweisung des Geräts aus und aktualisiert sie bei Bedarf für Bereitstellungsanforderungen, die über das erste von einem bestimmten Gerät hinausgehen. Wenn dieser Wert auf "false" festgelegt ist, bleibt das Gerät dem aktuellen IoT-Hub zugewiesen.

SymmetricKeyAttestation

Objekt

Nachweis über SymmetricKey.

Name	Typ	Beschreibung
primaryKey	string	Primär symmetrischer Schlüssel.
secondaryKey	string	Sekundärer symmetrischer Schlüssel.

TpmAttestation

Objekt

Nachweis über TPM.

Name	Typ	Beschreibung
endorsementKey	string
storageRootKey	string

TwinCollection

Objekt

Stellt eine Auflistung von Eigenschaften innerhalb eines Twin dar.

Name	Typ	Beschreibung
count	integer	Anzahl der Eigenschaften in TwinCollection
metadata	Metadata	Metadaten für TwinCollection
version	integer (int64)	Version der TwinCollection

X509Attestation

Objekt

Nachweis über X509.

Name	Typ	Beschreibung
caReferences	X509CAReferences	Primäre und sekundäre Zertifizierungsstellenverweise.
clientCertificates	X509Certificates	Primäre und sekundäre Zertifikate
signingCertificates	X509Certificates	Primäre und sekundäre Zertifikate

X509CAReferences

Objekt

Primäre und sekundäre Zertifizierungsstellenverweise.

Name	Typ	Beschreibung
primary	string
secondary	string

X509CertificateInfo

Objekt

X509-Zertifikatinformationen.

Name	Typ	Beschreibung
issuerName	string
notAfterUtc	string (date-time)
notBeforeUtc	string (date-time)
serialNumber	string
sha1Thumbprint	string
sha256Thumbprint	string
subjectName	string
version	integer (int32)

X509Certificates

Objekt

Primäre und sekundäre Zertifikate

Name	Typ	Beschreibung
primary	X509CertificateWithInfo	Zertifikat- und Zertifikatinformationen
secondary	X509CertificateWithInfo	Zertifikat- und Zertifikatinformationen

X509CertificateWithInfo

Objekt

Zertifikat- und Zertifikatinformationen

Name	Typ	Beschreibung
certificate	string
info	X509CertificateInfo	X509-Zertifikatinformationen.