Individual Enrollment - Create Or Update

Dienst:: IoT Hub Device Provisioning Service

API-Version:: 2021-10-01

Erstellen oder aktualisieren Sie einen Eintrag zur Einschreibung von Geräten.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
dpsName	path	True	string	Der DPS-Instanz-Hostname.
id	path	True	string	Diese ID wird verwendet, um eine Geräteregistrierung einer Einschreibung eindeutig zu identifizieren. Eine kleinschreibungsunempfindliche Zeichenkette (bis zu 128 Zeichen lang) aus alphanumerischen Zeichen plus bestimmten Sonderzeichen : . _ -. Keine Spezialzeichen zu Beginn oder Ende erlaubt.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
Authorization	True	string
If-Match		string	Der ETag des Einschreibungsrekords.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
attestation	True	AttestationMechanism	Attestierungsmethode, die vom Gerät verwendet wird.
registrationId	True	string	Diese ID wird verwendet, um eine Geräteregistrierung einer Einschreibung eindeutig zu identifizieren. Eine kleinschreibungsunempfindliche Zeichenkette (bis zu 128 Zeichen lang) aus alphanumerischen Zeichen plus bestimmten Sonderzeichen : . _ -. Keine Spezialzeichen zu Beginn oder Ende erlaubt.
allocationPolicy		AllocationPolicy	Die Zuteilungspolitik dieser Ressource. Diese Richtlinie überstimmt die Zuweisungsrichtlinie auf Mieterebene für diese einzelne Einschreibung oder Einschreibungsgruppe. Mögliche Werte sind 'gehasht': Verbundene IoT-Hubs haben ebenso wahrscheinlich Geräte bereitgestellt, 'geoLatency': Geräte werden an einen IoT-Hub mit der niedrigsten Latenz für das Gerät bereitgestellt. Wenn mehrere verbundene IoT-Hubs die gleiche niedrigste Latenz bieten, hasht der bereitstellende Dienst Geräte über diese Hubs hinweg, 'statisch': Die Spezifikation des gewünschten IoT-Hubs in der Enrollment-Liste hat Vorrang gegenüber der Service-Level-Allokationspolitik, 'benutzerdefiniert': Geräte werden basierend auf Ihrer eigenen benutzerdefinierten Logik an einen IoT-Hub bereitgestellt. Der Provisioning-Dienst übermittelt Informationen über das Gerät an die Logik, und die Logik liefert den gewünschten IoT-Hub sowie die gewünschte Anfangskonfiguration zurück. Wir empfehlen, Azure Functions zu verwenden, um Ihre Logik zu hosten.
capabilities		DeviceCapabilities	Fähigkeiten des Geräts.
customAllocationDefinition		CustomAllocationDefinition	Das sagt DPS, welchen Webhook er aufrufen soll, wenn man benutzerdefinierte Zuweisung verwendet.
deviceId		string	Gewünschte IoT-Hub-Geräte-ID (optional).
etag		string	Das mit der Ressource verknüpfte Entitäten-Tag.
initialTwin		InitialTwin	Initiales Geräte-Zwilling.
iotHubHostName		string	Der Hostname Iot Hub.
iotHubs		string[]	Die Liste der IoT-Hub-Hostnamen, denen das Gerät(e) in dieser Ressource zugewiesen werden kann. Muss eine Teilmenge der Mieter-Level-Liste der IoT-Hubs sein.
optionalDeviceInformation		TwinCollection	Optionale Geräteinformationen.
provisioningStatus		ProvisioningStatus	Der Versorgungsstatus.
reprovisionPolicy		ReprovisionPolicy	Das Verhalten, wenn ein Gerät an einen IoT-Hub neu bereitgestellt wird.

Antworten

Name	Typ	Beschreibung
200 OK	IndividualEnrollment	Die Anforderung war erfolgreich.
Other Status Codes	ProvisioningServiceErrorDetails	Unerwartete Fehlerantwort. Header x-ms-error-code: string

Name

Typ

Beschreibung

200 OK

IndividualEnrollment

Die Anforderung war erfolgreich.

Other Status Codes

