你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Jobs - Create Import Export Job

  • 参考
Service:
IoT Hub
API Version:
2020-05-31-preview

在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=2020-05-31-preview

URI 参数

名称 在 必需 类型 说明
api-version
 query True

string

Api 的版本。

请求正文

名称 类型 说明
configurationsBlobName

string

默认为 configurations.txt。 指定导出/导入配置时要使用的 Blob 的名称。
endTimeUtc

string

系统生成。 创建时忽略。 作业的结束日期和时间（UTC）。
excludeKeysInExport

boolean

对于导出作业是可选的;忽略了其他作业。 如果未指定，则服务默认为 false。 如果为 false，则授权密钥包含在导出输出中。 否则，密钥导出为 null。
failureReason

string

系统基因化。 创建时忽略。 失败的原因（如果发生失败）。
includeConfigurations

boolean

默认为 false。 如果为 true，则配置将包含在数据导出/导入中。
inputBlobContainerUri

string

包含 Blob 容器的 SAS 令牌的 URI，该容器包含要同步的注册表数据。
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

作业类型。

响应

名称 类型 说明
200 OK

JobProperties

没问题。

定义

JobProperties

名称 类型 说明
configurationsBlobName

string

默认为 configurations.txt。 指定导出/导入配置时要使用的 Blob 的名称。
endTimeUtc

string

系统生成。 创建时忽略。 作业的结束日期和时间（UTC）。
excludeKeysInExport

boolean

对于导出作业是可选的;忽略了其他作业。 如果未指定，则服务默认为 false。 如果为 false，则授权密钥包含在导出输出中。 否则，密钥导出为 null。
failureReason

string

系统基因化。 创建时忽略。 失败的原因（如果发生失败）。
includeConfigurations

boolean

默认为 false。 如果为 true，则配置将包含在数据导出/导入中。
inputBlobContainerUri

string

包含 Blob 容器的 SAS 令牌的 URI，该容器包含要同步的注册表数据。
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

作业类型。