Freigeben über

Individual Enrollment - Run Bulk Operation

  • Referenz
Dienst:
IoT Hub Device Provisioning Service
API-Version:
2021-10-01

Massenvorgang für die Geräteregistrierung mit maximal 10 Registrierungen.

POST https://your-dps.azure-devices-provisioning.net/enrollments?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

Anforderungstext

Name Erforderlich Typ Beschreibung
enrollments True

IndividualEnrollment[]

Registrierungselemente
mode True enum:
  • create
  • update
  • updateIfMatchETag
  • delete

Vorgangsmodus.

Antworten

Name Typ Beschreibung
200 OK

BulkEnrollmentOperationResult

Erfolg
Other Status Codes

ProvisioningServiceErrorDetails

Fehlerantwort

Header

x-ms-error-code: string

Definitionen

Name Beschreibung
AttestationMechanism

Nachweismechanismus für individualEnrollment und enrollmentGroup.
BulkEnrollmentOperation

Massenregistrierungsvorgang.
BulkEnrollmentOperationError

Fehler beim Massenregistrierungsvorgang
BulkEnrollmentOperationResult

Ergebnisse eines Massenregistrierungsvorgangs
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ätezwillen 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.
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

Primäre und sekundäre Zertifizierungsstellenverweise.
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.

BulkEnrollmentOperation

Massenregistrierungsvorgang.

Name Typ Beschreibung
enrollments

IndividualEnrollment[]

Registrierungselemente
mode enum:
  • create
  • delete
  • update
  • updateIfMatchETag

Betriebsmodus.

BulkEnrollmentOperationError

Fehler beim Massenregistrierungsvorgang

Name Typ Beschreibung
errorCode

integer

Fehlercode
errorStatus

string

Fehler status.
registrationId

string

Diese ID wird verwendet, um eine Geräteregistrierung einer Registrierung eindeutig zu identifizieren. Eine Zeichenfolge ohne Beachtung der Groß-/Kleinschreibung (bis zu 128 Zeichen lang) mit alphanumerischen Zeichen und bestimmten Sonderzeichen: . _ -. Am Anfang oder Ende sind keine Sonderzeichen zulässig.

BulkEnrollmentOperationResult

Ergebnisse eines Massenregistrierungsvorgangs

Name Typ Beschreibung
errors

BulkEnrollmentOperationError[]

Registrierungsfehler
isSuccessful

boolean

Gibt an, ob der Vorgang vollständig erfolgreich war.

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 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

Anmeldedatum erstellen (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 Beachtung der Groß-/Kleinschreibung (bis zu 128 Zeichen lang) mit alphanumerischen Zeichen und bestimmten Sonderzeichen: . _ -. Am Anfang oder Ende sind keine Sonderzeichen zulässig.
status enum:
  • assigned
  • assigning
  • disabled
  • failed
  • unassigned

Registrierung 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 aus dem 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 setzt die Zuordnungsrichtlinie auf Mandantenebene für diese einzelne Registrierung oder Registrierungsgruppe außer Kraft. Mögliche Werte sind "hashed": Bei verknüpften IoT-Hubs ist es ebenfalls wahrscheinlich, dass Geräte für sie bereitgestellt werden, "geoLatency": Geräte werden für einen IoT-Hub mit der niedrigsten Latenz für das Gerät bereitgestellt. Wenn mehrere verknüpfte IoT Hubs die gleiche niedrigste Latenz bieten 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 Zuordnungsrichtlinie auf Dienstebene, "benutzerdefiniert": Geräte werden auf Grundlage Ihrer eigenen benutzerdefinierten Logik für einen 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 Anfangskonfiguration 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-Ressource wurde erstellt.
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, die die Geräte in dieser Ressource zugeordnet werden können. Muss eine Teilmenge der Liste der IoT Hubs auf Mandantenebene sein.
lastUpdatedDateTimeUtc

string

Die DateTime dieser Ressource wurde zuletzt aktualisiert.
optionalDeviceInformation

TwinCollection

Stellt eine Auflistung von Eigenschaften innerhalb eines Zwillings dar.
provisioningStatus enum:
  • disabled
  • enabled
enabled

Die Bereitstellungs-status.
registrationId

string

Diese ID wird verwendet, um eine Geräteregistrierung einer Registrierung eindeutig zu identifizieren. Eine Zeichenfolge ohne Beachtung der Groß-/Kleinschreibung (bis zu 128 Zeichen lang) mit alphanumerischen Zeichen und 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ätezwillen 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ätezwillen 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

Das letzte Mal, wenn die TwinCollection aktualisiert wurde
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

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 Gerätebereitstellungsdienst während eines IoT Hub-Zuweisungsupdates die Gerätedaten (Zwilling, Gerätefunktionen und Geräte-ID) von einem IoT Hub zu einem anderen. Wenn auf false festgelegt ist, setzt der Gerätebereitstellungsdienst die Daten des Geräts auf die anfängliche gewünschte Konfiguration zurück, die in der entsprechenden Registrierungsliste gespeichert ist.
updateHubAssignment

boolean

True

Wenn auf true (Standard) festgelegt ist, wertet der Gerätebereitstellungsdienst die IoT Hub Zuweisung des Geräts aus und aktualisiert sie bei Bedarf für Bereitstellungsanforderungen, die über die erste von einem bestimmten Gerät hinausgehen. Wenn auf false festgelegt ist, bleibt das Gerät seinem aktuellen IoT Hub zugewiesen.

SymmetricKeyAttestation

Nachweis über SymmetricKey.

Name Typ Beschreibung
primaryKey

string

Primärsymmetrischer 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

Primäre und sekundäre Zertifizierungsstellenverweise.
clientCertificates

X509Certificates

Primäre und sekundäre Zertifikate
signingCertificates

X509Certificates

Primäre und sekundäre Zertifikate

X509CAReferences

Primäre und sekundäre Zertifizierungsstellenverweise.

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.