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	この資源の配分方針。このポリシーは、この個別の登録または登録グループのテナントレベルの割り当てポリシーを上書きします。可能な値には「ハッシュ化」:連結されたIoTハブにはデバイスがプロビジョニングされている可能性が同じくらい、「geoLatency」:デバイスはデバイス間の遅延が最も低いIoTハブにプロビジョニングされます。複数の連結されたIoTハブが同じ最低遅延を提供できる場合、プロビジョニングサービスはそれらのハブ間でデバイスをハッシュ化します。「静的」:登録リストで希望するIoTハブの指定がサービスレベルの割り当てポリシーより優先されます。「カスタム」:デバイスは独自のカスタムロジックに基づいてIoTハブにプロビジョニングされます。プロビジョニングサービスはデバイスに関する情報をロジックに伝え、ロジックは望ましいIoTハブと希望する初期設定を返します。ロジックのホストにはAzure Functionsを使うことをおすすめします。
AttestationMechanism	個人登録および登録グループのための認証メカニズム。
AttestationType	証言タイプ。
CustomAllocationDefinition	これにより、カスタム割り当てを使う際にどのウェブフックを呼び出すかDPSに指示されます。
DeviceCapabilities	デバイスの機能。
EnrollmentGroup	登録グループ記録。
InitialTwin	初期のデバイスツインです。 Twinの性質の一部を含む。
InitialTwinProperties	デバイスツインに設定される初期プロパティを表します。
Metadata	TwinCollectionのメタデータ
ProvisioningServiceErrorDetails	Azure IoT Hub Provisioning Serviceによって返されたエラーのプロパティが含まれています。
ProvisioningStatus	プロビジョニング状況。
ReprovisionPolicy	デバイスがIoTハブに再プロビジョニングされた際のサービスの挙動。
SymmetricKeyAttestation	SymmetricKeyによる認証。
TpmAttestation	TPMによる認証。
TwinCollection	双子内の性質の集合を表します
X509Attestation	認証はX509より。
X509CAReferences	一次および二次的なCAの参考資料。
X509CertificateInfo	X509証明書の情報。
X509Certificates	初級および中等資格
X509CertificateWithInfo	証明書および証明書情報

AllocationPolicy

列挙

この資源の配分方針。このポリシーは、この個別の登録または登録グループのテナントレベルの割り当てポリシーを上書きします。可能な値には「ハッシュ化」:連結されたIoTハブにはデバイスがプロビジョニングされている可能性が同じくらい、「geoLatency」:デバイスはデバイス間の遅延が最も低いIoTハブにプロビジョニングされます。複数の連結されたIoTハブが同じ最低遅延を提供できる場合、プロビジョニングサービスはそれらのハブ間でデバイスをハッシュ化します。「静的」:登録リストで希望するIoTハブの指定がサービスレベルの割り当てポリシーより優先されます。「カスタム」:デバイスは独自のカスタムロジックに基づいてIoTハブにプロビジョニングされます。プロビジョニングサービスはデバイスに関する情報をロジックに伝え、ロジックは望ましいIoTハブと希望する初期設定を返します。ロジックのホストにはAzure Functionsを使うことをおすすめします。

値	説明
hashed	ハッシュ化
geoLatency	geoLatency
static	静的
custom	custom

AttestationMechanism

Object

個人登録および登録グループのための認証メカニズム。

名前	型	説明
symmetricKey	SymmetricKeyAttestation	対称鍵証明法。
tpm	TpmAttestation	TPM認証方法。
type	AttestationType	証言タイプ。
x509	X509Attestation	X509の証明方法。

AttestationType

列挙

証言タイプ。

値	説明
none	なし
tpm	tpm
x509	x509
symmetricKey	symmetricKey

CustomAllocationDefinition

Object

これにより、カスタム割り当てを使う際にどのウェブフックを呼び出すかDPSに指示されます。

名前	型	説明
apiVersion	string	カスタム割り当てリクエストで送信されたプロビジョニングサービスタイプ(IndividualEnrollmentなど)のAPIバージョンです。最小サポートバージョン:「2018-09-01-preview」。
webhookUrl	string	割り当て要求に使用されるウェブフックURL。

DeviceCapabilities

Object

デバイスの機能。

名前	型	規定値	説明
iotEdge	boolean	False	trueに設定すると、このデバイスはIoTEdgeデバイスとなります。

EnrollmentGroup

Object

登録グループ記録。

