Individual Enrollment - Run Bulk Operation

Bulksgewijs apparaatinschrijving met maximaal 10 inschrijvingen.

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

URI-parameters

Name In Vereist Type Description
api-version
query True

string

De API-versie die moet worden gebruikt voor de aanvraag. Ondersteunde versies zijn: 2021-06-01

Aanvraagbody

Name Vereist Type Description
enrollments True

IndividualEnrollment[]

Inschrijvingsitems

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

Bewerkingsmodus.

Antwoorden

Name Type Description
200 OK

BulkEnrollmentOperationResult

Geslaagd

Other Status Codes

ProvisioningServiceErrorDetails

Foutreactie

Definities

Name Description
AttestationMechanism

Attestation-mechanisme voor individualEnrollment en enrollmentGroup.

BulkEnrollmentOperation

Bulkinschrijvingsbewerking.

BulkEnrollmentOperationError

Fout bij bulkinschrijvingsbewerking

BulkEnrollmentOperationResult

Resultaten van een bulkinschrijvingsbewerking

CustomAllocationDefinition

Hiermee vertelt DPS welke webhook moet worden aangeroepen bij het gebruik van aangepaste toewijzing.

DeviceCapabilities

Apparaatmogelijkheden.

DeviceRegistrationState

Status van apparaatregistratie.

IndividualEnrollment

De registratierecord van het apparaat.

InitialTwin

Eerste apparaatdubbel. Bevat een subset van de eigenschappen van Dubbel.

InitialTwinProperties

Vertegenwoordigt de eerste eigenschappen die worden ingesteld op de apparaatdubbel.

Metadata

Metagegevens voor de TwinCollection

ProvisioningServiceErrorDetails

Bevat de eigenschappen van een fout die is geretourneerd door de Azure IoT Hub Provisioning Service.

ReprovisionPolicy

Het gedrag van de service wanneer een apparaat opnieuw wordt ingericht voor een IoT-hub.

SymmetricKeyAttestation

Attestation via SymmetricKey.

TpmAttestation

Attestation via TPM.

TwinCollection

Vertegenwoordigt een verzameling eigenschappen binnen een dubbel

X509Attestation

Attestation via X509.

X509CAReferences

Primaire en secundaire CA-verwijzingen.

X509CertificateInfo

X509-certificaatgegevens.

X509Certificates

Primaire en secundaire certificaten

X509CertificateWithInfo

Certificaat en certificaatgegevens

AttestationMechanism

Attestation-mechanisme voor individualEnrollment en enrollmentGroup.

Name Type Description
symmetricKey

SymmetricKeyAttestation

Attestation-methode voor symmetrische sleutel.

tpm

TpmAttestation

TPM-attestation-methode.

type enum:
  • none
  • symmetricKey
  • tpm
  • x509

Attestation-type.

x509

X509Attestation

X509 attestation-methode.

BulkEnrollmentOperation

Bulkinschrijvingsbewerking.

Name Type Description
enrollments

IndividualEnrollment[]

Inschrijvingsitems

mode enum:
  • create
  • delete
  • update
  • updateIfMatchETag

Bewerkingsmodus.

BulkEnrollmentOperationError

Fout bij bulkinschrijvingsbewerking

Name Type Description
errorCode

integer

Foutcode

errorStatus

string

Foutstatus.

registrationId

string

Apparaatregistratie-id.

BulkEnrollmentOperationResult

Resultaten van een bulkinschrijvingsbewerking

Name Type Description
errors

BulkEnrollmentOperationError[]

Registratiefouten

isSuccessful

boolean

Geeft aan of de bewerking in zijn geheel is geslaagd.

CustomAllocationDefinition

Hiermee vertelt DPS welke webhook moet worden aangeroepen bij het gebruik van aangepaste toewijzing.

Name Type Description
apiVersion

string

De API-versie van de inrichtingsservicetypen (zoals IndividualEnrollment) die zijn verzonden in de aangepaste toewijzingsaanvraag. Minimaal ondersteunde versie: "2018-09-01-preview".

webhookUrl

string

De url van de webhook die wordt gebruikt voor toewijzingsaanvragen.

DeviceCapabilities

Apparaatmogelijkheden.

Name Type Standaardwaarde Description
iotEdge

boolean

