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 參數

名稱	位於	必要	類型	Description
dpsName	path	True	string	DPS 實例的主機名稱。
id	path	True	string	註冊群組標識碼。
api-version	query	True	string minLength: 1	用於此作業的 API 版本。

要求標頭

名稱	必要	類型	Description
Authorization	True	string

回應

名稱	類型	Description
200 OK	EnrollmentGroup	要求已成功。
Other Status Codes	ProvisioningServiceErrorDetails	未預期的錯誤回應。標題 x-ms-error-code: string

名稱

類型

Description

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"
}

定義

名稱	Description
AllocationPolicy	此資源的分配政策。此政策優先於該個別登記或登記群組的租戶層級分配政策。可能的數值包括「雜湊」：連結的物聯網集線器同樣可能有裝置配置;「geoLatency」：裝置配置到延遲最低的物聯網集線。如果多個連結的物聯網中樞能提供相同的最低延遲，配置服務會透過這些中樞器對裝置進行雜湊，「靜態」：註冊列表中指定目標物聯網中樞優先於服務層級分配政策，「自訂」：裝置會根據你自己的自訂邏輯配置到物聯網中樞。配置服務會將裝置資訊傳遞給邏輯，邏輯則回傳所需的物聯網集線及初始配置。我們建議使用 Azure Functions 來架設你的邏輯系統。
AttestationMechanism	個人註冊及 enrollmentGroup 的認證機制。
AttestationType	認證類型。
CustomAllocationDefinition	這會告訴 DPS 在使用自訂配置時該呼叫哪個 webhook。
DeviceCapabilities	裝置功能。
EnrollmentGroup	註冊組紀錄。
InitialTwin	初始裝置雙胞胎。包含 Twin 性質的子集。
InitialTwinProperties	代表將被設定在裝置雙胞胎上的初始屬性。
Metadata	TwinCollection 的元資料
ProvisioningServiceErrorDetails	包含 Azure IoT Hub Provisioning Service 回傳錯誤的屬性。
ProvisioningStatus	配置狀態。
ReprovisionPolicy	當裝置重新配置到物聯網樞紐時，服務的行為。
SymmetricKeyAttestation	透過 SymmetricKey 進行認證。
TpmAttestation	透過TPM認證。
TwinCollection	代表雙生子中的一組屬性集合
X509Attestation	經由 X509 認證。
X509CAReferences	主要與次要加州參考資料。
X509CertificateInfo	X509 證書資訊。
X509Certificates	小學與中學證書
X509CertificateWithInfo	證書及證書資訊

AllocationPolicy

列舉型別

此資源的分配政策。此政策優先於該個別登記或登記群組的租戶層級分配政策。可能的數值包括「雜湊」：連結的物聯網集線器同樣可能有裝置配置;「geoLatency」：裝置配置到延遲最低的物聯網集線。如果多個連結的物聯網中樞能提供相同的最低延遲，配置服務會透過這些中樞器對裝置進行雜湊，「靜態」：註冊列表中指定目標物聯網中樞優先於服務層級分配政策，「自訂」：裝置會根據你自己的自訂邏輯配置到物聯網中樞。配置服務會將裝置資訊傳遞給邏輯，邏輯則回傳所需的物聯網集線及初始配置。我們建議使用 Azure Functions 來架設你的邏輯系統。

值	Description
hashed	雜湊
geoLatency	geoLatency
static	靜態
custom	custom

AttestationMechanism

Object

個人註冊及 enrollmentGroup 的認證機制。

名稱	類型	Description
symmetricKey	SymmetricKeyAttestation	對稱鑰匙證明方法。
tpm	TpmAttestation	TPM 認證方法。
type	AttestationType	認證類型。
x509	X509Attestation	X509 認證方法。

AttestationType

列舉型別

認證類型。

值	Description
none	沒有
tpm	tpm
x509	x509
symmetricKey	對稱密鑰

CustomAllocationDefinition

Object

這會告訴 DPS 在使用自訂配置時該呼叫哪個 webhook。

名稱	類型	Description
apiVersion	string	自訂配置請求中提供的 API 版本配置服務類型（例如 IndividualEnrollment）。最低支援版本：「2018-09-01-preview」。
webhookUrl	string	用於分配請求的 webhook URL。

DeviceCapabilities

Object

裝置功能。

名稱	類型	預設值	Description
iotEdge	boolean	False	若設定為 true，該裝置為 IoTEdge 裝置。

EnrollmentGroup

Object

註冊組紀錄。

