通过

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

Runtime Registration - Device Registration Status Lookup

服务:
IoT Hub Device Provisioning Service
API 版本:
2021-10-01

获取设备注册状态。

POST https://global.azure-devices-provisioning.net/{idScope}/registrations/{registrationId}?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

DeviceRegistrationResult

成功
Other Status Codes

ProvisioningServiceErrorDetails

错误响应

标头

x-ms-error-code: string

定义

名称 说明
DeviceRegistration

设备注册。
DeviceRegistrationResult

设备注册结果。
ProvisioningServiceErrorDetails

包含 Azure IoT 中心预配服务返回的错误的属性。
SymmetricKeyRegistrationResult

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

通过 TPM 证明。
TpmRegistrationResult

TPM 注册结果。
X509CertificateInfo

X509 证书信息。
X509RegistrationResult

X509 注册结果。

DeviceRegistration

Object

设备注册。

名称 类型 说明
payload

object

registrationId

string

注册 ID 是字母数字字符的不区分大小写的字符串（最长为 128 个字符），以及某些特殊字符： _ -. 开头或结尾不允许使用特殊字符。
tpm

TpmAttestation

通过 TPM 证明。

DeviceRegistrationResult

Object

设备注册结果。

名称 类型 说明
assignedHub

string

分配的 Azure IoT 中心。
createdDateTimeUtc

string (date-time)

注册创建日期时间（UTC）。
deviceId

string

设备 ID。
errorCode

integer (int32)

错误代码。
errorMessage

string

错误信息。
etag

string

与资源关联的实体标记。
lastUpdatedDateTimeUtc

string (date-time)

上次更新时间（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

Object

包含 Azure IoT 中心预配服务返回的错误的属性。

名称 类型 说明
errorCode

integer (int32)

info

object

message

string

timestampUtc

string (date-time)

trackingId

string

SymmetricKeyRegistrationResult

Object

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

名称 类型 说明
enrollmentGroupId

string

TpmAttestation

Object

通过 TPM 证明。

名称 类型 说明
endorsementKey

string

storageRootKey

string

TpmRegistrationResult

Object

TPM 注册结果。

名称 类型 说明
authenticationKey

string

加密的身份验证密钥。

X509CertificateInfo

Object

X509 证书信息。

名称 类型 说明
issuerName

string

notAfterUtc

string (date-time)

notBeforeUtc

string (date-time)

serialNumber

string

sha1Thumbprint

string

sha256Thumbprint

string

subjectName

string

version

integer (int32)

X509RegistrationResult

Object

X509 注册结果。

名称 类型 说明
certificateInfo

X509CertificateInfo

X509 证书信息。
enrollmentGroupId

string

signingCertificateInfo

X509CertificateInfo

X509 证书信息。