ProvisioningServiceErrorDetails

Unerwartete Fehlerantwort.

Header

x-ms-error-code: string

Sicherheit

Authorization

Typ: apiKey
In: header

Beispiele

IndividualEnrollment_CreateOrUpdate_MaximumSet_Gen

IndividualEnrollment_CreateOrUpdate_MinimumSet_Gen

IndividualEnrollment_CreateOrUpdate_MaximumSet_Gen

Beispielanforderung

HTTP

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


{
  "allocationPolicy": "hashed",
  "attestation": {
    "type": "none",
    "symmetricKey": {
      "primaryKey": "tdoshkmlo",
      "secondaryKey": "lmajoyzuojahffcmdlcwjhntqzyqzk"
    },
    "tpm": {
      "endorsementKey": "naoofgjbxiulcitlysusxdvagyucgn",
      "storageRootKey": "tdgkgcvptrsw"
    },
    "x509": {
      "caReferences": {
        "primary": "efbkbboxkvrsdl",
        "secondary": "vckhuzqgbcinighxwyuyd"
      },
      "clientCertificates": {
        "primary": {
          "info": {
            "issuerName": "pkuinyhttjlozsbtvxuizzkjlakga",
            "notAfterUtc": "2025-10-01T17:42:04.76Z",
            "notBeforeUtc": "2025-10-01T17:42:04.76Z",
            "serialNumber": "mzoidcxayenpgyrek",
            "sha1Thumbprint": "fdmftjqllzvxcd",
            "sha256Thumbprint": "ei",
            "subjectName": "qqjdjgrkiqvtnshkisozut",
            "version": 12
          },
          "certificate": "gkozpt"
        },
        "secondary": {
          "info": {
            "issuerName": "pkuinyhttjlozsbtvxuizzkjlakga",
            "notAfterUtc": "2025-10-01T17:42:04.76Z",
            "notBeforeUtc": "2025-10-01T17:42:04.76Z",
            "serialNumber": "mzoidcxayenpgyrek",
            "sha1Thumbprint": "fdmftjqllzvxcd",
            "sha256Thumbprint": "ei",
            "subjectName": "qqjdjgrkiqvtnshkisozut",
            "version": 12
          },
          "certificate": "gkozpt"
        }
      },
      "signingCertificates": {
        "primary": {
          "info": {
            "issuerName": "pkuinyhttjlozsbtvxuizzkjlakga",
            "notAfterUtc": "2025-10-01T17:42:04.76Z",
            "notBeforeUtc": "2025-10-01T17:42:04.76Z",
            "serialNumber": "mzoidcxayenpgyrek",
            "sha1Thumbprint": "fdmftjqllzvxcd",
            "sha256Thumbprint": "ei",
            "subjectName": "qqjdjgrkiqvtnshkisozut",
            "version": 12
          },
          "certificate": "gkozpt"
        },
        "secondary": {
          "info": {
            "issuerName": "pkuinyhttjlozsbtvxuizzkjlakga",
            "notAfterUtc": "2025-10-01T17:42:04.76Z",
            "notBeforeUtc": "2025-10-01T17:42:04.76Z",
            "serialNumber": "mzoidcxayenpgyrek",
            "sha1Thumbprint": "fdmftjqllzvxcd",
            "sha256Thumbprint": "ei",
            "subjectName": "qqjdjgrkiqvtnshkisozut",
            "version": 12
          },
          "certificate": "gkozpt"
        }
      }
    }
  },
  "capabilities": {
    "iotEdge": true
  },
  "customAllocationDefinition": {
    "apiVersion": "gbannxdstouqrfonxdxfurv",
    "webhookUrl": "todqbubyxeumrtvhsscedwrkz"
  },
  "deviceId": "wfgzhrgpvmwddrknnmcggbae",
  "etag": "ngtrmhcikthymtknva",
  "initialTwin": {
    "properties": {
      "desired": {
        "count": 16,
        "key2428": {},
        "metadata": {
          "lastUpdated": "2025-10-01T17:42:04.76Z",
          "lastUpdatedVersion": 19
        },
        "version": 9
      }
    },
    "tags": {
      "count": 16,
      "key2428": {},
      "metadata": {
        "lastUpdated": "2025-10-01T17:42:04.76Z",
        "lastUpdatedVersion": 19
      },
      "version": 9
    }
  },
  "iotHubHostName": "vtewercilhukfboi",
  "iotHubs": [
    "lwgwrfdherfrbowfdbrdhvnragwrs"
  ],
  "optionalDeviceInformation": {
    "count": 16,
    "key2428": {},
    "metadata": {
      "lastUpdated": "2025-10-01T17:42:04.76Z",
      "lastUpdatedVersion": 19
    },
    "version": 9
  },
  "provisioningStatus": "enabled",
  "registrationId": "kz",
  "registrationState": {},
  "reprovisionPolicy": {
    "migrateDeviceData": true,
    "updateHubAssignment": true
  }
}

