Individual Enrollment - Get
Získat záznam 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í registrace. Řetězec nerozlišující velká a malá písmena (až 128 znaků dlouhý) alfanumerických znaků plus určité speciální znaky : . _ -. Na začátku nebo 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ří: 10. 10. 2021 |
Odpovědi
Name | Typ | Description |
---|---|---|
200 OK |
Úspěch |
|
Other Status Codes |
Chybová odpověď Hlavičky x-ms-error-code: string |
Definice
Name | Description |
---|---|
Attestation |
Mechanismus ověření identity pro individualEnrollment i enrollmentGroup. |
Custom |
To službě DPS řekne, který webhook má volat při použití vlastního přidělení. |
Device |
Možnosti zařízení. |
Device |
Stav registrace zařízení. |
Individual |
Záznam registrace zařízení. |
Initial |
Počáteční dvojče zařízení Obsahuje podmnožinu vlastností dvojčete. |
Initial |
Představuje počáteční vlastnosti, které budou nastaveny na dvojčeti zařízení. |
Metadata |
Metadata pro TwinCollection |
Provisioning |
Obsahuje vlastnosti chyby vrácené službou Azure IoT Hub Provisioning. |
Reprovision |
Chování služby při opětovném zřízení zařízení v centru IoT. |
Symmetric |
Ověření identity prostřednictvím symetrického klíče. |
Tpm |
Ověření identity prostřednictvím čipu TPM. |
Twin |
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. |
X509Certificate |
Informace o certifikátu X509 |
X509Certificates |
Primární a sekundární certifikáty |
X509Certificate |
Informace o certifikátu a certifikátu |
AttestationMechanism
Mechanismus ověření identity pro individualEnrollment i enrollmentGroup.
Name | Typ | Description |
---|---|---|
symmetricKey |
Ověření identity prostřednictvím symetrického klíče. |
|
tpm |
Ověření identity prostřednictvím čipu TPM. |
|
type |
enum:
|
Typ ověření identity. |
x509 |
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 minLength: 1 |
Verze rozhraní API pro typy služeb 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 minLength: 1 |
Adresa URL webhooku používaná 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řadili jsme Azure IoT Hub. |
createdDateTimeUtc |
string (date-time) |
Datum vytvoření registrace (v UTC). |
deviceId |
string |
ID zařízení. |
errorCode |
integer (int32) |
Kód chyby |
errorMessage |
string |
Zpráva o chybě. |
etag |
string |
Značka entity přidružená k prostředku. |
lastUpdatedDateTimeUtc |
string (date-time) |
Datum poslední aktualizace (v UTC). |
payload |
object |
|
registrationId |
string |
Toto ID slouží k jednoznačné identifikaci registrace zařízení registrace. Řetězec nerozlišující velká a malá písmena (až 128 znaků dlouhý) alfanumerických znaků plus určité speciální znaky : . _ -. Na začátku nebo konci nejsou povoleny žádné speciální znaky. |
status |
enum:
|
Stav registrace. |
substatus |
enum:
|
Podstatus pro přiřazená zařízení. Mezi možné hodnoty patří " initialAssignment": Zařízení bylo poprvé přiřazeno k centru IoT, deviceDataMigrated: Zařízení bylo přiřazeno k jinému centru IoT a jeho 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í byla naplněna 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 do dříve přiřazeného centra IoT. |
IndividualEnrollment
Záznam registrace zařízení.
Name | Typ | Default value | Description |
---|---|---|---|
allocationPolicy |
enum:
|
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ří hashované: Propojené ioT huby mají stejnou pravděpodobnost, že se jim zařízení zřídí, "geoLatency": Zařízení se zřídí pro centrum IoT s nejnižší latencí zařízení. Pokud by několik propojených center IoT poskytovalo stejnou nejnižší latenci, zřizovací služba hashuje 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žby, vlastní: Zařízení se zřídí pro centrum IoT na základě vlastní logiky. Služba zřizování předává informace o zařízení do logiky a logika vrátí požadované centrum IoT a požadovanou počáteční konfiguraci. K hostování logiky doporučujeme použít Azure Functions. |
|
attestation |
Mechanismus ověření identity pro individualEnrollment i enrollmentGroup. |
||
capabilities |
Možnosti zařízení. |
||
createdDateTimeUtc |
string (date-time) |
Datum a čas vytvoření tohoto prostředku. |
|
customAllocationDefinition |
To službě DPS řekne, který webhook má volat při použití vlastního přidělení. |
||
deviceId |
string |
ID požadovaného zařízení ioT Hubu (volitelné). |
|
etag |
string |
Značka entity přidružená k prostředku. |
|
initialTwin |
Počáteční dvojče zařízení Obsahuje podmnožinu vlastností dvojčete. |
||
iotHubHostName |
string |
Název hostitele iot Hubu. |
|
iotHubs |
string[] |
Seznam názvů hostitelů služby IoT Hub, ke které se zařízení v tomto prostředku přidělují. Musí se jednat o podmnožinu seznamu úrovní tenanta center IoT. |
|
lastUpdatedDateTimeUtc |
string (date-time) |
Datum a čas, kdy byl tento prostředek naposledy aktualizován. |
|
optionalDeviceInformation |
Představuje kolekci vlastností v rámci dvojčete. |
||
provisioningStatus |
enum:
|
enabled |
Stav zřizování. |
registrationId |
string minLength: 1 |
Toto ID slouží k jednoznačné identifikaci registrace zařízení registrace. Řetězec nerozlišující velká a malá písmena (až 128 znaků dlouhý) alfanumerických znaků plus určité speciální znaky : . _ -. Na začátku nebo konci nejsou povoleny žádné speciální znaky. |
|
registrationState |
Stav registrace zařízení. |
||
reprovisionPolicy |
Chování služby při opětovném zřízení zařízení v centru IoT. |
InitialTwin
Počáteční dvojče zařízení Obsahuje podmnožinu vlastností dvojčete.
Name | Typ | Description |
---|---|---|
properties |
Představuje počáteční vlastnosti, které budou nastaveny na dvojčeti zařízení. |
|
tags |
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 |
Představuje kolekci vlastností v rámci dvojčete. |
Metadata
Metadata pro TwinCollection
Name | Typ | Description |
---|---|---|
lastUpdated |
string (date-time) |
Čas poslední aktualizace TwinCollection |
lastUpdatedVersion |
integer (int64) |
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 (int32) |
|
info |
object |
|
message |
string |
|
timestampUtc |
string (date-time) |
|
trackingId |
string |
ReprovisionPolicy
Chování služby při opětovném zřízení zařízení v centru IoT.
Name | Typ | Default value | Description |
---|---|---|---|
migrateDeviceData |
boolean |
True |
Když nastavíte hodnotu true (výchozí), služba Device Provisioning migruje data zařízení (dvojče, možnosti zařízení a ID zařízení) z jednoho centra IoT do jiného během aktualizace přiřazení centra IoT. Pokud je nastavená hodnota false, služba Device Provisioning obnoví 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 Hubu zařízení a v případě potřeby ho aktualizuje pro všechny požadavky zřizování nad rámec první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 prostřednictvím symetrického klíče.
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 pro TwinCollection |
|
version |
integer (int64) |
Verze TwinCollection |
X509Attestation
Ověření identity prostřednictvím X509.
Name | Typ | Description |
---|---|---|
caReferences |
Odkazy na primární a sekundární certifikační autoritu. |
|
clientCertificates |
Primární a sekundární certifikáty |
|
signingCertificates |
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 (date-time) |
|
notBeforeUtc |
string (date-time) |
|
serialNumber |
string |
|
sha1Thumbprint |
string |
|
sha256Thumbprint |
string |
|
subjectName |
string |
|
version |
integer (int32) |
X509Certificates
Primární a sekundární certifikáty
Name | Typ | Description |
---|---|---|
primary |
Informace o certifikátu a certifikátu |
|
secondary |
Informace o certifikátu a certifikátu |
X509CertificateWithInfo
Informace o certifikátu a certifikátu
Name | Typ | Description |
---|---|---|
certificate |
string |
|
info |
Informace o certifikátu X509 |