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

Enrollment Group - Query

参考

服务:: IoT Hub Device Provisioning Service

API 版本:: 2021-10-01

查询设备注册组。

POST https://your-dps.azure-devices-provisioning.net/enrollmentGroups/query?api-version=2021-10-01

URI 参数

名称	在	必需	类型	说明
api-version	query	True	string	要用于请求的 API 版本。支持的版本包括：2021-10-01

请求头

名称	必需	类型	说明
x-ms-max-item-count		integer (int32)	页面大小
x-ms-continuation		string	继续标记

请求正文

名称	必需	类型	说明
query	True	string

响应

名称	类型	说明
200 OK	EnrollmentGroup[]	成功标头 x-ms-continuation: string x-ms-max-item-count: integer x-ms-item-type: string
Other Status Codes	ProvisioningServiceErrorDetails	错误响应标头 x-ms-error-code: string

名称

类型

说明

200 OK

EnrollmentGroup[]

成功

标头

x-ms-continuation: string
x-ms-max-item-count: integer
x-ms-item-type: string

Other Status Codes

ProvisioningServiceErrorDetails

错误响应

标头

x-ms-error-code: string

定义

名称	说明
AttestationMechanism	单个Enrollment 和 enrollmentGroup 的证明机制。
CustomAllocationDefinition	这会告知 DPS 使用自定义分配时要调用的 Webhook。
DeviceCapabilities	设备功能。
EnrollmentGroup	注册组记录。
InitialTwin	初始设备孪生。包含孪生属性的子集。
InitialTwinProperties	表示将在设备孪生上设置的初始属性。
Metadata	TwinCollection 的元数据
ProvisioningServiceErrorDetails	包含 Azure IoT 中心预配服务返回的错误的属性。
QuerySpecification
ReprovisionPolicy	将设备重新预配到 IoT 中心时服务的行为。
SymmetricKeyAttestation	通过 SymmetricKey 证明。
TpmAttestation	通过 TPM 证明。
TwinCollection	表示孪生体中的属性集合
X509Attestation	通过 X509 证明。
X509CAReferences	主要和辅助 CA 引用。
X509CertificateInfo	X509 证书信息。
X509Certificates	主证书和辅助证书
X509CertificateWithInfo	证书和证书信息

AttestationMechanism

Object

单个Enrollment 和 enrollmentGroup 的证明机制。

名称	类型	说明
symmetricKey	SymmetricKeyAttestation	通过 SymmetricKey 证明。
tpm	TpmAttestation	通过 TPM 证明。
type	enum: none symmetricKey tpm x509	证明类型。
x509	X509Attestation	通过 X509 证明。

CustomAllocationDefinition

Object

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

名称	类型	说明
apiVersion	string minLength: 1	在自定义分配请求中发送的预配服务类型的 API 版本（如 IndividualEnrollment）。支持的最低版本：“2018-09-01-preview”。
webhookUrl	string minLength: 1	用于分配请求的 Webhook URL。

DeviceCapabilities

Object

设备功能。

名称	类型	默认值	说明
iotEdge	boolean	False	如果设置为 true，则此设备是 IoTEdge 设备。

EnrollmentGroup

Object

注册组记录。

名称	类型	默认值	说明
allocationPolicy	enum: custom geoLatency hashed static		此资源的分配策略。此策略替代此单独注册或注册组的租户级别分配策略。可能的值包括“hashed”：链接的 IoT 中心同样可能为其预配设备，“geoLatency”：设备预配到 IoT 中心，延迟最低的设备。如果多个链接的 IoT 中心提供相同的最低延迟，则预配服务会在这些中心对设备进行哈希处理，“静态”：注册列表中的所需 IoT 中心的规范优先于服务级别分配策略“custom”：设备根据自己的自定义逻辑预配到 IoT 中心。预配服务将有关设备的信息传递给逻辑，逻辑返回所需的 IoT 中心和所需的初始配置。建议使用 Azure Functions 托管逻辑。
attestation	AttestationMechanism		单个Enrollment 和 enrollmentGroup 的证明机制。
capabilities	DeviceCapabilities		设备功能。
createdDateTimeUtc	string (date-time)		创建此资源的 DateTime。
customAllocationDefinition	CustomAllocationDefinition		这会告知 DPS 使用自定义分配时要调用的 Webhook。
enrollmentGroupId	string minLength: 1		注册组 ID。
etag	string		与资源关联的实体标记。
initialTwin	InitialTwin		初始设备孪生。包含孪生属性的子集。
iotHubHostName	string		IoT 中心主机名。
iotHubs	string[]		可将此资源中的设备（s）的 IoT 中心主机名列表分配给该资源。必须是 IoT 中心的租户级别列表的子集。
lastUpdatedDateTimeUtc	string (date-time)		上次更新此资源的 DateTime。
provisioningStatus	enum: disabled enabled	enabled	预配状态。
reprovisionPolicy	ReprovisionPolicy		将设备重新预配到 IoT 中心时服务的行为。

