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

Enrollment Group - Get

服务:: IoT Hub Device Provisioning Service

API 版本:: 2021-10-01

获取设备注册组。

GET https://{dpsName}.azure-devices-provisioning.net/enrollmentGroups/{id}?api-version=2021-10-01

URI 参数

名称	在	必需	类型	说明
dpsName	path	True	string	DPS实例的主机名。
id	path	True	string	注册组 ID。
api-version	query	True	string minLength: 1	用于此作的 API 版本。

请求头

名称	必需	类型	说明
Authorization	True	string

响应

名称	类型	说明
200 OK	EnrollmentGroup	请求已成功。
Other Status Codes	ProvisioningServiceErrorDetails	意外的错误响应。标头 x-ms-error-code: string

名称

类型

说明

200 OK

EnrollmentGroup

请求已成功。

Other Status Codes

ProvisioningServiceErrorDetails

意外的错误响应。

标头

x-ms-error-code: string

安全性

Authorization

类型: apiKey
在: header

示例

EnrollmentGroup_Get_MaximumSet_Gen

EnrollmentGroup_Get_MinimumSet_Gen

EnrollmentGroup_Get_MaximumSet_Gen

示例请求

HTTP

GET https://{dpsName}.azure-devices-provisioning.net/enrollmentGroups/aeejtkwwsgoraodfdlh?api-version=2021-10-01

示例响应

状态代码:: 200

{
  "allocationPolicy": "hashed",
  "attestation": {
    "type": "none",
    "symmetricKey": {
      "primaryKey": "tdoshkmlo",
      "secondaryKey": "lmajoyzuojahffcmdlcwjhntqzyqzk"
    },
    "tpm": {
      "endorsementKey": "naoofgjbxiulcitlysusxdvagyucgn",
      "storageRootKey": "tdgkgcvptrsw"
    },
    "x509": {
      "caReferences": {
        "primary": "efbkbboxkvrsdl",
        "secondary": "vckhuzqgbcinighxwyuyd"
      },
      "clientCertificates": {
        "primary": {
          "info": {
            "issuerName": "pkuinyhttjlozsbtvxuizzkjlakga",
            "notAfterUtc": "2025-10-01T17:42:04.760Z",
            "notBeforeUtc": "2025-10-01T17:42:04.760Z",
            "serialNumber": "mzoidcxayenpgyrek",
            "sha1Thumbprint": "fdmftjqllzvxcd",
            "sha256Thumbprint": "ei",
            "subjectName": "qqjdjgrkiqvtnshkisozut",
            "version": 12
          },
          "certificate": "gkozpt"
        },
        "secondary": {
          "info": {
            "issuerName": "pkuinyhttjlozsbtvxuizzkjlakga",
            "notAfterUtc": "2025-10-01T17:42:04.760Z",
            "notBeforeUtc": "2025-10-01T17:42:04.760Z",
            "serialNumber": "mzoidcxayenpgyrek",
            "sha1Thumbprint": "fdmftjqllzvxcd",
            "sha256Thumbprint": "ei",
            "subjectName": "qqjdjgrkiqvtnshkisozut",
            "version": 12
          },
          "certificate": "gkozpt"
        }
      },
      "signingCertificates": {
        "primary": {
          "info": {
            "issuerName": "pkuinyhttjlozsbtvxuizzkjlakga",
            "notAfterUtc": "2025-10-01T17:42:04.760Z",
            "notBeforeUtc": "2025-10-01T17:42:04.760Z",
            "serialNumber": "mzoidcxayenpgyrek",
            "sha1Thumbprint": "fdmftjqllzvxcd",
            "sha256Thumbprint": "ei",
            "subjectName": "qqjdjgrkiqvtnshkisozut",
            "version": 12
          },
          "certificate": "gkozpt"
        },
        "secondary": {
          "info": {
            "issuerName": "pkuinyhttjlozsbtvxuizzkjlakga",
            "notAfterUtc": "2025-10-01T17:42:04.760Z",
            "notBeforeUtc": "2025-10-01T17:42:04.760Z",
            "serialNumber": "mzoidcxayenpgyrek",
            "sha1Thumbprint": "fdmftjqllzvxcd",
            "sha256Thumbprint": "ei",
            "subjectName": "qqjdjgrkiqvtnshkisozut",
            "version": 12
          },
          "certificate": "gkozpt"
        }
      }
    }
  },
  "capabilities": {
    "iotEdge": true
  },
  "createdDateTimeUtc": "2025-10-01T17:42:05.495Z",
  "customAllocationDefinition": {
    "apiVersion": "gbannxdstouqrfonxdxfurv",
    "webhookUrl": "todqbubyxeumrtvhsscedwrkz"
  },
  "enrollmentGroupId": "sfsevlobqfdnqmghunj",
  "etag": "kmvtdrkjyfzj",
  "initialTwin": {
    "properties": {
      "desired": {
        "count": 16,
        "key2428": {},
        "metadata": {
          "lastUpdated": "2025-10-01T17:42:04.760Z",
          "lastUpdatedVersion": 19
        },
        "version": 9
      }
    },
    "tags": {
      "count": 16,
      "key2428": {},
      "metadata": {
        "lastUpdated": "2025-10-01T17:42:04.760Z",
        "lastUpdatedVersion": 19
      },
      "version": 9
    }
  },
  "iotHubHostName": "dey",
  "iotHubs": [
    "ehqilokxpijrvaigiaf"
  ],
  "lastUpdatedDateTimeUtc": "2025-10-01T17:42:05.495Z",
  "provisioningStatus": "enabled",
  "reprovisionPolicy": {
    "migrateDeviceData": true,
    "updateHubAssignment": true
  }
}

