Device Registration State - Query

サービス:

IoT Hub Device Provisioning Service

API バージョン:

2021-10-01

この enrollmentGroup 内のデバイスの登録状態を取得します。

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

URI パラメーター

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

要求ヘッダー

名前	必須	型	説明
x-ms-max-item-count		integer int32	PageSize
x-ms-continuation		string	継続トークン

応答

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

定義

名前	説明
DeviceRegistrationState	デバイス登録の状態。
ProvisioningServiceErrorDetails	Azure IoT Hub プロビジョニング サービスによって返されるエラーのプロパティを格納します。

DeviceRegistrationState

デバイス登録の状態。

名前	型	説明
assignedHub	string	割り当てられたAzure IoT Hub。
createdDateTimeUtc	string	登録の作成日時 (UTC)。
deviceId	string	デバイス ID。
errorCode	integer	エラー コード。
errorMessage	string	エラー メッセージ。
etag	string	リソースに関連付けられているエンティティ タグ。
lastUpdatedDateTimeUtc	string	最終更新日時 (UTC)。
payload	object
registrationId	string	この ID は、登録のデバイス登録を一意に識別するために使用されます。 英数字と特定の特殊文字の大文字と小文字を区別しない文字列 (最大 128 文字)。 _ -. 先頭または末尾に特殊文字は使用できません。
status	enum: assigned assigning disabled failed unassigned	登録の状態。
substatus	enum: deviceDataMigrated deviceDataReset initialAssignment reprovisionedToInitialAssignment	"割り当て済み" デバイスのサブステータス。 使用可能な値には、"initialAssignment": デバイスが初めて IoT ハブに割り当てられました。"deviceDataMigrated": デバイスが別の IoT ハブに割り当てられ、そのデバイス データが以前に割り当てられた IoT ハブから移行されました。 以前に割り当てられた IoT ハブ 'deviceDataReset' からデバイス データが削除されました:デバイスが別の IoT ハブに割り当てられ、そのデバイス データは登録に格納されている初期状態から設定されました。 以前に割り当てられた IoT ハブ 'reprovisionedToInitialAssignment' からデバイス データが削除されました:デバイスは、以前に割り当てられた IoT ハブに再プロビジョニングされました。

ProvisioningServiceErrorDetails

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

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