Beispiel für eine Antwort

Statuscode:: 200

{
  "allocationPolicy": "hashed",
  "attestation": {
    "type": "none",
    "symmetricKey": {
      "primaryKey": "tdoshkmlo",
      "secondaryKey": "lmajoyzuojahffcmdlcwjhntqzyqzk"
    },
    "tpm": {
      "endorsementKey": "naoofgjbxiulcitlysusxdvagyucgn",
      "storageRootKey": "tdgkgcvptrsw"
    },
    "x509": {
      "caReferences": {
        "primary": "efbkbboxkvrsdl",
        "secondary": "vckhuzqgbcinighxwyuyd"
      },
      "clientCertificates": {
        "primary": {
          "info": {
            "issuerName": "pkuinyhttjlozsbtvxuizzkjlakga",
            "notAfterUtc": "2025-10-01T17:42:04.76Z",
            "notBeforeUtc": "2025-10-01T17:42:04.76Z",
            "serialNumber": "mzoidcxayenpgyrek",
            "sha1Thumbprint": "fdmftjqllzvxcd",
            "sha256Thumbprint": "ei",
            "subjectName": "qqjdjgrkiqvtnshkisozut",
            "version": 12
          },
          "certificate": "gkozpt"
        },
        "secondary": {
          "info": {
            "issuerName": "pkuinyhttjlozsbtvxuizzkjlakga",
            "notAfterUtc": "2025-10-01T17:42:04.76Z",
            "notBeforeUtc": "2025-10-01T17:42:04.76Z",
            "serialNumber": "mzoidcxayenpgyrek",
            "sha1Thumbprint": "fdmftjqllzvxcd",
            "sha256Thumbprint": "ei",
            "subjectName": "qqjdjgrkiqvtnshkisozut",
            "version": 12
          },
          "certificate": "gkozpt"
        }
      },
      "signingCertificates": {
        "primary": {
          "info": {
            "issuerName": "pkuinyhttjlozsbtvxuizzkjlakga",
            "notAfterUtc": "2025-10-01T17:42:04.76Z",
            "notBeforeUtc": "2025-10-01T17:42:04.76Z",
            "serialNumber": "mzoidcxayenpgyrek",
            "sha1Thumbprint": "fdmftjqllzvxcd",
            "sha256Thumbprint": "ei",
            "subjectName": "qqjdjgrkiqvtnshkisozut",
            "version": 12
          },
          "certificate": "gkozpt"
        },
        "secondary": {
          "info": {
            "issuerName": "pkuinyhttjlozsbtvxuizzkjlakga",
            "notAfterUtc": "2025-10-01T17:42:04.76Z",
            "notBeforeUtc": "2025-10-01T17:42:04.76Z",
            "serialNumber": "mzoidcxayenpgyrek",
            "sha1Thumbprint": "fdmftjqllzvxcd",
            "sha256Thumbprint": "ei",
            "subjectName": "qqjdjgrkiqvtnshkisozut",
            "version": 12
          },
          "certificate": "gkozpt"
        }
      }
    }
  },
  "capabilities": {
    "iotEdge": true
  },
  "createdDateTimeUtc": "2025-10-01T17:42:04.76Z",
  "customAllocationDefinition": {
    "apiVersion": "gbannxdstouqrfonxdxfurv",
    "webhookUrl": "todqbubyxeumrtvhsscedwrkz"
  },
  "deviceId": "wfgzhrgpvmwddrknnmcggbae",
  "etag": "ngtrmhcikthymtknva",
  "initialTwin": {
    "properties": {
      "desired": {
        "count": 16,
        "key2428": {},
        "metadata": {
          "lastUpdated": "2025-10-01T17:42:04.76Z",
          "lastUpdatedVersion": 19
        },
        "version": 9
      }
    },
    "tags": {
      "count": 16,
      "key2428": {},
      "metadata": {
        "lastUpdated": "2025-10-01T17:42:04.76Z",
        "lastUpdatedVersion": 19
      },
      "version": 9
    }
  },
  "iotHubHostName": "vtewercilhukfboi",
  "iotHubs": [
    "lwgwrfdherfrbowfdbrdhvnragwrs"
  ],
  "lastUpdatedDateTimeUtc": "2025-10-01T17:42:04.76Z",
  "optionalDeviceInformation": {
    "count": 16,
    "key2428": {},
    "metadata": {
      "lastUpdated": "2025-10-01T17:42:04.76Z",
      "lastUpdatedVersion": 19
    },
    "version": 9
  },
  "provisioningStatus": "enabled",
  "registrationId": "kz",
  "registrationState": {
    "assignedHub": "oasugtinnefgfklhldjhibq",
    "createdDateTimeUtc": "2025-10-01T17:42:04.759Z",
    "deviceId": "ttnhaugyyh",
    "errorCode": 2,
    "errorMessage": "ufqpjjmbiphiynoijjbocvl",
    "etag": "ctquvtjyhnomcmtddscxwjk",
    "lastUpdatedDateTimeUtc": "2025-10-01T17:42:04.759Z",
    "payload": {},
    "registrationId": "czvnrxvbka",
    "status": "unassigned",
    "substatus": "initialAssignment"
  },
  "reprovisionPolicy": {
    "migrateDeviceData": true,
    "updateHubAssignment": true
  }
}

