Jobs - Create Import Export Job

Service:

IoT Hub

API Version:

2020-05-31-preview

Új importálási vagy exportálási feladatot hoz létre a IoT Hub. További információ: 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-paraméterek

Name	In	Kötelező	Típus	Description
api-version	query	True	string	Az Api verziója.

Kérelem törzse

Name	Típus	Description
configurationsBlobName	string	Alapértelmezés szerint configurations.txt. Megadja a konfigurációk exportálásához/importálásához használni kívánt blob nevét.
endTimeUtc	string	Rendszer generálva. A létrehozáskor figyelmen kívül hagyva. A feladat befejezési dátuma és időpontja UTC-ben.
excludeKeysInExport	boolean	Exportálási feladatokhoz nem kötelező; más feladatok esetében figyelmen kívül hagyva. Ha nincs megadva, a szolgáltatás alapértelmezés szerint hamis. Ha hamis, az engedélyezési kulcsok szerepelnek az exportálási kimenetben. A kulcsokat a rendszer null értékűként exportálja.
failureReason	string	Rendszer genereated. A létrehozáskor figyelmen kívül hagyva. A hiba oka, ha hiba történt.
includeConfigurations	boolean	Az alapértelmezett érték a hamis. Ha igaz, akkor a konfigurációk az adatexportálás/-importálás részét képezik.
inputBlobContainerUri	string	Az SAS-jogkivonatot tartalmazó URI egy olyan blobtárolóba, amely a szinkronizálandó beállításjegyzék-adatokat tartalmazza.
inputBlobName	string	A bemeneti blobtárolóból való importáláskor használandó blobnév.
jobId	string	A feladat egyedi azonosítója.
outputBlobContainerUri	string	A blobtároló eléréséhez szükséges SAS-jogkivonat. Ez a feladat állapotának és eredményeinek kimenetére szolgál.
outputBlobName	string	A kimeneti blobtárolóban létrejövő blobnév. Ez a blob tartalmazza a IoT Hub exportált eszközregisztrációs adatbázisának adatait.
progress	integer	Rendszer generálva. A létrehozáskor figyelmen kívül hagyva. A feladat befejezésének százalékos aránya.
startTimeUtc	string	Rendszer generálva. A létrehozáskor figyelmen kívül hagyva. A feladat kezdési dátuma és időpontja UTC-ben.
status	enum: unknown enqueued running completed failed cancelled scheduled queued	Rendszer generálva. A létrehozáskor figyelmen kívül hagyva. A feladat állapota.
storageAuthenticationType	enum: keyBased identityBased	A tárfiókhoz való csatlakozáshoz használt hitelesítési típus.
type	enum: unknown export import backup readDeviceProperties writeDeviceProperties updateDeviceConfiguration rebootDevice factoryResetDevice firmwareUpdate scheduleDeviceMethod scheduleUpdateTwin restoreFromBackup failoverDataCopy	A feladat típusa.

Válaszok

Name	Típus	Description
200 OK	JobProperties	OK gombra.

Definíciók

JobProperties

Name	Típus	Description
configurationsBlobName	string	Alapértelmezés szerint configurations.txt. Megadja a konfigurációk exportálásához/importálásához használni kívánt blob nevét.
endTimeUtc	string	Rendszer generálva. A létrehozáskor figyelmen kívül hagyva. A feladat befejezési dátuma és időpontja UTC-ben.
excludeKeysInExport	boolean	Exportálási feladatokhoz nem kötelező; más feladatok esetében figyelmen kívül hagyva. Ha nincs megadva, a szolgáltatás alapértelmezés szerint hamis. Ha hamis, az engedélyezési kulcsok szerepelnek az exportálási kimenetben. A kulcsokat a rendszer null értékűként exportálja.
failureReason	string	Rendszer genereated. A létrehozáskor figyelmen kívül hagyva. A hiba oka, ha hiba történt.
includeConfigurations	boolean	Az alapértelmezett érték a hamis. Ha igaz, akkor a konfigurációk az adatexportálás/-importálás részét képezik.
inputBlobContainerUri	string	Az SAS-jogkivonatot tartalmazó URI egy olyan blobtárolóba, amely a szinkronizálandó beállításjegyzék-adatokat tartalmazza.
inputBlobName	string	A bemeneti blobtárolóból való importáláskor használandó blobnév.
jobId	string	A feladat egyedi azonosítója.
outputBlobContainerUri	string	A blobtároló eléréséhez szükséges SAS-jogkivonat. Ez a feladat állapotának és eredményeinek kimenetére szolgál.
outputBlobName	string	A kimeneti blobtárolóban létrejövő blobnév. Ez a blob tartalmazza a IoT Hub exportált eszközregisztrációs adatbázisának adatait.
progress	integer	Rendszer generálva. A létrehozáskor figyelmen kívül hagyva. A feladat befejezésének százalékos aránya.
startTimeUtc	string	Rendszer generálva. A létrehozáskor figyelmen kívül hagyva. A feladat kezdési dátuma és időpontja UTC-ben.
status	enum: cancelled completed enqueued failed queued running scheduled unknown	Rendszer generálva. A létrehozáskor figyelmen kívül hagyva. A feladat állapota.
storageAuthenticationType	enum: identityBased keyBased	A tárfiókhoz való csatlakozáshoz használt hitelesítési típus.
type	enum: backup export factoryResetDevice failoverDataCopy firmwareUpdate import readDeviceProperties rebootDevice restoreFromBackup scheduleDeviceMethod scheduleUpdateTwin unknown updateDeviceConfiguration writeDeviceProperties	A feladat típusa.