Runtime Registration - Device Registration Status Lookup

Service:: IoT Hub Device Provisioning Service

API バージョン:: 2026-11-01

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

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

URI パラメーター

Name	/	必須	型	説明
idScope	path	True	string	DPSインスタンスの範囲について。
registrationId	path	True	string	登録 ID。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求本文

Name	型	説明
csr	string	PKCS #10形式のBase64でエンコードされたDER証明書署名要求(CSR)で、PEMヘッダーとフッターを除外します。共通名(CN)はデバイスregistrationIdと一致しなければなりません。このフィールドをRuntimeRegistration_DeviceRegistrationStatusLookup操作に含めると、悪いリクエストが出てしまいます。
payload		任意のオブジェクト
registrationId	string	登録IDは、英数字文字と特定の特殊文字からなる大文字に区別されない文字列(最大128文字)です。 _ -. 開始時と終わりに特別な文字は禁止されています。
tpm	TpmAttestation	TPMによる認証。

応答

Name	型	説明
200 OK	DeviceRegistrationResult	要求は成功しました。
Other Status Codes	ProvisioningServiceErrorDetails	予期しないエラー応答。ヘッダー x-ms-error-code: string

Name

型

説明

200 OK

DeviceRegistrationResult

要求は成功しました。

Other Status Codes

ProvisioningServiceErrorDetails

予期しないエラー応答。

ヘッダー

x-ms-error-code: string

例

RuntimeRegistration_DeviceRegistrationStatusLookup_MaximumSet_Gen

RuntimeRegistration_DeviceRegistrationStatusLookup_MinimumSet_Gen

RuntimeRegistration_DeviceRegistrationStatusLookup_MaximumSet_Gen

要求のサンプル

HTTP

POST https://global.azure-devices-provisioning.net/a/registrations/urnfaaodcvbbllnmxj?api-version=2026-11-01

{
  "payload": {},
  "registrationId": "qypnuerjeunzogqdezhjgisfr",
  "tpm": {
    "endorsementKey": "sbvvzftylrpsetexcmnijtdezppq",
    "storageRootKey": "juohyrayid"
  }
}

応答のサンプル

状態コード:: 200

{
  "assignedHub": "ljexps",
  "createdDateTimeUtc": "2025-10-01T17:41:56.535Z",
  "deviceId": "hjvdlwpugzlk",
  "errorCode": 13,
  "errorMessage": "zpctqazbkbiqjkwosis",
  "etag": "hjtelksspyfzhmet",
  "issuedCertificateChain": [
    "MIIBkTCB+wIBADAZMRcwFQYDVQQDDA5leGFtcGxlLWRldmljZTCBnzANBgkqhkiG9w0BAQEFAAOBjQAw"
  ],
  "lastUpdatedDateTimeUtc": "2025-10-01T17:41:56.535Z",
  "payload": {},
  "registrationId": "urejrffpkqneou",
  "status": "unassigned",
  "substatus": "initialAssignment",
  "symmetricKey": {
    "enrollmentGroupId": "w"
  },
  "tpm": {
    "authenticationKey": "sofbxakhjrxpiyysjjxkx"
  },
  "x509": {
    "certificateInfo": {
      "issuerName": "pvpbipnhcahytrcq",
      "notAfterUtc": "2025-10-01T17:41:56.534Z",
      "notBeforeUtc": "2025-10-01T17:41:56.534Z",
      "serialNumber": "jjvdijgwgpagrjdi",
      "sha1Thumbprint": "guqltcfgusf",
      "sha256Thumbprint": "ysryarleygpkejrjlwuxacvcwbxqw",
      "subjectName": "jtsfqnbcmmott",
      "version": 20
    },
    "enrollmentGroupId": "qbw",
    "signingCertificateInfo": {
      "issuerName": "pvpbipnhcahytrcq",
      "notAfterUtc": "2025-10-01T17:41:56.534Z",
      "notBeforeUtc": "2025-10-01T17:41:56.534Z",
      "serialNumber": "jjvdijgwgpagrjdi",
      "sha1Thumbprint": "guqltcfgusf",
      "sha256Thumbprint": "ysryarleygpkejrjlwuxacvcwbxqw",
      "subjectName": "jtsfqnbcmmott",
      "version": 20
    }
  }
}

RuntimeRegistration_DeviceRegistrationStatusLookup_MinimumSet_Gen

要求のサンプル

HTTP

POST https://global.azure-devices-provisioning.net/mucolayhjusj/registrations/okxnmx?api-version=2026-11-01

{}

応答のサンプル

状態コード:: 200

{}

定義

Name	説明
AssignedDeviceSubstatus	「割り当て済み」デバイスのサブステータス。可能な値には以下が含まれます:『initialAssignment』:デバイスが初めてIoTハブに割り当てられた場合、「deviceDataMigrated」:デバイスが別のIoTハブに割り当てられ、そのデバイスデータが以前に割り当てられたIoTハブから移行された場合。デバイスデータが以前に割り当てられたIoTハブ「deviceDataReset」から削除されました:デバイスは別のIoTハブに割り当てられ、そのデバイスデータは登録時に保存された初期状態から入力されました。デバイスデータが以前割り当てられたIoTハブから削除されました。'reprovisionedToInitialAssignment':デバイスは以前に割り当てられたIoTハブに再プロビジョニングされました。
DeviceRegistration	デバイスの登録。
DeviceRegistrationResult	デバイス登録の結果。
EnrollmentStatus	在籍状況。
ProvisioningServiceErrorDetails	Azure IoT Hub Provisioning Serviceによって返されたエラーのプロパティが含まれています。
SymmetricKeyRegistrationResult	SymmetricKey認証を使用した場合、登録結果が返されました。
TpmAttestation	TPMによる認証。
TpmRegistrationResult	TPM登録結果。
X509CertificateInfo	X509証明書の情報。
X509RegistrationResult	X509の登録結果。

