Bagikan melalui

BatchTaskCreateOptions interface

Paket:
@azure-rest/batch

Parameter untuk membuat Tugas Azure Batch.

Properti

affinityInfo

Petunjuk lokalitas yang dapat digunakan oleh layanan Batch untuk memilih Simpul Komputasi tempat memulai Tugas baru.
applicationPackageReferences

Daftar Paket yang akan disebarkan layanan Batch ke Simpul Komputasi sebelum menjalankan baris perintah. Paket aplikasi diunduh dan disebarkan ke direktori bersama, bukan direktori kerja Tugas. Oleh karena itu, jika paket yang direferensikan sudah ada di Node, dan sudah diperbarui, maka paket tersebut tidak diunduh ulang; salinan yang ada pada Simpul Komputasi digunakan. Jika Paket yang direferensikan tidak dapat diinstal, misalnya karena paket telah dihapus atau karena pengunduhan gagal, Tugas gagal.
authenticationTokenSettings

Pengaturan untuk token autentikasi yang dapat digunakan Tugas untuk melakukan operasi layanan Batch. Jika properti ini diatur, layanan Batch menyediakan Tugas dengan token autentikasi yang dapat digunakan untuk mengautentikasi operasi layanan Batch tanpa memerlukan kunci akses Akun. Token disediakan melalui variabel lingkungan AZ_BATCH_AUTHENTICATION_TOKEN. Operasi yang dapat dilakukan Tugas menggunakan token bergantung pada pengaturan. Misalnya, Tugas dapat meminta izin Pekerjaan untuk menambahkan Tugas lain ke Pekerjaan, atau memeriksa status Pekerjaan atau Tugas lain di bawah Pekerjaan.
commandLine

Baris perintah Tugas. Untuk Tugas multi-instans, baris perintah dijalankan sebagai Tugas utama, setelah Tugas utama dan semua subtugas selesai menjalankan baris perintah koordinasi. Baris perintah tidak berjalan di bawah shell, dan oleh karena itu tidak dapat memanfaatkan fitur shell seperti ekspansi variabel lingkungan. Jika Anda ingin memanfaatkan fitur tersebut, Anda harus memanggil shell di baris perintah, misalnya menggunakan "cmd /c MyCommand" di Windows atau "/bin/sh -c MyCommand" di Linux. Jika baris perintah mengacu pada jalur file, baris tersebut harus menggunakan jalur relatif (relatif terhadap direktori kerja Tugas), atau menggunakan variabel lingkungan yang disediakan Batch (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables).
constraints

Batasan eksekusi yang berlaku untuk Tugas ini. Jika Anda tidak menentukan batasan, maxTaskRetryCount adalah maxTaskRetryCount yang ditentukan untuk Pekerjaan, maxWallClockTime tidak terbatas, dan retentionTime adalah 7 hari.
containerSettings

Pengaturan untuk kontainer tempat Tugas berjalan. Jika Kumpulan yang akan menjalankan Tugas ini memiliki kumpulan containerConfiguration, ini juga harus diatur. Jika Kumpulan yang akan menjalankan Tugas ini tidak memiliki kumpulan containerConfiguration, ini tidak boleh diatur. Ketika ini ditentukan, semua direktori secara rekursif di bawah AZ_BATCH_NODE_ROOT_DIR (akar direktori Azure Batch pada simpul) dipetakan ke dalam kontainer, semua variabel lingkungan Tugas dipetakan ke dalam kontainer, dan baris perintah Tugas dijalankan dalam kontainer. File yang diproduksi dalam kontainer di luar AZ_BATCH_NODE_ROOT_DIR mungkin tidak tercermin ke disk host, yang berarti bahwa API file Batch tidak akan dapat mengakses file tersebut.
dependsOn

Tugas yang bergantung pada Tugas ini. Tugas ini tidak akan dijadwalkan sampai semua Tugas yang bergantung padanya berhasil diselesaikan. Jika salah satu Tugas tersebut gagal dan menghabiskan jumlah coba lagi, Tugas ini tidak akan pernah dijadwalkan. Jika Pekerjaan tidak memiliki usesTaskDependencies yang diatur ke true, dan elemen ini ada, permintaan gagal dengan kode kesalahan TaskDependenciesNotSpecifiedOnJob.
displayName

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

Daftar pengaturan variabel lingkungan untuk Tugas.
exitConditions

Bagaimana layanan Batch harus merespons ketika Tugas selesai.
id

String yang secara unik mengidentifikasi Tugas dalam Pekerjaan. 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 Pekerjaan yang hanya berbeda menurut kasus).
multiInstanceSettings

