Freigeben über

Jobs - Create Import Export Job

  • Referenz
Dienst:
IoT Hub
API-Version:
2021-04-12

Erstellt einen neuen Import- oder Exportauftrag auf dem 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=2021-04-12

URI-Parameter

Name In Erforderlich Typ Beschreibung
api-version
 query True

string

Version der API.

Anforderungstext

Name Typ Beschreibung
configurationsBlobName

string

Standardmäßig wird configurations.txt. Gibt den Namen des Blobs an, das beim Exportieren/Importieren von Konfigurationen verwendet werden soll.
endTimeUtc

string (date-time)

Das System wurde generiert. Beim Erstellen ignoriert. Enddatum und -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, werden Autorisierungsschlüssel in der Exportausgabe enthalten. Schlüssel werden andernfalls als NULL exportiert.
failureReason

string

System genereiert. Beim Erstellen ignoriert. Der Grund für einen Fehler, wenn ein Fehler aufgetreten ist.
identity

ManagedIdentity

includeConfigurations

boolean

Standardwert ist "false". Wenn true, werden Konfigurationen im Datenexport/-import enthalten.
inputBlobContainerUri

string

Der URI, der SAS-Token für einen BLOB-Container enthält, der Registrierungsdaten enthält, die synchronisiert werden sollen.
inputBlobName

string

Der blob-Name, der beim Importieren aus dem Eingabe-BLOB-Container verwendet werden soll.
jobId

string

Der eindeutige Bezeichner des Auftrags.
outputBlobContainerUri

string

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

string

Der Blobname, der im Ausgabe-BLOB-Container erstellt wird. Dieser Blob enthält die exportierten Geräteregistrierungsinformationen für den IoT Hub.
progress

integer (int32)

Das System wurde generiert. Beim Erstellen ignoriert. Der Prozentsatz des Auftragsabschlusses.
startTimeUtc

string (date-time)

Das System wurde generiert. Beim Erstellen ignoriert. Das Startdatum und die Startzeit des Auftrags in UTC.
status enum:
  • unknown
  • enqueued
  • running
  • completed
  • failed
  • cancelled
  • scheduled
  • queued

Das System wurde generiert. Beim Erstellen ignoriert. Der Status des Auftrags.
storageAuthenticationType enum:
  • keyBased
  • identityBased

Der Authentifizierungstyp, der für die 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

OKAY.

Definitionen

Name Beschreibung
JobProperties
ManagedIdentity

JobProperties

Objekt
Name Typ Beschreibung
configurationsBlobName

string

Standardmäßig wird configurations.txt. Gibt den Namen des Blobs an, das beim Exportieren/Importieren von Konfigurationen verwendet werden soll.
endTimeUtc

string (date-time)

Das System wurde generiert. Beim Erstellen ignoriert. Enddatum und -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, werden Autorisierungsschlüssel in der Exportausgabe enthalten. Schlüssel werden andernfalls als NULL exportiert.
failureReason

string

System genereiert. Beim Erstellen ignoriert. Der Grund für einen Fehler, wenn ein Fehler aufgetreten ist.
identity

ManagedIdentity

includeConfigurations

boolean

Standardwert ist "false". Wenn true, werden Konfigurationen im Datenexport/-import enthalten.
inputBlobContainerUri

string

Der URI, der SAS-Token für einen BLOB-Container enthält, der Registrierungsdaten enthält, die synchronisiert werden sollen.
inputBlobName

string

Der blob-Name, der beim Importieren aus dem Eingabe-BLOB-Container verwendet werden soll.
jobId

string

Der eindeutige Bezeichner des Auftrags.
outputBlobContainerUri

string

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

string

Der Blobname, der im Ausgabe-BLOB-Container erstellt wird. Dieser Blob enthält die exportierten Geräteregistrierungsinformationen für den IoT Hub.
progress

integer (int32)

Das System wurde generiert. Beim Erstellen ignoriert. Der Prozentsatz des Auftragsabschlusses.
startTimeUtc

string (date-time)

Das System wurde generiert. Beim Erstellen ignoriert. Das Startdatum und die Startzeit des Auftrags in UTC.
status enum:
  • cancelled
  • completed
  • enqueued
  • failed
  • queued
  • running
  • scheduled
  • unknown

Das System wurde generiert. Beim Erstellen ignoriert. Der Status des Auftrags.
storageAuthenticationType enum:
  • identityBased
  • keyBased

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

Der Auftragstyp.

ManagedIdentity

Objekt
Name Typ Beschreibung
userAssignedIdentity

string