IndividualEnrollment_CreateOrUpdate_MinimumSet_Gen

Beispielanforderung

HTTP

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

{
  "attestation": {
    "type": "none"
  },
  "registrationId": "kz"
}

Beispiel für eine Antwort

Statuscode:: 200

{
  "attestation": {
    "type": "none"
  },
  "registrationId": "kz"
}

Definitionen

Name	Beschreibung
AllocationPolicy	Die Zuteilungspolitik dieser Ressource. Diese Richtlinie überstimmt die Zuweisungsrichtlinie auf Mieterebene für diese einzelne Einschreibung oder Einschreibungsgruppe. Mögliche Werte sind 'gehasht': Verbundene IoT-Hubs haben ebenso wahrscheinlich Geräte bereitgestellt, 'geoLatency': Geräte werden an einen IoT-Hub mit der niedrigsten Latenz für das Gerät bereitgestellt. Wenn mehrere verbundene IoT-Hubs die gleiche niedrigste Latenz bieten, hasht der bereitstellende Dienst Geräte über diese Hubs hinweg, 'statisch': Die Spezifikation des gewünschten IoT-Hubs in der Enrollment-Liste hat Vorrang gegenüber der Service-Level-Allokationspolitik, 'benutzerdefiniert': Geräte werden basierend auf Ihrer eigenen benutzerdefinierten Logik an einen IoT-Hub bereitgestellt. Der Provisioning-Dienst übermittelt Informationen über das Gerät an die Logik, und die Logik liefert den gewünschten IoT-Hub sowie die gewünschte Anfangskonfiguration zurück. Wir empfehlen, Azure Functions zu verwenden, um Ihre Logik zu hosten.
AssignedDeviceSubstatus	Substatus für 'zugewiesene' Geräte. Mögliche Werte sind - "initialAssignment": Das Gerät wurde erstmals 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 vom zuvor zugewiesenen IoT-Hub entfernt, 'deviceDataReset': Das Gerät wurde einem anderen IoT-Hub zugewiesen und seine Gerätedaten wurden aus dem ursprünglichen Zustand, der bei der Registrierung gespeichert war, ausgefüllt. Gerätedaten wurden vom zuvor zugewiesenen IoT-Hub entfernt, 'reprovisionedToInitialAssignment': Das Gerät wurde an einen zuvor zugewiesenen IoT-Hub neu bereitgestellt.
AttestationMechanism	Attestationsmechanismus für individuelle Einschreibung sowie für Einschreibungsgruppe.
AttestationType	Attestationstyp.
CustomAllocationDefinition	Das sagt DPS, welchen Webhook er aufrufen soll, wenn man benutzerdefinierte Zuweisung verwendet.
DeviceCapabilities	Gerätefähigkeiten.
DeviceRegistrationState	Geräteregistrierungsstatus
EnrollmentStatus	Einschreibungsstatus.
IndividualEnrollment	Der Eintrag der Geräte.
InitialTwin	Initiales Geräte-Zwilling. Enthält eine Teilmenge der Eigenschaften von Twin.
InitialTwinProperties	Repräsentiert die Anfangseigenschaften, die auf dem Gerätezwilling gesetzt werden.
Metadata	Metadaten für die TwinCollection
ProvisioningServiceErrorDetails	Enthält die Eigenschaften eines Fehlers, der vom Azure IoT Hub Provisioning Service zurückgegeben wird.
ProvisioningStatus	Der Versorgungsstatus.
ReprovisionPolicy	Das Verhalten des Dienstes, wenn ein Gerät an einen IoT-Hub neu bereitgestellt wird.
SymmetricKeyAttestation	Attestation über SymmetricKey.
TpmAttestation	Attestierung mittels TPM.
TwinCollection	Repräsentiert eine Sammlung von Eigenschaften innerhalb eines Zwillings
X509Attestation	Attestierung über X509.
X509CAReferences	Primäre und sekundäre CA-Referenzen.
X509CertificateInfo	Informationen zum X509-Zertifikat.
X509Certificates	Grundschul- und Sekundarschulzertifikate
X509CertificateWithInfo	Zertifikat und Zertifikatsinformationen

