Individual Enrollment - Create Or Update

サービス:: IoT Hub Device Provisioning Service

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

デバイス登録記録を作成または更新してください。

PUT https://{dpsName}.azure-devices-provisioning.net/enrollments/{id}?api-version=2021-10-01

URI パラメーター

名前	/	必須	型	説明
dpsName	path	True	string	DPSインスタンスのホスト名です。
id	path	True	string	このIDは、登録のデバイス登録を一意に識別するために使われます。英数字と特定の特殊文字からなる大文字を区別しない文字列(最大128文字)です。 _ -. 開始時と終わりに特別な文字は禁止されています。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求ヘッダー

名前	必須	型	説明
Authorization	True	string
If-Match		string	登録記録のETag。

要求本文

名前	必須	型	説明
attestation	True	AttestationMechanism	この装置で使用されている認証方法。
registrationId	True	string	このIDは、登録のデバイス登録を一意に識別するために使われます。英数字と特定の特殊文字からなる大文字を区別しない文字列(最大128文字)です。 _ -. 開始時と終わりに特別な文字は禁止されています。
allocationPolicy		AllocationPolicy	この資源の配分方針。このポリシーは、この個別の登録または登録グループのテナントレベルの割り当てポリシーを上書きします。可能な値には「ハッシュ化」:連結されたIoTハブにはデバイスがプロビジョニングされている可能性が同じくらい、「geoLatency」:デバイスはデバイス間の遅延が最も低いIoTハブにプロビジョニングされます。複数の連結されたIoTハブが同じ最低遅延を提供できる場合、プロビジョニングサービスはそれらのハブ間でデバイスをハッシュ化します。「静的」:登録リストで希望するIoTハブの指定がサービスレベルの割り当てポリシーより優先されます。「カスタム」:デバイスは独自のカスタムロジックに基づいてIoTハブにプロビジョニングされます。プロビジョニングサービスはデバイスに関する情報をロジックに伝え、ロジックは望ましいIoTハブと希望する初期設定を返します。ロジックのホストにはAzure Functionsを使うことをおすすめします。
capabilities		DeviceCapabilities	デバイスの機能について。
customAllocationDefinition		CustomAllocationDefinition	これにより、カスタム割り当てを使う際にどのウェブフックを呼び出すかDPSに指示されます。
deviceId		string	望むIoT HubデバイスID(オプション)。
etag		string	リソースに関連付けられたエンティティタグです。
initialTwin		InitialTwin	初期のデバイスツインです。
iotHubHostName		string	Iot Hubのホスト名です。
iotHubs		string[]	このリソース内のデバイスが割り当てられるIoTハブのホストネームのリストです。 IoTハブのテナントレベルリストの一部でなければなりません。
optionalDeviceInformation		TwinCollection	オプションデバイス情報。
provisioningStatus		ProvisioningStatus	プロビジョニング状況。
reprovisionPolicy		ReprovisionPolicy	デバイスがIoTハブに再割り当てされた際の挙動。

応答

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

名前

型

説明

200 OK

IndividualEnrollment

要求は成功しました。

Other Status Codes

ProvisioningServiceErrorDetails

予期しないエラー応答。

ヘッダー

x-ms-error-code: string

セキュリティ

Authorization

型: apiKey
/: header

例

IndividualEnrollment_CreateOrUpdate_MaximumSet_Gen

IndividualEnrollment_CreateOrUpdate_MinimumSet_Gen

IndividualEnrollment_CreateOrUpdate_MaximumSet_Gen

要求のサンプル

HTTP

PUT https://{dpsName}.azure-devices-provisioning.net/enrollments/ivz?api-version=2021-10-01


