Bagikan melalui

BatchTaskOutput interface

Paket:
@azure-rest/batch

Batch akan mencoba kembali Tugas ketika operasi pemulihan dipicu pada Node. Contoh operasi pemulihan termasuk (tetapi tidak terbatas pada) ketika Node yang tidak sehat di-boot ulang atau Simpul Komputasi menghilang karena kegagalan host. Percobaan ulang karena operasi pemulihan tidak bergantung pada dan tidak dihitung terhadap maxTaskRetryCount. Bahkan jika maxTaskRetryCount adalah 0, coba lagi internal karena operasi pemulihan dapat terjadi. Karena itu, semua Tugas harus idempotoen. Ini berarti Tugas perlu mentolerir terganggu dan dimulai ulang tanpa menyebabkan kerusakan atau data duplikat. Praktik terbaik untuk Tugas yang berjalan lama adalah menggunakan beberapa bentuk titik pemeriksaan.

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.
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.
creationTime

Waktu pembuatan Tugas.
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.
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.
eTag

ETag Tugas. Ini adalah string buram. Anda dapat menggunakannya untuk mendeteksi apakah Tugas telah berubah di antara permintaan. Secara khusus, Anda dapat meneruskan ETag saat memperbarui Tugas untuk menentukan bahwa perubahan Anda harus berlaku hanya jika tidak ada orang lain yang mengubah Tugas sementara itu.
executionInfo

Informasi tentang eksekusi 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.
lastModified

Waktu terakhir yang dimodifikasi dari Tugas.
multiInstanceSettings

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

Informasi tentang Simpul Komputasi tempat Tugas dijalankan.
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.
previousState

Status Tugas sebelumnya. Properti ini tidak diatur jika Tugas dalam status Aktif awal.

Nilai yang mungkin: "active", "preparing", "running", "completed"
previousStateTransitionTime

Waktu saat Tugas memasuki status sebelumnya. Properti ini tidak diatur jika Tugas dalam status Aktif awal.
requiredSlots

Jumlah slot penjadwalan yang perlu dijalankan Tugas. 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.
state

Status Tugas saat ini.

Nilai yang mungkin: "active", "preparing", "running", "completed"
stateTransitionTime

Waktu saat Tugas memasuki statusnya saat ini.
stats

Statistik penggunaan sumber daya untuk Tugas.
url

URL Tugas.
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?: BatchAffinityInfoOutput

Nilai Properti

BatchAffinityInfoOutput

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?: BatchApplicationPackageReferenceOutput[]

Nilai Properti

BatchApplicationPackageReferenceOutput[]

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?: AuthenticationTokenSettingsOutput

Nilai Properti

AuthenticationTokenSettingsOutput

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.

constraints?: BatchTaskConstraintsOutput

Nilai Properti

BatchTaskConstraintsOutput

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?: BatchTaskContainerSettingsOutput

Nilai Properti

BatchTaskContainerSettingsOutput

creationTime

Waktu pembuatan Tugas.

creationTime: string

Nilai Properti

string

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.

dependsOn?: BatchTaskDependenciesOutput

Nilai Properti

BatchTaskDependenciesOutput

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?: EnvironmentSettingOutput[]

Nilai Properti

EnvironmentSettingOutput[]

eTag

ETag Tugas. Ini adalah string buram. Anda dapat menggunakannya untuk mendeteksi apakah Tugas telah berubah di antara permintaan. Secara khusus, Anda dapat meneruskan ETag saat memperbarui Tugas untuk menentukan bahwa perubahan Anda harus berlaku hanya jika tidak ada orang lain yang mengubah Tugas sementara itu.

eTag: string

Nilai Properti

string

executionInfo

Informasi tentang eksekusi Tugas.

executionInfo?: BatchTaskExecutionInfoOutput

Nilai Properti

BatchTaskExecutionInfoOutput

exitConditions

Bagaimana layanan Batch harus merespons ketika Tugas selesai.

exitConditions?: ExitConditionsOutput

Nilai Properti

ExitConditionsOutput

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: string

Nilai Properti

string

lastModified

Waktu terakhir yang dimodifikasi dari Tugas.

lastModified: string

Nilai Properti

string

multiInstanceSettings

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

multiInstanceSettings?: MultiInstanceSettingsOutput

Nilai Properti

MultiInstanceSettingsOutput

nodeInfo

Informasi tentang Simpul Komputasi tempat Tugas dijalankan.

nodeInfo?: BatchNodeInfoOutput

Nilai Properti

BatchNodeInfoOutput

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?: OutputFileOutput[]

Nilai Properti

OutputFileOutput[]

previousState

Status Tugas sebelumnya. Properti ini tidak diatur jika Tugas dalam status Aktif awal.

Nilai yang mungkin: "active", "preparing", "running", "completed"

previousState?: string

Nilai Properti

string

previousStateTransitionTime

Waktu saat Tugas memasuki status sebelumnya. Properti ini tidak diatur jika Tugas dalam status Aktif awal.

previousStateTransitionTime?: string

Nilai Properti

string

requiredSlots

Jumlah slot penjadwalan yang perlu dijalankan Tugas. 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?: ResourceFileOutput[]

Nilai Properti

ResourceFileOutput[]

state

Status Tugas saat ini.

Nilai yang mungkin: "active", "preparing", "running", "completed"

state: string

Nilai Properti

string

stateTransitionTime

Waktu saat Tugas memasuki statusnya saat ini.

stateTransitionTime: string

Nilai Properti

string

stats

Statistik penggunaan sumber daya untuk Tugas.

stats?: BatchTaskStatisticsOutput

Nilai Properti

BatchTaskStatisticsOutput

url

URL Tugas.

url: string

Nilai Properti

string

userIdentity

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

userIdentity?: UserIdentityOutput

Nilai Properti

UserIdentityOutput