Individual Enrollment - Create Or Update

服務:

IoT Hub Device Provisioning Service

API 版本:

2021-10-01

Create 或更新裝置註冊記錄。

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

URI 參數

名稱	位於	必要	類型	Description
id	path	True	string	此標識碼用來唯一識別註冊的裝置註冊。 不區分大小寫的字串 (最多 128 個字元長) 英數位元加上特定特殊字元 ： 。 _ -. 開頭或結尾不允許任何特殊字元。
api-version	query	True	string	要用於要求的 API 版本。 支援的版本包括：2021-10-01

要求標頭

名稱	必要	類型	Description
If-Match		string	註冊記錄的 ETag。

要求本文

名稱	必要	類型	Description
attestation	True	AttestationMechanism	個別註冊和 enrollmentGroup 的證明機制。
registrationId	True	string	此標識碼可用來唯一識別註冊的裝置註冊。 不區分大小寫的字串 (最多 128 個字元的英數位元長) 加上特定特殊字元：。 _ -. 開頭或結尾不允許任何特殊字元。
allocationPolicy		enum: hashed geoLatency static custom	此資源的配置原則。 此原則會覆寫此個別註冊或註冊群組的租用戶層級配置原則。 可能的值包括「哈希」：連結的 IoT 中樞同樣可能會布建裝置，『geoLatency』：裝置會布建到延遲最低的 IoT 中樞。如果多個連結的IoT中樞會提供相同的最低延遲，則布建服務會將裝置哈希到這些中樞『static』：註冊清單中的所需IoT中樞規格會優先於服務層級配置原則『custom』：裝置會根據您自己的自定義邏輯布建到 IoT 中樞。 布建服務會將裝置的相關信息傳遞給邏輯，而邏輯會傳回所需的IoT中樞以及所需的初始設定。 建議您使用 Azure Functions 來裝載邏輯。
capabilities		DeviceCapabilities	裝置功能。
customAllocationDefinition		CustomAllocationDefinition	這會告知 DPS 在使用自定義配置時要呼叫的 Webhook。
deviceId		string	所需的 IoT 中樞 裝置識別碼 (選擇性) 。
etag		string	與資源相關聯的實體標記。
initialTwin		InitialTwin	初始裝置對應項。 包含 Twin 屬性的子集。
iotHubHostName		string	IoT 中樞主機名。
iotHubs		string[]	此資源中裝置 () IoT 中樞 主機名的清單可以配置給該資源。 必須是IoT中樞租用戶層級清單的子集。
optionalDeviceInformation		TwinCollection	表示對應項內屬性的集合
provisioningStatus		enum: enabled disabled	布建狀態。
registrationState		DeviceRegistrationState	裝置註冊狀態。
reprovisionPolicy		ReprovisionPolicy	將裝置重新布建至IoT中樞時服務的行為。

回應

名稱	類型	Description
200 OK	IndividualEnrollment	Success
Other Status Codes	ProvisioningServiceErrorDetails	錯誤回應 標題 x-ms-error-code: string

定義

名稱	Description
AttestationMechanism	個別註冊和 enrollmentGroup 的證明機制。
CustomAllocationDefinition	這會告知 DPS 使用自訂配置時要呼叫的 Webhook。
DeviceCapabilities	裝置功能。
DeviceRegistrationState	裝置註冊狀態。
IndividualEnrollment	裝置註冊記錄。
InitialTwin	初始裝置對應項。 包含 Twin 屬性的子集。
InitialTwinProperties	表示將在裝置對應項上設定的初始屬性。
Metadata	TwinCollection 的元數據
ProvisioningServiceErrorDetails	包含 Azure IoT 中樞 布建服務所傳回之錯誤的屬性。
ReprovisionPolicy	將裝置重新佈建至IoT中樞時，服務的行為。
SymmetricKeyAttestation	透過 SymmetricKey 證明。
TpmAttestation	透過 TPM 證明。
TwinCollection	表示對應項內屬性的集合
X509Attestation	透過 X509 證明。
X509CAReferences	主要和次要 CA 參考。
X509CertificateInfo	X509 憑證資訊。
X509Certificates	主要和次要憑證
X509CertificateWithInfo	憑證和憑證資訊