{
  "allocationPolicy": "hashed",
  "attestation": {
    "type": "none",
    "symmetricKey": {
      "primaryKey": "tdoshkmlo",
      "secondaryKey": "lmajoyzuojahffcmdlcwjhntqzyqzk"
    },
    "tpm": {
      "endorsementKey": "naoofgjbxiulcitlysusxdvagyucgn",
      "storageRootKey": "tdgkgcvptrsw"
    },
    "x509": {
      "caReferences": {
        "primary": "efbkbboxkvrsdl",
        "secondary": "vckhuzqgbcinighxwyuyd"
      },
      "clientCertificates": {
        "primary": {
          "info": {
            "issuerName": "pkuinyhttjlozsbtvxuizzkjlakga",
            "notAfterUtc": "2025-10-01T17:42:04.76Z",
            "notBeforeUtc": "2025-10-01T17:42:04.76Z",
            "serialNumber": "mzoidcxayenpgyrek",
            "sha1Thumbprint": "fdmftjqllzvxcd",
            "sha256Thumbprint": "ei",
            "subjectName": "qqjdjgrkiqvtnshkisozut",
            "version": 12
          },
          "certificate": "gkozpt"
        },
        "secondary": {
          "info": {
            "issuerName": "pkuinyhttjlozsbtvxuizzkjlakga",
            "notAfterUtc": "2025-10-01T17:42:04.76Z",
            "notBeforeUtc": "2025-10-01T17:42:04.76Z",
            "serialNumber": "mzoidcxayenpgyrek",
            "sha1Thumbprint": "fdmftjqllzvxcd",
            "sha256Thumbprint": "ei",
            "subjectName": "qqjdjgrkiqvtnshkisozut",
            "version": 12
          },
          "certificate": "gkozpt"
        }
      },
      "signingCertificates": {
        "primary": {
          "info": {
            "issuerName": "pkuinyhttjlozsbtvxuizzkjlakga",
            "notAfterUtc": "2025-10-01T17:42:04.76Z",
            "notBeforeUtc": "2025-10-01T17:42:04.76Z",
            "serialNumber": "mzoidcxayenpgyrek",
            "sha1Thumbprint": "fdmftjqllzvxcd",
            "sha256Thumbprint": "ei",
            "subjectName": "qqjdjgrkiqvtnshkisozut",
            "version": 12
          },
          "certificate": "gkozpt"
        },
        "secondary": {
          "info": {
            "issuerName": "pkuinyhttjlozsbtvxuizzkjlakga",
            "notAfterUtc": "2025-10-01T17:42:04.76Z",
            "notBeforeUtc": "2025-10-01T17:42:04.76Z",
            "serialNumber": "mzoidcxayenpgyrek",
            "sha1Thumbprint": "fdmftjqllzvxcd",
            "sha256Thumbprint": "ei",
            "subjectName": "qqjdjgrkiqvtnshkisozut",
            "version": 12
          },
          "certificate": "gkozpt"
        }
      }
    }
  },
  "capabilities": {
    "iotEdge": true
  },
  "customAllocationDefinition": {
    "apiVersion": "gbannxdstouqrfonxdxfurv",
    "webhookUrl": "todqbubyxeumrtvhsscedwrkz"
  },
  "deviceId": "wfgzhrgpvmwddrknnmcggbae",
  "etag": "ngtrmhcikthymtknva",
  "initialTwin": {
    "properties": {
      "desired": {
        "count": 16,
        "key2428": {},
        "metadata": {
          "lastUpdated": "2025-10-01T17:42:04.76Z",
          "lastUpdatedVersion": 19
        },
        "version": 9
      }
    },
    "tags": {
      "count": 16,
      "key2428": {},
      "metadata": {
        "lastUpdated": "2025-10-01T17:42:04.76Z",
        "lastUpdatedVersion": 19
      },
      "version": 9
    }
  },
  "iotHubHostName": "vtewercilhukfboi",
  "iotHubs": [
    "lwgwrfdherfrbowfdbrdhvnragwrs"
  ],
  "optionalDeviceInformation": {
    "count": 16,
    "key2428": {},
    "metadata": {
      "lastUpdated": "2025-10-01T17:42:04.76Z",
      "lastUpdatedVersion": 19
    },
    "version": 9
  },
  "provisioningStatus": "enabled",
  "registrationId": "kz",
  "registrationState": {},
  "reprovisionPolicy": {
    "migrateDeviceData": true,
    "updateHubAssignment": true
  }
}

応答のサンプル

状態コード:: 200

