你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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 参数

名称	在	必需	类型	说明
idScope	path	True	string
registrationId	path	True	string	注册 ID 是小写的字母数字，并且可包含连字符。
api-version	query	True	string	要用于请求的 API 版本。 支持的版本包括：2021-10-01

请求正文

名称	类型	说明
payload	object
registrationId	string	注册 ID 是一个不区分大小写的字符串， (最多 128 个字符，) 字母数字字符和某些特殊字符：。 _ -. 开头或结尾不允许使用特殊字符。
tpm	TpmAttestation	通过 TPM 证明。

响应

名称	类型	说明
200 OK	RegistrationOperationStatus	成功
202 Accepted	RegistrationOperationStatus	已接受 标头 Location: string retry-after: integer
Other Status Codes	ProvisioningServiceErrorDetails	错误响应 标头 x-ms-error-code: string

定义

名称	说明
DeviceRegistration	设备注册。
DeviceRegistrationResult	设备注册结果。
ProvisioningServiceErrorDetails	包含Azure IoT 中心预配服务返回的错误的属性。
RegistrationOperationStatus	注册操作状态。
SymmetricKeyRegistrationResult	使用 SymmetricKey 证明时返回的注册结果。
TpmAttestation	通过 TPM 证明。
TpmRegistrationResult	TPM 注册结果。
X509CertificateInfo	X509 证书信息。
X509RegistrationResult	X509 注册结果。

DeviceRegistration

设备注册。

名称	类型	说明
payload	object
registrationId	string	注册 ID 是一个不区分大小写的字符串， (最多 128 个字符，) 字母数字字符和某些特殊字符：。 _ -. 开头或结尾不允许使用特殊字符。
tpm	TpmAttestation	通过 TPM 证明。

DeviceRegistrationResult

设备注册结果。

名称	类型	说明
assignedHub	string	已分配Azure IoT 中心。
createdDateTimeUtc	string	注册创建日期时间 (UTC) 。
deviceId	string	设备 ID。
errorCode	integer	错误代码。
errorMessage	string	错误消息。
etag	string	与资源关联的实体标记。
lastUpdatedDateTimeUtc	string	上次更新日期时间 (UTC) 。
payload	object
registrationId	string	此 ID 用于唯一标识注册的设备注册。 不区分大小写的字符串 (最多 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 中心预配服务返回的错误的属性。

名称	类型	说明
errorCode	integer
info	object
message	string
timestampUtc	string
trackingId	string

RegistrationOperationStatus

注册操作状态。

名称	类型	说明
operationId	string	操作 ID。
registrationState	DeviceRegistrationResult	设备注册结果。
status	enum: assigned assigning disabled failed unassigned	设备注册状态。

SymmetricKeyRegistrationResult

使用 SymmetricKey 证明时返回的注册结果。

名称	类型	说明
enrollmentGroupId	string

TpmAttestation

通过 TPM 证明。

名称	类型	说明
endorsementKey	string
storageRootKey	string

TpmRegistrationResult

TPM 注册结果。

名称	类型	说明
authenticationKey	string	加密的身份验证密钥。

X509CertificateInfo

X509 证书信息。

名称	类型	说明
issuerName	string
notAfterUtc	string
notBeforeUtc	string
serialNumber	string
sha1Thumbprint	string
sha256Thumbprint	string
subjectName	string
version	integer

X509RegistrationResult

X509 注册结果。

名称	类型	说明
certificateInfo	X509CertificateInfo	X509 证书信息。
enrollmentGroupId	string
signingCertificateInfo	X509CertificateInfo	X509 证书信息。