Enrollment Group - Create Or Update

サービス:

IoT Hub Device Provisioning Service

API バージョン:

2021-10-01

デバイス登録グループをCreateまたは更新します。

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

URI パラメーター

名前	/	必須	型	説明
id	path	True	string	登録グループ ID。
api-version	query	True	string	要求で使用する API のバージョン。 サポートされているバージョンは次のとおりです: 2021-10-01

要求ヘッダー

名前	必須	型	説明
If-Match		string	登録レコードの ETag。

要求本文

名前	必須	型	説明
attestation	True	AttestationMechanism	enrollmentGroup だけでなく、individualEnrollment の構成証明メカニズム。
enrollmentGroupId	True	string	登録グループ ID。
allocationPolicy		enum: hashed geoLatency static custom	このリソースの割り当てポリシー。 このポリシーは、この個々の登録または登録グループのテナント レベルの割り当てポリシーをオーバーライドします。 使用可能な値には、"ハッシュ済み" が含まれます。リンクされた IoT ハブには、デバイスがプロビジョニングされている可能性が高い場合があります。"geoLatency": デバイスは、デバイスへの待機時間が最も短い IoT ハブにプロビジョニングされます。リンクされた複数の IoT ハブで同じ最短待機時間が提供される場合、プロビジョニング サービスはそれらのハブ全体でデバイスをハッシュします。"静的" : 登録リスト内の目的の IoT ハブの指定は、サービス レベルの割り当てポリシー 'custom' よりも優先されます。デバイスは、独自のカスタム ロジックに基づいて IoT ハブにプロビジョニングされます。 プロビジョニング サービスはデバイスに関する情報をロジックに渡し、ロジックは目的の IoT ハブと目的の初期構成を返します。 ロジックをホストするには、Azure Functionsを使用することをお勧めします。
capabilities		DeviceCapabilities	デバイス機能。
customAllocationDefinition		CustomAllocationDefinition	これにより、カスタム割り当てを使用するときに呼び出す Webhook が DPS に指示されます。
etag		string	リソースに関連付けられているエンティティ タグ。
initialTwin		InitialTwin	初期デバイス ツイン。 Twin のプロパティのサブセットが含まれます。
iotHubHostName		string	Iot Hub ホスト名。
iotHubs		string[]	このリソース内のデバイスが割り当てることができるIoT Hubホスト名の一覧。 IoT ハブのテナント レベルリストのサブセットである必要があります。
provisioningStatus		enum: enabled disabled	プロビジョニングの状態。
reprovisionPolicy		ReprovisionPolicy	デバイスが IoT ハブに再プロビジョニングされたときのサービスの動作。

応答

名前	型	説明
200 OK	EnrollmentGroup	Success
Other Status Codes	ProvisioningServiceErrorDetails	エラー応答 ヘッダー x-ms-error-code: string

定義

名前	説明
AttestationMechanism	enrollmentGroup だけでなく、individualEnrollment の構成証明メカニズム。
CustomAllocationDefinition	これにより、カスタム割り当てを使用するときに呼び出す Webhook が DPS に指示されます。
DeviceCapabilities	デバイス機能。
EnrollmentGroup	登録グループ レコード。
InitialTwin	初期デバイス ツイン。 Twin のプロパティのサブセットが含まれます。
InitialTwinProperties	デバイス ツインで設定される初期プロパティを表します。
Metadata	TwinCollection のメタデータ
ProvisioningServiceErrorDetails	Azure IoT Hub Provisioning Service によって返されるエラーのプロパティを格納します。
ReprovisionPolicy	デバイスが IoT ハブに再プロビジョニングされたときのサービスの動作。
SymmetricKeyAttestation	SymmetricKey を使用した構成証明。
TpmAttestation	TPM による構成証明。
TwinCollection	Twin 内のプロパティのコレクションを表します
X509Attestation	X509 による構成証明。
X509CAReferences	プライマリ CA 参照とセカンダリ CA 参照。
X509CertificateInfo	X509 証明書情報。
X509Certificates	プライマリ証明書とセカンダリ証明書
X509CertificateWithInfo	証明書と証明書の情報

AttestationMechanism

enrollmentGroup だけでなく、individualEnrollment の構成証明メカニズム。

名前	型	説明
symmetricKey	SymmetricKeyAttestation	SymmetricKey を使用した構成証明。
tpm	TpmAttestation	TPM による構成証明。
type	enum: none symmetricKey tpm x509	構成証明の種類。
x509	X509Attestation	X509 による構成証明。

CustomAllocationDefinition

これにより、カスタム割り当てを使用するときに呼び出す Webhook が DPS に指示されます。

名前	型	説明
apiVersion	string	カスタム割り当て要求で送信されるプロビジョニング サービスの種類 (IndividualEnrollment など) の API バージョン。 サポートされている最小バージョン: "2018-09-01-preview"
webhookUrl	string	割り当て要求に使用される Webhook URL。

DeviceCapabilities

デバイス機能。

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

EnrollmentGroup

登録グループ レコード。