{
  "allocationPolicy": "hashed",
  "attestation": {
    "type": "none",
    "symmetricKey": {
      "primaryKey": "tdoshkmlo",
      "secondaryKey": "lmajoyzuojahffcmdlcwjhntqzyqzk"
    },
    "tpm": {
      "endorsementKey": "naoofgjbxiulcitlysusxdvagyucgn",
      "storageRootKey": "tdgkgcvptrsw"
    },
    "x509": {
      "caReferences": {
        "primary": "efbkbboxkvrsdl",
        "secondary": "vckhuzqgbcinighxwyuyd"
      },
      "clientCertificates": {
        "primary": {
          "info": {
            "issuerName": "pkuinyhttjlozsbtvxuizzkjlakga",
            "notAfterUtc": "2025-10-01T17:42:04.76Z",
            "notBeforeUtc": "2025-10-01T17:42:04.76Z",
            "serialNumber": "mzoidcxayenpgyrek",
            "sha1Thumbprint": "fdmftjqllzvxcd",
            "sha256Thumbprint": "ei",
            "subjectName": "qqjdjgrkiqvtnshkisozut",
            "version": 12
          },
          "certificate": "gkozpt"
        },
        "secondary": {
          "info": {
            "issuerName": "pkuinyhttjlozsbtvxuizzkjlakga",
            "notAfterUtc": "2025-10-01T17:42:04.76Z",
            "notBeforeUtc": "2025-10-01T17:42:04.76Z",
            "serialNumber": "mzoidcxayenpgyrek",
            "sha1Thumbprint": "fdmftjqllzvxcd",
            "sha256Thumbprint": "ei",
            "subjectName": "qqjdjgrkiqvtnshkisozut",
            "version": 12
          },
          "certificate": "gkozpt"
        }
      },
      "signingCertificates": {
        "primary": {
          "info": {
            "issuerName": "pkuinyhttjlozsbtvxuizzkjlakga",
            "notAfterUtc": "2025-10-01T17:42:04.76Z",
            "notBeforeUtc": "2025-10-01T17:42:04.76Z",
            "serialNumber": "mzoidcxayenpgyrek",
            "sha1Thumbprint": "fdmftjqllzvxcd",
            "sha256Thumbprint": "ei",
            "subjectName": "qqjdjgrkiqvtnshkisozut",
            "version": 12
          },
          "certificate": "gkozpt"
        },
        "secondary": {
          "info": {
            "issuerName": "pkuinyhttjlozsbtvxuizzkjlakga",
            "notAfterUtc": "2025-10-01T17:42:04.76Z",
            "notBeforeUtc": "2025-10-01T17:42:04.76Z",
            "serialNumber": "mzoidcxayenpgyrek",
            "sha1Thumbprint": "fdmftjqllzvxcd",
            "sha256Thumbprint": "ei",
            "subjectName": "qqjdjgrkiqvtnshkisozut",
            "version": 12
          },
          "certificate": "gkozpt"
        }
      }
    }
  },
  "capabilities": {
    "iotEdge": true
  },
  "createdDateTimeUtc": "2025-10-01T17:42:04.76Z",
  "customAllocationDefinition": {
    "apiVersion": "gbannxdstouqrfonxdxfurv",
    "webhookUrl": "todqbubyxeumrtvhsscedwrkz"
  },
  "deviceId": "wfgzhrgpvmwddrknnmcggbae",
  "etag": "ngtrmhcikthymtknva",
  "initialTwin": {
    "properties": {
      "desired": {
        "count": 16,
        "key2428": {},
        "metadata": {
          "lastUpdated": "2025-10-01T17:42:04.76Z",
          "lastUpdatedVersion": 19
        },
        "version": 9
      }
    },
    "tags": {
      "count": 16,
      "key2428": {},
      "metadata": {
        "lastUpdated": "2025-10-01T17:42:04.76Z",
        "lastUpdatedVersion": 19
      },
      "version": 9
    }
  },
  "iotHubHostName": "vtewercilhukfboi",
  "iotHubs": [
    "lwgwrfdherfrbowfdbrdhvnragwrs"
  ],
  "lastUpdatedDateTimeUtc": "2025-10-01T17:42:04.76Z",
  "optionalDeviceInformation": {
    "count": 16,
    "key2428": {},
    "metadata": {
      "lastUpdated": "2025-10-01T17:42:04.76Z",
      "lastUpdatedVersion": 19
    },
    "version": 9
  },
  "provisioningStatus": "enabled",
  "registrationId": "kz",
  "registrationState": {
    "assignedHub": "oasugtinnefgfklhldjhibq",
    "createdDateTimeUtc": "2025-10-01T17:42:04.759Z",
    "deviceId": "ttnhaugyyh",
    "errorCode": 2,
    "errorMessage": "ufqpjjmbiphiynoijjbocvl",
    "etag": "ctquvtjyhnomcmtddscxwjk",
    "lastUpdatedDateTimeUtc": "2025-10-01T17:42:04.759Z",
    "payload": {},
    "registrationId": "czvnrxvbka",
    "status": "unassigned",
    "substatus": "initialAssignment"
  },
  "reprovisionPolicy": {
    "migrateDeviceData": true,
    "updateHubAssignment": true
  }
}

