Pool - Delete

  • Referensi
Service:
Batch Service
API Version:
2022-01-01.15.0

Menghapus Kumpulan dari Akun yang ditentukan.
Saat Anda meminta agar Kumpulan dihapus, tindakan berikut terjadi: status Kumpulan diatur untuk menghapus; setiap operasi pengurangan ukuran yang sedang berlangsung pada Kumpulan dihentikan; layanan Batch mulai mengubah ukuran Kumpulan menjadi nol Simpul Komputasi; Tugas apa pun yang berjalan pada Simpul Komputasi yang ada dihentikan dan diantrekan ulang (seolah-olah operasi Kumpulan Pengurutan Ukuran telah diminta dengan opsi antrean ulang default); akhirnya, Kumpulan dihapus dari sistem. Karena menjalankan Tugas diantrekan ulang, pengguna dapat menjalankan ulang Tugas ini dengan memperbarui Pekerjaan mereka untuk menargetkan Kumpulan yang berbeda. Tugas kemudian dapat berjalan pada Kumpulan baru. Jika Anda ingin mengambil alih perilaku antrean ulang, maka Anda harus memanggil mengubah ukuran Kumpulan secara eksplisit untuk menyusutkan Kumpulan ke ukuran nol sebelum menghapus Kumpulan. Jika Anda memanggil API Pembaruan, Patch, atau Hapus pada Kumpulan dalam status penghapusan, itu akan gagal dengan kode status HTTP 409 dengan kode kesalahan PoolBeingDeleted.

DELETE {batchUrl}/pools/{poolId}?api-version=2022-01-01.15.0
With optional parameters: 
DELETE {batchUrl}/pools/{poolId}?timeout={timeout}&api-version=2022-01-01.15.0

Parameter URI

Name In Required Type Description
batchUrl
 path True
  • string

URL dasar untuk semua permintaan layanan Azure Batch.
poolId
 path True
  • string

ID Kumpulan yang akan dihapus.
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"

Name Required Type Description
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.

Respons

Name Type Description
202 Accepted

Permintaan ke layanan Batch berhasil.

Headers

  • client-request-id: string
  • request-id: string
Other Status Codes

Kesalahan dari layanan Batch.

Keamanan

azure_auth

Azure Active Directory Flow OAuth2

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

Scopes

Name Description
user_impersonation Meniru akun pengguna Anda

Authorization

Type: apiKey
In: header

Contoh

Pool delete

Sample Request

DELETE account.region.batch.azure.com/pools/poolId?api-version=2022-01-01.15.0

Sample Response

Status code:
202

Definisi

BatchError

Respons kesalahan yang 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.

BatchError

Respons kesalahan yang diterima dari layanan Azure Batch.

Name Type Description
code
  • string

Pengidentifikasi untuk kesalahan. Kode tidak berubah dan dimaksudkan untuk dikonsumsi secara terprogram.
message

Pesan yang menjelaskan kesalahan, dimaksudkan agar cocok untuk ditampilkan di antarmuka pengguna.
values

Kumpulan pasangan kunci-nilai yang berisi detail tambahan tentang kesalahan.

BatchErrorDetail

Item informasi tambahan yang disertakan dalam respons kesalahan Azure Batch.

Name Type Description
key
  • string

Pengidentifikasi yang menentukan arti properti Nilai.
value
  • string

Informasi tambahan disertakan dengan respons kesalahan.

ErrorMessage

Pesan kesalahan diterima dalam respons kesalahan Azure Batch.

Name Type Description
lang
  • string

Kode bahasa pesan kesalahan
value
  • string

Teks pesan.