Bagikan melalui

BatchJobCreateOptions interface

Paket:
@azure-rest/batch

Parameter untuk membuat Azure Batch Job.

Properti

allowTaskPreemption

Apakah Tugas dalam pekerjaan ini dapat didahulukan oleh pekerjaan prioritas tinggi lainnya. (Properti ini tidak tersedia secara default. Silakan hubungi dukungan untuk informasi selengkapnya) Jika nilainya diatur ke True, pekerjaan prioritas tinggi lainnya yang dikirimkan ke sistem akan diprioritaskan dan akan dapat mengantrekan ulang tugas dari pekerjaan ini. Anda dapat memperbarui allowTaskPreemption pekerjaan setelah dibuat menggunakan API pekerjaan pembaruan.
commonEnvironmentSettings

Daftar pengaturan variabel lingkungan umum. Variabel lingkungan ini diatur untuk semua Tugas dalam Pekerjaan (termasuk Tugas Manajer Pekerjaan, Persiapan Pekerjaan, dan Rilis Pekerjaan). Tugas Individual dapat mengambil alih pengaturan lingkungan yang ditentukan di sini dengan menentukan nama pengaturan yang sama dengan nilai yang berbeda.
constraints

Batasan eksekusi untuk Pekerjaan.
displayName

Nama tampilan untuk Pekerjaan. Nama tampilan tidak perlu unik dan dapat berisi karakter Unicode hingga panjang maksimum 1024.
id

String yang secara unik mengidentifikasi Pekerjaan dalam Akun. ID dapat berisi kombinasi karakter alfanumerik termasuk tanda hubung dan garis bawah, dan tidak boleh berisi lebih dari 64 karakter. ID ini mempertahankan huruf besar/kecil dan tidak peka huruf besar/kecil (artinya, Anda mungkin tidak memiliki dua ID dalam Akun yang hanya berbeda menurut kasus).
jobManagerTask

Detail Tugas Manajer Pekerjaan yang akan diluncurkan saat Pekerjaan dimulai. Jika Pekerjaan tidak menentukan Tugas Manajer Pekerjaan, pengguna harus secara eksplisit menambahkan Tugas ke Pekerjaan. Jika Pekerjaan menentukan Tugas Manajer Pekerjaan, layanan Batch membuat Tugas Manajer Pekerjaan saat Pekerjaan dibuat, dan akan mencoba menjadwalkan Tugas Manajer Pekerjaan sebelum menjadwalkan Tugas lain dalam Pekerjaan. Tujuan khas Tugas Manajer Pekerjaan adalah untuk mengontrol dan/atau memantau eksekusi Pekerjaan, misalnya dengan memutuskan Tugas tambahan apa yang akan dijalankan, menentukan kapan pekerjaan selesai, dll. (Namun, Tugas Manajer Pekerjaan tidak dibatasi untuk aktivitas ini - ini adalah Tugas yang sepenuhnya lengkap dalam sistem dan melakukan tindakan apa pun yang diperlukan untuk Pekerjaan.) Misalnya, Tugas Manajer Pekerjaan mungkin mengunduh file yang ditentukan sebagai parameter, menganalisis konten file tersebut dan mengirimkan Tugas tambahan berdasarkan konten tersebut.
jobPreparationTask

Tugas persiapan pekerjaan. Jika Pekerjaan memiliki Tugas Persiapan Pekerjaan, layanan Batch akan menjalankan Tugas Persiapan Pekerjaan pada Simpul sebelum memulai Tugas pekerjaan tersebut pada Simpul Komputasi tersebut.
jobReleaseTask

Tugas Rilis Pekerjaan. Tugas Rilis Pekerjaan tidak dapat ditentukan tanpa juga menentukan Tugas Persiapan Pekerjaan untuk Pekerjaan. Layanan Batch menjalankan Tugas Rilis Pekerjaan pada Simpul yang telah menjalankan Tugas Persiapan Pekerjaan. Tujuan utama Tugas Rilis Pekerjaan adalah untuk membatalkan perubahan pada Simpul Komputasi yang dibuat oleh Tugas Persiapan Pekerjaan. Contoh aktivitas termasuk menghapus file lokal, atau mematikan layanan yang dimulai sebagai bagian dari persiapan Pekerjaan.
maxParallelTasks

Jumlah maksimum tugas yang dapat dijalankan secara paralel untuk pekerjaan tersebut. (Properti ini tidak tersedia secara default. Silakan hubungi dukungan untuk informasi lebih lanjut) Nilai maxParallelTasks harus -1 atau lebih besar dari 0 jika ditentukan. Jika tidak ditentukan, nilai defaultnya adalah -1, yang berarti tidak ada batasan jumlah tugas yang dapat dijalankan sekaligus. Anda dapat memperbarui maxParallelTasks pekerjaan setelah dibuat menggunakan API pekerjaan pembaruan.
metadata

Daftar pasangan nilai nama yang terkait dengan Pekerjaan sebagai metadata. Layanan Batch tidak menetapkan arti apa pun untuk metadata; hanya untuk penggunaan kode pengguna.
networkConfiguration

