Dela via

Individual Enrollment - Create Or Update

  • Referens
Tjänst:
IoT Hub Device Provisioning Service
API-version:
2021-10-01

Skapa eller uppdatera en enhetsregistreringspost.

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

URI-parametrar

Name I Obligatorisk Typ Description
id
 path True

string

Det här ID:t används för att unikt identifiera en enhetsregistrering av en registrering. En skiftlägesokänslig sträng (upp till 128 tecken lång) med alfanumeriska tecken plus vissa specialtecken : . _ -. Inga specialtecken tillåts i början eller slutet.
api-version
 query True

string

DEN API-version som ska användas för begäran. Versioner som stöds är: 2021-10-01

Begärandehuvud

Name Obligatorisk Typ Description
If-Match

string

ETag för registreringsposten.

Begärandetext

Name Obligatorisk Typ Description
attestation True

AttestationMechanism

Attesteringsmekanism för individualEnrollment samt enrollmentGroup.
registrationId True

string

Det här ID:t används för att unikt identifiera en enhetsregistrering av en registrering. En skiftlägesokänslig sträng (upp till 128 tecken lång) med alfanumeriska tecken plus vissa specialtecken: . _ -. Inga specialtecken tillåts i början eller slutet.
allocationPolicy enum:
  • hashed
  • geoLatency
  • static
  • custom

Resursens allokeringsprincip. Den här principen åsidosätter allokeringsprincipen på klientnivå för den här enskilda registrerings- eller registreringsgruppen. Möjliga värden är "hashed": Länkade IoT-hubbar har lika stor sannolikhet att ha enheter etablerade till sig, "geoLatency": Enheter etableras till en IoT-hubb med den lägsta svarstiden till enheten. Om flera länkade IoT-hubbar skulle ge samma lägsta svarstid prioriterar etableringstjänsten enheter över dessa hubbar, "statisk" : Specifikationen av önskad IoT-hubb i registreringslistan prioriteras framför allokeringsprincipen på tjänstnivå, "anpassad": Enheter etableras till en IoT-hubb baserat på din egen anpassade logik. Etableringstjänsten skickar information om enheten till logiken och logiken returnerar önskad IoT-hubb samt önskad inledande konfiguration. Vi rekommenderar att du använder Azure Functions som värd för din logik.
capabilities

DeviceCapabilities

Enhetsfunktioner.
customAllocationDefinition

CustomAllocationDefinition

Detta talar om för DPS vilken webhook som ska anropas när du använder anpassad allokering.
deviceId

string

Önskat IoT Hub enhets-ID (valfritt).
etag

string

Entitetstaggen som är associerad med resursen.
initialTwin

InitialTwin

Första enhetstvilling. Innehåller en delmängd av egenskaperna för Twin.
iotHubHostName

string

Iot Hub-värdnamnet.
iotHubs

string[]

Listan över IoT Hub värdnamn som enheterna i den här resursen kan allokeras till. Måste vara en delmängd av klientnivålistan över IoT-hubbar.
optionalDeviceInformation

TwinCollection

Representerar en samling egenskaper inom en tvilling
provisioningStatus enum:
  • enabled
  • disabled

Etableringsstatus.
registrationState

DeviceRegistrationState

Enhetsregistreringstillstånd.
reprovisionPolicy

ReprovisionPolicy

Beteendet för tjänsten när en enhet etableras på nytt till en IoT-hubb.

Svar

Name Typ Description
200 OK

IndividualEnrollment

Klart
Other Status Codes

ProvisioningServiceErrorDetails

Felsvar

Sidhuvuden

x-ms-error-code: string

Definitioner

Name Description
AttestationMechanism

Attesteringsmekanism för individualEnrollment samt enrollmentGroup.
CustomAllocationDefinition

Detta talar om för DPS vilken webhook som ska anropas när du använder anpassad allokering.
DeviceCapabilities

Enhetsfunktioner.
DeviceRegistrationState

Enhetsregistreringstillstånd.
IndividualEnrollment

Enhetsregistreringsposten.
InitialTwin

Första enhetstvilling. Innehåller en delmängd av egenskaperna för Twin.
InitialTwinProperties

Representerar de inledande egenskaperna som ska anges på enhetstvillingen.
Metadata

Metadata för TwinCollection
ProvisioningServiceErrorDetails

Innehåller egenskaperna för ett fel som returneras av Azure IoT Hub Provisioning Service.
ReprovisionPolicy

Beteendet för tjänsten när en enhet etableras på nytt till en IoT-hubb.
SymmetricKeyAttestation

Attestering via SymmetricKey.
TpmAttestation

Attestering via TPM.
TwinCollection

Representerar en samling egenskaper inom en tvilling
X509Attestation

