Runtime Registration - Device Registration Status Lookup

サービス:

IoT Hub Device Provisioning Service

API バージョン:

2021-10-01

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

POST https://global.azure-devices-provisioning.net/{idScope}/registrations/{registrationId}?api-version=2021-10-01

URI パラメーター

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

要求本文

名前	型	説明
payload	object
registrationId	string	登録 ID は、英数字と特定の特殊文字の大文字と小文字を区別しない文字列 (最大 128 文字) です。 _ -. 先頭または末尾に特殊文字を使用できません。
tpm	TpmAttestation	TPM を使用した構成証明。

応答

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

定義

名前	説明
DeviceRegistration	デバイスの登録。
DeviceRegistrationResult	デバイス登録の結果。
ProvisioningServiceErrorDetails	Azure IoT Hub プロビジョニング サービスによって返されるエラーのプロパティが含まれています。
SymmetricKeyRegistrationResult	SymmetricKey 構成証明の使用時に返される登録結果。
TpmAttestation	TPM を使用した構成証明。
TpmRegistrationResult	TPM 登録の結果。
X509CertificateInfo	X509 証明書情報。
X509RegistrationResult	X509 登録の結果。

DeviceRegistration

Object

デバイスの登録。

名前	型	説明
payload	object
registrationId	string	登録 ID は、英数字と特定の特殊文字の大文字と小文字を区別しない文字列 (最大 128 文字) です。 _ -. 先頭または末尾に特殊文字を使用できません。
tpm	TpmAttestation	TPM を使用した構成証明。

DeviceRegistrationResult

Object

デバイス登録の結果。

名前	型	説明
assignedHub	string	割り当てられた Azure IoT Hub。
createdDateTimeUtc	string (date-time)	登録の作成日時 (UTC)。
deviceId	string	デバイス ID。
errorCode	integer (int32)	エラー コード。
errorMessage	string	エラーメッセージ。
etag	string	リソースに関連付けられているエンティティ タグ。
lastUpdatedDateTimeUtc	string (date-time)	最終更新日時 (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 ハブに再プロビジョニングされました。
symmetricKey	SymmetricKeyRegistrationResult	SymmetricKey 構成証明の使用時に返される登録結果。
tpm	TpmRegistrationResult	TPM 登録の結果。
x509	X509RegistrationResult	X509 登録の結果。

ProvisioningServiceErrorDetails

Object

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

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

SymmetricKeyRegistrationResult

Object

SymmetricKey 構成証明の使用時に返される登録結果。

名前	型	説明
enrollmentGroupId	string

TpmAttestation

Object

TPM を使用した構成証明。

名前	型	説明
endorsementKey	string
storageRootKey	string

TpmRegistrationResult

Object

TPM 登録の結果。

名前	型	説明
authenticationKey	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)

X509RegistrationResult

Object

X509 登録の結果。

名前	型	説明
certificateInfo	X509CertificateInfo	X509 証明書情報。
enrollmentGroupId	string
signingCertificateInfo	X509CertificateInfo	X509 証明書情報。