名前	型	規定値	説明
allocationPolicy	enum: custom geoLatency hashed static		このリソースの割り当てポリシー。 このポリシーは、この個々の登録または登録グループのテナント レベルの割り当てポリシーをオーバーライドします。 使用可能な値には、"ハッシュ済み" が含まれます。リンクされた IoT ハブには、デバイスがプロビジョニングされている可能性が高い場合があります。"geoLatency": デバイスは、デバイスへの待機時間が最も短い IoT ハブにプロビジョニングされます。リンクされた複数の IoT ハブで同じ最短待機時間が提供される場合、プロビジョニング サービスはそれらのハブ全体でデバイスをハッシュします。"静的" : 登録リスト内の目的の IoT ハブの指定は、サービス レベルの割り当てポリシー 'custom' よりも優先されます。デバイスは、独自のカスタム ロジックに基づいて IoT ハブにプロビジョニングされます。 プロビジョニング サービスはデバイスに関する情報をロジックに渡し、ロジックは目的の IoT ハブと目的の初期構成を返します。 ロジックをホストするには、Azure Functionsを使用することをお勧めします。
attestation	AttestationMechanism		enrollmentGroup だけでなく、individualEnrollment の構成証明メカニズム。
capabilities	DeviceCapabilities		デバイス機能。
createdDateTimeUtc	string		このリソースが作成された DateTime。
customAllocationDefinition	CustomAllocationDefinition		これにより、カスタム割り当てを使用するときに呼び出す Webhook が DPS に指示されます。
enrollmentGroupId	string		登録グループ ID。
etag	string		リソースに関連付けられているエンティティ タグ。
initialTwin	InitialTwin		初期デバイス ツイン。 Twin のプロパティのサブセットが含まれます。
iotHubHostName	string		Iot Hub ホスト名。
iotHubs	string[]		このリソース内のデバイスが割り当てることができるIoT Hubホスト名の一覧。 IoT ハブのテナント レベルリストのサブセットである必要があります。
lastUpdatedDateTimeUtc	string		このリソースが最後に更新された DateTime。
provisioningStatus	enum: disabled enabled	enabled	プロビジョニングの状態。
reprovisionPolicy	ReprovisionPolicy		デバイスが IoT ハブに再プロビジョニングされたときのサービスの動作。

InitialTwin

初期デバイス ツイン。 Twin のプロパティのサブセットが含まれます。

名前	型	説明
properties	InitialTwinProperties	デバイス ツインで設定される初期プロパティを表します。
tags	TwinCollection	Twin 内のプロパティのコレクションを表します

InitialTwinProperties

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

名前	型	説明
desired	TwinCollection	Twin 内のプロパティのコレクションを表します

Metadata

TwinCollection のメタデータ

名前	型	説明
lastUpdated	string	TwinCollection が最後に更新された時刻
lastUpdatedVersion	integer	これは、報告されたプロパティ メタデータの場合は null であり、必要なプロパティ メタデータの場合は null ではありません。

ProvisioningServiceErrorDetails

Azure IoT Hub Provisioning Service によって返されるエラーのプロパティを格納します。

名前	型	説明
errorCode	integer
info	object
message	string
timestampUtc	string
trackingId	string

ReprovisionPolicy

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

名前	型	規定値	説明
migrateDeviceData	boolean	True	true (既定値) に設定すると、Device Provisioning Service は、IoT ハブの割り当ての更新中に、デバイスのデータ (ツイン、デバイス機能、およびデバイス ID) を 1 つの IoT ハブから別の IoT ハブに移行します。 false に設定すると、Device Provisioning Service はデバイスのデータを、対応する登録リストに格納されている最初の目的の構成にリセットします。
updateHubAssignment	boolean	True	true (既定値) に設定すると、Device Provisioning Service はデバイスのIoT Hub割り当てを評価し、特定のデバイスからの最初の要求を超えるプロビジョニング要求に必要に応じて更新します。 false に設定すると、デバイスは現在の IoT ハブに割り当てられたままになります。

SymmetricKeyAttestation

SymmetricKey を使用した構成証明。

名前	型	説明
primaryKey	string	主対称キー。
secondaryKey	string	セカンダリ対称キー。

TpmAttestation

TPM による構成証明。

名前	型	説明
endorsementKey	string
storageRootKey	string

TwinCollection

Twin 内のプロパティのコレクションを表します

名前	型	説明
count	integer	TwinCollection のプロパティの数
metadata	Metadata	TwinCollection のメタデータ
version	integer	TwinCollection のバージョン

X509Attestation

X509 による構成証明。

名前	型	説明
caReferences	X509CAReferences	プライマリ CA 参照とセカンダリ CA 参照。
clientCertificates	X509Certificates	プライマリ証明書とセカンダリ証明書
signingCertificates	X509Certificates	プライマリ証明書とセカンダリ証明書

X509CAReferences

プライマリ CA 参照とセカンダリ CA 参照。

名前	型	説明
primary	string
secondary	string

X509CertificateInfo

X509 証明書情報。

名前	型	説明
issuerName	string
notAfterUtc	string
notBeforeUtc	string
serialNumber	string
sha1Thumbprint	string
sha256Thumbprint	string
subjectName	string
version	integer

X509Certificates

プライマリ証明書とセカンダリ証明書

名前	型	説明
primary	X509CertificateWithInfo	証明書と証明書の情報
secondary	X509CertificateWithInfo	証明書と証明書の情報

X509CertificateWithInfo

証明書と証明書の情報

名前	型	説明
certificate	string
info	X509CertificateInfo	X509 証明書情報。