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

Individual Enrollment - Create Or Update

创建或更新设备注册记录。

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

URI 参数

Name In Required Type Description
id
path True
  • string

注册 ID 是小写的字母数字,并且可包含连字符。

api-version
query True
  • string

要用于请求的 API 版本。 支持的版本包括:2021-06-01

请求头

Name Required Type Description
If-Match
  • string

注册记录的 ETag。

请求正文

Name Required Type Description
attestation True

设备使用的证明方法。

registrationId True
  • string

注册 ID 是小写的字母数字,并且可包含连字符。

allocationPolicy enum:
  • hashed
  • geoLatency
  • static
  • custom

此资源的分配策略。 此策略覆盖此单独注册或注册组的租户级别分配策略。 可能的值包括“hashed”:链接的 IoT 中心同样可能为其预配设备,“geoLatency”:将设备预配到具有最低延迟的 IoT 中心。如果多个链接的 IoT 中心提供相同的最低延迟,预配服务会在这些中心对设备进行哈希处理:注册列表中的所需 IoT 中心的规范优先于服务级别分配策略“custom”:设备根据自己的自定义逻辑预配到 IoT 中心。 预配服务将有关设备的信息传递给逻辑,逻辑返回所需的 IoT 中心和所需的初始配置。 建议使用Azure Functions来托管逻辑。

capabilities

设备的功能。

customAllocationDefinition

这告知 DPS 在使用自定义分配时要调用的 Webhook。

deviceId
  • string

所需IoT 中心设备 ID (可选) 。

etag
  • string

与资源关联的实体标记。

initialTwin

初始设备孪生。

iotHubHostName
  • string

IoT 中心主机名。

iotHubs
  • string[]

可以分配给此资源中的设备 () 的IoT 中心主机名列表。 必须是 IoT 中心的租户级别列表的子集。

optionalDeviceInformation

可选设备信息。

provisioningStatus enum:
  • enabled
  • disabled

预配状态。

reprovisionPolicy

将设备重新预配到 IoT 中心时的行为。

响应

Name Type Description
200 OK

Success

Other Status Codes

错误响应

定义

AttestationMechanism

单个Enrollment 和 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

单个Enrollment 和 enrollmentGroup 的证明机制。

Name Type Description
symmetricKey

对称密钥证明方法。

tpm

TPM 证明方法。

type enum:
  • none
  • symmetricKey
  • tpm
  • x509

证明类型。

x509

X509 证明方法。

CustomAllocationDefinition

这会告知 DPS 在使用自定义分配时要调用的 Webhook。

Name Type Description
apiVersion
  • string

预配服务的 API 版本 (,例如在自定义分配请求中发送的 IndividualEnrollment) 。 支持的最低版本:“2018-09-01-preview”。

webhookUrl
  • string

用于分配请求的 Webhook URL。

DeviceCapabilities

设备功能。

Name Type Default Value Description
iotEdge
  • boolean
false

如果设置为 true,则此设备是 IoTEdge 设备。

DeviceRegistrationState

设备注册状态。

Name Type Description
assignedHub
  • string

分配的Azure IoT 中心。

createdDateTimeUtc
  • string

注册创建日期时间 (UTC) 。

deviceId
  • string

设备 ID。

errorCode
  • integer

错误代码。

errorMessage
  • string

错误消息。

etag
  • string

与资源关联的实体标记。

lastUpdatedDateTimeUtc
  • string

上次更新时间 (UTC) 。

payload
  • object

从 Webhook 返回到设备的自定义分配有效负载。

registrationId
  • string

注册 ID 是小写的字母数字,并且可包含连字符。

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

设备注册记录。

Name Type Default Value Description
allocationPolicy enum:
  • custom
  • geoLatency
  • hashed
  • static

此资源的分配策略。 此策略覆盖此单独注册或注册组的租户级别分配策略。 可能的值包括“hashed”:链接的 IoT 中心同样可能为其预配设备,“geoLatency”:将设备预配到具有最低延迟的 IoT 中心。如果多个链接的 IoT 中心提供相同的最低延迟,预配服务会在这些中心对设备进行哈希处理:注册列表中的所需 IoT 中心的规范优先于服务级别分配策略“custom”:设备根据自己的自定义逻辑预配到 IoT 中心。 预配服务将有关设备的信息传递给逻辑,逻辑返回所需的 IoT 中心和所需的初始配置。 建议使用Azure Functions来托管逻辑。