IndividualEnrollment_CreateOrUpdate_MinimumSet_Gen

要求のサンプル

HTTP

PUT https://{dpsName}.azure-devices-provisioning.net/enrollments/ttxioksxhjlzkrnamknqbiw?api-version=2021-10-01

{
  "attestation": {
    "type": "none"
  },
  "registrationId": "kz"
}

応答のサンプル

状態コード:: 200

{
  "attestation": {
    "type": "none"
  },
  "registrationId": "kz"
}

定義

名前	説明
AllocationPolicy	この資源の配分方針。このポリシーは、この個別の登録または登録グループのテナントレベルの割り当てポリシーを上書きします。可能な値には「ハッシュ化」:連結されたIoTハブにはデバイスがプロビジョニングされている可能性が同じくらい、「geoLatency」:デバイスはデバイス間の遅延が最も低いIoTハブにプロビジョニングされます。複数の連結されたIoTハブが同じ最低遅延を提供できる場合、プロビジョニングサービスはそれらのハブ間でデバイスをハッシュ化します。「静的」:登録リストで希望するIoTハブの指定がサービスレベルの割り当てポリシーより優先されます。「カスタム」:デバイスは独自のカスタムロジックに基づいてIoTハブにプロビジョニングされます。プロビジョニングサービスはデバイスに関する情報をロジックに伝え、ロジックは望ましいIoTハブと希望する初期設定を返します。ロジックのホストにはAzure Functionsを使うことをおすすめします。
AssignedDeviceSubstatus	「割り当て済み」デバイスのサブステータス。可能な値には以下が含まれます:『initialAssignment』:デバイスが初めてIoTハブに割り当てられた場合、「deviceDataMigrated」:デバイスが別のIoTハブに割り当てられ、そのデバイスデータが以前に割り当てられたIoTハブから移行された場合。デバイスデータが以前に割り当てられたIoTハブ「deviceDataReset」から削除されました:デバイスは別のIoTハブに割り当てられ、そのデバイスデータは登録時に保存された初期状態から入力されました。デバイスデータが以前割り当てられたIoTハブから削除されました。'reprovisionedToInitialAssignment':デバイスは以前に割り当てられたIoTハブに再プロビジョニングされました。
AttestationMechanism	個人登録および登録グループのための認証メカニズム。
AttestationType	証言タイプ。
CustomAllocationDefinition	これにより、カスタム割り当てを使う際にどのウェブフックを呼び出すかDPSに指示されます。
DeviceCapabilities	デバイスの機能。
DeviceRegistrationState	デバイスの登録状態。
EnrollmentStatus	在籍状況。
IndividualEnrollment	デバイスの登録記録です。
InitialTwin	初期のデバイスツインです。 Twinの性質の一部を含む。
InitialTwinProperties	デバイスツインに設定される初期プロパティを表します。
Metadata	TwinCollectionのメタデータ
ProvisioningServiceErrorDetails	Azure IoT Hub Provisioning Serviceによって返されたエラーのプロパティが含まれています。
ProvisioningStatus	プロビジョニング状況。
ReprovisionPolicy	デバイスがIoTハブに再プロビジョニングされた際のサービスの挙動。
SymmetricKeyAttestation	SymmetricKeyによる認証。
TpmAttestation	TPMによる認証。
TwinCollection	双子内の性質の集合を表します
X509Attestation	認証はX509より。
X509CAReferences	一次および二次的なCAの参考資料。
X509CertificateInfo	X509証明書の情報。
X509Certificates	初級および中等資格
X509CertificateWithInfo	証明書および証明書情報