Attestering via X509.
X509CAReferences

Primära och sekundära CA-referenser.
X509CertificateInfo

X509-certifikatinformation.
X509Certificates

Primära och sekundära certifikat
X509CertificateWithInfo

Certifikat- och certifikatinformation

AttestationMechanism

Attesteringsmekanism för individualEnrollment samt enrollmentGroup.

Name Typ Description
symmetricKey

SymmetricKeyAttestation

Attestering via SymmetricKey.
tpm

TpmAttestation

Attestering via TPM.
type enum:
  • none
  • symmetricKey
  • tpm
  • x509

Attesteringstyp.
x509

X509Attestation

Attestering via X509.

CustomAllocationDefinition

Detta talar om för DPS vilken webhook som ska anropas när du använder anpassad allokering.

Name Typ Description
apiVersion

string

API-versionen av etableringstjänsttyperna (till exempel IndividualEnrollment) som skickas i den anpassade allokeringsbegäran. Lägsta version som stöds: "2018-09-01-preview".
webhookUrl

string

Webhook-URL:en som används för allokeringsbegäranden.

DeviceCapabilities

Enhetsfunktioner.

Name Typ Standardvärde Description
iotEdge

boolean

False

Om värdet är true är den här enheten en IoTEdge-enhet.

DeviceRegistrationState

Enhetsregistreringstillstånd.

Name Typ Description
assignedHub

string

Tilldelade Azure IoT Hub.
createdDateTimeUtc

string

Registrering skapa datumtid (i UTC).
deviceId

string

Enhets-ID.
errorCode

integer

Felkod.
errorMessage

string

Felmeddelande.
etag

string

Entitetstaggen som är associerad med resursen.
lastUpdatedDateTimeUtc

string

Senast uppdaterad datumtid (i UTC).
payload

object

registrationId

string

Det här ID:t används för att unikt identifiera en enhetsregistrering av en registrering. En skiftlägesokänslig sträng (upp till 128 tecken lång) med alfanumeriska tecken plus vissa specialtecken: . _ -. Inga specialtecken tillåts i början eller slutet.
status enum:
  • assigned
  • assigning
  • disabled
  • failed
  • unassigned

Registreringsstatus.
substatus enum:
  • deviceDataMigrated
  • deviceDataReset
  • initialAssignment
  • reprovisionedToInitialAssignment

Understatus för tilldelade enheter. Möjliga värden är – "initialAssignment": Enheten har tilldelats till en IoT-hubb för första gången, "deviceDataMigrated": Enheten har tilldelats till en annan IoT-hubb och dess enhetsdata har migrerats från den tidigare tilldelade IoT-hubben. Enhetsdata togs bort från den tidigare tilldelade IoT-hubben deviceDataReset: Enheten har tilldelats till en annan IoT-hubb och dess enhetsdata fylldes i från det ursprungliga tillståndet som lagrades i registreringen. Enhetsdata togs bort från den tidigare tilldelade IoT-hubben "reprovisionedToInitialAssignment": Enheten har ometablerats till en tidigare tilldelad IoT-hubb.

IndividualEnrollment

Enhetsregistreringsposten.

Name Typ Standardvärde Description
allocationPolicy enum:
  • custom
  • geoLatency
  • hashed
  • static

Allokeringsprincipen för den här resursen. Den här principen åsidosätter allokeringsprincipen på klientnivå för den här enskilda registrerings- eller registreringsgruppen. Möjliga värden är "hashade": Länkade IoT-hubbar har lika stor sannolikhet att ha enheter etablerade till sig, "geoLatency": Enheter etableras till en IoT-hubb med den lägsta svarstiden till enheten. Om flera länkade IoT-hubbar skulle ge samma lägsta svarstid prioriteras etableringstjänstens hashenheter mellan dessa hubbar, "statisk" : Specifikationen för önskad IoT-hubb i registreringslistan prioriteras framför allokeringsprincipen på tjänstnivå, "anpassad": Enheter etableras till en IoT-hubb baserat på din egen anpassade logik. Etableringstjänsten skickar information om enheten till logiken och logiken returnerar önskad IoT-hubb samt önskad inledande konfiguration. Vi rekommenderar att du använder Azure Functions som värd för din logik.
attestation

AttestationMechanism

Attesteringsmekanism för individualEnrollment samt enrollmentGroup.
capabilities

DeviceCapabilities

Enhetsfunktioner.
createdDateTimeUtc

string

DateTime som den här resursen skapades.
customAllocationDefinition

CustomAllocationDefinition

Detta talar om för DPS vilken webhook som ska anropas när du använder anpassad allokering.
deviceId

string

Önskat IoT Hub enhets-ID (valfritt).
etag

