共用方式為

Runtime Registration - Register Device

  • 參考
服務:
IoT Hub Device Provisioning Service
API 版本:
2021-10-01

註冊裝置。

PUT https://global.azure-devices-provisioning.net/{idScope}/registrations/{registrationId}/register?api-version=2021-10-01

URI 參數

名稱 位於 必要 類型 Description
idScope
 path True

string

registrationId
 path True

string

註冊識別碼中有英數字元、小寫字母且可能包含連字號。
api-version
 query True

string

要用於要求的 API 版本。 支援的版本包括：2021-10-01

要求本文

名稱 類型 Description
payload

object

registrationId

string

註冊標識碼是不區分大小寫的字串， (最多 128 個字元的英數位元長) 加上特定特殊字元 ：。 _ -. 開頭或結尾不允許任何特殊字元。
tpm

TpmAttestation

透過 TPM 證明。

回應

名稱 類型 Description
200 OK

RegistrationOperationStatus

Success
202 Accepted

RegistrationOperationStatus

已接受

標題

  • Location: string
  • retry-after: integer
Other Status Codes

ProvisioningServiceErrorDetails

錯誤回應

標題

x-ms-error-code: string

定義

名稱 Description
DeviceRegistration

裝置註冊。
DeviceRegistrationResult

裝置註冊結果。
ProvisioningServiceErrorDetails

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

註冊作業狀態。
SymmetricKeyRegistrationResult

使用 SymmetricKey 證明時傳回的註冊結果。
TpmAttestation

透過 TPM 證明。
TpmRegistrationResult

TPM 註冊結果。
X509CertificateInfo

X509 憑證資訊。
X509RegistrationResult

X509 註冊結果。

DeviceRegistration

裝置註冊。

名稱 類型 Description
payload

object

registrationId

string

註冊標識碼是不區分大小寫的字串， (最多 128 個字元的英數位元長) 加上特定特殊字元 ：。 _ -. 開頭或結尾不允許任何特殊字元。
tpm

TpmAttestation

透過 TPM 證明。

DeviceRegistrationResult

裝置註冊結果。

名稱 類型 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中樞。
symmetricKey

SymmetricKeyRegistrationResult

使用 SymmetricKey 證明時傳回的註冊結果。
tpm

TpmRegistrationResult

TPM 註冊結果。
x509

X509RegistrationResult

X509 註冊結果。

ProvisioningServiceErrorDetails

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

名稱 類型 Description
errorCode

integer

info

object

message

string

timestampUtc

string

trackingId

string

RegistrationOperationStatus

註冊作業狀態。

名稱 類型 Description
operationId

string

作業識別碼。
registrationState

DeviceRegistrationResult

裝置註冊結果。
status enum:
  • assigned
  • assigning
  • disabled
  • failed
  • unassigned

裝置註冊狀態。

SymmetricKeyRegistrationResult

使用 SymmetricKey 證明時傳回的註冊結果。

名稱 類型 Description
enrollmentGroupId

string

TpmAttestation

透過 TPM 證明。

名稱 類型 Description
endorsementKey

string

storageRootKey

string

TpmRegistrationResult

TPM 註冊結果。

名稱 類型 Description
authenticationKey

string

加密的驗證金鑰。

X509CertificateInfo

X509 憑證資訊。

名稱 類型 Description
issuerName

string

notAfterUtc

string

notBeforeUtc

string

serialNumber

string

sha1Thumbprint

string

sha256Thumbprint

string

subjectName

string

version

integer

X509RegistrationResult

X509 註冊結果。

名稱 類型 Description
certificateInfo

X509CertificateInfo

X509 憑證資訊。
enrollmentGroupId

string

signingCertificateInfo

X509CertificateInfo

X509 憑證資訊。