Share via

Jobs - Create Import Export Job

Service:
IoT Hub
API Version:
2021-04-12

Creates a new import or export job on the IoT Hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities for more information.

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

URI Parameters

Name In Required Type Description
api-version
 query True

string

Version of the Api.

Request Body

Name Type Description
configurationsBlobName

string

Defaults to configurations.txt. Specifies the name of the blob to use when exporting/importing configurations.
endTimeUtc

string (date-time)

System generated. Ignored at creation. The end date and time of the job in UTC.
excludeKeysInExport

boolean

Optional for export jobs; ignored for other jobs. If not specified, the service defaults to false. If false, authorization keys are included in export output. Keys are exported as null otherwise.
failureReason

string

System genereated. Ignored at creation. The reason for failure, if a failure occurred.
identity

ManagedIdentity

includeConfigurations

boolean

Defaults to false. If true, then configurations are included in the data export/import.
inputBlobContainerUri

string

The URI containing SAS token to a blob container that contains registry data to sync.
inputBlobName

string

The blob name to use when importing from the input blob container.
jobId

string

The unique identifier of the job.
outputBlobContainerUri

string

The SAS token to access the blob container. This is used to output the status and results of the job.
outputBlobName

string

The blob name that will be created in the output blob container. This blob will contain the exported device registry information for the IoT Hub.
progress

integer (int32)

System generated. Ignored at creation. The percentage of job completion.
startTimeUtc

string (date-time)

System generated. Ignored at creation. The start date and time of the job in UTC.
status enum:
  • unknown
  • enqueued
  • running
  • completed
  • failed
  • cancelled
  • scheduled
  • queued

System generated. Ignored at creation. The status of the job.
storageAuthenticationType enum:
  • keyBased
  • identityBased

The authentication type used for connecting to the storage account.
type enum:
  • unknown
  • export
  • import
  • backup
  • readDeviceProperties
  • writeDeviceProperties
  • updateDeviceConfiguration
  • rebootDevice
  • factoryResetDevice
  • firmwareUpdate
  • scheduleDeviceMethod
  • scheduleUpdateTwin
  • restoreFromBackup
  • failoverDataCopy

The job type.

Responses

Name Type Description
200 OK

JobProperties

OK.

Definitions

Name Description
JobProperties
ManagedIdentity

JobProperties

Object
Name Type Description
configurationsBlobName

string

Defaults to configurations.txt. Specifies the name of the blob to use when exporting/importing configurations.
endTimeUtc

string (date-time)

System generated. Ignored at creation. The end date and time of the job in UTC.
excludeKeysInExport

boolean

Optional for export jobs; ignored for other jobs. If not specified, the service defaults to false. If false, authorization keys are included in export output. Keys are exported as null otherwise.
failureReason

string

System genereated. Ignored at creation. The reason for failure, if a failure occurred.
identity

ManagedIdentity

includeConfigurations

boolean

Defaults to false. If true, then configurations are included in the data export/import.
inputBlobContainerUri

string

The URI containing SAS token to a blob container that contains registry data to sync.
inputBlobName

string

The blob name to use when importing from the input blob container.
jobId

string

The unique identifier of the job.
outputBlobContainerUri

string

The SAS token to access the blob container. This is used to output the status and results of the job.
outputBlobName

string

The blob name that will be created in the output blob container. This blob will contain the exported device registry information for the IoT Hub.
progress

integer (int32)

System generated. Ignored at creation. The percentage of job completion.
startTimeUtc

string (date-time)

System generated. Ignored at creation. The start date and time of the job in UTC.
status enum:
  • cancelled
  • completed
  • enqueued
  • failed
  • queued
  • running
  • scheduled
  • unknown

System generated. Ignored at creation. The status of the job.
storageAuthenticationType enum:
  • identityBased
  • keyBased

The authentication type used for connecting to the storage account.
type enum:
  • backup
  • export
  • factoryResetDevice
  • failoverDataCopy
  • firmwareUpdate
  • import
  • readDeviceProperties
  • rebootDevice
  • restoreFromBackup
  • scheduleDeviceMethod
  • scheduleUpdateTwin
  • unknown
  • updateDeviceConfiguration
  • writeDeviceProperties

The job type.

ManagedIdentity

Object
Name Type Description
userAssignedIdentity

string