EnrollmentGroup_Get_MinimumSet_Gen

示例请求

HTTP

GET https://{dpsName}.azure-devices-provisioning.net/enrollmentGroups/foizrzwygyrulkdxcyb?api-version=2021-10-01

示例响应

状态代码:: 200

{
  "attestation": {
    "type": "none"
  },
  "enrollmentGroupId": "sfsevlobqfdnqmghunj"
}

定义

名称	说明
AllocationPolicy	该资源的分配政策。该政策优先于该个别注册或注册组的租户层级分配政策。可能的数值包括“哈希”：连接的物联网枢纽同样可能被配置设备;“geoLatency”：设备被配置到延迟最低的物联网枢纽。如果多个连接的物联网枢纽都能提供相同的最低延迟，配置服务会对这些枢纽之间的设备进行哈希，“静态”：注册列表中指定目标物联网枢纽优先于服务级分配策略，“自定义”：设备根据你自己的自定义逻辑被配置到物联网枢纽。配置服务将设备信息传递给逻辑，逻辑返回所需的物联网集线器以及期望的初始配置。我们建议使用 Azure Functions 来托管你的逻辑。
AttestationMechanism	个人注册认证机制及注册集团认证机制。
AttestationType	认证类型。
CustomAllocationDefinition	这会告诉DPS在使用自定义分配时该调用哪个webhook。
DeviceCapabilities	设备功能。
EnrollmentGroup	招生组记录。
InitialTwin	初始设备双胞胎。包含 Twin 性质的一个子集。
InitialTwinProperties	表示将在设备孪生体上设置的初始属性。
Metadata	TwinCollection 的元数据
ProvisioningServiceErrorDetails	包含 Azure IoT Hub 配置服务返回的错误属性。
ProvisioningStatus	配置状态。
ReprovisionPolicy	设备重新配置到物联网集线器时服务的行为。
SymmetricKeyAttestation	通过SymmetricKey认证。
TpmAttestation	通过TPM认证。
TwinCollection	表示孪生体中的一组属性
X509Attestation	认证通过X509。
X509CAReferences	主要和次要加州推荐。
X509CertificateInfo	X509证书信息。
X509Certificates	小学和中学证书
X509CertificateWithInfo	证书及证书信息

AllocationPolicy

枚举

该资源的分配政策。该政策优先于该个别注册或注册组的租户层级分配政策。可能的数值包括“哈希”：连接的物联网枢纽同样可能被配置设备;“geoLatency”：设备被配置到延迟最低的物联网枢纽。如果多个连接的物联网枢纽都能提供相同的最低延迟，配置服务会对这些枢纽之间的设备进行哈希，“静态”：注册列表中指定目标物联网枢纽优先于服务级分配策略，“自定义”：设备根据你自己的自定义逻辑被配置到物联网枢纽。配置服务将设备信息传递给逻辑，逻辑返回所需的物联网集线器以及期望的初始配置。我们建议使用 Azure Functions 来托管你的逻辑。

值	说明
hashed	哈希
geoLatency	地理延迟
static	静态的
custom	习惯

AttestationMechanism

对象

个人注册认证机制及注册集团认证机制。

名称	类型	说明
symmetricKey	SymmetricKeyAttestation	对称密钥认证方法。
tpm	TpmAttestation	TPM认证方法。
type	AttestationType	认证类型。
x509	X509Attestation	X509认证方法。

AttestationType

枚举

认证类型。

值	说明
none	无
tpm	tpm
x509	x509
symmetricKey	对称密钥

CustomAllocationDefinition

对象

这会告诉DPS在使用自定义分配时该调用哪个webhook。

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

DeviceCapabilities

对象

设备功能。

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

EnrollmentGroup

对象

招生组记录。