(Properti ini tidak tersedia secara default. Silakan hubungi dukungan untuk informasi selengkapnya) Konfigurasi jaringan untuk Pekerjaan.
onAllTasksComplete

Tindakan yang harus diambil layanan Batch ketika semua Tugas dalam Pekerjaan dalam status selesai. Perhatikan bahwa jika Pekerjaan tidak berisi Tugas, maka semua Tugas dianggap selesai. Oleh karena itu, opsi ini paling umum digunakan dengan tugas Manajer Pekerjaan; jika Anda ingin menggunakan penghentian Pekerjaan otomatis tanpa Job Manager, Anda awalnya harus mengatur padaAllTasksComplete ke noaction dan memperbarui properti Pekerjaan untuk mengatur onAllTasksComplete ke terminatejob setelah Anda selesai menambahkan Tugas. Defaultnya adalah noaction.

Nilai yang mungkin: "noaction", "terminatejob"
onTaskFailure

Tindakan yang harus dilakukan layanan Batch ketika Ada Tugas dalam Pekerjaan yang gagal. Tugas dianggap gagal jika memiliki failureInfo. failureInfo diatur jika Tugas selesai dengan kode keluar bukan nol setelah menghabiskan jumlah coba lagi, atau jika ada kesalahan saat memulai Tugas, misalnya karena kesalahan pengunduhan file sumber daya. Defaultnya adalah noaction.

Nilai yang mungkin: "noaction", "performexitoptionsjobaction"
poolInfo

Kumpulan tempat layanan Batch menjalankan Tugas Pekerjaan.
priority

Prioritas Pekerjaan. Nilai prioritas dapat berkisar dari -1000 hingga 1000, dengan -1000 menjadi prioritas terendah dan 1000 menjadi prioritas tertinggi. Nilai defaultnya adalah 0.
usesTaskDependencies

Apakah Tugas dalam Pekerjaan dapat menentukan dependensi satu sama lain. Defaultnya adalah false.

Detail Properti

allowTaskPreemption

Apakah Tugas dalam pekerjaan ini dapat didahulukan oleh pekerjaan prioritas tinggi lainnya. (Properti ini tidak tersedia secara default. Silakan hubungi dukungan untuk informasi selengkapnya) Jika nilainya diatur ke True, pekerjaan prioritas tinggi lainnya yang dikirimkan ke sistem akan diprioritaskan dan akan dapat mengantrekan ulang tugas dari pekerjaan ini. Anda dapat memperbarui allowTaskPreemption pekerjaan setelah dibuat menggunakan API pekerjaan pembaruan.

allowTaskPreemption?: boolean

Nilai Properti

boolean

commonEnvironmentSettings

Daftar pengaturan variabel lingkungan umum. Variabel lingkungan ini diatur untuk semua Tugas dalam Pekerjaan (termasuk Tugas Manajer Pekerjaan, Persiapan Pekerjaan, dan Rilis Pekerjaan). Tugas Individual dapat mengambil alih pengaturan lingkungan yang ditentukan di sini dengan menentukan nama pengaturan yang sama dengan nilai yang berbeda.

commonEnvironmentSettings?: EnvironmentSetting[]

Nilai Properti

EnvironmentSetting[]

constraints

Batasan eksekusi untuk Pekerjaan.

constraints?: BatchJobConstraints

Nilai Properti

BatchJobConstraints

displayName

Nama tampilan untuk Pekerjaan. Nama tampilan tidak perlu unik dan dapat berisi karakter Unicode hingga panjang maksimum 1024.

displayName?: string

Nilai Properti

string

id

String yang secara unik mengidentifikasi Pekerjaan dalam Akun. ID dapat berisi kombinasi karakter alfanumerik termasuk tanda hubung dan garis bawah, dan tidak boleh berisi lebih dari 64 karakter. ID ini mempertahankan huruf besar/kecil dan tidak peka huruf besar/kecil (artinya, Anda mungkin tidak memiliki dua ID dalam Akun yang hanya berbeda menurut kasus).

id: string

Nilai Properti

string

jobManagerTask

Detail Tugas Manajer Pekerjaan yang akan diluncurkan saat Pekerjaan dimulai. Jika Pekerjaan tidak menentukan Tugas Manajer Pekerjaan, pengguna harus secara eksplisit menambahkan Tugas ke Pekerjaan. Jika Pekerjaan menentukan Tugas Manajer Pekerjaan, layanan Batch membuat Tugas Manajer Pekerjaan saat Pekerjaan dibuat, dan akan mencoba menjadwalkan Tugas Manajer Pekerjaan sebelum menjadwalkan Tugas lain dalam Pekerjaan. Tujuan khas Tugas Manajer Pekerjaan adalah untuk mengontrol dan/atau memantau eksekusi Pekerjaan, misalnya dengan memutuskan Tugas tambahan apa yang akan dijalankan, menentukan kapan pekerjaan selesai, dll. (Namun, Tugas Manajer Pekerjaan tidak dibatasi untuk aktivitas ini - ini adalah Tugas yang sepenuhnya lengkap dalam sistem dan melakukan tindakan apa pun yang diperlukan untuk Pekerjaan.) Misalnya, Tugas Manajer Pekerjaan mungkin mengunduh file yang ditentukan sebagai parameter, menganalisis konten file tersebut dan mengirimkan Tugas tambahan berdasarkan konten tersebut.