false

Als dit is ingesteld op true, is dit apparaat een IoTEdge-apparaat.

DeviceRegistrationState

Status van apparaatregistratie.

Name Type Description
assignedHub

string

Toegewezen Azure IoT Hub.

createdDateTimeUtc

string

Datum van registratie maken (in UTC).

deviceId

string

Apparaat-id.

errorCode

integer

Foutcode.

errorMessage

string

Foutbericht.

etag

string

De entiteitstag die is gekoppeld aan de resource.

lastUpdatedDateTimeUtc

string

Datum/tijd laatst bijgewerkt (in UTC).

payload

object

Aangepaste toewijzingspayload die door de webhook naar het apparaat wordt geretourneerd.

registrationId

string

De registratie-id is alfanumeriek, kleine letters en kan afbreekstreepjes bevatten.

status enum:
  • assigned
  • assigning
  • disabled
  • failed
  • unassigned

Inschrijvingsstatus.

substatus enum:
  • deviceDataMigrated
  • deviceDataReset
  • initialAssignment
  • reprovisionedToInitialAssignment

Substatus voor toegewezen apparaten. Mogelijke waarden zijn : 'initialAssignment': het apparaat is voor het eerst toegewezen aan een IoT-hub, 'deviceDataMigrated': het apparaat is toegewezen aan een andere IoT-hub en de apparaatgegevens zijn gemigreerd vanuit de eerder toegewezen IoT-hub. Apparaatgegevens zijn verwijderd uit de eerder toegewezen IoT-hub deviceDataReset: het apparaat is toegewezen aan een andere IoT-hub en de apparaatgegevens zijn ingevuld vanaf de oorspronkelijke status die is opgeslagen in de inschrijving. Apparaatgegevens zijn verwijderd uit de eerder toegewezen IoT-hub, 'reprovisionedToInitialAssignment': het apparaat is opnieuw ingericht voor een eerder toegewezen IoT-hub.

IndividualEnrollment

De registratierecord van het apparaat.

Name Type Standaardwaarde Description
allocationPolicy enum:
  • custom
  • geoLatency
  • hashed
  • static

Het toewijzingsbeleid van deze resource. Dit beleid overschrijft het toewijzingsbeleid op tenantniveau voor deze afzonderlijke inschrijving of inschrijvingsgroep. Mogelijke waarden zijn 'gehasht': gekoppelde IoT-hubs hebben even waarschijnlijk apparaten ingericht, 'geoLatency': apparaten worden ingericht voor een IoT-hub met de laagste latentie voor het apparaat. Als meerdere gekoppelde IoT-hubs dezelfde laagste latentie bieden, worden door de inrichtingsservice apparaten in deze hubs 'statisch' gehesen: de specificatie van de gewenste IoT-hub in de registratielijst heeft voorrang op het toewijzingsbeleid op serviceniveau 'aangepast': apparaten worden ingericht voor een IoT-hub op basis van uw eigen aangepaste logica. De inrichtingsservice geeft informatie over het apparaat door aan de logica en de logica retourneert de gewenste IoT-hub en de gewenste initiële configuratie. U wordt aangeraden Azure Functions te gebruiken om uw logica te hosten.

attestation

AttestationMechanism

Attestation-methode die door het apparaat wordt gebruikt.

capabilities

DeviceCapabilities

Mogelijkheden van het apparaat.

createdDateTimeUtc

string

De Datum/tijd van deze resource is gemaakt.

customAllocationDefinition

CustomAllocationDefinition

Hiermee vertelt DPS welke webhook moet worden aangeroepen bij het gebruik van aangepaste toewijzing.

deviceId

string

Gewenste IoT Hub apparaat-id (optioneel).

etag

string

De entiteitstag die is gekoppeld aan de resource.

initialTwin

InitialTwin

Eerste apparaatdubbel.

iotHubHostName

string

De hostnaam van de IoT Hub.

iotHubs

string[]

De lijst met IoT Hub hostnamen waaraan de apparaten in deze resource kunnen worden toegewezen. Moet een subset zijn van de lijst met IoT-hubs op tenantniveau.

lastUpdatedDateTimeUtc

string

De Datum/tijd van deze resource is voor het laatst bijgewerkt.

optionalDeviceInformation

TwinCollection