名前	型	規定値	説明
allocationPolicy	AllocationPolicy		この資源の配分方針。このポリシーは、この個別の登録または登録グループのテナントレベルの割り当てポリシーを上書きします。可能な値には「ハッシュ化」:連結されたIoTハブにはデバイスがプロビジョニングされている可能性が同じくらい、「geoLatency」:デバイスはデバイス間の遅延が最も低いIoTハブにプロビジョニングされます。複数の連結されたIoTハブが同じ最低遅延を提供できる場合、プロビジョニングサービスはそれらのハブ間でデバイスをハッシュ化します。「静的」:登録リストで希望するIoTハブの指定がサービスレベルの割り当てポリシーより優先されます。「カスタム」:デバイスは独自のカスタムロジックに基づいてIoTハブにプロビジョニングされます。プロビジョニングサービスはデバイスに関する情報をロジックに伝え、ロジックは望ましいIoTハブと希望する初期設定を返します。ロジックのホストにはAzure Functionsを使うことをおすすめします。
attestation	AttestationMechanism		この装置で使用されている認証方法。
capabilities	DeviceCapabilities		デバイスの機能について。
createdDateTimeUtc	string (date-time)		このリソースはDateTimeで作成されました。
customAllocationDefinition	CustomAllocationDefinition		これにより、カスタム割り当てを使う際にどのウェブフックを呼び出すかDPSに指示されます。
enrollmentGroupId	string		登録グループID。
etag	string		リソースに関連付けられたエンティティタグです。
initialTwin	InitialTwin		初期のデバイスツインです。
iotHubHostName	string		Iot Hubのホスト名です。
iotHubs	string[]		このリソース内のデバイスが割り当てられるIoTハブのホストネームのリストです。 IoTハブのテナントレベルリストの一部でなければなりません。
lastUpdatedDateTimeUtc	string (date-time)		このリソースはDateTimeが最後に更新されました。
provisioningStatus	ProvisioningStatus	enabled	プロビジョニング状況。
reprovisionPolicy	ReprovisionPolicy		デバイスがIoTハブに再割り当てされた際の挙動。

InitialTwin

Object

初期のデバイスツインです。 Twinの性質の一部を含む。

名前	型	説明
properties	InitialTwinProperties	ツインの必要なプロパティ。
tags	TwinCollection	ツインタグ。

InitialTwinProperties

Object

デバイスツインに設定される初期プロパティを表します。

名前	型	説明
desired	TwinCollection	InitialTwinの目的プロパティを取得して設定します。

Metadata

Object

TwinCollectionのメタデータ

名前	型	説明
lastUpdated	string (date-time)	前回のTwinCollectionの更新
lastUpdatedVersion	integer (int32)	報告されたプロパティメタデータにはnullですが、望ましいプロパティメタデータにはnullではありません。

ProvisioningServiceErrorDetails

Object

Azure IoT Hub Provisioning Serviceによって返されたエラーのプロパティが含まれています。

名前	型	説明
errorCode	integer (int32)	操作のエラーコード。
info	object	文字列<>辞書
message	string	人間が読み取れるエラーメッセージ。
timestampUtc	string (date-time)	エラーのUTCタイムスタンプ。
trackingId	string	エラーの追跡IDです。

ProvisioningStatus

列挙

プロビジョニング状況。

値	説明
enabled	enabled
disabled	無効

ReprovisionPolicy

Object

デバイスがIoTハブに再プロビジョニングされた際のサービスの挙動。

名前	型	規定値	説明
migrateDeviceData	boolean	True	デフォルトでtrueに設定すると、デバイスプロビジョニングサービスはIoTハブ割り当ての更新時に、デバイスのデータ(ツイン、デバイス機能、デバイスID)を1つのIoTハブから別のハブへ移行します。 falseに設定された場合、デバイスプロビジョニングサービスは対応する登録リストに保存された初期の希望設定にデバイスをリセットします。
updateHubAssignment	boolean	True	true(デフォルト)に設定されると、デバイスプロビジョニングサービスはデバイスのIoTハブ割り当てを評価し、特定のデバイスからの最初のプロビジョニング要求以降に必要に応じて更新します。 falseに設定されている場合、デバイスは現在のIoTハブに割り当てられたままです。

SymmetricKeyAttestation

Object

SymmetricKeyによる認証。

名前	型	説明
primaryKey	string	主対称キー。
secondaryKey	string	二次対称キー。

TpmAttestation

Object

TPMによる認証。

名前	型	説明
endorsementKey	string	TPM推薦キー。
storageRootKey	string	TPMストレージのルートキーです。

TwinCollection

Object

双子内の性質の集合を表します

名前	型	説明
count	integer (int32)	TwinCollectionのプロパティ数
metadata	Metadata	TwinCollectionのメタデータ
version	integer (int32)	ツインコレクションのバージョン

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)	証明書有効性終了(UTC)。
notBeforeUtc	string (date-time)	証明書有効性開始(UTC)。
serialNumber	string	証明書のシリアル番号。
sha1Thumbprint	string	証明書のSHA-1指紋。
sha256Thumbprint	string	証明書のSHA-256指紋。
subjectName	string	証明書のサブジェクト名。
version	integer (int32)	証明書のバージョン。

X509Certificates

Object

初級および中等資格

名前	型	説明
primary	X509CertificateWithInfo	証明書および証明書情報
secondary	X509CertificateWithInfo	証明書および証明書情報

X509CertificateWithInfo

Object

証明書および証明書情報

名前	型	説明
certificate	string	PEM形式の証明書文字列。
info	X509CertificateInfo	X509証明書の情報。