Enrollment Group - Query

リファレンス

サービス:: IoT Hub Device Provisioning Service

API バージョン:: 2021-10-01

デバイス登録グループに対してクエリを実行します。

POST https://your-dps.azure-devices-provisioning.net/enrollmentGroups/query?api-version=2021-10-01

URI パラメーター

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

要求ヘッダー

名前	必須	型	説明
x-ms-max-item-count		integer (int32)	ページサイズ
x-ms-continuation		string	継続トークン

要求本文

名前	必須	型	説明
query	True	string

応答

名前	型	説明
200 OK	EnrollmentGroup[]	成功ヘッダー x-ms-continuation: string x-ms-max-item-count: integer x-ms-item-type: string
Other Status Codes	ProvisioningServiceErrorDetails	エラー応答ヘッダー x-ms-error-code: string

名前

型

説明

200 OK

EnrollmentGroup[]

成功

ヘッダー

x-ms-continuation: string
x-ms-max-item-count: integer
x-ms-item-type: string

Other Status Codes

ProvisioningServiceErrorDetails

エラー応答

ヘッダー

x-ms-error-code: string

定義

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

AttestationMechanism

Object

individualEnrollment と enrollmentGroup の構成証明メカニズム。

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

CustomAllocationDefinition

Object

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

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

DeviceCapabilities

Object

デバイスの機能。

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

EnrollmentGroup

Object

登録グループレコード。

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

InitialTwin

Object

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

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

InitialTwinProperties

Object

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

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

Metadata

Object

TwinCollection のメタデータ

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

ProvisioningServiceErrorDetails

Object

Azure IoT Hub プロビジョニングサービスによって返されるエラーのプロパティが含まれています。

名前	型	説明
errorCode	integer (int32)
info	object
message	string
timestampUtc	string (date-time)
trackingId	string

QuerySpecification

Object

名前	型	説明
query	string

ReprovisionPolicy

Object

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

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

SymmetricKeyAttestation

Object

SymmetricKey を使用した構成証明。

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

TpmAttestation

Object

TPM を使用した構成証明。

名前	型	説明
endorsementKey	string
storageRootKey	string

TwinCollection

Object

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

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

X509Attestation

Object

X509 による構成証明。

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

X509CAReferences

Object

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

名前	型	説明
primary	string
secondary	string

X509CertificateInfo

Object

X509 証明書情報。

名前	型	説明
issuerName	string
notAfterUtc	string (date-time)
notBeforeUtc	string (date-time)
serialNumber	string
sha1Thumbprint	string
sha256Thumbprint	string
subjectName	string
version	integer (int32)

X509Certificates

Object

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

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

X509CertificateWithInfo

Object

証明書と証明書の情報

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

次の方法で共有

Enrollment Group - Query

URI パラメーター

要求ヘッダー

要求本文

応答

定義

AttestationMechanism

CustomAllocationDefinition

DeviceCapabilities

EnrollmentGroup

InitialTwin

InitialTwinProperties

Metadata

ProvisioningServiceErrorDetails

QuerySpecification

ReprovisionPolicy

SymmetricKeyAttestation

TpmAttestation

TwinCollection

X509Attestation

X509CAReferences

X509CertificateInfo

X509Certificates

X509CertificateWithInfo

その他のリソース