Runtime Registration - Register Device

サービス:: IoT Hub Device Provisioning Service

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

デバイスを登録します。

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

URI パラメーター

名前	/	必須	型	説明
idScope	path	True	string	DPSインスタンスの範囲について。
registrationId	path	True	string	登録IDは英数字で小文字で、ハイフンを含む場合があります。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求本文

名前	型	説明
payload		任意のオブジェクト
registrationId	string	登録IDは、英数字文字と特定の特殊文字からなる大文字に区別されない文字列(最大128文字)です。 _ -. 開始時と終わりに特別な文字は禁止されています。
tpm	TpmAttestation	TPMによる認証。

応答

名前	型	説明
200 OK	RegistrationOperationStatus	要求は成功しました。
202 Accepted	RegistrationOperationStatus	要求は処理のために受け入れ済みですが、処理はまだ完了していません。ヘッダー Location: string retry-after: integer
Other Status Codes	ProvisioningServiceErrorDetails	予期しないエラー応答。ヘッダー x-ms-error-code: string

名前

型

説明

200 OK

RegistrationOperationStatus

要求は成功しました。

202 Accepted

RegistrationOperationStatus

要求は処理のために受け入れ済みですが、処理はまだ完了していません。

ヘッダー

Location: string
retry-after: integer

Other Status Codes

ProvisioningServiceErrorDetails

予期しないエラー応答。

ヘッダー

x-ms-error-code: string

例

RuntimeRegistration_RegisterDevice_MaximumSet_Gen

RuntimeRegistration_RegisterDevice_MinimumSet_Gen

RuntimeRegistration_RegisterDevice_MaximumSet_Gen

要求のサンプル

HTTP

PUT https://global.azure-devices-provisioning.net/ofvgihmgllfsmm/registrations/macgmlbhpb/register?api-version=2021-10-01

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

応答のサンプル

状態コード:: 200

{
  "operationId": "xosjboksmobnotwgqejpvxiwi",
  "registrationState": {
    "assignedHub": "ljexps",
    "createdDateTimeUtc": "2025-10-01T17:41:56.535Z",
    "deviceId": "hjvdlwpugzlk",
    "errorCode": 13,
    "errorMessage": "zpctqazbkbiqjkwosis",
    "etag": "hjtelksspyfzhmet",
    "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
      }
    }
  },
  "status": "unassigned"
}

状態コード:: 202

{
  "operationId": "xosjboksmobnotwgqejpvxiwi",
  "registrationState": {
    "assignedHub": "ljexps",
    "createdDateTimeUtc": "2025-10-01T17:41:56.535Z",
    "deviceId": "hjvdlwpugzlk",
    "errorCode": 13,
    "errorMessage": "zpctqazbkbiqjkwosis",
    "etag": "hjtelksspyfzhmet",
    "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
      }
    }
  },
  "status": "unassigned"
}

RuntimeRegistration_RegisterDevice_MinimumSet_Gen

要求のサンプル

HTTP

PUT https://global.azure-devices-provisioning.net/gwgyqmyyzzzjpjmxml/registrations/tuodrxicixbbekaajxfiyvoxsbe/register?api-version=2021-10-01

{}

応答のサンプル

状態コード:: 200

{
  "operationId": "xosjboksmobnotwgqejpvxiwi"
}

状態コード:: 202

{
  "operationId": "xosjboksmobnotwgqejpvxiwi"
}

定義

名前	説明
AssignedDeviceSubstatus	「割り当て済み」デバイスのサブステータス。可能な値には以下が含まれます:『initialAssignment』:デバイスが初めてIoTハブに割り当てられた場合、「deviceDataMigrated」:デバイスが別のIoTハブに割り当てられ、そのデバイスデータが以前に割り当てられたIoTハブから移行された場合。デバイスデータが以前に割り当てられたIoTハブ「deviceDataReset」から削除されました:デバイスは別のIoTハブに割り当てられ、そのデバイスデータは登録時に保存された初期状態から入力されました。デバイスデータが以前割り当てられたIoTハブから削除されました。'reprovisionedToInitialAssignment':デバイスは以前に割り当てられたIoTハブに再プロビジョニングされました。
DeviceRegistration	デバイスの登録。
DeviceRegistrationResult	デバイス登録の結果。
EnrollmentStatus	在籍状況。
ProvisioningServiceErrorDetails	Azure IoT Hub Provisioning Serviceによって返されたエラーのプロパティが含まれています。
RegistrationOperationStatus	登録運用状況。
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

デバイスの登録。

名前	型	説明
payload		任意のオブジェクト
registrationId	string	登録IDは、英数字文字と特定の特殊文字からなる大文字に区別されない文字列(最大128文字)です。 _ -. 開始時と終わりに特別な文字は禁止されています。
tpm	TpmAttestation	TPMによる認証。

DeviceRegistrationResult

Object

デバイス登録の結果。

名前	型	説明
assignedHub	string	Assigned Azure IoT Hub.
createdDateTimeUtc	string (date-time)	登録日時(UTC単位)を作成します。
deviceId	string	デバイス ID。
errorCode	integer (int32)	エラーコード。
errorMessage	string	エラーメッセージ。
etag	string	リソースに関連付けられたエンティティタグです。
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	未割り当て
assigning	割り当て
assigned	割り当てられた
failed	失敗
disabled	無効

ProvisioningServiceErrorDetails

Object

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

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

RegistrationOperationStatus

Object

登録運用状況。

名前	型	説明
operationId	string minLength: 1	操作 ID。
registrationState	DeviceRegistrationResult	デバイス登録の結果。
status	EnrollmentStatus	デバイス登録状況。

SymmetricKeyRegistrationResult

Object

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

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

TpmAttestation

Object

TPMによる認証。

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

TpmRegistrationResult

Object

TPM登録結果。

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

X509CertificateInfo

Object

X509証明書の情報。

名前	型	説明
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の登録結果。

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