Optionele apparaatgegevens.

provisioningStatus enum:
  • disabled
  • enabled
enabled

De inrichtingsstatus.

registrationId

string

De registratie-id is alfanumeriek, kleine letters en kan afbreekstreepjes bevatten.

registrationState

DeviceRegistrationState

Huidige registratiestatus.

reprovisionPolicy

ReprovisionPolicy

Het gedrag wanneer een apparaat opnieuw wordt ingericht voor een IoT-hub.

InitialTwin

Eerste apparaatdubbel. Bevat een subset van de eigenschappen van Dubbel.

Name Type Description
properties

InitialTwinProperties

Gewenste eigenschappen van dubbels.

tags

TwinCollection

Dubbele tags.

InitialTwinProperties

Vertegenwoordigt de eerste eigenschappen die worden ingesteld op de apparaatdubbel.

Name Type Description
desired

TwinCollection

Hiermee worden de gewenste eigenschappen van InitialTwin opgehaald en ingesteld.

Metadata

Metagegevens voor de TwinCollection

Name Type Description
lastUpdated

string

De laatste keer dat de TwinCollection is bijgewerkt

lastUpdatedVersion

integer

Dit is null voor metagegevens van gerapporteerde eigenschappen en is niet null voor metagegevens van gewenste eigenschappen.

ProvisioningServiceErrorDetails

Bevat de eigenschappen van een fout die is geretourneerd door de Azure IoT Hub Provisioning Service.

Name Type Description
errorCode

integer

info

object

message

string

timestampUtc

string

trackingId

string

ReprovisionPolicy

Het gedrag van de service wanneer een apparaat opnieuw wordt ingericht voor een IoT-hub.

Name Type Standaardwaarde Description
migrateDeviceData

boolean

true

Als deze optie is ingesteld op true (standaard), migreert Device Provisioning Service de gegevens van het apparaat (dubbel, apparaatmogelijkheden en apparaat-id) van de ene IoT-hub naar de andere tijdens een update van een IoT-hubtoewijzing. Als deze optie is ingesteld op onwaar, worden de gegevens van het apparaat opnieuw ingesteld op de oorspronkelijke gewenste configuratie die is opgeslagen in de bijbehorende inschrijvingslijst.

updateHubAssignment

boolean

true

Als deze optie is ingesteld op true (standaard), evalueert Device Provisioning Service de IoT Hub toewijzing van het apparaat en werkt deze zo nodig bij voor inrichtingsaanvragen die verder gaan dan de eerste van een bepaald apparaat. Als dit is ingesteld op false, blijft het apparaat toegewezen aan de huidige IoT-hub.

SymmetricKeyAttestation

Attestation via SymmetricKey.

Name Type Description
primaryKey

string

Primaire symmetrische sleutel.

secondaryKey

string

Secundaire symmetrische sleutel.

TpmAttestation

Attestation via TPM.

Name Type Description
endorsementKey

string

storageRootKey

string

TwinCollection

Vertegenwoordigt een verzameling eigenschappen binnen een dubbel

Name Type Description
count

integer

Aantal eigenschappen in de TwinCollection

metadata

Metadata

Metagegevens voor de TwinCollection

version

integer

Versie van de TwinCollection

X509Attestation

Attestation via X509.

Name Type Description
caReferences

X509CAReferences

Primaire en secundaire CA-verwijzingen.

clientCertificates

X509Certificates

Primaire en secundaire certificaten

signingCertificates

X509Certificates

Primaire en secundaire certificaten

X509CAReferences

Primaire en secundaire CA-verwijzingen.

Name Type Description
primary

string

secondary

string

X509CertificateInfo

X509-certificaatgegevens.

Name Type Description
issuerName

string

notAfterUtc

string

notBeforeUtc

string

serialNumber

string

sha1Thumbprint

string

sha256Thumbprint

string

subjectName

string

version

integer

X509Certificates

Primaire en secundaire certificaten

Name Type Description
primary

X509CertificateWithInfo

Certificaat en certificaatgegevens

secondary

X509CertificateWithInfo

Certificaat en certificaatgegevens

X509CertificateWithInfo

Certificaat en certificaatgegevens

Name Type Description
certificate

string

info

X509CertificateInfo

X509-certificaatgegevens.