Condividi tramite


Jobs - Create Import Export Job

Crea un nuovo processo di importazione o esportazione nel hub IoT. Per altre informazioni, vedere 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=2021-04-12

Parametri dell'URI

Nome In Necessario Tipo Descrizione
api-version
query True

string

Versione dell'API.

Corpo della richiesta

Nome Tipo Descrizione
configurationsBlobName

string

Le impostazioni predefinite sono configurations.txt. Specifica il nome del BLOB da usare durante l'esportazione/importazione di configurazioni.

endTimeUtc

string

Sistema generato. Ignorato alla creazione. Data e ora di fine del processo in formato UTC.

excludeKeysInExport

boolean

Facoltativo per i processi di esportazione; ignorato per altri processi. Se non specificato, il servizio viene predefinito su false. Se false, le chiavi di autorizzazione sono incluse nell'output di esportazione. Le chiavi vengono esportate come Null in caso contrario.

failureReason

string

Genereato dal sistema. Ignorato alla creazione. Motivo dell'errore, se si è verificato un errore.

identity

ManagedIdentity

includeConfigurations

boolean

Il valore predefinito è false. Se true, le configurazioni vengono incluse nell'esportazione/importazione dei dati.

inputBlobContainerUri

string

URI contenente token di firma di accesso condiviso in un contenitore BLOB che contiene dati del Registro di sistema da sincronizzare.

inputBlobName

string

Nome BLOB da usare durante l'importazione dal contenitore BLOB di input.

jobId

string

Identificatore univoco del processo.

outputBlobContainerUri

string

Token di firma di accesso condiviso per accedere al contenitore BLOB. Viene usato per restituire lo stato e i risultati del processo.

outputBlobName

string

Nome BLOB che verrà creato nel contenitore BLOB di output. Questo BLOB conterrà le informazioni del Registro di sistema dei dispositivi esportate per il hub IoT.

progress

integer

Sistema generato. Ignorato alla creazione. Percentuale di completamento del processo.

startTimeUtc

string

Sistema generato. Ignorato alla creazione. Data e ora di inizio del processo in formato UTC.

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

Sistema generato. Ignorato alla creazione. Stato del processo.

storageAuthenticationType enum:
  • keyBased
  • identityBased

Tipo di autenticazione usato per la connessione all'account di archiviazione.

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

Tipo di processo.

Risposte

Nome Tipo Descrizione
200 OK

JobProperties

OK.

Definizioni

Nome Descrizione
JobProperties
ManagedIdentity

JobProperties

Nome Tipo Descrizione
configurationsBlobName

string

Le impostazioni predefinite sono configurations.txt. Specifica il nome del BLOB da usare durante l'esportazione/importazione di configurazioni.

endTimeUtc

string

Sistema generato. Ignorato alla creazione. Data e ora di fine del processo in formato UTC.

excludeKeysInExport

boolean

Facoltativo per i processi di esportazione; ignorato per altri processi. Se non specificato, il servizio viene predefinito su false. Se false, le chiavi di autorizzazione sono incluse nell'output di esportazione. Le chiavi vengono esportate come Null in caso contrario.

failureReason

string

Genereato dal sistema. Ignorato alla creazione. Motivo dell'errore, se si è verificato un errore.

identity

ManagedIdentity

includeConfigurations

boolean

Il valore predefinito è false. Se true, le configurazioni vengono incluse nell'esportazione/importazione dei dati.

inputBlobContainerUri

string

URI contenente token di firma di accesso condiviso in un contenitore BLOB che contiene dati del Registro di sistema da sincronizzare.

inputBlobName

string

Nome BLOB da usare durante l'importazione dal contenitore BLOB di input.

jobId

string

Identificatore univoco del processo.

outputBlobContainerUri

string

Token di firma di accesso condiviso per accedere al contenitore BLOB. Viene usato per restituire lo stato e i risultati del processo.

outputBlobName

string

Nome BLOB che verrà creato nel contenitore BLOB di output. Questo BLOB conterrà le informazioni del Registro di sistema dei dispositivi esportate per il hub IoT.

progress

integer

Sistema generato. Ignorato alla creazione. Percentuale di completamento del processo.

startTimeUtc

string

Sistema generato. Ignorato alla creazione. Data e ora di inizio del processo in formato UTC.

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

Sistema generato. Ignorato alla creazione. Stato del processo.

storageAuthenticationType enum:
  • identityBased
  • keyBased

Tipo di autenticazione usato per la connessione all'account di archiviazione.

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

Tipo di processo.

ManagedIdentity

Nome Tipo Descrizione
userAssignedIdentity

string