string

Entitetstaggen som är associerad med resursen.
initialTwin

InitialTwin

Första enhetstvilling. Innehåller en delmängd av egenskaperna för Twin.
iotHubHostName

string

Iot Hub-värdnamnet.
iotHubs

string[]

Listan över IoT Hub värdnamn som enheterna i den här resursen kan allokeras till. Måste vara en delmängd av listan på klientorganisationsnivå för IoT-hubbar.
lastUpdatedDateTimeUtc

string

DateTime den här resursen uppdaterades senast.
optionalDeviceInformation

TwinCollection

Representerar en samling egenskaper inom en tvilling
provisioningStatus enum:
  • disabled
  • enabled
enabled

Etableringsstatus.
registrationId

string

Det här ID:t används för att unikt identifiera en enhetsregistrering av en registrering. En skiftlägesokänslig sträng (upp till 128 tecken lång) med alfanumeriska tecken plus vissa specialtecken: . _ -. Inga specialtecken tillåts i början eller slutet.
registrationState

DeviceRegistrationState

Enhetsregistreringstillstånd.
reprovisionPolicy

ReprovisionPolicy

Beteendet för tjänsten när en enhet etableras på nytt till en IoT-hubb.

InitialTwin

Första enhetstvilling. Innehåller en delmängd av egenskaperna för Twin.

Name Typ Description
properties

InitialTwinProperties

Representerar de inledande egenskaperna som ska anges på enhetstvillingen.
tags

TwinCollection

Representerar en samling egenskaper inom en tvilling

InitialTwinProperties

Representerar de inledande egenskaperna som ska anges på enhetstvillingen.

Name Typ Description
desired

TwinCollection

Representerar en samling egenskaper inom en tvilling

Metadata

Metadata för TwinCollection

Name Typ Description
lastUpdated

string

Senaste gången TwinCollection uppdaterades
lastUpdatedVersion

integer

Detta är null för metadata för rapporterade egenskaper och är inte null för metadata för önskade egenskaper.

ProvisioningServiceErrorDetails

Innehåller egenskaperna för ett fel som returneras av Azure IoT Hub Provisioning Service.

Name Typ Description
errorCode

integer

info

object

message

string

timestampUtc

string

trackingId

string

ReprovisionPolicy

Beteendet för tjänsten när en enhet etableras på nytt till en IoT-hubb.

Name Typ Standardvärde Description
migrateDeviceData

boolean

True

När värdet är true (standard) migrerar Device Provisioning Service enhetens data (tvilling, enhetsfunktioner och enhets-ID) från en IoT-hubb till en annan under en uppdatering av IoT Hub-tilldelningen. Om värdet är falskt återställer Enhetsetableringstjänsten enhetens data till den ursprungliga önskade konfigurationen som lagras i motsvarande registreringslista.
updateHubAssignment

boolean

True

När värdet är true (standard) utvärderar Device Provisioning Service enhetens IoT Hub tilldelning och uppdaterar den om det behövs för alla etableringsbegäranden utöver den första från en viss enhet. Om värdet är false förblir enheten tilldelad till sin aktuella IoT-hubb.

SymmetricKeyAttestation

Attestering via SymmetricKey.

Name Typ Description
primaryKey

string

Primär symmetrisk nyckel.
secondaryKey

string

Sekundär symmetrisk nyckel.

TpmAttestation

Attestering via TPM.

Name Typ Description
endorsementKey

string

storageRootKey

string

TwinCollection

Representerar en samling egenskaper inom en tvilling

Name Typ Description
count

integer

Antal egenskaper i TwinCollection
metadata

Metadata

Metadata för TwinCollection
version

integer

Version av TwinCollection

X509Attestation

Attestering via X509.

Name Typ Description
caReferences

X509CAReferences

Primära och sekundära CA-referenser.
clientCertificates

X509Certificates

Primära och sekundära certifikat
signingCertificates

X509Certificates

Primära och sekundära certifikat

X509CAReferences

Primära och sekundära CA-referenser.

Name Typ Description
primary

string

secondary

string

X509CertificateInfo

X509-certifikatinformation.

Name Typ Description
issuerName

string

notAfterUtc

string

notBeforeUtc

string

serialNumber

string

sha1Thumbprint

string

sha256Thumbprint

string

subjectName

string

version

integer

X509Certificates

Primära och sekundära certifikat

Name Typ Description
primary

X509CertificateWithInfo

Certifikat- och certifikatinformation
secondary

X509CertificateWithInfo

Certifikat- och certifikatinformation

X509CertificateWithInfo

Certifikat- och certifikatinformation

Name Typ Description
certificate

string

info

X509CertificateInfo

X509-certifikatinformation.