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

Enrollment Groups - List

获取应用程序中的注册组列表

GET https://{subdomain}.{baseDomain}/api/enrollmentGroups?api-version=2022-06-30-preview

URI 参数

Name In Required Type Description
baseDomain
path True
  • string

所有 Azure IoT Central 服务请求的基本域。

subdomain
path True
  • string

应用程序子域。

api-version
query True
  • string

要调用的 API 的版本。

响应

Name Type Description
200 OK

成功

Other Status Codes

从 IoT Central 服务收到的错误响应。

Headers

  • x-ms-error-code: string

安全性

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation 模拟用户帐户

示例

List enrollment groups

Sample Request

GET https://appsubdomain.azureiotcentral.com/api/enrollmentGroups?api-version=2022-06-30-preview

Sample Response

{
  "value": [
    {
      "id": "myEnrollmentGroupId",
      "displayName": "My group",
      "enabled": true,
      "type": "iot",
      "attestation": {
        "type": "symmetricKey",
        "symmetricKey": {
          "primaryKey": "<primary-symmetric-key>",
          "secondaryKey": "<secondary-symmetric-key>"
        }
      },
      "etag": "IjA4MDUwMTJiLTAwMDAtMDcwMC0wMDAwLTYyODJhOWVjMDAwMCI="
    }
  ]
}

定义

EnrollmentGroup

注册组定义。

EnrollmentGroupCollection

注册组的分页结果。

EnrollmentGroupType

通过组进行连接的设备类型。

Error

响应错误定义。

ErrorDetails

错误的详细信息。

GroupSymmetricKeyAttestation

对称密钥证明定义。

GroupX509Attestation

X509 证明定义。

SigningX509

X509 定义。

SigningX509Certificate

X509 证书定义。

SigningX509Certificates

X509 证书定义。

SymmetricKey

对称密钥定义。

X509CertificateInfo

X509 证书信息。

EnrollmentGroup

注册组定义。

Name Type Default Value Description
attestation GroupAttestation:

注册组的证明机制。

displayName
  • string

注册组的显示名称。

enabled
  • boolean
True

是否允许使用组的设备连接到 IoT Central。

etag
  • string

用于防止注册组更新冲突的 ETag。

id
  • string

注册组的唯一 ID。

type

通过组进行连接的设备类型。

EnrollmentGroupCollection

注册组的分页结果。

Name Type Description
nextLink
  • string

用于获取注册组的下一页的 URL。

value

注册组的集合。

EnrollmentGroupType

通过组进行连接的设备类型。

Name Type Description
iot
  • string

常规 (非 Edge) IoT 设备

iotEdge
  • string

IoT Edge 设备

Error

响应错误定义。

Name Type Description
error

当前请求的错误详细信息。

ErrorDetails

错误的详细信息。

Name Type Description
code
  • string

错误代码。

message
  • string

错误消息详细信息。

requestId
  • string

当前请求的相关 ID。

time
  • string

错误请求失败的时间。

GroupSymmetricKeyAttestation

对称密钥证明定义。

Name Type Description
symmetricKey

此证明的对称密钥凭据。

type string:
  • symmetricKey

证明的类型。

GroupX509Attestation

X509 证明定义。

Name Type Description
type string:
  • x509

证明的类型。

x509

此证明的 X.509 凭据。

SigningX509

X509 定义。

Name Type Description
signingCertificates

此凭据的 X.509 签名证书。

SigningX509Certificate

X509 证书定义。

Name Type Default Value Description
certificate
  • string

此证书的字符串表示形式。

etag
  • string

用于防止跨多个更新发生冲突的 ETag

info

有关此证书的信息。

verified
  • boolean
False

证书是否已验证。

SigningX509Certificates

X509 证书定义。

Name Type Description
primary

此凭据的主 X.509 证书。

secondary

此凭据的辅助 X.509 证书。

SymmetricKey

对称密钥定义。

Name Type Description
primaryKey
  • string

此凭据的主密钥。

secondaryKey
  • string

此凭据的辅助密钥。

X509CertificateInfo

X509 证书信息。

Name Type Description
sha1Thumbprint
  • string

证书的 SHA-1 哈希值。