InitialTwin

Object

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

名称	类型	说明
properties	InitialTwinProperties	表示将在设备孪生上设置的初始属性。
tags	TwinCollection	表示孪生体中的属性集合

InitialTwinProperties

Object

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

名称	类型	说明
desired	TwinCollection	表示孪生体中的属性集合

Metadata

Object

TwinCollection 的元数据

名称	类型	说明
lastUpdated	string (date-time)	上次更新 TwinCollection 的时间
lastUpdatedVersion	integer (int64)	对于报告的属性元数据，这为 null，对于所需的属性元数据则不为 null。

ProvisioningServiceErrorDetails

Object

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

名称	类型	说明
errorCode	integer (int32)
info	object
message	string
timestampUtc	string (date-time)
trackingId	string

QuerySpecification

Object

名称	类型	说明
query	string

ReprovisionPolicy

Object

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

名称	类型	默认值	说明
migrateDeviceData	boolean	True	如果设置为 true（默认值），设备预配服务将在 IoT 中心分配更新期间将设备的数据（孪生、设备功能和设备 ID）从一个 IoT 中心迁移到另一个 IoT 中心。如果设置为 false，设备预配服务会将设备的数据重置为相应注册列表中存储的初始所需配置。
updateHubAssignment	boolean	True	设置为 true（默认值）时，设备预配服务将评估设备的 IoT 中心分配，并在必要时更新给定设备以外的任何预配请求。如果设置为 false，设备将保留为其当前 IoT 中心分配。

SymmetricKeyAttestation

Object

通过 SymmetricKey 证明。

名称	类型	说明
primaryKey	string	主对称密钥。
secondaryKey	string	辅助对称密钥。

TpmAttestation

Object

通过 TPM 证明。

名称	类型	说明
endorsementKey	string
storageRootKey	string

TwinCollection

Object

表示孪生体中的属性集合

名称	类型	说明
count	integer	TwinCollection 中的属性数
metadata	Metadata	TwinCollection 的元数据
version	integer (int64)	TwinCollection 的版本

X509Attestation

Object

通过 X509 证明。

名称	类型	说明
caReferences	X509CAReferences	主要和辅助 CA 引用。
clientCertificates	X509Certificates	主证书和辅助证书
signingCertificates	X509Certificates	主证书和辅助证书

X509CAReferences

Object

主要和辅助 CA 引用。

名称	类型	说明
primary	string
secondary	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)

X509Certificates

Object

主证书和辅助证书

名称	类型	说明
primary	X509CertificateWithInfo	证书和证书信息
secondary	X509CertificateWithInfo	证书和证书信息

X509CertificateWithInfo

Object

证书和证书信息

名称	类型	说明
certificate	string
info	X509CertificateInfo	X509 证书信息。

通过

Enrollment Group - Query

URI 参数

请求头

请求正文

响应

定义

AttestationMechanism

CustomAllocationDefinition

DeviceCapabilities

EnrollmentGroup

InitialTwin

InitialTwinProperties

Metadata

ProvisioningServiceErrorDetails

QuerySpecification

ReprovisionPolicy

SymmetricKeyAttestation

TpmAttestation

TwinCollection

X509Attestation

X509CAReferences

X509CertificateInfo

X509Certificates

X509CertificateWithInfo

其他资源