AssignedDeviceSubstatus

列挙

「割り当て済み」デバイスのサブステータス。可能な値には以下が含まれます:『initialAssignment』:デバイスが初めてIoTハブに割り当てられた場合、「deviceDataMigrated」:デバイスが別のIoTハブに割り当てられ、そのデバイスデータが以前に割り当てられたIoTハブから移行された場合。デバイスデータが以前に割り当てられたIoTハブ「deviceDataReset」から削除されました:デバイスは別のIoTハブに割り当てられ、そのデバイスデータは登録時に保存された初期状態から入力されました。デバイスデータが以前割り当てられたIoTハブから削除されました。'reprovisionedToInitialAssignment':デバイスは以前に割り当てられたIoTハブに再プロビジョニングされました。

値	説明
initialAssignment	初期配属
deviceDataMigrated	deviceDataMigrated
deviceDataReset	deviceDataReset(デバイスデータリセット)
reprovisionedToInitialAssignment	再割り当てされ初期割り当て

DeviceRegistration

Object

デバイスの登録。

Name	型	説明
csr	string	PKCS #10形式のBase64でエンコードされたDER証明書署名要求(CSR)で、PEMヘッダーとフッターを除外します。共通名(CN)はデバイスregistrationIdと一致しなければなりません。このフィールドをRuntimeRegistration_DeviceRegistrationStatusLookup操作に含めると、悪いリクエストが出てしまいます。
payload		任意のオブジェクト
registrationId	string	登録IDは、英数字文字と特定の特殊文字からなる大文字に区別されない文字列(最大128文字)です。 _ -. 開始時と終わりに特別な文字は禁止されています。
tpm	TpmAttestation	TPMによる認証。

DeviceRegistrationResult

Object

デバイス登録の結果。

Name	型	説明
assignedHub	string	Assigned Azure IoT Hub.
createdDateTimeUtc	string (date-time)	登録日時(UTC単位)を作成します。
deviceId	string	デバイス ID。
errorCode	integer (int32)	エラーコード。
errorMessage	string	エラーメッセージ。
etag	string	リソースに関連付けられたエンティティタグです。
issuedCertificateChain	string[] (byte)	発行された証明書の完全な証明書チェーンを含む配列です。最初の要素は発行されたリーフ証明書で、その後に中間認証機関(ICA)が続き、最後にルート認証機関(CA)が続きます。アレイ内の各証明書は、前の証明書の発行元となります。この性質はRuntimeRegistration_DeviceRegistrationStatusLookup操作の応答には含まれていません。
lastUpdatedDateTimeUtc	string (date-time)	最終更新日時(UTC時)。
payload		任意のオブジェクト
registrationId	string	このIDは、登録のデバイス登録を一意に識別するために使われます。英数字と特定の特殊文字からなる大文字を区別しない文字列(最大128文字)です。 _ -. 開始時と終わりに特別な文字は禁止されています。
status	EnrollmentStatus	在籍状況。
substatus	AssignedDeviceSubstatus	「割り当て済み」デバイスのサブステータス。可能な値には以下が含まれます:『initialAssignment』:デバイスが初めてIoTハブに割り当てられた場合、「deviceDataMigrated」:デバイスが別のIoTハブに割り当てられ、そのデバイスデータが以前に割り当てられたIoTハブから移行された場合。デバイスデータが以前に割り当てられたIoTハブ「deviceDataReset」から削除されました:デバイスは別のIoTハブに割り当てられ、そのデバイスデータは登録時に保存された初期状態から入力されました。デバイスデータが以前割り当てられたIoTハブから削除されました。'reprovisionedToInitialAssignment':デバイスは以前に割り当てられたIoTハブに再プロビジョニングされました。
symmetricKey	SymmetricKeyRegistrationResult	SymmetricKey認証を使用した場合、登録結果が返されました。
tpm	TpmRegistrationResult	TPM登録結果。
x509	X509RegistrationResult	X509の登録結果。

EnrollmentStatus

列挙

在籍状況。

値	説明
unassigned	unassigned
assigning	割り当て
assigned	割り当て済み
failed	失敗
disabled	無効

ProvisioningServiceErrorDetails

Object

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

Name	型	説明
errorCode	integer (int32)	数値のエラーコードです。
info	object	文字列<>辞書
message	string	エラーメッセージ。
timestampUtc	string (date-time)	エラータイムスタンプ(UTC)。
trackingId	string	エラー追跡IDです。

SymmetricKeyRegistrationResult

Object

SymmetricKey認証を使用した場合、登録結果が返されました。

Name	型	説明
enrollmentGroupId	string	登録グループ ID。

TpmAttestation

Object

TPMによる認証。

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

TpmRegistrationResult

Object

TPM登録結果。

Name	型	説明
authenticationKey	string	暗号化された認証キー。

X509CertificateInfo

Object

X509証明書の情報。

Name	型	説明
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)	証明書のバージョン。

X509RegistrationResult

Object

X509の登録結果。

Name	型	説明
certificateInfo	X509CertificateInfo	X509証明書の情報。
enrollmentGroupId	string	登録グループ ID。
signingCertificateInfo	X509CertificateInfo	X509証明書の情報。