Runtime Registration - Operation Status Lookup
登録操作の状態を取得します。
GET https://global.azure-devices-provisioning.net/{idScope}/registrations/{registrationId}/operations/{operationId}?api-version=2021-06-01
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
id
|
path | True |
string |
|
operation
|
path | True |
string |
操作 ID |
registration
|
path | True |
string |
登録 ID。 |
api-version
|
query | True |
string |
要求で使用する API のバージョン。 サポートされているバージョンは次のとおりです: 2021-06-01 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
成功 |
|
202 Accepted |
Success Headers
|
|
Other Status Codes |
エラー応答 |
定義
名前 | 説明 |
---|---|
Device |
デバイス登録の結果。 |
Provisioning |
Azure IoT Hub プロビジョニング サービスによって返されるエラーのプロパティを格納します。 |
Registration |
登録操作の状態。 |
Symmetric |
SymmetricKey 構成証明を使用すると、登録結果が返されます。 |
Tpm |
TPM 登録の結果。 |
X509Certificate |
X509 証明書情報。 |
X509Registration |
X509 登録の結果。 |
DeviceRegistrationResult
デバイス登録の結果。
名前 | 型 | 説明 |
---|---|---|
assignedHub |
string |
割り当てられたAzure IoT Hub。 |
createdDateTimeUtc |
string |
登録の作成日時 (UTC)。 |
deviceId |
string |
デバイス ID。 |
errorCode |
integer |
エラー コード。 |
errorMessage |
string |
エラー メッセージ。 |
etag |
string |
リソースに関連付けられているエンティティ タグ。 |
lastUpdatedDateTimeUtc |
string |
最終更新日時 (UTC)。 |
payload |
object |
Webhook からデバイスに返されるカスタム割り当てペイロード。 |
registrationId |
string |
登録 ID には、英数字、小文字と、必要に応じてハイフンを含めます。 |
status |
enum:
|
登録の状態。 |
substatus |
enum:
|
"割り当て済み" デバイスのサブステータス。 使用可能な値には、"initialAssignment": デバイスが初めて IoT ハブに割り当てられました。"deviceDataMigrated": デバイスが別の IoT ハブに割り当てられ、そのデバイス データが以前に割り当てられた IoT ハブから移行されました。 以前に割り当てられた IoT ハブ 'deviceDataReset' からデバイス データが削除されました:デバイスが別の IoT ハブに割り当てられ、そのデバイス データは登録に格納されている初期状態から設定されました。 以前に割り当てられた IoT ハブ 'reprovisionedToInitialAssignment' からデバイス データが削除されました:デバイスは、以前に割り当てられた IoT ハブに再プロビジョニングされました。 |
symmetricKey |
SymmetricKey 構成証明を使用すると、登録結果が返されます。 |
|
tpm |
TPM 構成証明を使用するときに返される登録結果。 |
|
x509 |
X509 構成証明を使用すると、登録結果が返されます。 |
ProvisioningServiceErrorDetails
Azure IoT Hub プロビジョニング サービスによって返されるエラーのプロパティを格納します。
名前 | 型 | 説明 |
---|---|---|
errorCode |
integer |
|
info |
object |
|
message |
string |
|
timestampUtc |
string |
|
trackingId |
string |
RegistrationOperationStatus
登録操作の状態。
名前 | 型 | 説明 |
---|---|---|
operationId |
string |
操作 ID |
registrationState |
デバイス登録の状態。 |
|
status |
enum:
|
デバイス登録の状態。 |
SymmetricKeyRegistrationResult
SymmetricKey 構成証明を使用すると、登録結果が返されます。
名前 | 型 | 説明 |
---|---|---|
enrollmentGroupId |
string |
TpmRegistrationResult
TPM 登録の結果。
名前 | 型 | 説明 |
---|---|---|
authenticationKey |
string |
暗号化された認証キー。 |
X509CertificateInfo
X509 証明書情報。
名前 | 型 | 説明 |
---|---|---|
issuerName |
string |
|
notAfterUtc |
string |
|
notBeforeUtc |
string |
|
serialNumber |
string |
|
sha1Thumbprint |
string |
|
sha256Thumbprint |
string |
|
subjectName |
string |
|
version |
integer |
X509RegistrationResult
X509 登録の結果。
名前 | 型 | 説明 |
---|---|---|
certificateInfo |
X509 証明書情報。 |
|
enrollmentGroupId |
string |
|
signingCertificateInfo |
X509 証明書情報。 |