AllocationPolicy

Enumeration

Die Zuteilungspolitik dieser Ressource. Diese Richtlinie überstimmt die Zuweisungsrichtlinie auf Mieterebene für diese einzelne Einschreibung oder Einschreibungsgruppe. Mögliche Werte sind 'gehasht': Verbundene IoT-Hubs haben ebenso wahrscheinlich Geräte bereitgestellt, 'geoLatency': Geräte werden an einen IoT-Hub mit der niedrigsten Latenz für das Gerät bereitgestellt. Wenn mehrere verbundene IoT-Hubs die gleiche niedrigste Latenz bieten, hasht der bereitstellende Dienst Geräte über diese Hubs hinweg, 'statisch': Die Spezifikation des gewünschten IoT-Hubs in der Enrollment-Liste hat Vorrang gegenüber der Service-Level-Allokationspolitik, 'benutzerdefiniert': Geräte werden basierend auf Ihrer eigenen benutzerdefinierten Logik an einen IoT-Hub bereitgestellt. Der Provisioning-Dienst übermittelt Informationen über das Gerät an die Logik, und die Logik liefert den gewünschten IoT-Hub sowie die gewünschte Anfangskonfiguration zurück. Wir empfehlen, Azure Functions zu verwenden, um Ihre Logik zu hosten.

Wert	Beschreibung
hashed	Hashed
geoLatency	geoLatency
static	Statisch
custom	custom

AssignedDeviceSubstatus

Enumeration

Substatus für 'zugewiesene' Geräte. Mögliche Werte sind - "initialAssignment": Das Gerät wurde erstmals 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 vom zuvor zugewiesenen IoT-Hub entfernt, 'deviceDataReset': Das Gerät wurde einem anderen IoT-Hub zugewiesen und seine Gerätedaten wurden aus dem ursprünglichen Zustand, der bei der Registrierung gespeichert war, ausgefüllt. Gerätedaten wurden vom zuvor zugewiesenen IoT-Hub entfernt, 'reprovisionedToInitialAssignment': Das Gerät wurde an einen zuvor zugewiesenen IoT-Hub neu bereitgestellt.

