Jobs - Get Import Export Job

  • Referentie
Service:
IoT Hub
API Version:
2021-04-12

Hiermee wordt de status van een import- of exporttaak in 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.

GET https://fully-qualified-iothubname.azure-devices.net/jobs/{id}?api-version=2021-04-12

URI-parameters

Name In Vereist Type Description
id
 path True

string

De unieke id van de taak.
api-version
 query True

string

Versie van de API.

Antwoorden

Name Type Description
200 OK

JobProperties

OK.

Definities

Name Description
JobProperties
ManagedIdentity

JobProperties

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

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. Indien onwaar, worden autorisatiesleutels opgenomen in exportuitvoer. Sleutels worden anders geëxporteerd als null.
failureReason

string

Systeem genereated. Genegeerd bij het maken. De reden voor de fout, als er een fout is opgetreden.
identity

ManagedIdentity

includeConfigurations

boolean

De standaardinstelling is false. Als dit waar is, worden configuraties opgenomen in de gegevensexport/-import.
inputBlobContainerUri

string

De URI met een SAS-token naar een blobcontainer die registergegevens bevat die moeten worden gesynchroniseerd.
inputBlobName

string

De blobnaam die moet worden gebruikt bij het importeren vanuit 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 uitvoer-blobcontainer. Deze blob bevat de geëxporteerde apparaatregistergegevens voor de IoT Hub.
progress

integer

Door het systeem gegenereerd. Genegeerd bij het maken. Het voltooiingspercentage van de taak.
startTimeUtc

string

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

Name Type Description
userAssignedIdentity

string