Jobs - Create Import Export Job

  • Odwołanie
Service:
IoT Hub
API Version:
2021-04-12

Tworzy nowe zadanie importowania lub eksportowania w IoT Hub. Aby uzyskać więcej informacji, zobacz 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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
api-version
 query True

string

Wersja interfejsu API.

Treść żądania

Nazwa Typ Opis
configurationsBlobName

string

Domyślnie configurations.txt. Określa nazwę obiektu blob do użycia podczas eksportowania/importowania konfiguracji.
endTimeUtc

string

Wygenerowany system. Ignorowane podczas tworzenia. Data i godzina zakończenia zadania w formacie UTC.
excludeKeysInExport

boolean

Opcjonalnie dla zadań eksportu; ignorowane dla innych zadań. Jeśli nie zostanie określony, usługa domyślnie ma wartość false. Jeśli wartość false, klucze autoryzacji są uwzględniane w danych wyjściowych eksportu. Klucze są eksportowane jako null w przeciwnym razie.
failureReason

string

Wygenerowany system. Ignorowane podczas tworzenia. Przyczyna niepowodzenia, jeśli wystąpił błąd.
identity

ManagedIdentity

includeConfigurations

boolean

Wartość domyślna to false. Jeśli jest to prawda, konfiguracje są uwzględniane w eksporcie/importowaniu danych.
inputBlobContainerUri

string

Identyfikator URI zawierający token SAS do kontenera obiektów blob, który zawiera dane rejestru do synchronizacji.
inputBlobName

string

Nazwa obiektu blob do użycia podczas importowania z wejściowego kontenera obiektów blob.
jobId

string

Unikatowy identyfikator zadania.
outputBlobContainerUri

string

Token sygnatury dostępu współdzielonego w celu uzyskania dostępu do kontenera obiektów blob. Służy do wyprowadzania stanu i wyników zadania.
outputBlobName

string

Nazwa obiektu blob, który zostanie utworzony w kontenerze wyjściowych obiektów blob. Ten obiekt blob będzie zawierać wyeksportowane informacje o rejestrze urządzeń dla IoT Hub.
progress

integer

Wygenerowany system. Ignorowane podczas tworzenia. Procent ukończenia zadania.
startTimeUtc

string

Wygenerowany system. Ignorowane podczas tworzenia. Data i godzina rozpoczęcia zadania w formacie UTC.
status enum:
  • unknown
  • enqueued
  • running
  • completed
  • failed
  • cancelled
  • scheduled
  • queued

Wygenerowany system. Ignorowane podczas tworzenia. Stan zadania.
storageAuthenticationType enum:
  • keyBased
  • identityBased

Typ uwierzytelniania używany do nawiązywania połączenia z kontem magazynu.
type enum:
  • unknown
  • export
  • import
  • backup
  • readDeviceProperties
  • writeDeviceProperties
  • updateDeviceConfiguration
  • rebootDevice
  • factoryResetDevice
  • firmwareUpdate
  • scheduleDeviceMethod
  • scheduleUpdateTwin
  • restoreFromBackup
  • failoverDataCopy

Typ zadania.

Odpowiedzi

Nazwa Typ Opis
200 OK

JobProperties

OK.

Definicje

Nazwa Opis
JobProperties
ManagedIdentity

JobProperties

Nazwa Typ Opis
configurationsBlobName

string

Domyślnie configurations.txt. Określa nazwę obiektu blob do użycia podczas eksportowania/importowania konfiguracji.
endTimeUtc

string

Wygenerowany system. Ignorowane podczas tworzenia. Data i godzina zakończenia zadania w formacie UTC.
excludeKeysInExport

boolean

Opcjonalnie dla zadań eksportu; ignorowane dla innych zadań. Jeśli nie zostanie określony, usługa domyślnie ma wartość false. Jeśli wartość false, klucze autoryzacji są uwzględniane w danych wyjściowych eksportu. Klucze są eksportowane jako null w przeciwnym razie.
failureReason

string

Wygenerowany system. Ignorowane podczas tworzenia. Przyczyna niepowodzenia, jeśli wystąpił błąd.
identity

ManagedIdentity

includeConfigurations

boolean

Wartość domyślna to false. Jeśli jest to prawda, konfiguracje są uwzględniane w eksporcie/importowaniu danych.
inputBlobContainerUri

string

Identyfikator URI zawierający token SAS do kontenera obiektów blob, który zawiera dane rejestru do synchronizacji.
inputBlobName

string

Nazwa obiektu blob do użycia podczas importowania z wejściowego kontenera obiektów blob.
jobId

string

Unikatowy identyfikator zadania.
outputBlobContainerUri

string

Token sygnatury dostępu współdzielonego w celu uzyskania dostępu do kontenera obiektów blob. Służy do wyprowadzania stanu i wyników zadania.
outputBlobName

string

Nazwa obiektu blob, który zostanie utworzony w kontenerze wyjściowych obiektów blob. Ten obiekt blob będzie zawierać wyeksportowane informacje o rejestrze urządzeń dla IoT Hub.
progress

integer

Wygenerowany system. Ignorowane podczas tworzenia. Procent ukończenia zadania.
startTimeUtc

string

Wygenerowany system. Ignorowane podczas tworzenia. Data i godzina rozpoczęcia zadania w formacie UTC.
status enum:
  • cancelled
  • completed
  • enqueued
  • failed
  • queued
  • running
  • scheduled
  • unknown

Wygenerowany system. Ignorowane podczas tworzenia. Stan zadania.
storageAuthenticationType enum:
  • identityBased
  • keyBased

Typ uwierzytelniania używany do nawiązywania połączenia z kontem magazynu.
type enum:
  • backup
  • export
  • factoryResetDevice
  • failoverDataCopy
  • firmwareUpdate
  • import
  • readDeviceProperties
  • rebootDevice
  • restoreFromBackup
  • scheduleDeviceMethod
  • scheduleUpdateTwin
  • unknown
  • updateDeviceConfiguration
  • writeDeviceProperties

Typ zadania.

ManagedIdentity

Nazwa Typ Opis
userAssignedIdentity

string