Jobs - Create Import Export Job

  • Referenz
Service:
IoT Hub
API Version:
2020-05-31-preview

Erstellt einen neuen Import- oder Exportauftrag für die IoT Hub. Weitere Informationen finden Sie unter 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-Parameter

Name In Erforderlich Typ Beschreibung
api-version
 query True

string

Version der API.

Anforderungstext

Name Typ Beschreibung
configurationsBlobName

string

Der Standardwert ist configurations.txt. Gibt den Namen des Blobs an, das beim Exportieren/Importieren von Konfigurationen verwendet werden soll.
endTimeUtc

string

System generiert. Wird bei der Erstellung ignoriert. Das Enddatum und die Uhrzeit des Auftrags in UTC.
excludeKeysInExport

boolean

Optional für Exportaufträge; Wird für andere Aufträge ignoriert. Wenn nicht angegeben, wird der Dienst standardmäßig auf false festgelegt. Wenn false, sind Autorisierungsschlüssel in der Exportausgabe enthalten. Schlüssel werden andernfalls als NULL exportiert.
failureReason

string

System genreated. Wird bei der Erstellung ignoriert. Der Grund für den Fehler, wenn ein Fehler aufgetreten ist.
includeConfigurations

boolean

Der Standardwert ist „false“. Wenn true, sind Konfigurationen im Datenexport/-import enthalten.
inputBlobContainerUri

string

Der URI, der ein SAS-Token für einen Blobcontainer enthält, der die zu synchronisierenden Registrierungsdaten enthält.
inputBlobName

string

Der Blobname, der beim Importieren aus dem Eingabeblobcontainer verwendet werden soll.
jobId

string

Der eindeutige Bezeichner des Auftrags.
outputBlobContainerUri

string

Das SAS-Token für den Zugriff auf den Blobcontainer. Dies wird verwendet, um die status und Ergebnisse des Auftrags auszugeben.
outputBlobName

string

Der Blobname, der im Ausgabeblobcontainer erstellt wird. Dieses Blob enthält die exportierten Geräteregistrierungsinformationen für die IoT Hub.
progress

integer

System generiert. Wird bei der Erstellung ignoriert. Der Prozentsatz des Auftragsabschlusses.
startTimeUtc

string

System generiert. Wird bei der Erstellung ignoriert. Das Startdatum und die Uhrzeit des Auftrags in UTC.
status enum:
  • unknown
  • enqueued
  • running
  • completed
  • failed
  • cancelled
  • scheduled
  • queued

System generiert. Wird bei der Erstellung ignoriert. Der Status des Auftrags.
storageAuthenticationType enum:
  • keyBased
  • identityBased

Der Authentifizierungstyp, der zum Herstellen einer Verbindung mit dem Speicherkonto verwendet wird.
type enum:
  • unknown
  • export
  • import
  • backup
  • readDeviceProperties
  • writeDeviceProperties
  • updateDeviceConfiguration
  • rebootDevice
  • factoryResetDevice
  • firmwareUpdate
  • scheduleDeviceMethod
  • scheduleUpdateTwin
  • restoreFromBackup
  • failoverDataCopy

Der Auftragstyp.

Antworten

Name Typ Beschreibung
200 OK

JobProperties

OK.

Definitionen

JobProperties

Name Typ Beschreibung
configurationsBlobName

string

Der Standardwert ist configurations.txt. Gibt den Namen des Blobs an, das beim Exportieren/Importieren von Konfigurationen verwendet werden soll.
endTimeUtc

string

System generiert. Wird bei der Erstellung ignoriert. Das Enddatum und die Uhrzeit des Auftrags in UTC.
excludeKeysInExport

boolean

Optional für Exportaufträge; Wird für andere Aufträge ignoriert. Wenn nicht angegeben, wird der Dienst standardmäßig auf false festgelegt. Wenn false, sind Autorisierungsschlüssel in der Exportausgabe enthalten. Schlüssel werden andernfalls als NULL exportiert.
failureReason

string

System genreated. Wird bei der Erstellung ignoriert. Der Grund für den Fehler, wenn ein Fehler aufgetreten ist.
includeConfigurations

boolean

Der Standardwert ist „false“. Wenn true, sind Konfigurationen im Datenexport/-import enthalten.
inputBlobContainerUri

string

Der URI, der ein SAS-Token für einen Blobcontainer enthält, der die zu synchronisierenden Registrierungsdaten enthält.
inputBlobName

string

Der Blobname, der beim Importieren aus dem Eingabeblobcontainer verwendet werden soll.
jobId

string

Der eindeutige Bezeichner des Auftrags.
outputBlobContainerUri

string

Das SAS-Token für den Zugriff auf den Blobcontainer. Dies wird verwendet, um die status und Ergebnisse des Auftrags auszugeben.
outputBlobName

string

Der Blobname, der im Ausgabeblobcontainer erstellt wird. Dieses Blob enthält die exportierten Geräteregistrierungsinformationen für die IoT Hub.
progress

integer

System generiert. Wird bei der Erstellung ignoriert. Der Prozentsatz des Auftragsabschlusses.
startTimeUtc

string

System generiert. Wird bei der Erstellung ignoriert. Das Startdatum und die Uhrzeit des Auftrags in UTC.
status enum:
  • cancelled
  • completed
  • enqueued
  • failed
  • queued
  • running
  • scheduled
  • unknown

System generiert. Wird bei der Erstellung ignoriert. Der Status des Auftrags.
storageAuthenticationType enum:
  • identityBased
  • keyBased

Der Authentifizierungstyp, der zum Herstellen einer Verbindung mit dem Speicherkonto verwendet wird.
type enum:
  • backup
  • export
  • factoryResetDevice
  • failoverDataCopy
  • firmwareUpdate
  • import
  • readDeviceProperties
  • rebootDevice
  • restoreFromBackup
  • scheduleDeviceMethod
  • scheduleUpdateTwin
  • unknown
  • updateDeviceConfiguration
  • writeDeviceProperties

Der Auftragstyp.