Objek yang menunjukkan bahwa Tugas adalah Tugas multi-instans, dan berisi informasi tentang cara menjalankan Tugas multi-instans.
outputFiles

Daftar file yang akan diunggah layanan Batch dari Simpul Komputasi setelah menjalankan baris perintah. Untuk Tugas multi-instans, file hanya akan diunggah dari Simpul Komputasi tempat Tugas utama dijalankan.
requiredSlots

Jumlah slot penjadwalan yang diperlukan Tugas untuk dijalankan. Defaultnya adalah 1. Tugas hanya dapat dijadwalkan untuk dijalankan pada simpul komputasi jika simpul memiliki slot penjadwalan gratis yang cukup tersedia. Untuk Tugas multi-instans, ini harus 1.
resourceFiles

Daftar file yang akan diunduh layanan Batch ke Simpul Komputasi sebelum menjalankan baris perintah. Untuk Tugas multi-instans, file sumber daya hanya akan diunduh ke Simpul Komputasi tempat Tugas utama dijalankan. Ada ukuran maksimum untuk daftar file sumber daya. Ketika ukuran maksimum terlampaui, permintaan akan gagal dan kode kesalahan respons akan menjadi RequestEntityTooLarge. Jika ini terjadi, kumpulan ResourceFiles harus dikurangi ukurannya. Ini dapat dicapai menggunakan file .zip, Paket Aplikasi, atau Kontainer Docker.
userIdentity

Identitas pengguna tempat Tugas berjalan. Jika dihilangkan, Tugas berjalan sebagai pengguna non-administratif yang unik untuk Tugas.

Detail Properti

affinityInfo

Petunjuk lokalitas yang dapat digunakan oleh layanan Batch untuk memilih Simpul Komputasi tempat memulai Tugas baru.

affinityInfo?: BatchAffinityInfo

Nilai Properti

BatchAffinityInfo

applicationPackageReferences

Daftar Paket yang akan disebarkan layanan Batch ke Simpul Komputasi sebelum menjalankan baris perintah. Paket aplikasi diunduh dan disebarkan ke direktori bersama, bukan direktori kerja Tugas. Oleh karena itu, jika paket yang direferensikan sudah ada di Node, dan sudah diperbarui, maka paket tersebut tidak diunduh ulang; salinan yang ada pada Simpul Komputasi digunakan. Jika Paket yang direferensikan tidak dapat diinstal, misalnya karena paket telah dihapus atau karena pengunduhan gagal, Tugas gagal.

applicationPackageReferences?: BatchApplicationPackageReference[]

Nilai Properti

BatchApplicationPackageReference[]

authenticationTokenSettings

Pengaturan untuk token autentikasi yang dapat digunakan Tugas untuk melakukan operasi layanan Batch. Jika properti ini diatur, layanan Batch menyediakan Tugas dengan token autentikasi yang dapat digunakan untuk mengautentikasi operasi layanan Batch tanpa memerlukan kunci akses Akun. Token disediakan melalui variabel lingkungan AZ_BATCH_AUTHENTICATION_TOKEN. Operasi yang dapat dilakukan Tugas menggunakan token bergantung pada pengaturan. Misalnya, Tugas dapat meminta izin Pekerjaan untuk menambahkan Tugas lain ke Pekerjaan, atau memeriksa status Pekerjaan atau Tugas lain di bawah Pekerjaan.

authenticationTokenSettings?: AuthenticationTokenSettings

Nilai Properti

AuthenticationTokenSettings

commandLine

Baris perintah Tugas. Untuk Tugas multi-instans, baris perintah dijalankan sebagai Tugas utama, setelah Tugas utama dan semua subtugas selesai menjalankan baris perintah koordinasi. Baris perintah tidak berjalan di bawah shell, dan oleh karena itu tidak dapat memanfaatkan fitur shell seperti ekspansi variabel lingkungan. Jika Anda ingin memanfaatkan fitur tersebut, Anda harus memanggil shell di baris perintah, misalnya menggunakan "cmd /c MyCommand" di Windows atau "/bin/sh -c MyCommand" di Linux. Jika baris perintah mengacu pada jalur file, baris tersebut harus menggunakan jalur relatif (relatif terhadap direktori kerja Tugas), atau menggunakan variabel lingkungan yang disediakan Batch (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables).

commandLine: string

Nilai Properti

string

constraints