attestation

设备使用的证明方法。

capabilities

设备的功能。

createdDateTimeUtc
  • string

已创建此资源的 DateTime。

customAllocationDefinition

这会告知 DPS 在使用自定义分配时要调用的 Webhook。

deviceId
  • string

所需IoT 中心设备 ID (可选) 。

etag
  • string

与资源关联的实体标记。

initialTwin

初始设备孪生。

iotHubHostName
  • string

IoT 中心主机名。

iotHubs
  • string[]

可以分配给此资源中的设备 () 的IoT 中心主机名列表。 必须是 IoT 中心的租户级别列表的子集。

lastUpdatedDateTimeUtc
  • string

上次更新此资源的 DateTime。

optionalDeviceInformation

可选设备信息。

provisioningStatus enum:
  • disabled
  • enabled
enabled

预配状态。

registrationId
  • string

注册 ID 是小写的字母数字,并且可包含连字符。

registrationState

当前注册状态。

reprovisionPolicy

将设备重新预配到 IoT 中心时的行为。

InitialTwin

初始设备孪生。 包含 Twin 属性的子集。

Name Type Description
properties

孪生所需属性。

tags

孪生标记。

InitialTwinProperties

表示将在设备孪生上设置的初始属性。

Name Type Description
desired

获取和设置 InitialTwin 所需的属性。

Metadata

TwinCollection 的元数据

Name Type Description
lastUpdated
  • string

上次更新 TwinCollection

lastUpdatedVersion
  • integer

对于报告的属性元数据,这为 null,对于所需的属性元数据不为 null。

ProvisioningServiceErrorDetails

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

Name Type Description
errorCode
  • integer
info
  • object
message
  • string
timestampUtc
  • string
trackingId
  • string

ReprovisionPolicy

将设备重新预配到 IoT 中心时服务的行为。

Name Type Default Value Description
migrateDeviceData
  • boolean
true

如果设置为 true (默认) ,设备预配服务将在 IoT 中心分配更新期间将设备的数据 (孪生体、设备功能和设备 ID) 从一个 IoT 中心迁移到另一个 IoT 中心。 如果设置为 false,设备预配服务会将设备的数据重置为相应注册列表中存储的初始所需配置。

updateHubAssignment
  • boolean
true

如果设置为 true (默认) ,设备预配服务将评估设备的IoT 中心分配,并在必要时更新从给定设备发出的第一个设备以外的任何预配请求。 如果设置为 false,设备将保留为其当前 IoT 中心分配。

SymmetricKeyAttestation

通过 SymmetricKey 证明。

Name Type Description
primaryKey
  • string

主对称密钥。

secondaryKey
  • string

辅助对称密钥。

TpmAttestation

通过 TPM 证明。

Name Type Description
endorsementKey
  • string
storageRootKey
  • string

TwinCollection

表示孪生体中属性的集合

Name Type Description
count
  • integer

TwinCollection 中的属性数

metadata

TwinCollection 的元数据

version
  • integer

TwinCollection 的版本

X509Attestation

通过 X509 证明。

Name Type Description
caReferences

主要和辅助 CA 引用。

clientCertificates

主证书和辅助证书

signingCertificates

主证书和辅助证书

X509CAReferences

主要和辅助 CA 引用。

Name Type Description
primary
  • string
secondary
  • string

X509CertificateInfo

X509 证书信息。

Name Type Description
issuerName
  • string
notAfterUtc
  • string
notBeforeUtc
  • string
serialNumber
  • string
sha1Thumbprint
  • string
sha256Thumbprint
  • string
subjectName
  • string
version
  • integer

X509Certificates

主证书和辅助证书

Name Type Description
primary

证书和证书信息

secondary

证书和证书信息

X509CertificateWithInfo

证书和证书信息

Name Type Description
certificate
  • string
info

X509 证书信息。