Jobs - Create Import Export Job

  • Referência
Serviço:
IoT Hub
Versão da API:
2021-04-12

Cria um novo trabalho de importação ou exportação no Hub IoT. Consulte https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities para obter mais informações.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
api-version
 query True

string

Versão da API.

Corpo da solicitação

Nome Tipo Description
configurationsBlobName

string

O padrão é configurations.txt. Especifica o nome do blob a ser usado ao exportar/importar configurações.
endTimeUtc

string

Sistema gerado. Ignorado na criação. A data e a hora de término do trabalho em UTC.
excludeKeysInExport

boolean

Opcional para trabalhos de exportação; ignorado para outros trabalhos. Se não for especificado, o serviço usará como padrão false. Se for false, as chaves de autorização serão incluídas na saída de exportação. As chaves serão exportadas como nulas caso contrário.
failureReason

string

Sistema genereado. Ignorado na criação. O motivo da falha, se ocorreu uma falha.
identity

ManagedIdentity

includeConfigurations

boolean

O padrão é false. Se for true, as configurações serão incluídas na exportação/importação de dados.
inputBlobContainerUri

string

O URI que contém o token SAS para um contêiner de blob que contém dados do Registro a serem sincronizados.
inputBlobName

string

O nome do blob a ser usado ao importar do contêiner de blob de entrada.
jobId

string

O identificador exclusivo do trabalho.
outputBlobContainerUri

string

O token SAS para acessar o contêiner de blob. Isso é usado para gerar o status e os resultados do trabalho.
outputBlobName

string

O nome do blob que será criado no contêiner de blob de saída. Esse blob conterá as informações do registro de dispositivo exportado para o Hub IoT.
progress

integer

Sistema gerado. Ignorado na criação. O percentual de conclusão do trabalho.
startTimeUtc

string

Sistema gerado. Ignorado na criação. A data e a hora de início do trabalho em UTC.
status enum:
  • unknown
  • enqueued
  • running
  • completed
  • failed
  • cancelled
  • scheduled
  • queued

Sistema gerado. Ignorado na criação. O status do trabalho.
storageAuthenticationType enum:
  • keyBased
  • identityBased

O tipo de autenticação usado para se conectar à conta de armazenamento.
type enum:
  • unknown
  • export
  • import
  • backup
  • readDeviceProperties
  • writeDeviceProperties
  • updateDeviceConfiguration
  • rebootDevice
  • factoryResetDevice
  • firmwareUpdate
  • scheduleDeviceMethod
  • scheduleUpdateTwin
  • restoreFromBackup
  • failoverDataCopy

O tipo de trabalho.

Respostas

Nome Tipo Description
200 OK

JobProperties

OK.

Definições

Nome Description
JobProperties
ManagedIdentity

JobProperties

Nome Tipo Description
configurationsBlobName

string

O padrão é configurations.txt. Especifica o nome do blob a ser usado ao exportar/importar configurações.
endTimeUtc

string

Sistema gerado. Ignorado na criação. A data e a hora de término do trabalho em UTC.
excludeKeysInExport

boolean

Opcional para trabalhos de exportação; ignorado para outros trabalhos. Se não for especificado, o serviço usará como padrão false. Se for false, as chaves de autorização serão incluídas na saída de exportação. As chaves serão exportadas como nulas caso contrário.
failureReason

string

Sistema genereado. Ignorado na criação. O motivo da falha, se ocorreu uma falha.
identity

ManagedIdentity

includeConfigurations

boolean

O padrão é false. Se for true, as configurações serão incluídas na exportação/importação de dados.
inputBlobContainerUri

string

O URI que contém o token SAS para um contêiner de blob que contém dados do Registro a serem sincronizados.
inputBlobName

string

O nome do blob a ser usado ao importar do contêiner de blob de entrada.
jobId

string

O identificador exclusivo do trabalho.
outputBlobContainerUri

string

O token SAS para acessar o contêiner de blob. Isso é usado para gerar o status e os resultados do trabalho.
outputBlobName

string

O nome do blob que será criado no contêiner de blob de saída. Esse blob conterá as informações do registro de dispositivo exportado para o Hub IoT.
progress

integer

Sistema gerado. Ignorado na criação. O percentual de conclusão do trabalho.
startTimeUtc

string

Sistema gerado. Ignorado na criação. A data e a hora de início do trabalho em UTC.
status enum:
  • cancelled
  • completed
  • enqueued
  • failed
  • queued
  • running
  • scheduled
  • unknown

Sistema gerado. Ignorado na criação. O status do trabalho.
storageAuthenticationType enum:
  • identityBased
  • keyBased

O tipo de autenticação usado para se conectar à conta de armazenamento.
type enum:
  • backup
  • export
  • factoryResetDevice
  • failoverDataCopy
  • firmwareUpdate
  • import
  • readDeviceProperties
  • rebootDevice
  • restoreFromBackup
  • scheduleDeviceMethod
  • scheduleUpdateTwin
  • unknown
  • updateDeviceConfiguration
  • writeDeviceProperties

O tipo de trabalho.

ManagedIdentity

Nome Tipo Description
userAssignedIdentity

string