Jobs - Create Import Export Job

Crea un nuevo trabajo de importación o exportación en el IoT Hub. Consulte https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities para obtener más información.

POST https://fully-qualified-iothubname.azure-devices.net/jobs/create?api-version=2020-05-31-preview

Parámetros de identificador URI

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

Versión de la API.

Cuerpo de la solicitud

Name Type Description
configurationsBlobName
  • string

El valor predeterminado es configurations.txt. Especifica el nombre del blob que se va a usar al exportar o importar configuraciones.

endTimeUtc
  • string

Generado por el sistema. Se omite en la creación. Fecha y hora de finalización del trabajo en UTC.

excludeKeysInExport
  • boolean

Opcional para trabajos de exportación; se omite para otros trabajos. Si no se especifica, el servicio tiene como valor predeterminado false. Si es false, las claves de autorización se incluyen en la salida de exportación. Las claves se exportan como null en caso contrario.

failureReason
  • string

Generado por el sistema. Se omite en la creación. El motivo del error, si se produjo un error.

includeConfigurations
  • boolean

El valor predeterminado es "false". Si es true, las configuraciones se incluyen en la exportación o importación de datos.

inputBlobContainerUri
  • string

Identificador URI que contiene el token de SAS en un contenedor de blobs que contiene los datos del Registro que se van a sincronizar.

inputBlobName
  • string

Nombre del blob que se va a usar al importar desde el contenedor de blobs de entrada.

jobId
  • string

Identificador único del trabajo.

outputBlobContainerUri
  • string

Token de SAS para acceder al contenedor de blobs. Se usa para generar el estado y los resultados del trabajo.

outputBlobName
  • string

Nombre del blob que se creará en el contenedor de blobs de salida. Este blob contendrá la información del Registro de dispositivos exportado para el IoT Hub.

progress
  • integer

Generado por el sistema. Se omite en la creación. Porcentaje de finalización del trabajo.

startTimeUtc
  • string

Generado por el sistema. Se omite en la creación. Fecha y hora de inicio del trabajo en UTC.

status enum:
  • unknown
  • enqueued
  • running
  • completed
  • failed
  • cancelled
  • scheduled
  • queued

Generado por el sistema. Se omite en la creación. El estado del trabajo.

storageAuthenticationType enum:
  • keyBased
  • identityBased

Tipo de autenticación que se usa para conectarse a la cuenta de almacenamiento.

type enum:
  • unknown
  • export
  • import
  • backup
  • readDeviceProperties
  • writeDeviceProperties
  • updateDeviceConfiguration
  • rebootDevice
  • factoryResetDevice
  • firmwareUpdate
  • scheduleDeviceMethod
  • scheduleUpdateTwin
  • restoreFromBackup
  • failoverDataCopy

El tipo de trabajo.

Respuestas

Name Type Description
200 OK

Aceptar.

Definiciones

JobProperties

Name Type Description
configurationsBlobName
  • string

El valor predeterminado es configurations.txt. Especifica el nombre del blob que se va a usar al exportar o importar configuraciones.

endTimeUtc
  • string

Generado por el sistema. Se omite en la creación. Fecha y hora de finalización del trabajo en UTC.

excludeKeysInExport
  • boolean

Opcional para trabajos de exportación; se omite para otros trabajos. Si no se especifica, el servicio tiene como valor predeterminado false. Si es false, las claves de autorización se incluyen en la salida de exportación. Las claves se exportan como null en caso contrario.

failureReason
  • string

Generado por el sistema. Se omite en la creación. El motivo del error, si se produjo un error.

includeConfigurations
  • boolean

El valor predeterminado es "false". Si es true, las configuraciones se incluyen en la exportación o importación de datos.

inputBlobContainerUri
  • string

Identificador URI que contiene el token de SAS en un contenedor de blobs que contiene los datos del Registro que se van a sincronizar.

inputBlobName
  • string

Nombre del blob que se va a usar al importar desde el contenedor de blobs de entrada.

jobId
  • string

Identificador único del trabajo.

outputBlobContainerUri
  • string

Token de SAS para acceder al contenedor de blobs. Se usa para generar el estado y los resultados del trabajo.

outputBlobName
  • string

Nombre del blob que se creará en el contenedor de blobs de salida. Este blob contendrá la información del Registro de dispositivos exportado para el IoT Hub.

progress
  • integer

Generado por el sistema. Se omite en la creación. Porcentaje de finalización del trabajo.

startTimeUtc
  • string

Generado por el sistema. Se omite en la creación. Fecha y hora de inicio del trabajo en UTC.

status enum:
  • cancelled
  • completed
  • enqueued
  • failed
  • queued
  • running
  • scheduled
  • unknown

Generado por el sistema. Se omite en la creación. El estado del trabajo.

storageAuthenticationType enum:
  • identityBased
  • keyBased

Tipo de autenticación que se usa para conectarse a la cuenta de almacenamiento.

type enum:
  • backup
  • export
  • factoryResetDevice
  • failoverDataCopy
  • firmwareUpdate
  • import
  • readDeviceProperties
  • rebootDevice
  • restoreFromBackup
  • scheduleDeviceMethod
  • scheduleUpdateTwin
  • unknown
  • updateDeviceConfiguration
  • writeDeviceProperties

El tipo de trabajo.