Batasan eksekusi yang berlaku untuk Tugas ini. Jika Anda tidak menentukan batasan, maxTaskRetryCount adalah maxTaskRetryCount yang ditentukan untuk Pekerjaan, maxWallClockTime tidak terbatas, dan retentionTime adalah 7 hari.

constraints?: BatchTaskConstraints

Nilai Properti

BatchTaskConstraints

containerSettings

Pengaturan untuk kontainer tempat Tugas berjalan. Jika Kumpulan yang akan menjalankan Tugas ini memiliki kumpulan containerConfiguration, ini juga harus diatur. Jika Kumpulan yang akan menjalankan Tugas ini tidak memiliki kumpulan containerConfiguration, ini tidak boleh diatur. Ketika ini ditentukan, semua direktori secara rekursif di bawah AZ_BATCH_NODE_ROOT_DIR (akar direktori Azure Batch pada simpul) dipetakan ke dalam kontainer, semua variabel lingkungan Tugas dipetakan ke dalam kontainer, dan baris perintah Tugas dijalankan dalam kontainer. File yang diproduksi dalam kontainer di luar AZ_BATCH_NODE_ROOT_DIR mungkin tidak tercermin ke disk host, yang berarti bahwa API file Batch tidak akan dapat mengakses file tersebut.

containerSettings?: BatchTaskContainerSettings

Nilai Properti

BatchTaskContainerSettings

dependsOn

Tugas yang bergantung pada Tugas ini. Tugas ini tidak akan dijadwalkan sampai semua Tugas yang bergantung padanya berhasil diselesaikan. Jika salah satu Tugas tersebut gagal dan menghabiskan jumlah coba lagi, Tugas ini tidak akan pernah dijadwalkan. Jika Pekerjaan tidak memiliki usesTaskDependencies yang diatur ke true, dan elemen ini ada, permintaan gagal dengan kode kesalahan TaskDependenciesNotSpecifiedOnJob.

dependsOn?: BatchTaskDependencies

Nilai Properti

BatchTaskDependencies

displayName

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

displayName?: string

Nilai Properti

string

environmentSettings

Daftar pengaturan variabel lingkungan untuk Tugas.

environmentSettings?: EnvironmentSetting[]

Nilai Properti

EnvironmentSetting[]

exitConditions

Bagaimana layanan Batch harus merespons ketika Tugas selesai.

exitConditions?: ExitConditions

Nilai Properti

ExitConditions

id

String yang secara unik mengidentifikasi Tugas dalam Pekerjaan. 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 Pekerjaan yang hanya berbeda menurut kasus).

id: string

Nilai Properti

string

multiInstanceSettings

Objek yang menunjukkan bahwa Tugas adalah Tugas multi-instans, dan berisi informasi tentang cara menjalankan Tugas multi-instans.

multiInstanceSettings?: MultiInstanceSettings

Nilai Properti

MultiInstanceSettings

outputFiles

Daftar file yang akan diunggah layanan Batch dari Simpul Komputasi setelah menjalankan baris perintah. Untuk Tugas multi-instans, file hanya akan diunggah dari Simpul Komputasi tempat Tugas utama dijalankan.

outputFiles?: OutputFile[]

Nilai Properti

OutputFile[]

requiredSlots

Jumlah slot penjadwalan yang diperlukan Tugas untuk dijalankan. Defaultnya adalah 1. Tugas hanya dapat dijadwalkan untuk dijalankan pada simpul komputasi jika simpul memiliki slot penjadwalan gratis yang cukup tersedia. Untuk Tugas multi-instans, ini harus 1.

requiredSlots?: number

Nilai Properti

number

resourceFiles

Daftar file yang akan diunduh layanan Batch ke Simpul Komputasi sebelum menjalankan baris perintah. Untuk Tugas multi-instans, file sumber daya hanya akan diunduh ke Simpul Komputasi tempat Tugas utama dijalankan. Ada ukuran maksimum untuk daftar file sumber daya. Ketika ukuran maksimum terlampaui, permintaan akan gagal dan kode kesalahan respons akan menjadi RequestEntityTooLarge. Jika ini terjadi, kumpulan ResourceFiles harus dikurangi ukurannya. Ini dapat dicapai menggunakan file .zip, Paket Aplikasi, atau Kontainer Docker.

resourceFiles?: ResourceFile[]

Nilai Properti

ResourceFile[]

userIdentity

Identitas pengguna tempat Tugas berjalan. Jika dihilangkan, Tugas berjalan sebagai pengguna non-administratif yang unik untuk Tugas.

userIdentity?: UserIdentity

Nilai Properti

UserIdentity