Jobs - Create Import Export Job

  • Ссылка
Service:
IoT Hub
API Version:
2020-05-31-preview

Создает новое задание импорта или экспорта в Центр Интернета вещей. Подробнее см. в разделе 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

Name In Required Type Description
api-version
 query True
  • string

Версия API.

Текст запроса

Name Type Description
configurationsBlobName
  • string

По умолчанию используется configurations.txt. Указывает имя большого двоичного объекта, используемого при экспорте и импорте конфигураций.
endTimeUtc
  • string

Созданная система. Игнорируется при создании. Дата и время окончания задания в формате UTC.
excludeKeysInExport
  • boolean

Необязательно для заданий экспорта; игнорируется для других заданий. Если значение не указано, служба по умолчанию имеет значение false. Если значение равно false, ключи авторизации включаются в выходные данные экспорта. Ключи экспортируются как null в противном случае.
failureReason
  • string

Система генеирована. Игнорируется при создании. Причина сбоя, если произошел сбой.
includeConfigurations
  • boolean

Значение по умолчанию — false. Если значение равно true, то конфигурации включаются в экспорт и импорт данных.
inputBlobContainerUri
  • string

Универсальный код ресурса (URI), содержащий маркер SAS для контейнера больших двоичных объектов, который содержит данные реестра для синхронизации.
inputBlobName
  • string

Имя большого двоичного объекта, используемое при импорте из контейнера входных BLOB-объектов.
jobId
  • string

Уникальный идентификатор задания.
outputBlobContainerUri
  • string

Маркер SAS для доступа к контейнеру BLOB-объектов. Используется для вывода состояния и результатов задания.
outputBlobName
  • string

Имя большого двоичного объекта, которое будет создано в контейнере выходных BLOB-объектов. Этот большой двоичный объект будет содержать экспортированные сведения о реестре устройств для Центр Интернета вещей.
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

Тип задания.

Ответы

Name Type Description
200 OK

Все в порядке.

Определения

JobProperties

Name Type Description
configurationsBlobName
  • string

По умолчанию используется configurations.txt. Указывает имя большого двоичного объекта, используемого при экспорте и импорте конфигураций.
endTimeUtc
  • string

Созданная система. Игнорируется при создании. Дата и время окончания задания в формате UTC.
excludeKeysInExport
  • boolean

Необязательно для заданий экспорта; игнорируется для других заданий. Если значение не указано, служба по умолчанию имеет значение false. Если значение равно false, ключи авторизации включаются в выходные данные экспорта. Ключи экспортируются как null в противном случае.
failureReason
  • string

Система генеирована. Игнорируется при создании. Причина сбоя, если произошел сбой.
includeConfigurations
  • boolean

Значение по умолчанию — false. Если значение равно true, то конфигурации включаются в экспорт и импорт данных.
inputBlobContainerUri
  • string

Универсальный код ресурса (URI), содержащий маркер SAS для контейнера больших двоичных объектов, который содержит данные реестра для синхронизации.
inputBlobName
  • string

Имя большого двоичного объекта, используемое при импорте из контейнера входных BLOB-объектов.
jobId
  • string

Уникальный идентификатор задания.
outputBlobContainerUri
  • string

Маркер SAS для доступа к контейнеру BLOB-объектов. Используется для вывода состояния и результатов задания.
outputBlobName
  • string

Имя большого двоичного объекта, которое будет создано в контейнере выходных BLOB-объектов. Этот большой двоичный объект будет содержать экспортированные сведения о реестре устройств для Центр Интернета вещей.
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

Тип задания.