Sdílet prostřednictvím

Jobs - Create Import Export Job

  • Reference
Služba:
IoT Hub
Verze rozhraní API:
2021-04-12

Vytvoří novou úlohu importu nebo exportu na IoT Hub. Další informace naleznete v tématu 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 identifikátoru URI

Name V Vyžadováno Typ Description
api-version
 query True

string

Verze rozhraní API.

Text požadavku

Name Typ Description
configurationsBlobName

string

Výchozí hodnota je configurations.txt. Určuje název objektu blob, který se má použít při exportu nebo importu konfigurací.
endTimeUtc

string

Vygenerováno systémem. Při vytváření se ignoruje. Koncové datum a čas úlohy v UTC.
excludeKeysInExport

boolean

Volitelné pro úlohy exportu; u jiných úloh se ignoruje. Pokud není zadaný, služba bude ve výchozím nastavení false. Pokud je hodnota false, autorizační klíče se zahrnou do výstupu exportu. Jinak se klíče exportují jako null.
failureReason

string

Systém byl vygenerován. Při vytváření se ignoruje. Důvod selhání, pokud došlo k chybě.
identity

ManagedIdentity

includeConfigurations

boolean

Výchozí hodnota je false. Pokud je true, jsou konfigurace zahrnuté do exportu nebo importu dat.
inputBlobContainerUri

string

Identifikátor URI obsahující token SAS pro kontejner objektů blob, který obsahuje data registru k synchronizaci.
inputBlobName

string

Název objektu blob, který se má použít při importu ze vstupního kontejneru objektů blob.
jobId

string

Jedinečný identifikátor úlohy.
outputBlobContainerUri

string

Token SAS pro přístup ke kontejneru objektů blob. Slouží k výstupu stavu a výsledků úlohy.
outputBlobName

string

Název objektu blob, který se vytvoří ve výstupním kontejneru objektů blob. Tento objekt blob bude obsahovat exportované informace registru zařízení pro IoT Hub.
progress

integer

Vygenerováno systémem. Při vytváření se ignoruje. Procento dokončení úlohy
startTimeUtc

string

Vygenerováno systémem. Při vytváření se ignoruje. Datum a čas zahájení úlohy v UTC.
status enum:
  • unknown
  • enqueued
  • running
  • completed
  • failed
  • cancelled
  • scheduled
  • queued

Vygenerováno systémem. Při vytváření se ignoruje. Stav úlohy.
storageAuthenticationType enum:
  • keyBased
  • identityBased

Typ ověřování použitý pro připojení k účtu úložiště.
type enum:
  • unknown
  • export
  • import
  • backup
  • readDeviceProperties
  • writeDeviceProperties
  • updateDeviceConfiguration
  • rebootDevice
  • factoryResetDevice
  • firmwareUpdate
  • scheduleDeviceMethod
  • scheduleUpdateTwin
  • restoreFromBackup
  • failoverDataCopy

Typ úlohy.

Odpovědi

Name Typ Description
200 OK

JobProperties

OK.

Definice

Name Description
JobProperties
ManagedIdentity

JobProperties

Name Typ Description
configurationsBlobName

string

Výchozí hodnota je configurations.txt. Určuje název objektu blob, který se má použít při exportu nebo importu konfigurací.
endTimeUtc

string

Vygenerováno systémem. Při vytváření se ignoruje. Koncové datum a čas úlohy v UTC.
excludeKeysInExport

boolean

Volitelné pro úlohy exportu; u jiných úloh se ignoruje. Pokud není zadaný, služba bude ve výchozím nastavení false. Pokud je hodnota false, autorizační klíče se zahrnou do výstupu exportu. Jinak se klíče exportují jako null.
failureReason

string

Systém byl vygenerován. Při vytváření se ignoruje. Důvod selhání, pokud došlo k chybě.
identity

ManagedIdentity

includeConfigurations

boolean

Výchozí hodnota je false. Pokud je true, jsou konfigurace zahrnuté do exportu nebo importu dat.
inputBlobContainerUri

string

Identifikátor URI obsahující token SAS pro kontejner objektů blob, který obsahuje data registru k synchronizaci.
inputBlobName

string

Název objektu blob, který se má použít při importu ze vstupního kontejneru objektů blob.
jobId

string

Jedinečný identifikátor úlohy.
outputBlobContainerUri

string

Token SAS pro přístup ke kontejneru objektů blob. Slouží k výstupu stavu a výsledků úlohy.
outputBlobName

string

Název objektu blob, který se vytvoří ve výstupním kontejneru objektů blob. Tento objekt blob bude obsahovat exportované informace registru zařízení pro IoT Hub.
progress

integer

Vygenerováno systémem. Při vytváření se ignoruje. Procento dokončení úlohy
startTimeUtc

string

Vygenerováno systémem. Při vytváření se ignoruje. Datum a čas zahájení úlohy v UTC.
status enum:
  • cancelled
  • completed
  • enqueued
  • failed
  • queued
  • running
  • scheduled
  • unknown

Vygenerováno systémem. Při vytváření se ignoruje. Stav úlohy.
storageAuthenticationType enum:
  • identityBased
  • keyBased

Typ ověřování použitý pro připojení k účtu úložiště.
type enum:
  • backup
  • export
  • factoryResetDevice
  • failoverDataCopy
  • firmwareUpdate
  • import
  • readDeviceProperties
  • rebootDevice
  • restoreFromBackup
  • scheduleDeviceMethod
  • scheduleUpdateTwin
  • unknown
  • updateDeviceConfiguration
  • writeDeviceProperties

Typ úlohy.

ManagedIdentity

Name Typ Description
userAssignedIdentity

string