Individual Enrollment - Run Bulk Operation

  • Reference
Service:
IoT Hub Device Provisioning Service
API Version:
2021-10-01

Operace hromadné registrace zařízení s maximálně 10 registracemi.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
api-version
 query True

string

Verze rozhraní API, která se má použít pro požadavek. Mezi podporované verze patří: 2021-10-01

Text požadavku

Name Vyžadováno Typ Description
enrollments True

IndividualEnrollment[]

Položky registrace
mode True enum:
  • create
  • update
  • updateIfMatchETag
  • delete

Provozní režim.

Odpovědi

Name Typ Description
200 OK

BulkEnrollmentOperationResult

Success
Other Status Codes

ProvisioningServiceErrorDetails

Chybová odpověď

Headers

x-ms-error-code: string

Definice

Name Description
AttestationMechanism

Mechanismus ověření identity pro individualEnrollment i enrollmentGroup.
BulkEnrollmentOperation

Operace hromadné registrace.
BulkEnrollmentOperationError

Chyba operace hromadné registrace
BulkEnrollmentOperationResult

Výsledky operace hromadné registrace
CustomAllocationDefinition

Tím dps zjistíte, který webhook má volat při použití vlastního přidělení.
DeviceCapabilities

Možnosti zařízení.
DeviceRegistrationState

Stav registrace zařízení.
IndividualEnrollment

Záznam registrace zařízení.
InitialTwin

Počáteční dvojče zařízení. Obsahuje podmnožinu vlastností dvojčete.
InitialTwinProperties

Představuje počáteční vlastnosti, které se nastaví na dvojčeti zařízení.
Metadata

Metadata pro TwinCollection
ProvisioningServiceErrorDetails

Obsahuje vlastnosti chyby vrácené službou Azure IoT Hub Provisioning.
ReprovisionPolicy

Chování služby při opětovném zřízení zařízení ve službě IoT Hub.
SymmetricKeyAttestation

Ověření identity přes SymmetricKey.
TpmAttestation

Ověření identity prostřednictvím čipu TPM.
TwinCollection

Představuje kolekci vlastností v rámci dvojčete.
X509Attestation

Ověření identity přes X509.
X509CAReferences

Odkazy na primární a sekundární certifikační autoritu.
X509CertificateInfo

Informace o certifikátu X509
X509Certificates

Primární a sekundární certifikáty
X509CertificateWithInfo

Informace o certifikátu a certifikátu

AttestationMechanism

Mechanismus ověření identity pro individualEnrollment i enrollmentGroup.

Name Typ Description
symmetricKey

SymmetricKeyAttestation

Ověření identity přes SymmetricKey.
tpm

TpmAttestation

Ověření identity prostřednictvím čipu TPM.
type enum:
  • none
  • symmetricKey
  • tpm
  • x509

Typ ověření identity.
x509

X509Attestation

Ověření identity přes X509.

BulkEnrollmentOperation

Operace hromadné registrace.

Name Typ Description
enrollments

IndividualEnrollment[]

Položky registrace
mode enum:
  • create
  • delete
  • update
  • updateIfMatchETag

Provozní režim.

BulkEnrollmentOperationError

Chyba operace hromadné registrace

Name Typ Description
errorCode

integer

Kód chyby
errorStatus

string

Stav chyby.
registrationId

string

Toto ID slouží k jedinečné identifikaci registrace zařízení. Řetězec alfanumerických znaků nerozlišující velká a malá písmena (dlouhý až 128 znaků) plus určité speciální znaky: . _ -. Na začátku ani na konci nejsou povolené žádné speciální znaky.

BulkEnrollmentOperationResult

Výsledky operace hromadné registrace

Name Typ Description
errors

BulkEnrollmentOperationError[]

Chyby registrace
isSuccessful

boolean

Označuje, jestli byla operace úspěšná v celém rozsahu.

CustomAllocationDefinition

Tím dps zjistíte, který webhook má volat při použití vlastního přidělení.

Name Typ Description
apiVersion

string

Verze rozhraní API typů služby zřizování (například IndividualEnrollment) odeslaná ve vlastní žádosti o přidělení Minimální podporovaná verze: "2018-09-01-preview".
webhookUrl

string

Adresa URL webhooku používaná pro žádosti o přidělení

DeviceCapabilities