AttestationMechanism

個別註冊和 enrollmentGroup 的證明機制。

名稱	類型	Description
symmetricKey	SymmetricKeyAttestation	透過 SymmetricKey 證明。
tpm	TpmAttestation	透過 TPM 證明。
type	enum: none symmetricKey tpm x509	證明類型。
x509	X509Attestation	透過 X509 證明。

CustomAllocationDefinition

這會告知 DPS 使用自訂配置時要呼叫的 Webhook。

名稱	類型	Description
apiVersion	string	布建服務類型的 API 版本 (，例如在自定義配置要求中傳送的 IndividualEnrollment) 。 最低支援版本：「2018-09-01-preview」。。
webhookUrl	string	用於配置要求的 Webhook URL。

DeviceCapabilities

裝置功能。

名稱	類型	預設值	Description
iotEdge	boolean	False	如果設定為 true，則此裝置為 IoTEdge 裝置。

DeviceRegistrationState

裝置註冊狀態。

名稱	類型	Description
assignedHub	string	指派 Azure IoT 中樞。
createdDateTimeUtc	string	註冊建立日期時間 (UTC) 。
deviceId	string	裝置識別碼。
errorCode	integer	錯誤碼。
errorMessage	string	錯誤訊息。
etag	string	與資源相關聯的實體標記。
lastUpdatedDateTimeUtc	string	上次更新的日期時間 (UTC) 。
payload	object
registrationId	string	此標識碼可用來唯一識別註冊的裝置註冊。 不區分大小寫的字串 (最多 128 個字元的英數位元長) 加上特定特殊字元：。 _ -. 開頭或結尾不允許任何特殊字元。
status	enum: assigned assigning disabled failed unassigned	註冊狀態。
substatus	enum: deviceDataMigrated deviceDataReset initialAssignment reprovisionedToInitialAssignment	「已指派」裝置的子狀態。 可能的值包括 - 'initialAssignment'：裝置已第一次指派給 IoT 中樞，'deviceDataMigrated'：裝置已指派給不同的 IoT 中樞，且其裝置數據已從先前指派的 IoT 中樞移轉。 裝置數據已從先前指派的IoT中樞「deviceDataReset」移除：裝置已指派給不同的IoT中樞，且其裝置數據已從註冊中儲存的初始狀態填入。 裝置數據已從先前指派的IoT中樞「reprovisionedToInitialAssignment」中移除：裝置已重新布建至先前指派的IoT中樞。

IndividualEnrollment

裝置註冊記錄。

名稱	類型	預設值	Description
allocationPolicy	enum: custom geoLatency hashed static		此資源的配置原則。 此原則會覆寫此個別註冊或註冊群組的租用戶層級配置原則。 可能的值包括「哈希」：連結的 IoT 中樞同樣可能會讓裝置布建至這些裝置，「geoLatency」：裝置會布建至 IoT 中樞，且延遲最低的裝置。如果多個連結的IoT中樞會提供相同的最低延遲，則布建服務會根據您自己的自定義邏輯，在這些中樞「靜態」之間哈希裝置：註冊清單中的所需IoT中樞規格優先於服務層級配置原則「自定義」：裝置會根據您自己的自定義邏輯布建至IoT中樞。 布建服務會將裝置的相關信息傳遞至邏輯，而邏輯會傳回所需的IoT中樞以及所需的初始設定。 建議您使用 Azure Functions 來裝載邏輯。
attestation	AttestationMechanism		個別註冊和 enrollmentGroup 的證明機制。
capabilities	DeviceCapabilities		裝置功能。
createdDateTimeUtc	string		建立此資源的 DateTime。
customAllocationDefinition	CustomAllocationDefinition		這會告知 DPS 使用自訂配置時要呼叫的 Webhook。
deviceId	string		所需的 IoT 中樞 裝置識別碼 (選擇性) 。
etag	string		與資源相關聯的實體標記。
initialTwin	InitialTwin		初始裝置對應項。 包含 Twin 屬性的子集。
iotHubHostName	string		IoT 中樞主機名。
iotHubs	string[]		可以配置此資源中裝置 () 的主機名清單 IoT 中樞。 必須是IoT中樞租用戶層級清單的子集。
lastUpdatedDateTimeUtc	string		上次更新此資源的 DateTime。
optionalDeviceInformation	TwinCollection		表示對應項內屬性的集合
provisioningStatus	enum: disabled enabled	enabled	布建狀態。
registrationId	string		此標識碼可用來唯一識別註冊的裝置註冊。 不區分大小寫的字串 (最多 128 個字元的英數位元長) 加上特定特殊字元：。 _ -. 開頭或結尾不允許任何特殊字元。
registrationState	DeviceRegistrationState		裝置註冊狀態。
reprovisionPolicy	ReprovisionPolicy		將裝置重新佈建至IoT中樞時，服務的行為。