AllocationPolicy

列挙

この資源の配分方針。このポリシーは、この個別の登録または登録グループのテナントレベルの割り当てポリシーを上書きします。可能な値には「ハッシュ化」:連結されたIoTハブにはデバイスがプロビジョニングされている可能性が同じくらい、「geoLatency」:デバイスはデバイス間の遅延が最も低いIoTハブにプロビジョニングされます。複数の連結されたIoTハブが同じ最低遅延を提供できる場合、プロビジョニングサービスはそれらのハブ間でデバイスをハッシュ化します。「静的」:登録リストで希望するIoTハブの指定がサービスレベルの割り当てポリシーより優先されます。「カスタム」:デバイスは独自のカスタムロジックに基づいてIoTハブにプロビジョニングされます。プロビジョニングサービスはデバイスに関する情報をロジックに伝え、ロジックは望ましいIoTハブと希望する初期設定を返します。ロジックのホストにはAzure Functionsを使うことをおすすめします。

値	説明
hashed	ハッシュ化
geoLatency	geoLatency
static	静的
custom	custom

AssignedDeviceSubstatus

列挙

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

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

AttestationMechanism

Object

個人登録および登録グループのための認証メカニズム。

名前	型	説明
symmetricKey	SymmetricKeyAttestation	対称鍵証明法。
tpm	TpmAttestation	TPM認証方法。
type	AttestationType	証言タイプ。
x509	X509Attestation	X509の証明方法。

AttestationType

列挙

証言タイプ。

値	説明
none	なし
tpm	tpm
x509	x509
symmetricKey	symmetricKey

CustomAllocationDefinition

Object

これにより、カスタム割り当てを使う際にどのウェブフックを呼び出すかDPSに指示されます。

名前	型	説明
apiVersion	string	カスタム割り当てリクエストで送信されたプロビジョニングサービスタイプ(IndividualEnrollmentなど)のAPIバージョンです。最小サポートバージョン:「2018-09-01-preview」。
webhookUrl	string	割り当て要求に使用されるウェブフックURL。

DeviceCapabilities

Object

デバイスの機能。

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

DeviceRegistrationState

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ハブに再プロビジョニングされました。

EnrollmentStatus

列挙

在籍状況。

値	説明
unassigned	未割り当て
assigning	割り当て
assigned	割り当てられた
failed	失敗
disabled	無効

IndividualEnrollment

Object

デバイスの登録記録です。

名前	型	規定値	説明
allocationPolicy	AllocationPolicy		この資源の配分方針。このポリシーは、この個別の登録または登録グループのテナントレベルの割り当てポリシーを上書きします。可能な値には「ハッシュ化」:連結されたIoTハブにはデバイスがプロビジョニングされている可能性が同じくらい、「geoLatency」:デバイスはデバイス間の遅延が最も低いIoTハブにプロビジョニングされます。複数の連結されたIoTハブが同じ最低遅延を提供できる場合、プロビジョニングサービスはそれらのハブ間でデバイスをハッシュ化します。「静的」:登録リストで希望するIoTハブの指定がサービスレベルの割り当てポリシーより優先されます。「カスタム」:デバイスは独自のカスタムロジックに基づいてIoTハブにプロビジョニングされます。プロビジョニングサービスはデバイスに関する情報をロジックに伝え、ロジックは望ましいIoTハブと希望する初期設定を返します。ロジックのホストにはAzure Functionsを使うことをおすすめします。
attestation	AttestationMechanism		この装置で使用されている認証方法。
capabilities	DeviceCapabilities		デバイスの機能について。
createdDateTimeUtc	string (date-time)		このリソースはDateTimeで作成されました。
customAllocationDefinition	CustomAllocationDefinition		これにより、カスタム割り当てを使う際にどのウェブフックを呼び出すかDPSに指示されます。
deviceId	string		望むIoT HubデバイスID(オプション)。
etag	string		リソースに関連付けられたエンティティタグです。
initialTwin	InitialTwin		初期のデバイスツインです。
iotHubHostName	string		Iot Hubのホスト名です。
iotHubs	string[]		このリソース内のデバイスが割り当てられるIoTハブのホストネームのリストです。 IoTハブのテナントレベルリストの一部でなければなりません。
lastUpdatedDateTimeUtc	string (date-time)		このリソースはDateTimeが最後に更新されました。
optionalDeviceInformation	TwinCollection		オプションデバイス情報。
provisioningStatus	ProvisioningStatus	enabled	プロビジョニング状況。
registrationId	string		このIDは、登録のデバイス登録を一意に識別するために使われます。英数字と特定の特殊文字からなる大文字を区別しない文字列(最大128文字)です。 _ -. 開始時と終わりに特別な文字は禁止されています。
registrationState	DeviceRegistrationState		現在の登録状況。
reprovisionPolicy	ReprovisionPolicy		デバイスがIoTハブに再割り当てされた際の挙動。

