Dela via

Jobs - Get Import Export Job

  • Referens
Tjänst:
IoT Hub
API-version:
2021-04-12

Hämtar status för ett import- eller exportjobb i IoT Hub. Mer information finns i https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.

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

URI-parametrar

Name I Obligatorisk Typ Description
id
 path True

string

Den unika identifieraren för jobbet.
api-version
 query True

string

Version av API:et.

Svar

Name Typ Description
200 OK

JobProperties

OKEJ.

Definitioner

Name Description
JobProperties
ManagedIdentity

JobProperties

Objekt
Name Typ Description
configurationsBlobName

string

Standardvärdet är configurations.txt. Anger namnet på bloben som ska användas vid export/import av konfigurationer.
endTimeUtc

string (date-time)

Systemet har genererats. Ignoreras vid skapandet. Slutdatum och tid för jobbet i UTC.
excludeKeysInExport

boolean

Valfritt för exportjobb; ignoreras för andra jobb. Om det inte anges är tjänsten som standard false. Om det är falskt inkluderas auktoriseringsnycklar i exportutdata. Nycklar exporteras annars som null.
failureReason

string

Systemgenererad. Ignoreras vid skapandet. Orsaken till felet, om ett fel inträffade.
identity

ManagedIdentity

includeConfigurations

boolean

Standardvärdet är falskt. Om det är sant inkluderas konfigurationer i dataexporten/importen.
inputBlobContainerUri

string

URI:n som innehåller SAS-token till en blobcontainer som innehåller registerdata som ska synkroniseras.
inputBlobName

string

Det blobnamn som ska användas vid import från indatablobcontainern.
jobId

string

Den unika identifieraren för jobbet.
outputBlobContainerUri

string

SAS-token för åtkomst till blobcontainern. Detta används för att mata ut status och resultat för jobbet.
outputBlobName

string

Det blobnamn som ska skapas i utdatablobcontainern. Den här bloben innehåller den exporterade enhetsregisterinformationen för IoT Hub.
progress

integer (int32)

Systemet har genererats. Ignoreras vid skapandet. Procentandelen slutfört jobb.
startTimeUtc

string (date-time)

Systemet har genererats. Ignoreras vid skapandet. Startdatum och tid för jobbet i UTC.
status enum:
  • cancelled
  • completed
  • enqueued
  • failed
  • queued
  • running
  • scheduled
  • unknown

Systemet har genererats. Ignoreras vid skapandet. Jobbets status.
storageAuthenticationType enum:
  • identityBased
  • keyBased

Den autentiseringstyp som används för att ansluta till lagringskontot.
type enum:
  • backup
  • export
  • factoryResetDevice
  • failoverDataCopy
  • firmwareUpdate
  • import
  • readDeviceProperties
  • rebootDevice
  • restoreFromBackup
  • scheduleDeviceMethod
  • scheduleUpdateTwin
  • unknown
  • updateDeviceConfiguration
  • writeDeviceProperties

Jobbtypen.

ManagedIdentity

Objekt
Name Typ Description
userAssignedIdentity

string