Jobs - Create Import Export Job

Service:

IoT Hub

API-versie:

2021-04-12

Hiermee maakt u een nieuwe import- of exporttaak op de IoT Hub. Zie https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities voor meer informatie.

POST https://fully-qualified-iothubname.azure-devices.net/jobs/create?api-version=2021-04-12

URI-parameters

Name	In	Vereist	Type	Description
api-version	query	True	string	Versie van de API.

Aanvraagbody

Name	Type	Description
configurationsBlobName	string	Standaard ingesteld op configurations.txt. Hiermee geeft u de naam op van de blob die moet worden gebruikt bij het exporteren/importeren van configuraties.
endTimeUtc	string (date-time)	Door het systeem gegenereerd. Genegeerd bij het maken. De einddatum en -tijd van de taak in UTC.
excludeKeysInExport	boolean	Optioneel voor exporttaken; genegeerd voor andere taken. Als dit niet is opgegeven, wordt de service standaard ingesteld op false. Als dit onwaar is, worden autorisatiesleutels opgenomen in exportuitvoer. Sleutels worden geëxporteerd als null, anders.
failureReason	string	Systeem genereeerd. Genegeerd bij het maken. De reden voor de fout, als er een fout is opgetreden.
identity	ManagedIdentity
includeConfigurations	boolean	Standaard ingesteld op onwaar. Indien waar, worden configuraties opgenomen in de gegevensexport/-import.
inputBlobContainerUri	string	De URI met SAS-token naar een blobcontainer die registergegevens bevat die moeten worden gesynchroniseerd.
inputBlobName	string	De blobnaam die moet worden gebruikt bij het importeren uit de invoerblobcontainer.
jobId	string	De unieke id van de taak.
outputBlobContainerUri	string	Het SAS-token voor toegang tot de blobcontainer. Dit wordt gebruikt om de status en resultaten van de taak uit te voeren.
outputBlobName	string	De blobnaam die wordt gemaakt in de uitvoerblobcontainer. Deze blob bevat de geëxporteerde apparaatregistergegevens voor de IoT Hub.
progress	integer (int32)	Door het systeem gegenereerd. Genegeerd bij het maken. Het percentage voltooide taken.
startTimeUtc	string (date-time)	Door het systeem gegenereerd. Genegeerd bij het maken. De begindatum en -tijd van de taak in UTC.
status	enum: unknown enqueued running completed failed cancelled scheduled queued	Door het systeem gegenereerd. Genegeerd bij het maken. De status van de taak.
storageAuthenticationType	enum: keyBased identityBased	Het verificatietype dat wordt gebruikt om verbinding te maken met het opslagaccount.
type	enum: unknown export import backup readDeviceProperties writeDeviceProperties updateDeviceConfiguration rebootDevice factoryResetDevice firmwareUpdate scheduleDeviceMethod scheduleUpdateTwin restoreFromBackup failoverDataCopy	Het taaktype.

Antwoorden

Name	Type	Description
200 OK	JobProperties	OK.

Definities

Name	Description
JobProperties
ManagedIdentity

JobProperties

Object

Name	Type	Description
configurationsBlobName	string	Standaard ingesteld op configurations.txt. Hiermee geeft u de naam op van de blob die moet worden gebruikt bij het exporteren/importeren van configuraties.
endTimeUtc	string (date-time)	Door het systeem gegenereerd. Genegeerd bij het maken. De einddatum en -tijd van de taak in UTC.
excludeKeysInExport	boolean	Optioneel voor exporttaken; genegeerd voor andere taken. Als dit niet is opgegeven, wordt de service standaard ingesteld op false. Als dit onwaar is, worden autorisatiesleutels opgenomen in exportuitvoer. Sleutels worden geëxporteerd als null, anders.
failureReason	string	Systeem genereeerd. Genegeerd bij het maken. De reden voor de fout, als er een fout is opgetreden.
identity	ManagedIdentity
includeConfigurations	boolean	Standaard ingesteld op onwaar. Indien waar, worden configuraties opgenomen in de gegevensexport/-import.
inputBlobContainerUri	string	De URI met SAS-token naar een blobcontainer die registergegevens bevat die moeten worden gesynchroniseerd.
inputBlobName	string	De blobnaam die moet worden gebruikt bij het importeren uit de invoerblobcontainer.
jobId	string	De unieke id van de taak.
outputBlobContainerUri	string	Het SAS-token voor toegang tot de blobcontainer. Dit wordt gebruikt om de status en resultaten van de taak uit te voeren.
outputBlobName	string	De blobnaam die wordt gemaakt in de uitvoerblobcontainer. Deze blob bevat de geëxporteerde apparaatregistergegevens voor de IoT Hub.
progress	integer (int32)	Door het systeem gegenereerd. Genegeerd bij het maken. Het percentage voltooide taken.
startTimeUtc	string (date-time)	Door het systeem gegenereerd. Genegeerd bij het maken. De begindatum en -tijd van de taak in UTC.
status	enum: cancelled completed enqueued failed queued running scheduled unknown	Door het systeem gegenereerd. Genegeerd bij het maken. De status van de taak.
storageAuthenticationType	enum: identityBased keyBased	Het verificatietype dat wordt gebruikt om verbinding te maken met het opslagaccount.
type	enum: backup export factoryResetDevice failoverDataCopy firmwareUpdate import readDeviceProperties rebootDevice restoreFromBackup scheduleDeviceMethod scheduleUpdateTwin unknown updateDeviceConfiguration writeDeviceProperties	Het taaktype.

ManagedIdentity

Object

Name	Type	Description
userAssignedIdentity	string