名称	类型	默认值	说明
allocationPolicy	AllocationPolicy		该资源的分配政策。该政策优先于该个别注册或注册组的租户层级分配政策。可能的数值包括“哈希”：连接的物联网枢纽同样可能被配置设备;“geoLatency”：设备被配置到延迟最低的物联网枢纽。如果多个连接的物联网枢纽都能提供相同的最低延迟，配置服务会对这些枢纽之间的设备进行哈希，“静态”：注册列表中指定目标物联网枢纽优先于服务级分配策略，“自定义”：设备根据你自己的自定义逻辑被配置到物联网枢纽。配置服务将设备信息传递给逻辑，逻辑返回所需的物联网集线器以及期望的初始配置。我们建议使用 Azure Functions 来托管你的逻辑。
attestation	AttestationMechanism		设备使用的认证方法。
capabilities	DeviceCapabilities		设备的功能。
createdDateTimeUtc	string (date-time)		该资源由DateTime创建。
customAllocationDefinition	CustomAllocationDefinition		这会告诉DPS在使用自定义分配时该调用哪个webhook。
enrollmentGroupId	string		注册组ID。
etag	string		与资源相关的实体标签。
initialTwin	InitialTwin		初始设备双胞胎。
iotHubHostName	string		物联网中心主机名。
iotHubs	string[]		该资源中设备可以分配到物联网中心主机名列表。一定是租户级别物联网集线器列表的一个子集。
lastUpdatedDateTimeUtc	string (date-time)		该资源最后更新时间。
provisioningStatus	ProvisioningStatus	enabled	配置状态。
reprovisionPolicy	ReprovisionPolicy		设备重新配置到物联网集线器时的行为。

InitialTwin

对象

初始设备双胞胎。包含 Twin 性质的一个子集。

名称	类型	说明
properties	InitialTwinProperties	孪生所需属性。
tags	TwinCollection	孪生标记。

InitialTwinProperties

对象

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

名称	类型	说明
desired	TwinCollection	获取并设置InitialTwin所需的属性。

Metadata

对象

TwinCollection 的元数据

名称	类型	说明
lastUpdated	string (date-time)	上次TwinCollection更新
lastUpdatedVersion	integer (int32)	对于报告的属性元数据，这为空，但对于期望的属性元数据则不为空。

ProvisioningServiceErrorDetails

对象

包含 Azure IoT Hub 配置服务返回的错误属性。

名称	类型	说明
errorCode	integer (int32)	操作错误代码。
info	object	<字符串> 字典
message	string	人类可读的错误信息。
timestampUtc	string (date-time)	错误的UTC时间戳。
trackingId	string	错误的物流信息。

ProvisioningStatus

枚举

配置状态。

值	说明
enabled	enabled
disabled	禁用的

ReprovisionPolicy

对象

设备重新配置到物联网集线器时服务的行为。

名称	类型	默认值	说明
migrateDeviceData	boolean	True	当设置为true（默认）时，设备配置服务将在IoT网关分配更新期间，将设备的数据（孪生节点、设备能力和设备ID）从一个物联网枢纽迁移到另一个。如果设置为 false，设备配置服务会将设备数据重置为对应注册列表中存储的初始期望配置。
updateHubAssignment	boolean	True	当设置为true（默认）时，设备配置服务会评估设备的IoT Hub分配，并在必要时更新该分配，以应对超出该设备的首次配置请求。如果设置为虚假，设备仍会被分配到当前的物联网集线器。

SymmetricKeyAttestation

对象

通过SymmetricKey认证。

名称	类型	说明
primaryKey	string	主对称钥匙。
secondaryKey	string	次要对称钥匙。

TpmAttestation

对象

通过TPM认证。

名称	类型	说明
endorsementKey	string	TPM背书密钥。
storageRootKey	string	TPM存储根键。

TwinCollection

对象

表示孪生体中的一组属性

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

X509Attestation

对象

认证通过X509。

名称	类型	说明
caReferences	X509CAReferences	主要和次要加州推荐。
clientCertificates	X509Certificates	小学和中学证书
signingCertificates	X509Certificates	小学和中学证书

X509CAReferences

对象

主要和次要加州推荐。

名称	类型	说明
primary	string	主要的加州参考资料。
secondary	string	加州的次要参考。

X509CertificateInfo

对象

X509证书信息。

名称	类型	说明
issuerName	string	证书的发行人名称。
notAfterUtc	string (date-time)	证书有效期结束（UTC）。
notBeforeUtc	string (date-time)	证书有效期开始（UTC）。
serialNumber	string	证书的序列号。
sha1Thumbprint	string	证书的SHA-1指纹。
sha256Thumbprint	string	证书上的SHA-256指纹。
subjectName	string	证书的使用者名称。
version	integer (int32)	证书的版本。

X509Certificates

对象

小学和中学证书

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

X509CertificateWithInfo

对象

证书及证书信息

名称	类型	说明
certificate	string	PEM格式的证书字符串。
info	X509CertificateInfo	X509证书信息。