InitialTwin

Object

初期のデバイスツインです。 Twinの性質の一部を含む。

名前	型	説明
properties	InitialTwinProperties	ツインの必要なプロパティ。
tags	TwinCollection	ツインタグ。

InitialTwinProperties

Object

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

名前	型	説明
desired	TwinCollection	InitialTwinの目的プロパティを取得して設定します。

Metadata

Object

TwinCollectionのメタデータ

名前	型	説明
lastUpdated	string (date-time)	前回のTwinCollectionの更新
lastUpdatedVersion	integer (int32)	報告されたプロパティメタデータにはnullですが、望ましいプロパティメタデータにはnullではありません。

ProvisioningServiceErrorDetails

Object

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

名前	型	説明
errorCode	integer (int32)	操作のエラーコード。
info	object	文字列<>辞書
message	string	人間が読み取れるエラーメッセージ。
timestampUtc	string (date-time)	エラーのUTCタイムスタンプ。
trackingId	string	エラーの追跡IDです。

ProvisioningStatus

列挙

プロビジョニング状況。

値	説明
enabled	enabled
disabled	無効

ReprovisionPolicy

Object

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

名前	型	規定値	説明
migrateDeviceData	boolean	True	デフォルトでtrueに設定すると、デバイスプロビジョニングサービスはIoTハブ割り当ての更新時に、デバイスのデータ(ツイン、デバイス機能、デバイスID)を1つのIoTハブから別のハブへ移行します。 falseに設定された場合、デバイスプロビジョニングサービスは対応する登録リストに保存された初期の希望設定にデバイスをリセットします。
updateHubAssignment	boolean	True	true(デフォルト)に設定されると、デバイスプロビジョニングサービスはデバイスのIoTハブ割り当てを評価し、特定のデバイスからの最初のプロビジョニング要求以降に必要に応じて更新します。 falseに設定されている場合、デバイスは現在のIoTハブに割り当てられたままです。

SymmetricKeyAttestation

Object

SymmetricKeyによる認証。

名前	型	説明
primaryKey	string	主対称キー。
secondaryKey	string	二次対称キー。

TpmAttestation

Object

TPMによる認証。

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

TwinCollection

Object

双子内の性質の集合を表します

名前	型	説明
count	integer (int32)	TwinCollectionのプロパティ数
metadata	Metadata	TwinCollectionのメタデータ
version	integer (int32)	ツインコレクションのバージョン

X509Attestation

Object

認証はX509より。

名前	型	説明
caReferences	X509CAReferences	一次および二次的なCAの参考資料。
clientCertificates	X509Certificates	初級および中等資格
signingCertificates	X509Certificates	初級および中等資格

X509CAReferences

Object

一次および二次的なCAの参考資料。

名前	型	説明
primary	string	主なカリフォルニア州の参考資料。
secondary	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)	証明書のバージョン。

X509Certificates

Object

初級および中等資格

名前	型	説明
primary	X509CertificateWithInfo	証明書および証明書情報
secondary	X509CertificateWithInfo	証明書および証明書情報

X509CertificateWithInfo

Object

証明書および証明書情報

名前	型	説明
certificate	string	PEM形式の証明書文字列。
info	X509CertificateInfo	X509証明書の情報。