Možnosti zařízení.

Name Typ Výchozí hodnota Description
iotEdge

boolean

False

Pokud je nastavená hodnota true, jedná se o zařízení IoTEdge.

DeviceRegistrationState

Stav registrace zařízení.

Name Typ Description
assignedHub

string

Přiřazeno Azure IoT Hub.
createdDateTimeUtc

string

Registrace vytvoří datum a čas (v UTC).
deviceId

string

ID zařízení.
errorCode

integer

Kód chyby
errorMessage

string

Chybová zpráva.
etag

string

Značka entity přidružená k prostředku.
lastUpdatedDateTimeUtc

string

Datum poslední aktualizace (v UTC)
payload

object

registrationId

string

Toto ID slouží k jedinečné identifikaci registrace zařízení. Řetězec alfanumerických znaků nerozlišující velká a malá písmena (dlouhý až 128 znaků) plus určité speciální znaky: . _ -. Na začátku ani na konci nejsou povolené žádné speciální znaky.
status enum:
  • assigned
  • assigning
  • disabled
  • failed
  • unassigned

Stav registrace.
substatus enum:
  • deviceDataMigrated
  • deviceDataReset
  • initialAssignment
  • reprovisionedToInitialAssignment

Dílčí stav pro přiřazená zařízení. Mezi možné hodnoty patří initialAssignment: Zařízení bylo poprvé přiřazeno ke službě IoT Hub, deviceDataMigrated: Zařízení bylo přiřazeno k jinému centru IoT a data zařízení se migrovala z dříve přiřazeného centra IoT. Data zařízení byla odebrána z dříve přiřazeného centra IoT, deviceDataReset: Zařízení bylo přiřazeno k jinému centru IoT a jeho data zařízení se naplnila z počátečního stavu uloženého v registraci. Data zařízení byla odebrána z dříve přiřazeného centra IoT, reprovisionedToInitialAssignment: Zařízení bylo znovu zřízeno na dříve přiřazené centrum IoT.

IndividualEnrollment

Záznam registrace zařízení.

Name Typ Výchozí hodnota Description
allocationPolicy enum:
  • custom
  • geoLatency
  • hashed
  • static

Zásady přidělování tohoto prostředku. Tato zásada přepíše zásady přidělení na úrovni tenanta pro tuto individuální registraci nebo skupinu registrací. Mezi možné hodnoty patří hodnota hash: Propojená centra IoT mají stejnou pravděpodobnost, že budou mít zařízení zřízená pro ně, "geoLatency": Zařízení se zřizují ve službě IoT Hub s nejnižší latencí zařízení. Pokud by více propojených center IoT poskytovalo stejnou nejnižší latenci, zřizovací služba vytřiďuje hodnoty hash zařízení v těchto centrech, statická: Specifikace požadovaného centra IoT v seznamu registrací má přednost před zásadami přidělování na úrovni služeb. Vlastní: Zařízení se zřídí do centra IoT na základě vlastní logiky. Zřizovací služba předá do logiky informace o zařízení a logika vrátí požadované centrum IoT a také požadovanou počáteční konfiguraci. K hostování logiky doporučujeme použít Azure Functions.
attestation

AttestationMechanism

Mechanismus ověření identity pro individualEnrollment i enrollmentGroup.
capabilities

DeviceCapabilities

Možnosti zařízení.
createdDateTimeUtc

string

DateTime byl tento prostředek vytvořen.
customAllocationDefinition

CustomAllocationDefinition

Tím dps zjistíte, který webhook má volat při použití vlastního přidělení.
deviceId

string

Desired IoT Hub ID zařízení (volitelné).
etag

string

Značka entity přidružená k prostředku.
initialTwin

InitialTwin

Počáteční dvojče zařízení. Obsahuje podmnožinu vlastností dvojčete.
iotHubHostName

string

Název hostitele služby Iot Hub.
iotHubs

string[]

Seznam IoT Hub názvů hostitelů, ke které lze zařízení v tomto prostředku přidělit. Musí být podmnožinou seznamu služeb IoT Hub na úrovni tenanta.
lastUpdatedDateTimeUtc

string

Datum a čas byl tento prostředek naposledy aktualizován.
optionalDeviceInformation

TwinCollection

Představuje kolekci vlastností v rámci dvojčete.
provisioningStatus enum:
  • disabled
  • enabled