名稱	類型	預設值	Description
allocationPolicy	AllocationPolicy		此資源的分配政策。此政策優先於該個別登記或登記群組的租戶層級分配政策。可能的數值包括「雜湊」：連結的物聯網集線器同樣可能有裝置配置;「geoLatency」：裝置配置到延遲最低的物聯網集線。如果多個連結的物聯網中樞能提供相同的最低延遲，配置服務會透過這些中樞器對裝置進行雜湊，「靜態」：註冊列表中指定目標物聯網中樞優先於服務層級分配政策，「自訂」：裝置會根據你自己的自訂邏輯配置到物聯網中樞。配置服務會將裝置資訊傳遞給邏輯，邏輯則回傳所需的物聯網集線及初始配置。我們建議使用 Azure Functions 來架設你的邏輯系統。
attestation	AttestationMechanism		裝置所使用的認證方法。
capabilities	DeviceCapabilities		裝置的功能。
createdDateTimeUtc	string (date-time)		這個資源就是 DateTime 的建立。
customAllocationDefinition	CustomAllocationDefinition		這會告訴 DPS 在使用自訂配置時該呼叫哪個 webhook。
enrollmentGroupId	string		註冊群組編號。
etag	string		與該資源相關的實體標籤。
initialTwin	InitialTwin		初始裝置雙胞胎。
iotHubHostName	string		Iot Hub 主機名稱。
iotHubs	string[]		此資源中裝置可分配至物聯網樞紐主機名稱清單。一定是租戶層級物聯網集線清單的子集。
lastUpdatedDateTimeUtc	string (date-time)		此資源最後更新日期時間。
provisioningStatus	ProvisioningStatus	enabled	配置狀態。
reprovisionPolicy	ReprovisionPolicy		裝置重新配置到物聯網集線時的行為。

InitialTwin

Object

初始裝置雙胞胎。包含 Twin 性質的子集。

名稱	類型	Description
properties	InitialTwinProperties	對應項所需的屬性。
tags	TwinCollection	對應項標籤。

InitialTwinProperties

Object

代表將被設定在裝置雙胞胎上的初始屬性。

名稱	類型	Description
desired	TwinCollection	取得並設定 InitialTwin 所需的屬性。

Metadata

Object

TwinCollection 的元資料

名稱	類型	Description
lastUpdated	string (date-time)	上次 TwinCollection 更新
lastUpdatedVersion	integer (int32)	對於報告的屬性元資料，這個設定為空，對於想要的屬性元資料則不為空。

ProvisioningServiceErrorDetails

Object

包含 Azure IoT Hub Provisioning Service 回傳錯誤的屬性。

名稱	類型	Description
errorCode	integer (int32)	操作錯誤代碼。
info	object	<字串> 字典
message	string	人類可讀的錯誤訊息。
timestampUtc	string (date-time)	錯誤的時間戳記。
trackingId	string	錯誤的追蹤ID。

ProvisioningStatus

列舉型別

配置狀態。

值	Description
enabled	enabled
disabled	停用

ReprovisionPolicy

Object

當裝置重新配置到物聯網樞紐時，服務的行為。

名稱	類型	預設值	Description
migrateDeviceData	boolean	True	當設定為 true（預設值）時，裝置配置服務會在物聯網樞紐指派更新時，將裝置的資料（雙重、裝置能力及裝置 ID）從一個物聯網樞紐遷移到另一個。若設為 false，裝置配置服務會將裝置資料重設為對應註冊清單中儲存的初始設定。
updateHubAssignment	boolean	True	當設定為 true（預設值）時，裝置配置服務會評估該裝置的物聯網中樞指派，並在必要時更新該指派，以應對超出該裝置首次配置請求的請求。若設為 false，裝置仍會被分配到目前的物聯網集線。

SymmetricKeyAttestation

Object

透過 SymmetricKey 進行認證。

名稱	類型	Description
primaryKey	string	主鑰匙對稱。
secondaryKey	string	次要對稱鑰匙。

TpmAttestation

Object

透過TPM認證。

名稱	類型	Description
endorsementKey	string	TPM 背書鑰匙。
storageRootKey	string	TPM 儲存根金鑰。

TwinCollection

Object

代表雙生子中的一組屬性集合

名稱	類型	Description
count	integer (int32)	TwinCollection 中的屬性數量
metadata	Metadata	TwinCollection 的元資料
version	integer (int32)	TwinCollection 版本

X509Attestation

Object

經由 X509 認證。

名稱	類型	Description
caReferences	X509CAReferences	主要與次要加州參考資料。
clientCertificates	X509Certificates	小學與中學證書
signingCertificates	X509Certificates	小學與中學證書

X509CAReferences

Object

主要與次要加州參考資料。

名稱	類型	Description
primary	string	主要的加州參考資料。
secondary	string	加州的次要參考。

X509CertificateInfo

Object

X509 證書資訊。

名稱	類型	Description
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

Object

小學與中學證書

名稱	類型	Description
primary	X509CertificateWithInfo	證書及證書資訊
secondary	X509CertificateWithInfo	證書及證書資訊

X509CertificateWithInfo

Object

證書及證書資訊

名稱	類型	Description
certificate	string	PEM 格式的憑證字串。
info	X509CertificateInfo	X509 證書資訊。