InitialTwin

初始裝置對應項。 包含 Twin 屬性的子集。

名稱	類型	Description
properties	InitialTwinProperties	表示將在裝置對應項上設定的初始屬性。
tags	TwinCollection	表示對應項內屬性的集合

InitialTwinProperties

表示將在裝置對應項上設定的初始屬性。

名稱	類型	Description
desired	TwinCollection	表示對應項內屬性的集合

Metadata

TwinCollection 的元數據

名稱	類型	Description
lastUpdated	string	上次更新 TwinCollection 的時間
lastUpdatedVersion	integer	這是報告屬性元數據的 Null，對於所需的屬性元數據而言不是 Null。

ProvisioningServiceErrorDetails

包含 Azure IoT 中樞 布建服務所傳回之錯誤的屬性。

名稱	類型	Description
errorCode	integer
info	object
message	string
timestampUtc	string
trackingId	string

ReprovisionPolicy

將裝置重新佈建至IoT中樞時，服務的行為。

名稱	類型	預設值	Description
migrateDeviceData	boolean	True	當設定為 true (預設) 時，裝置布建服務會在 IoT 中樞指派更新期間，將裝置的數據 (對應項、裝置功能和裝置識別碼) 移轉至另一個 IoT 中樞。 如果設定為 false，裝置布建服務會將裝置的數據重設為儲存在對應註冊清單中的初始所需設定。
updateHubAssignment	boolean	True	當設定為 true (預設) 時，裝置布建服務會評估裝置的 IoT 中樞 指派，並視需要針對指定裝置的第一個以外的任何布建要求進行更新。 如果設定為 false，裝置會保持指派給其目前的 IoT 中樞。

SymmetricKeyAttestation

透過 SymmetricKey 證明。

名稱	類型	Description
primaryKey	string	主要對稱金鑰。
secondaryKey	string	次要對稱金鑰。

TpmAttestation

透過 TPM 證明。

名稱	類型	Description
endorsementKey	string
storageRootKey	string

TwinCollection

表示對應項內屬性的集合

名稱	類型	Description
count	integer	TwinCollection 中的屬性數目
metadata	Metadata	TwinCollection 的元數據
version	integer	TwinCollection 的版本

X509Attestation

透過 X509 證明。

名稱	類型	Description
caReferences	X509CAReferences	主要和次要 CA 參考。
clientCertificates	X509Certificates	主要和次要憑證
signingCertificates	X509Certificates	主要和次要憑證

X509CAReferences

主要和次要 CA 參考。

名稱	類型	Description
primary	string
secondary	string

X509CertificateInfo

X509 憑證資訊。

名稱	類型	Description
issuerName	string
notAfterUtc	string
notBeforeUtc	string
serialNumber	string
sha1Thumbprint	string
sha256Thumbprint	string
subjectName	string
version	integer

X509Certificates

主要和次要憑證

名稱	類型	Description
primary	X509CertificateWithInfo	憑證和憑證資訊
secondary	X509CertificateWithInfo	憑證和憑證資訊

X509CertificateWithInfo

憑證和憑證資訊

名稱	類型	Description
certificate	string
info	X509CertificateInfo	X509 憑證資訊。