Job - Disable

Service:

Batch Service

API Version:

2023-11-01.18.0

Menonaktifkan Pekerjaan yang ditentukan, mencegah Tugas baru berjalan.
Layanan Batch segera memindahkan Pekerjaan ke status pennonaktifkan. Batch kemudian menggunakan parameter disableTasks untuk menentukan apa yang harus dilakukan dengan Tugas Pekerjaan yang sedang berjalan. Pekerjaan tetap dalam status penonaktifan hingga operasi penonaktifan selesai dan semua Tugas telah ditangani sesuai dengan opsi disableTasks; Pekerjaan kemudian berpindah ke status dinonaktifkan. Tidak ada Tugas baru yang dimulai di bawah Pekerjaan hingga berpindah kembali ke status aktif. Jika Anda mencoba menonaktifkan Pekerjaan yang berada dalam status apa pun selain aktif, menonaktifkan, atau menonaktifkan, permintaan gagal dengan kode status 409.

POST {batchUrl}/jobs/{jobId}/disable?api-version=2023-11-01.18.0

With optional parameters:

POST {batchUrl}/jobs/{jobId}/disable?timeout={timeout}&api-version=2023-11-01.18.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 akan dinonaktifkan.
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.

Header Permintaan

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

Nama	Diperlukan	Jenis	Deskripsi
client-request-id		string uuid	Identitas permintaan yang dihasilkan pemanggil, 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 modifikasi terakhir 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 modifikasi terakhir 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	Diperlukan	Jenis	Deskripsi
disableTasks	True	DisableJobOption	Apa yang harus dilakukan dengan Tugas aktif yang terkait dengan Pekerjaan.

Respons

Nama	Jenis	Deskripsi
202 Accepted		Permintaan ke layanan Batch berhasil. Headers 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

Microsoft Entra alur kode autentikasi OAuth 2.0

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nama	Deskripsi
user_impersonation	Meniru akun pengguna Anda

Authorization

Type: apiKey
In: header

Contoh

Job disable

Sample Request

HTTP

POST account.region.batch.azure.com/jobs/jobId/disable?api-version=2023-11-01.18.0



{
  "disableTasks": "terminate"
}

Sample Response

Status code:

202

Definisi

Nama	Deskripsi
BatchError	Respons kesalahan yang diterima dari layanan Azure Batch.
BatchErrorDetail	Item informasi tambahan yang disertakan dalam respons kesalahan Azure Batch.
DisableJobOption	Apa yang harus dilakukan dengan Tugas aktif yang terkait dengan Pekerjaan.
ErrorMessage	Pesan kesalahan diterima dalam respons kesalahan Azure Batch.
JobDisableParameter	Opsi saat menonaktifkan Pekerjaan.

BatchError

Respons kesalahan yang diterima dari layanan Azure Batch.

Nama	Jenis	Deskripsi
code	string	Pengidentifikasi untuk kesalahan. Kode tidak berubah 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 disertakan dengan respons kesalahan.

DisableJobOption

Apa yang harus dilakukan dengan Tugas aktif yang terkait dengan Pekerjaan.

Nama	Jenis	Deskripsi
requeue	string	Hentikan tugas yang sedang berjalan dan antre kembali. Tugas akan berjalan lagi ketika Pekerjaan diaktifkan.
terminate	string	Hentikan tugas yang sedang berjalan. Tugas akan diselesaikan dengan failureInfo yang menunjukkan bahwa tugas dihentikan, dan tidak akan berjalan lagi.
wait	string	Perbolehkan Tugas yang sedang berjalan selesai.

ErrorMessage

Pesan kesalahan diterima dalam respons kesalahan Azure Batch.

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

JobDisableParameter

Opsi saat menonaktifkan Pekerjaan.

Nama	Jenis	Deskripsi
disableTasks	DisableJobOption	Apa yang harus dilakukan dengan Tugas aktif yang terkait dengan Pekerjaan.