Wert	Beschreibung
initialAssignment	ursprüngliche Zuweisung
deviceDataMigrated	deviceDataMigrated
deviceDataReset	deviceDataReset
reprovisionedToInitialAssignment	reprovisionedToInitialAssignment

AttestationMechanism

Objekt

Attestationsmechanismus für individuelle Einschreibung sowie für Einschreibungsgruppe.

Name	Typ	Beschreibung
symmetricKey	SymmetricKeyAttestation	Symmetrische Schlüssel-Attestationsmethode.
tpm	TpmAttestation	TPM-Attestationsmethode.
type	AttestationType	Attestationstyp.
x509	X509Attestation	X509-Attestationsmethode.

AttestationType

Enumeration

Attestationstyp.

Wert	Beschreibung
none	nichts
tpm	tpm
x509	x509
symmetricKey	symmetrischer Schlüssel

CustomAllocationDefinition

Objekt

Das sagt DPS, welchen Webhook er aufrufen soll, wenn man benutzerdefinierte Zuweisung verwendet.

Name	Typ	Beschreibung
apiVersion	string	Die API-Version der Provisioning-Service-Typen (wie IndividualEnrollment), die bei der benutzerdefinierten Zuweisungsanfrage gesendet wird. Minimal unterstützte Version: "2018-09-01-preview".
webhookUrl	string	Die Webhook-URL, die für Zuteilungsanfragen verwendet wird.

DeviceCapabilities

Objekt

Gerätefähigkeiten.

Name	Typ	Standardwert	Beschreibung
iotEdge	boolean	False	Wenn es auf true gesetzt ist, handelt es sich dabei um ein IoTEdge-Gerät.

DeviceRegistrationState

Objekt

Geräteregistrierungsstatus

Name	Typ	Beschreibung
assignedHub	string	Assigned Azure IoT Hub.
createdDateTimeUtc	string (date-time)	Registrierung erstellt Datum (in UTC).
deviceId	string	Geräte-ID.
errorCode	integer (int32)	Fehlercode.
errorMessage	string	Fehlermeldung.
etag	string	Das mit der Ressource verknüpfte Entitäten-Tag.
lastUpdatedDateTimeUtc	string (date-time)	Zuletzt aktualisiertes Datum (in UTC).
payload		Benutzerdefinierte Zuweisungsnutzlast wird vom Webhook an das Gerät zurückgegeben.
registrationId	string	Diese ID wird verwendet, um eine Geräteregistrierung einer Einschreibung eindeutig zu identifizieren. Eine kleinschreibungsunempfindliche Zeichenkette (bis zu 128 Zeichen lang) aus alphanumerischen Zeichen plus bestimmten Sonderzeichen : . _ -. Keine Spezialzeichen zu Beginn oder Ende erlaubt.
status	EnrollmentStatus	Einschreibungsstatus.
substatus	AssignedDeviceSubstatus	Substatus für 'zugewiesene' Geräte. Mögliche Werte sind - "initialAssignment": Das Gerät wurde erstmals 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 vom zuvor zugewiesenen IoT-Hub entfernt, 'deviceDataReset': Das Gerät wurde einem anderen IoT-Hub zugewiesen und seine Gerätedaten wurden aus dem ursprünglichen Zustand, der bei der Registrierung gespeichert war, ausgefüllt. Gerätedaten wurden vom zuvor zugewiesenen IoT-Hub entfernt, 'reprovisionedToInitialAssignment': Das Gerät wurde an einen zuvor zugewiesenen IoT-Hub neu bereitgestellt.

EnrollmentStatus

Enumeration

Einschreibungsstatus.

Wert	Beschreibung
unassigned	Nicht zugewiesen
assigning	Zuweisung
assigned	zugewiesen
failed	misslungen
disabled	deaktiviert

IndividualEnrollment

Objekt

Der Eintrag der Geräte.

