共用方式為

Jobs - Create Import Export Job

  • 參考
服務:
IoT Hub
API 版本:
2021-04-12

在 IoT 中樞 上建立新的匯入或導出作業。 如需相關資訊，請參閱 https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities 。

POST https://fully-qualified-iothubname.azure-devices.net/jobs/create?api-version=2021-04-12

URI 參數

名稱 位於 必要 類型 Description
api-version
 query True

string

Api 的版本。

要求本文

名稱 類型 Description
configurationsBlobName

string

默認為 configurations.txt。 指定匯出/匯入組態時要使用的 Blob 名稱。
endTimeUtc

string

系統產生。 在建立時忽略。 以UTC為單位之作業的結束日期和時間。
excludeKeysInExport

boolean

匯出作業的選擇性;忽略其他作業。 如果未指定，服務預設為 false。 如果為 false，則授權金鑰會包含在匯出輸出中。 密鑰會匯出為 null，
failureReason

string

系統基因化。 在建立時忽略。 如果發生失敗，則為失敗的原因。
identity

ManagedIdentity

includeConfigurations

boolean

預設為 False。 如果為 true，則設定會包含在數據匯出/匯入中。
inputBlobContainerUri

string

包含 SAS 令牌的 URI，指向包含要同步之登錄數據的 Blob 容器。
inputBlobName

string

從輸入 Blob 容器匯入時要使用的 Blob 名稱。
jobId

string

作業的唯一識別碼。
outputBlobContainerUri

string

用來存取 Blob 容器的 SAS 令牌。 這會用來輸出作業的狀態和結果。
outputBlobName

string

將在輸出 Blob 容器中建立的 Blob 名稱。 此 Blob 將包含 IoT 中樞 導出的裝置登錄資訊。
progress

integer

系統產生。 在建立時忽略。 作業完成的百分比。
startTimeUtc

string

系統產生。 在建立時忽略。 以UTC為單位之作業的開始日期和時間。
status enum:
  • unknown
  • enqueued
  • running
  • completed
  • failed
  • cancelled
  • scheduled
  • queued

系統產生。 在建立時忽略。 工作的狀態。
storageAuthenticationType enum:
  • keyBased
  • identityBased

用於連線到記憶體帳戶的驗證類型。
type enum:
  • unknown
  • export
  • import
  • backup
  • readDeviceProperties
  • writeDeviceProperties
  • updateDeviceConfiguration
  • rebootDevice
  • factoryResetDevice
  • firmwareUpdate
  • scheduleDeviceMethod
  • scheduleUpdateTwin
  • restoreFromBackup
  • failoverDataCopy

作業類型。

回應

名稱 類型 Description
200 OK

JobProperties

正常。

定義

名稱 Description
JobProperties
ManagedIdentity

JobProperties

名稱 類型 Description
configurationsBlobName

string

默認為 configurations.txt。 指定匯出/匯入組態時要使用的 Blob 名稱。
endTimeUtc

string

系統產生。 在建立時忽略。 以UTC為單位之作業的結束日期和時間。
excludeKeysInExport

boolean

匯出作業的選擇性;忽略其他作業。 如果未指定，服務預設為 false。 如果為 false，則授權金鑰會包含在匯出輸出中。 密鑰會匯出為 null，
failureReason

string

系統基因化。 在建立時忽略。 如果發生失敗，則為失敗的原因。
identity

ManagedIdentity

includeConfigurations

boolean

預設為 False。 如果為 true，則設定會包含在數據匯出/匯入中。
inputBlobContainerUri

string

包含 SAS 令牌的 URI，指向包含要同步之登錄數據的 Blob 容器。
inputBlobName

string

從輸入 Blob 容器匯入時要使用的 Blob 名稱。
jobId

string

作業的唯一識別碼。
outputBlobContainerUri

string

用來存取 Blob 容器的 SAS 令牌。 這會用來輸出作業的狀態和結果。
outputBlobName

string

將在輸出 Blob 容器中建立的 Blob 名稱。 此 Blob 將包含 IoT 中樞 導出的裝置登錄資訊。
progress

integer

系統產生。 在建立時忽略。 作業完成的百分比。
startTimeUtc

string

系統產生。 在建立時忽略。 以UTC為單位之作業的開始日期和時間。
status enum:
  • cancelled
  • completed
  • enqueued
  • failed
  • queued
  • running
  • scheduled
  • unknown

系統產生。 在建立時忽略。 工作的狀態。
storageAuthenticationType enum:
  • identityBased
  • keyBased

用於連線到記憶體帳戶的驗證類型。
type enum:
  • backup
  • export
  • factoryResetDevice
  • failoverDataCopy
  • firmwareUpdate
  • import
  • readDeviceProperties
  • rebootDevice
  • restoreFromBackup
  • scheduleDeviceMethod
  • scheduleUpdateTwin
  • unknown
  • updateDeviceConfiguration
  • writeDeviceProperties

作業類型。

ManagedIdentity

名稱 類型 Description
userAssignedIdentity

string