enabled

Stav zřizování.
registrationId

string

Toto ID slouží k jedinečné identifikaci registrace zařízení. Řetězec alfanumerických znaků nerozlišující velká a malá písmena (dlouhý až 128 znaků) plus určité speciální znaky: . _ -. Na začátku ani na konci nejsou povolené žádné speciální znaky.
registrationState

DeviceRegistrationState

Stav registrace zařízení.
reprovisionPolicy

ReprovisionPolicy

Chování služby při opětovném zřízení zařízení ve službě IoT Hub.

InitialTwin

Počáteční dvojče zařízení. Obsahuje podmnožinu vlastností dvojčete.

Name Typ Description
properties

InitialTwinProperties

Představuje počáteční vlastnosti, které se nastaví na dvojčeti zařízení.
tags

TwinCollection

Představuje kolekci vlastností v rámci dvojčete.

InitialTwinProperties

Představuje počáteční vlastnosti, které se nastaví na dvojčeti zařízení.

Name Typ Description
desired

TwinCollection

Představuje kolekci vlastností v rámci dvojčete.

Metadata

Metadata pro TwinCollection

Name Typ Description
lastUpdated

string

Čas poslední aktualizace TwinCollection
lastUpdatedVersion

integer

Tato hodnota je null pro metadata ohlášených vlastností a není null pro metadata požadovaných vlastností.

ProvisioningServiceErrorDetails

Obsahuje vlastnosti chyby vrácené službou Azure IoT Hub Provisioning.

Name Typ Description
errorCode

integer

info

object

message

string

timestampUtc

string

trackingId

string

ReprovisionPolicy

Chování služby při opětovném zřízení zařízení ve službě IoT Hub.

Name Typ Výchozí hodnota Description
migrateDeviceData

boolean

True

Pokud je nastavená hodnota true (výchozí), služba Device Provisioning během aktualizace přiřazení centra IoT migruje data zařízení (dvojče, možnosti zařízení a ID zařízení) z jednoho centra IoT do jiného. Pokud je nastavená hodnota false, služba Device Provisioning resetuje data zařízení na počáteční požadovanou konfiguraci uloženou v odpovídajícím seznamu registrací.
updateHubAssignment

boolean

True

Pokud je nastavená hodnota true (výchozí), služba Device Provisioning vyhodnotí přiřazení IoT Hub zařízení a v případě potřeby ho aktualizuje pro jakékoli žádosti o zřízení nad rámec prvního z daného zařízení. Pokud je nastavená hodnota false, zařízení zůstane přiřazené k aktuálnímu centru IoT.

SymmetricKeyAttestation

Ověření identity přes SymmetricKey.

Name Typ Description
primaryKey

string

Primární symetrický klíč.
secondaryKey

string

Sekundární symetrický klíč.

TpmAttestation

Ověření identity prostřednictvím čipu TPM.

Name Typ Description
endorsementKey

string

storageRootKey

string

TwinCollection

Představuje kolekci vlastností v rámci dvojčete.

Name Typ Description
count

integer

Počet vlastností v TwinCollection
metadata

Metadata

Metadata pro TwinCollection
version

integer

Verze TwinCollection

X509Attestation

Ověření identity přes X509.

Name Typ Description
caReferences

X509CAReferences

Odkazy na primární a sekundární certifikační autoritu.
clientCertificates

X509Certificates

Primární a sekundární certifikáty
signingCertificates

X509Certificates

Primární a sekundární certifikáty

X509CAReferences

Odkazy na primární a sekundární certifikační autoritu.

Name Typ Description
primary

string

secondary

string

X509CertificateInfo

Informace o certifikátu X509

Name Typ Description
issuerName

string

notAfterUtc

string

notBeforeUtc

string

serialNumber

string

sha1Thumbprint

string

sha256Thumbprint

string

subjectName

string

version

integer

X509Certificates

Primární a sekundární certifikáty

Name Typ Description
primary

X509CertificateWithInfo

Informace o certifikátu a certifikátu
secondary

X509CertificateWithInfo

Informace o certifikátu a certifikátu

X509CertificateWithInfo

Informace o certifikátu a certifikátu

Name Typ Description
certificate

string

info

X509CertificateInfo

Informace o certifikátu X509