Name	Typ	Standardwert	Beschreibung
allocationPolicy	AllocationPolicy		Die Zuteilungspolitik dieser Ressource. Diese Richtlinie überstimmt die Zuweisungsrichtlinie auf Mieterebene für diese einzelne Einschreibung oder Einschreibungsgruppe. Mögliche Werte sind 'gehasht': Verbundene IoT-Hubs haben ebenso wahrscheinlich Geräte bereitgestellt, 'geoLatency': Geräte werden an einen IoT-Hub mit der niedrigsten Latenz für das Gerät bereitgestellt. Wenn mehrere verbundene IoT-Hubs die gleiche niedrigste Latenz bieten, hasht der bereitstellende Dienst Geräte über diese Hubs hinweg, 'statisch': Die Spezifikation des gewünschten IoT-Hubs in der Enrollment-Liste hat Vorrang gegenüber der Service-Level-Allokationspolitik, 'benutzerdefiniert': Geräte werden basierend auf Ihrer eigenen benutzerdefinierten Logik an einen IoT-Hub bereitgestellt. Der Provisioning-Dienst übermittelt Informationen über das Gerät an die Logik, und die Logik liefert den gewünschten IoT-Hub sowie die gewünschte Anfangskonfiguration zurück. Wir empfehlen, Azure Functions zu verwenden, um Ihre Logik zu hosten.
attestation	AttestationMechanism		Attestierungsmethode, die vom Gerät verwendet wird.
capabilities	DeviceCapabilities		Fähigkeiten des Geräts.
createdDateTimeUtc	string (date-time)		Die DateTime: Diese Ressource wurde erstellt.
customAllocationDefinition	CustomAllocationDefinition		Das sagt DPS, welchen Webhook er aufrufen soll, wenn man benutzerdefinierte Zuweisung verwendet.
deviceId	string		Gewünschte IoT-Hub-Geräte-ID (optional).
etag	string		Das mit der Ressource verknüpfte Entitäten-Tag.
initialTwin	InitialTwin		Initiales Geräte-Zwilling.
iotHubHostName	string		Der Hostname Iot Hub.
iotHubs	string[]		Die Liste der IoT-Hub-Hostnamen, denen das Gerät(e) in dieser Ressource zugewiesen werden kann. Muss eine Teilmenge der Mieter-Level-Liste der IoT-Hubs sein.
lastUpdatedDateTimeUtc	string (date-time)		Die DateTime: Diese Ressource wurde zuletzt aktualisiert.
optionalDeviceInformation	TwinCollection		Optionale Geräteinformationen.
provisioningStatus	ProvisioningStatus	enabled	Der Versorgungsstatus.
registrationId	string		Diese ID wird verwendet, um eine Geräteregistrierung einer Einschreibung eindeutig zu identifizieren. Eine kleinschreibungsunempfindliche Zeichenkette (bis zu 128 Zeichen lang) aus alphanumerischen Zeichen plus bestimmten Sonderzeichen : . _ -. Keine Spezialzeichen zu Beginn oder Ende erlaubt.
registrationState	DeviceRegistrationState		Aktueller Registrierungsstatus.
reprovisionPolicy	ReprovisionPolicy		Das Verhalten, wenn ein Gerät an einen IoT-Hub neu bereitgestellt wird.

InitialTwin

Objekt

Initiales Geräte-Zwilling. Enthält eine Teilmenge der Eigenschaften von Twin.

Name	Typ	Beschreibung
properties	InitialTwinProperties	Zwillingsgewünschte Eigenschaften.
tags	TwinCollection	Twin Tags.

InitialTwinProperties

Objekt

Repräsentiert die Anfangseigenschaften, die auf dem Gerätezwilling gesetzt werden.

Name	Typ	Beschreibung
desired	TwinCollection	Erhält und setzt die gewünschten Eigenschaften von InitialTwin.

Metadata

Objekt

Metadaten für die TwinCollection

Name	Typ	Beschreibung
lastUpdated	string (date-time)	Beim letzten Mal wurde die TwinCollection aktualisiert
lastUpdatedVersion	integer (int32)	Dies ist für gemeldete Properties-Metadaten null und nicht für gewünschte Properties-Metadaten.

ProvisioningServiceErrorDetails