jobManagerTask?: BatchJobManagerTask

Nilai Properti

BatchJobManagerTask

jobPreparationTask

Tugas persiapan pekerjaan. Jika Pekerjaan memiliki Tugas Persiapan Pekerjaan, layanan Batch akan menjalankan Tugas Persiapan Pekerjaan pada Simpul sebelum memulai Tugas pekerjaan tersebut pada Simpul Komputasi tersebut.

jobPreparationTask?: BatchJobPreparationTask

Nilai Properti

BatchJobPreparationTask

jobReleaseTask

Tugas Rilis Pekerjaan. Tugas Rilis Pekerjaan tidak dapat ditentukan tanpa juga menentukan Tugas Persiapan Pekerjaan untuk Pekerjaan. Layanan Batch menjalankan Tugas Rilis Pekerjaan pada Simpul yang telah menjalankan Tugas Persiapan Pekerjaan. Tujuan utama Tugas Rilis Pekerjaan adalah untuk membatalkan perubahan pada Simpul Komputasi yang dibuat oleh Tugas Persiapan Pekerjaan. Contoh aktivitas termasuk menghapus file lokal, atau mematikan layanan yang dimulai sebagai bagian dari persiapan Pekerjaan.

jobReleaseTask?: BatchJobReleaseTask

Nilai Properti

BatchJobReleaseTask

maxParallelTasks

Jumlah maksimum tugas yang dapat dijalankan secara paralel untuk pekerjaan tersebut. (Properti ini tidak tersedia secara default. Silakan hubungi dukungan untuk informasi lebih lanjut) Nilai maxParallelTasks harus -1 atau lebih besar dari 0 jika ditentukan. Jika tidak ditentukan, nilai defaultnya adalah -1, yang berarti tidak ada batasan jumlah tugas yang dapat dijalankan sekaligus. Anda dapat memperbarui maxParallelTasks pekerjaan setelah dibuat menggunakan API pekerjaan pembaruan.

maxParallelTasks?: number

Nilai Properti

number

metadata

Daftar pasangan nilai nama yang terkait dengan Pekerjaan sebagai metadata. Layanan Batch tidak menetapkan arti apa pun untuk metadata; hanya untuk penggunaan kode pengguna.

metadata?: BatchMetadataItem[]

Nilai Properti

BatchMetadataItem[]

networkConfiguration

(Properti ini tidak tersedia secara default. Silakan hubungi dukungan untuk informasi selengkapnya) Konfigurasi jaringan untuk Pekerjaan.

networkConfiguration?: BatchJobNetworkConfiguration

Nilai Properti

BatchJobNetworkConfiguration

onAllTasksComplete

Tindakan yang harus diambil layanan Batch ketika semua Tugas dalam Pekerjaan dalam status selesai. Perhatikan bahwa jika Pekerjaan tidak berisi Tugas, maka semua Tugas dianggap selesai. Oleh karena itu, opsi ini paling umum digunakan dengan tugas Manajer Pekerjaan; jika Anda ingin menggunakan penghentian Pekerjaan otomatis tanpa Job Manager, Anda awalnya harus mengatur padaAllTasksComplete ke noaction dan memperbarui properti Pekerjaan untuk mengatur onAllTasksComplete ke terminatejob setelah Anda selesai menambahkan Tugas. Defaultnya adalah noaction.

Nilai yang mungkin: "noaction", "terminatejob"

onAllTasksComplete?: string

Nilai Properti

string

onTaskFailure

Tindakan yang harus dilakukan layanan Batch ketika Ada Tugas dalam Pekerjaan yang gagal. Tugas dianggap gagal jika memiliki failureInfo. failureInfo diatur jika Tugas selesai dengan kode keluar bukan nol setelah menghabiskan jumlah coba lagi, atau jika ada kesalahan saat memulai Tugas, misalnya karena kesalahan pengunduhan file sumber daya. Defaultnya adalah noaction.

Nilai yang mungkin: "noaction", "performexitoptionsjobaction"

onTaskFailure?: string

Nilai Properti

string

poolInfo

Kumpulan tempat layanan Batch menjalankan Tugas Pekerjaan.

poolInfo: BatchPoolInfo

Nilai Properti

BatchPoolInfo

priority

Prioritas Pekerjaan. Nilai prioritas dapat berkisar dari -1000 hingga 1000, dengan -1000 menjadi prioritas terendah dan 1000 menjadi prioritas tertinggi. Nilai defaultnya adalah 0.

priority?: number

Nilai Properti

number

usesTaskDependencies

Apakah Tugas dalam Pekerjaan dapat menentukan dependensi satu sama lain. Defaultnya adalah false.

usesTaskDependencies?: boolean

Nilai Properti

boolean