Enrollment Group - Run Bulk Operation

  • Referens
Service:
IoT Hub Device Provisioning Service
API Version:
2021-06-01

Gruppåtgärd för massregistrering med högst 10 grupper.

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

URI-parametrar

Name I Obligatorisk Typ Description
api-version
 query True

string

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

Begärandetext

Name Obligatorisk Typ Description
enrollmentGroups True

EnrollmentGroup[]

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

Åtgärdsläge.

Svar

Name Typ Description
200 OK

BulkEnrollmentGroupOperationResult

Klart
Other Status Codes

ProvisioningServiceErrorDetails

Felsvar

Definitioner

Name Description
AttestationMechanism

Attesteringsmekanism för individualEnrollment samt enrollmentGroup.
BulkEnrollmentGroupOperation

Massregistreringsåtgärd.
BulkEnrollmentGroupOperationError

Massregistreringsfel.
BulkEnrollmentGroupOperationResult

Resultat av en massregistreringsgruppåtgärd.
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 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

Symmetrisk nyckelattesteringsmetod.
tpm

TpmAttestation

TPM-attesteringsmetod.
type enum:
  • none
  • symmetricKey
  • tpm
  • x509

Attesteringstyp.
x509

X509Attestation

X509-attesteringsmetod.

BulkEnrollmentGroupOperation

Massregistreringsåtgärd.

Name Typ Description
enrollmentGroups

EnrollmentGroup[]

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

Åtgärdsläge.

BulkEnrollmentGroupOperationError

Massregistreringsfel.

Name Typ Description
enrollmentGroupId

string

Registreringsgrupp-ID.
errorCode

integer

Felkod
errorStatus

string

Felstatus.

BulkEnrollmentGroupOperationResult

Resultat av en massregistreringsgruppåtgärd.

Name Typ Description
errors

BulkEnrollmentGroupOperationError[]

Registreringsfel
isSuccessful

boolean

Anger om åtgärden lyckades i sin helhet.

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.

EnrollmentGroup

Registreringsgrupppost.

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

Attesteringsmetod som används av enheten.
capabilities

DeviceCapabilities

Enhetens funktioner.
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.
enrollmentGroupId

string

Grupp-ID för registrering.
etag

string

Entitetstaggen som är associerad med resursen.
initialTwin

InitialTwin

Första enhetstvilling.
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.
provisioningStatus enum:
  • disabled
  • enabled
enabled

Etableringsstatus.
reprovisionPolicy

ReprovisionPolicy

Beteendet 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

Önskade egenskaper för tvillingen.
tags

TwinCollection

Tvillingtaggar.

InitialTwinProperties

Representerar de inledande egenskaperna som ska anges på enhetstvillingen.

Name Typ Description
desired

TwinCollection

Hämtar och anger önskade InitialTwin-egenskaper.

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.