Jobs - Create Import Export Job

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

Membuat pekerjaan impor atau ekspor baru pada IoT Hub. Lihat https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities untuk informasi lebih lanjut.

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

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi
api-version
 query True

string

Versi Api.

Isi Permintaan

Nama Jenis Deskripsi
configurationsBlobName

string

Default ke configurations.txt. Menentukan nama blob yang akan digunakan saat mengekspor/mengimpor konfigurasi.
endTimeUtc

string

Sistem yang dihasilkan. Diabaikan saat pembuatan. Tanggal dan waktu akhir pekerjaan di UTC.
excludeKeysInExport

boolean

Opsional untuk pekerjaan ekspor; diabaikan untuk pekerjaan lain. Jika tidak ditentukan, layanan default ke false. Jika false, kunci otorisasi disertakan dalam output ekspor. Kunci diekspor sebagai null jika tidak.
failureReason

string

Sistem dibuat. Diabaikan saat pembuatan. Alasan kegagalan, jika kegagalan terjadi.
identity

ManagedIdentity

includeConfigurations

boolean

Default ke false. Jika true, konfigurasi disertakan dalam ekspor/impor data.
inputBlobContainerUri

string

URI yang berisi token SAS ke kontainer blob yang berisi data registri untuk disinkronkan.
inputBlobName

string

Nama blob yang digunakan saat mengimpor dari kontainer blob input.
jobId

string

Pengidentifikasi unik pekerjaan.
outputBlobContainerUri

string

Token SAS untuk mengakses kontainer blob. Ini digunakan untuk menghasilkan status dan hasil pekerjaan.
outputBlobName

string

Nama blob yang akan dibuat dalam kontainer blob output. Blob ini akan berisi informasi registri perangkat yang diekspor untuk IoT Hub.
progress

integer

Sistem yang dihasilkan. Diabaikan saat pembuatan. Persentase penyelesaian pekerjaan.
startTimeUtc

string

Sistem yang dihasilkan. Diabaikan saat pembuatan. Tanggal dan waktu mulai pekerjaan di UTC.
status enum:
  • unknown
  • enqueued
  • running
  • completed
  • failed
  • cancelled
  • scheduled
  • queued

Sistem yang dihasilkan. Diabaikan saat pembuatan. Status pekerjaan.
storageAuthenticationType enum:
  • keyBased
  • identityBased

Jenis autentikasi yang digunakan untuk menyambungkan ke akun penyimpanan.
type enum:
  • unknown
  • export
  • import
  • backup
  • readDeviceProperties
  • writeDeviceProperties
  • updateDeviceConfiguration
  • rebootDevice
  • factoryResetDevice
  • firmwareUpdate
  • scheduleDeviceMethod
  • scheduleUpdateTwin
  • restoreFromBackup
  • failoverDataCopy

Jenis pekerjaan.

Respons

Nama Jenis Deskripsi
200 OK

JobProperties

OK.

Definisi

Nama Deskripsi
JobProperties
ManagedIdentity

JobProperties

Nama Jenis Deskripsi
configurationsBlobName

string

Default ke configurations.txt. Menentukan nama blob yang akan digunakan saat mengekspor/mengimpor konfigurasi.
endTimeUtc

string

Sistem yang dihasilkan. Diabaikan saat pembuatan. Tanggal dan waktu akhir pekerjaan di UTC.
excludeKeysInExport

boolean

Opsional untuk pekerjaan ekspor; diabaikan untuk pekerjaan lain. Jika tidak ditentukan, layanan default ke false. Jika false, kunci otorisasi disertakan dalam output ekspor. Kunci diekspor sebagai null jika tidak.
failureReason

string

Sistem dibuat. Diabaikan saat pembuatan. Alasan kegagalan, jika kegagalan terjadi.
identity

ManagedIdentity

includeConfigurations

boolean

Default ke false. Jika true, konfigurasi disertakan dalam ekspor/impor data.
inputBlobContainerUri

string

URI yang berisi token SAS ke kontainer blob yang berisi data registri untuk disinkronkan.
inputBlobName

string

Nama blob yang digunakan saat mengimpor dari kontainer blob input.
jobId

string

Pengidentifikasi unik pekerjaan.
outputBlobContainerUri

string

Token SAS untuk mengakses kontainer blob. Ini digunakan untuk menghasilkan status dan hasil pekerjaan.
outputBlobName

string

Nama blob yang akan dibuat dalam kontainer blob output. Blob ini akan berisi informasi registri perangkat yang diekspor untuk IoT Hub.
progress

integer

Sistem yang dihasilkan. Diabaikan saat pembuatan. Persentase penyelesaian pekerjaan.
startTimeUtc

string

Sistem yang dihasilkan. Diabaikan saat pembuatan. Tanggal dan waktu mulai pekerjaan di UTC.
status enum:
  • cancelled
  • completed
  • enqueued
  • failed
  • queued
  • running
  • scheduled
  • unknown

Sistem yang dihasilkan. Diabaikan saat pembuatan. Status pekerjaan.
storageAuthenticationType enum:
  • identityBased
  • keyBased

Jenis autentikasi yang digunakan untuk menyambungkan ke akun penyimpanan.
type enum:
  • backup
  • export
  • factoryResetDevice
  • failoverDataCopy
  • firmwareUpdate
  • import
  • readDeviceProperties
  • rebootDevice
  • restoreFromBackup
  • scheduleDeviceMethod
  • scheduleUpdateTwin
  • unknown
  • updateDeviceConfiguration
  • writeDeviceProperties

Jenis pekerjaan.

ManagedIdentity

Nama Jenis Deskripsi
userAssignedIdentity

string