Task - Update

Layanan:

Batch Service

Versi API:

2024-07-01.20.0

Memperbarui properti Tugas yang ditentukan.

PUT {batchUrl}/jobs/{jobId}/tasks/{taskId}?api-version=2024-07-01.20.0

Dengan parameter opsional:

PUT {batchUrl}/jobs/{jobId}/tasks/{taskId}?timeout={timeout}&api-version=2024-07-01.20.0

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
batchUrl	path	True	string	URL dasar untuk semua permintaan layanan Azure Batch.
jobId	path	True	string	ID Pekerjaan yang berisi Tugas.
taskId	path	True	string	ID Tugas yang akan diperbarui.
api-version	query	True	string	Versi API Klien.
timeout	query		integer int32	Waktu maksimum yang dapat dihabiskan server untuk memproses permintaan, dalam hitung detik. Defaultnya adalah 30 detik. Jika nilainya lebih besar dari 30, default akan digunakan sebagai gantinya.

Header Permintaan

Media Types: "application/json; odata=minimalmetadata"

Nama	Diperlukan	Jenis	Deskripsi
client-request-id		string uuid	Identitas permintaan yang dihasilkan penelepon, dalam bentuk GUID tanpa dekorasi seperti kurung kurawal, misalnya 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Apakah server harus mengembalikan client-request-id dalam respons.
ocp-date		string date-time-rfc1123	Waktu permintaan dikeluarkan. Pustaka klien biasanya mengatur ini ke waktu jam sistem saat ini; atur secara eksplisit jika Anda memanggil REST API secara langsung.
If-Match		string	Nilai ETag yang terkait dengan versi sumber daya yang diketahui oleh klien. Operasi akan dilakukan hanya jika ETag sumber daya saat ini pada layanan sama persis dengan nilai yang ditentukan oleh klien.
If-None-Match		string	Nilai ETag yang terkait dengan versi sumber daya yang diketahui oleh klien. Operasi akan dilakukan hanya jika ETag sumber daya saat ini pada layanan tidak cocok dengan nilai yang ditentukan oleh klien.
If-Modified-Since		string date-time-rfc1123	Tanda waktu yang menunjukkan waktu terakhir yang dimodifikasi dari sumber daya yang diketahui oleh klien. Operasi akan dilakukan hanya jika sumber daya pada layanan telah dimodifikasi sejak waktu yang ditentukan.
If-Unmodified-Since		string date-time-rfc1123	Tanda waktu yang menunjukkan waktu terakhir yang dimodifikasi dari sumber daya yang diketahui oleh klien. Operasi akan dilakukan hanya jika sumber daya pada layanan belum dimodifikasi sejak waktu yang ditentukan.

Isi Permintaan

Media Types: "application/json; odata=minimalmetadata"

Nama	Jenis	Deskripsi
constraints	TaskConstraints	Batasan yang berlaku untuk Tugas ini. Jika dihilangkan, Tugas diberikan batasan default. Untuk Tugas multi-instans, memperbarui waktu retensi hanya berlaku untuk Tugas utama dan bukan subtugas.

Respons

Nama	Jenis	Deskripsi
200 OK		Permintaan ke layanan Batch berhasil. Header client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: string
Other Status Codes	BatchError	Kesalahan dari layanan Batch.

Keamanan

azure_auth

Alur kode autentikasi Microsoft Entra OAuth 2.0

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	Meniru akun pengguna Anda

Authorization

Jenis: apiKey
Dalam: header

Contoh

Task update

Permintaan sampel

HTTP

PUT account.region.batch.azure.com/jobs/jobId/tasks/taskId?api-version=2024-07-01.20.0



{
  "constraints": {
    "maxWallClockTime": "PT1H",
    "maxTaskRetryCount": 3,
    "retentionTime": "PT1H"
  }
}

Respon sampel

Kode status:

200

Definisi

Nama	Deskripsi
BatchError	Respons kesalahan diterima dari layanan Azure Batch.
BatchErrorDetail	Item informasi tambahan yang disertakan dalam respons kesalahan Azure Batch.
ErrorMessage	Pesan kesalahan diterima dalam respons kesalahan Azure Batch.
TaskConstraints	Batasan eksekusi untuk diterapkan ke Tugas.
TaskUpdateParameter	Kumpulan perubahan yang akan dibuat pada Tugas.

BatchError

Respons kesalahan diterima dari layanan Azure Batch.

Nama	Jenis	Deskripsi
code	string	Pengidentifikasi untuk kesalahan. Kode invarian dan dimaksudkan untuk dikonsumsi secara terprogram.
message	ErrorMessage	Pesan yang menjelaskan kesalahan, dimaksudkan agar cocok untuk ditampilkan di antarmuka pengguna.
values	BatchErrorDetail[]	Kumpulan pasangan kunci-nilai yang berisi detail tambahan tentang kesalahan.

BatchErrorDetail

Item informasi tambahan yang disertakan dalam respons kesalahan Azure Batch.

Nama	Jenis	Deskripsi
key	string	Pengidentifikasi yang menentukan arti properti Nilai.
value	string	Informasi tambahan yang disertakan dengan respons kesalahan.

ErrorMessage

Pesan kesalahan diterima dalam respons kesalahan Azure Batch.

Nama	Jenis	Deskripsi
lang	string	Kode bahasa pesan kesalahan
value	string	Teks pesan.

TaskConstraints

Batasan eksekusi untuk diterapkan ke Tugas.

Nama	Jenis	Deskripsi
maxTaskRetryCount	integer	Jumlah maksimum kali Tugas dapat dicoba kembali. Layanan Batch mencoba kembali Tugas jika kode keluarnya bukan nol. Perhatikan bahwa nilai ini secara khusus mengontrol jumlah percobaan ulang untuk Tugas yang dapat dieksekusi karena kode keluar bukan nol. Layanan Batch akan mencoba Tugas sekali, dan kemudian dapat mencoba kembali hingga batas ini. Misalnya, jika jumlah coba lagi maksimum adalah 3, Batch mencoba Tugas hingga 4 kali (satu percobaan awal dan 3 percobaan ulang). Jika jumlah percobaan kembali maksimum adalah 0, layanan Batch tidak mencoba kembali Tugas setelah upaya pertama. Jika jumlah percobaan kembali maksimum adalah -1, layanan Batch mencoba kembali Tugas tanpa batas, namun ini tidak disarankan untuk tugas mulai atau tugas apa pun. Nilai defaultnya adalah 0 (tidak ada percobaan ulang).
maxWallClockTime	string	Waktu maksimum yang berlalu yang dapat dijalankan Tugas, diukur sejak Tugas dimulai. Jika Tugas tidak selesai dalam batas waktu, layanan Batch mengakhirinya. Jika ini tidak ditentukan, tidak ada batas waktu berapa lama Tugas dapat berjalan.
retentionTime	string	Waktu minimum untuk mempertahankan direktori Tugas pada Simpul Komputasi tempatnya berjalan, sejak selesai dieksekusi. Setelah waktu ini, layanan Batch dapat menghapus direktori Tugas dan semua kontennya. Defaultnya adalah 7 hari, yaitu direktori Tugas akan dipertahankan selama 7 hari kecuali Simpul Komputasi dihapus atau Pekerjaan dihapus.

TaskUpdateParameter

Kumpulan perubahan yang akan dibuat pada Tugas.

Nama	Jenis	Deskripsi
constraints	TaskConstraints	Batasan yang berlaku untuk Tugas ini. Jika dihilangkan, Tugas diberikan batasan default. Untuk Tugas multi-instans, memperbarui waktu retensi hanya berlaku untuk Tugas utama dan bukan subtugas.