Individual Enrollment - Get

  • Reference
Služba:
IoT Hub Device Provisioning Service
Verze rozhraní API:
2021-10-01

Získání záznamu o registraci zařízení

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
id
 path True

string

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

string

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

Odpovědi

Name Typ Description
200 OK

IndividualEnrollment

Success
Other Status Codes

ProvisioningServiceErrorDetails

Chybová odpověď

Hlavičky

x-ms-error-code: string

Definice

Name Description
AttestationMechanism

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

To službě DPS řekne, 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é budou nastaveny na dvojčeti zařízení.
Metadata

Metadata pro TwinCollection
ProvisioningServiceErrorDetails

Obsahuje vlastnosti chyby vrácené službou Azure IoT Hub Provisioning Service.
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 prostřednictvím 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 prostřednictvím X509.

CustomAllocationDefinition

To službě DPS řekne, 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á v požadavku na vlastní přidělení. Minimální podporovaná verze: 2018-09-01-preview.
webhookUrl

string

Adresa URL webhooku, která se používá pro žádosti o přidělení.

DeviceCapabilities

Možnosti zařízení.

Name Typ Default value 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

Datum vytvoření registrace (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 a čas poslední aktualizace (v UTC)
payload

object

registrationId

string

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

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

Dílčí stav přiřazených 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í se odebrala z dříve přiřazeného centra IoT, deviceDataReset: Zařízení bylo přiřazeno k jinému centru IoT a data zařízení se naplnila od počátečního stavu uloženého v registraci. Data zařízení se odebrala z dříve přiřazeného centra IoT, reprovisionedToInitialAssignment: Zařízení bylo znovu zřízeno do dříve přiřazeného centra IoT.

IndividualEnrollment

Záznam registrace zařízení.

Name Typ Default value 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ělování na úrovni tenanta pro tuto jednotlivou registraci nebo skupinu registrací. Mezi možné hodnoty patří hodnota hash: U propojených center IoT je stejně pravděpodobné, že pro ně budou zřízená zařízení, "geolatency": Zařízení se zřizují ve službě IoT Hub s nejnižší latencí pro zařízení. Pokud by několik propojených center IoT poskytovalo stejnou nejnižší latenci, služba zřizování vytřiďuje hodnoty hash zařízení napříč těmito centry, "statická": Specifikace požadovaného centra IoT v seznamu registrací má přednost před zásadami přidělování na úrovni služby. "vlastní": Zařízení se zřídí v centru IoT na základě vlastní logiky. Zřizovací služba předává informace o zařízení do logiky 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

Datum a čas, kdy byl tento prostředek vytvořen.
customAllocationDefinition

CustomAllocationDefinition

To službě DPS řekne, 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é je možné zařízení v tomto prostředku přidělit. Musí být podmnožinou seznamu ioT hub na úrovni tenanta.
lastUpdatedDateTimeUtc

string

Datum A čas, kdy 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 jednoznačné identifikaci registrace zařízení. Řetězec alfanumerických znaků nerozlišující velká a malá písmena (až 128 znaků dlouhý) plus určité speciální znaky: . _ -. Na začátku ani na konci nejsou povoleny žá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é budou nastaveny na dvojčeti zařízení.
tags

TwinCollection

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

InitialTwinProperties

Představuje počáteční vlastnosti, které budou nastaveny 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 Service.

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 Default value Description
migrateDeviceData

boolean

True

Pokud je nastavená hodnota true (výchozí), bude služba Device Provisioning během aktualizace přiřazení centra IoT migrovat 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 všechny žádosti o zřízení nad rámec první žádosti 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 objektu TwinCollection
metadata

Metadata

Metadata pro TwinCollection
version

integer

Verze TwinCollection

X509Attestation

Ověření identity prostřednictvím 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.