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

Имя В Обязательно Тип Описание
api-version
 query True

string

Версия API.

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

Имя Тип Описание
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-объектов. Этот 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

Тип задания.

Ответы

Имя Тип Описание
200 OK

JobProperties

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

Определения

JobProperties

Имя Тип Описание
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-объектов. Этот 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

Тип задания.