Dela via

Enrollment Group - Create Or Update

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

Skapa eller uppdatera en enhetsregistreringsgrupp.

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

URI-parametrar

Name I Obligatorisk Typ Description
id
 path True

string

Registreringsgrupp-ID.
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.
enrollmentGroupId True

string

minLength: 1

Registreringsgrupp-ID.
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 inkluderar "hashed": Länkade IoT-hubbar har lika stor sannolikhet att ha enheter etablerade till dem, "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, "static" : 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.
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.
provisioningStatus enum:
  • enabled
  • disabled

Etableringsstatus.
reprovisionPolicy

ReprovisionPolicy

Tjänstens beteende när en enhet etableras på nytt till en IoT-hubb.

Svar

Name Typ Description
200 OK

EnrollmentGroup

Framgång
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.
EnrollmentGroup

Registreringsgrupppost.
InitialTwin

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

Representerar de initiala egenskaper 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

Tjänstens beteende när en enhet etableras på nytt till en IoT-hubb.
SymmetricKeyAttestation

Attestering via SymmetricKey.
TpmAttestation

Attestering via TPM.
TwinCollection

Representerar en samling egenskaper i 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

Information om certifikat och certifikat

AttestationMechanism

Objekt

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

Objekt

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

Name Typ Description
apiVersion

string

minLength: 1

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

minLength: 1

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

DeviceCapabilities

Objekt

Enhetsfunktioner.

Name Typ Standardvärde Description
iotEdge

boolean

False

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

EnrollmentGroup

Objekt

Registreringsgrupppost.

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

Resursens allokeringsprincip. Den här principen åsidosätter allokeringsprincipen på klientnivå för den här enskilda registrerings- eller registreringsgruppen. Möjliga värden inkluderar "hashed": Länkade IoT-hubbar har lika stor sannolikhet att ha enheter etablerade till dem, "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, "static" : 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.
attestation

AttestationMechanism

Attesteringsmekanism för individualEnrollment samt enrollmentGroup.
capabilities

DeviceCapabilities

Enhetsfunktioner.
createdDateTimeUtc

string (date-time)

DateTime 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.
enrollmentGroupId

string

minLength: 1

Registreringsgrupp-ID.
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.
lastUpdatedDateTimeUtc

string (date-time)

DateTime den här resursen uppdaterades senast.
provisioningStatus enum:
  • disabled
  • enabled
enabled

Etableringsstatus.
reprovisionPolicy

ReprovisionPolicy

Tjänstens beteende när en enhet etableras på nytt till en IoT-hubb.

InitialTwin

Objekt

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

Name Typ Description
properties

InitialTwinProperties

Representerar de initiala egenskaper som ska anges på enhetstvillingen.
tags

TwinCollection

Representerar en samling egenskaper i en tvilling

InitialTwinProperties

Objekt

Representerar de initiala egenskaper som ska anges på enhetstvillingen.

Name Typ Description
desired

TwinCollection

Representerar en samling egenskaper i en tvilling

Metadata

Objekt

Metadata för TwinCollection

Name Typ Description
lastUpdated

string (date-time)

Senaste gången TwinCollection uppdaterades
lastUpdatedVersion

integer (int64)

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

ProvisioningServiceErrorDetails

Objekt

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

Name Typ Description
errorCode

integer (int32)

info

object

message

string

timestampUtc

string (date-time)

trackingId

string

ReprovisionPolicy

Objekt

Tjänstens beteende 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 Enhetsetableringstjänsten enhetens data (tvilling, enhetsfunktioner och enhets-ID) från en IoT-hubb till en annan under en IoT Hub-tilldelningsuppdatering. 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 Enhetsetableringstjänsten enhetens IoT Hub-tilldelning och uppdaterar den om det behövs för eventuella etableringsbegäranden utöver den första från en viss enhet. Om värdet är falskt förblir enheten tilldelad till sin aktuella IoT-hubb.

SymmetricKeyAttestation

Objekt

Attestering via SymmetricKey.

Name Typ Description
primaryKey

string

Primär symmetrisk nyckel.
secondaryKey

string

Sekundär symmetrisk nyckel.

TpmAttestation

Objekt

Attestering via TPM.

Name Typ Description
endorsementKey

string

storageRootKey

string

TwinCollection

Objekt

Representerar en samling egenskaper i en tvilling

Name Typ Description
count

integer

Antal egenskaper i TwinCollection
metadata

Metadata

Metadata för TwinCollection
version

integer (int64)

Version av TwinCollection

X509Attestation

Objekt

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

Objekt

Primära och sekundära CA-referenser.

Name Typ Description
primary

string

secondary

string

X509CertificateInfo

Objekt

X509-certifikatinformation.

Name Typ Description
issuerName

string

notAfterUtc

string (date-time)

notBeforeUtc

string (date-time)

serialNumber

string

sha1Thumbprint

string

sha256Thumbprint

string

subjectName

string

version

integer (int32)

X509Certificates

Objekt

Primära och sekundära certifikat

Name Typ Description
primary

X509CertificateWithInfo

Information om certifikat och certifikat
secondary

X509CertificateWithInfo

Information om certifikat och certifikat

X509CertificateWithInfo

Objekt

Information om certifikat och certifikat

Name Typ Description
certificate

string

info

X509CertificateInfo

X509-certifikatinformation.