Objekt

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

Name	Typ	Beschreibung
errorCode	integer (int32)	Fehlercode für die Operation.
info	object	Wörterbuch <Zeichenfolgen>
message	string	Für Menschen lesbare Fehlermeldung.
timestampUtc	string (date-time)	UTC-Zeitstempel des Fehlers.
trackingId	string	Tracking-ID für den Fehler.

ProvisioningStatus

Enumeration

Der Versorgungsstatus.

Wert	Beschreibung
enabled	enabled
disabled	deaktiviert

ReprovisionPolicy

Objekt

Das Verhalten des Dienstes, wenn ein Gerät an einen IoT-Hub neu bereitgestellt wird.

Name	Typ	Standardwert	Beschreibung
migrateDeviceData	boolean	True	Wenn der Device Provisioning Service auf true (Standard) gesetzt ist, überträgt er die Daten des Geräts (Zwilling, Gerätefähigkeiten und Geräte-ID) während eines IoT-Hub-Updates von einem IoT-Hub zum anderen. Setzt er auf False, setzt der Device Provisioning Service die Daten des Geräts auf die ursprünglich gewünschte Konfiguration zurück, die in der entsprechenden Einschreibungsliste gespeichert ist.
updateHubAssignment	boolean	True	Wenn es auf true (Standard) gesetzt ist, bewertet der Device Provisioning Service die IoT-Hub-Zuweisung des Geräts und aktualisiert sie bei Bedarf für Provisioning-Anfragen über die erste eines bestimmten Geräts hinaus. Setzt es auf falsch, bleibt das Gerät seinem aktuellen IoT-Hub zugewiesen.

SymmetricKeyAttestation

Objekt

Attestation über SymmetricKey.

Name	Typ	Beschreibung
primaryKey	string	Primäre symmetrische Tastart.
secondaryKey	string	Sekundärer symmetrischer Schlüssel.

TpmAttestation

Objekt

Attestierung mittels TPM.

Name	Typ	Beschreibung
endorsementKey	string	TPM-Endorsement-Schlüssel.
storageRootKey	string	TPM-Speicher-Root-Key.

TwinCollection

Objekt

Repräsentiert eine Sammlung von Eigenschaften innerhalb eines Zwillings

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

X509Attestation

Objekt

Attestierung über X509.

Name	Typ	Beschreibung
caReferences	X509CAReferences	Primäre und sekundäre CA-Referenzen.
clientCertificates	X509Certificates	Grundschul- und Sekundarschulzertifikate
signingCertificates	X509Certificates	Grundschul- und Sekundarschulzertifikate

X509CAReferences

Objekt

Primäre und sekundäre CA-Referenzen.

Name	Typ	Beschreibung
primary	string	Primäre Referenz in Kalifornien.
secondary	string	Sekundäre CA-Referenz.

X509CertificateInfo

Objekt

Informationen zum X509-Zertifikat.

Name	Typ	Beschreibung
issuerName	string	Name des Zertifikats ist der Herausgeber.
notAfterUtc	string (date-time)	Gültigkeit des Zertifikats endet (UTC).
notBeforeUtc	string (date-time)	Gültigkeit des Zertifikats beginnt (UTC).
serialNumber	string	Seriennummer des Zertifikats.
sha1Thumbprint	string	SHA-1-Daumenabdruck des Zertifikats.
sha256Thumbprint	string	SHA-256 Daumenabdruck des Zertifikats.
subjectName	string	Antragstellername des Zertifikats.
version	integer (int32)	Version des Zertifikats.

X509Certificates

Objekt

Grundschul- und Sekundarschulzertifikate

Name	Typ	Beschreibung
primary	X509CertificateWithInfo	Zertifikat und Zertifikatsinformationen
secondary	X509CertificateWithInfo	Zertifikat und Zertifikatsinformationen

X509CertificateWithInfo

Objekt

Zertifikat und Zertifikatsinformationen

Name	Typ	Beschreibung
certificate	string	PEM-formatierte Zertifikatszeichenzeichenfolge.
info	X509CertificateInfo	Informationen zum X509-Zertifikat.