TaskOperations Kelas

Operasi TaskOperations.

Anda tidak boleh membuat instans langsung kelas ini, tetapi membuat instans Klien yang akan membuatnya untuk Anda dan melampirkannya sebagai atribut.

Warisan

builtins.object

TaskOperations

Konstruktor

TaskOperations(client, config, serializer, deserializer)

Parameter

client

Diperlukan

Klien untuk permintaan layanan.

config

Diperlukan

Konfigurasi klien layanan.

serializer

Diperlukan

Serializer model objek.

deserializer

Diperlukan

Deserializer model objek.

Variabel

api_version

Versi API yang digunakan untuk permintaan. Nilai konstanta: "2023-05-01.17.0".

Metode

add	Menambahkan Tugas ke Pekerjaan yang ditentukan. Masa pakai maksimum Tugas dari penambahan hingga penyelesaian adalah 180 hari. Jika Tugas belum selesai dalam waktu 180 hari setelah ditambahkan, tugas tersebut akan dihentikan oleh layanan Batch dan dibiarkan dalam keadaan apa pun itu pada saat itu.
add_collection	Menambahkan kumpulan tugas ke pekerjaan yang ditentukan. Perhatikan bahwa setiap tugas harus memiliki ID unik. Layanan Batch mungkin tidak mengembalikan hasil untuk setiap tugas dalam urutan yang sama dengan tugas yang dikirimkan dalam permintaan ini. Jika waktu server habis atau koneksi ditutup selama permintaan, permintaan mungkin telah diproses sebagian atau sepenuhnya, atau tidak sama sekali. Dalam kasus seperti itu, pengguna harus mengeluarkan kembali permintaan. Perhatikan bahwa terserah pengguna untuk menangani kegagalan dengan benar saat mengeluarkan kembali permintaan. Misalnya, Anda harus menggunakan ID tugas yang sama selama coba lagi sehingga jika operasi sebelumnya berhasil, coba lagi tidak akan membuat tugas tambahan secara tiba-tiba. Jika respons berisi tugas apa pun yang gagal ditambahkan, klien dapat mencoba kembali permintaan tersebut. Dalam coba lagi, paling efisien untuk mengirim ulang hanya tugas yang gagal ditambahkan, dan untuk menghilangkan tugas yang berhasil ditambahkan pada upaya pertama. Masa pakai maksimum tugas dari penambahan hingga penyelesaian adalah 180 hari. Jika tugas belum selesai dalam waktu 180 hari setelah ditambahkan, tugas akan dihentikan oleh layanan Batch dan dibiarkan dalam keadaan apa pun itu pada saat itu.
delete	Menghapus Tugas dari Pekerjaan yang ditentukan. Saat Tugas dihapus, semua file di direktorinya pada Simpul Komputasi tempat tugas dijalankan juga dihapus (terlepas dari waktu retensi). Untuk Tugas multi-instans, operasi hapus Tugas berlaku secara sinkron ke tugas utama; subtugas dan filenya kemudian dihapus secara asinkron di latar belakang.
get	Mendapatkan informasi tentang Tugas yang ditentukan. Untuk Tugas multi-instans, informasi seperti affinityId, executionInfo, dan nodeInfo merujuk ke Tugas utama. Gunakan API subtugas daftar untuk mengambil informasi tentang subtugas.
list	Mencantumkan semua Tugas yang terkait dengan Pekerjaan yang ditentukan. Untuk Tugas multi-instans, informasi seperti affinityId, executionInfo, dan nodeInfo merujuk ke Tugas utama. Gunakan API subtugas daftar untuk mengambil informasi tentang subtugas.
list_subtasks	Mencantumkan semua subtugas yang terkait dengan Tugas multi-instans yang ditentukan. Jika Tugas bukan Tugas multi-instans, maka ini mengembalikan koleksi kosong.
reactivate	Mengaktifkan kembali Tugas, memungkinkannya berjalan lagi meskipun jumlah coba lagi telah habis. Pengaktifan ulang membuat Tugas memenuhi syarat untuk dicoba lagi hingga jumlah percobaan kembali maksimumnya. Status Tugas diubah menjadi aktif. Karena Tugas tidak lagi dalam status selesai, kode keluar atau informasi kegagalan sebelumnya tidak lagi tersedia setelah pengaktifan ulang. Setiap kali Tugas diaktifkan kembali, jumlah coba lagi direset ke 0. Pengaktifan ulang akan gagal untuk Tugas yang tidak selesai atau yang sebelumnya berhasil diselesaikan (dengan kode keluar 0). Selain itu, ini akan gagal jika Pekerjaan telah selesai (atau mengakhiri atau menghapus).
terminate	Mengakhiri Tugas yang ditentukan. Ketika Tugas telah dihentikan, tugas akan berpindah ke status selesai. Untuk Tugas multi-instans, operasi hentikan Tugas berlaku secara sinkron ke tugas utama; subtugas kemudian dihentikan secara asinkron di latar belakang.
update	Updates properti Tugas yang ditentukan.

add

Menambahkan Tugas ke Pekerjaan yang ditentukan.

Masa pakai maksimum Tugas dari penambahan hingga penyelesaian adalah 180 hari. Jika Tugas belum selesai dalam waktu 180 hari setelah ditambahkan, tugas tersebut akan dihentikan oleh layanan Batch dan dibiarkan dalam keadaan apa pun itu pada saat itu.

add(job_id, task, task_add_options=None, custom_headers=None, raw=False, **operation_config)

Parameter

job_id

str

Diperlukan

ID Pekerjaan tempat Tugas akan ditambahkan.

task

TaskAddParameter

Diperlukan

Tugas yang akan ditambahkan.

task_add_options

TaskAddOptions

nilai default: None

Parameter tambahan untuk operasi

custom_headers

dict

nilai default: None

header yang akan ditambahkan ke permintaan

raw

bool

nilai default: False

mengembalikan respons langsung bersama respons yang dideserialisasi

operation_config

Diperlukan

Penimpaan konfigurasi operasi.

Mengembalikan

Tidak ada atau ClientRawResponse jika raw=true

Tipe hasil

None,

ClientRawResponse

Pengecualian

BatchErrorException

add_collection

Menambahkan kumpulan tugas ke pekerjaan yang ditentukan.

Perhatikan bahwa setiap tugas harus memiliki ID unik. Layanan Batch mungkin tidak mengembalikan hasil untuk setiap tugas dalam urutan yang sama dengan tugas yang dikirimkan dalam permintaan ini. Jika waktu server habis atau koneksi ditutup selama permintaan, permintaan mungkin telah diproses sebagian atau sepenuhnya, atau tidak sama sekali. Dalam kasus seperti itu, pengguna harus mengeluarkan kembali permintaan. Perhatikan bahwa terserah pengguna untuk menangani kegagalan dengan benar saat mengeluarkan kembali permintaan. Misalnya, Anda harus menggunakan ID tugas yang sama selama coba lagi sehingga jika operasi sebelumnya berhasil, coba lagi tidak akan membuat tugas tambahan secara tiba-tiba. Jika respons berisi tugas apa pun yang gagal ditambahkan, klien dapat mencoba kembali permintaan tersebut. Dalam coba lagi, paling efisien untuk mengirim ulang hanya tugas yang gagal ditambahkan, dan untuk menghilangkan tugas yang berhasil ditambahkan pada upaya pertama. Masa pakai maksimum tugas dari penambahan hingga penyelesaian adalah 180 hari. Jika tugas belum selesai dalam waktu 180 hari setelah ditambahkan, tugas akan dihentikan oleh layanan Batch dan dibiarkan dalam keadaan apa pun itu pada saat itu.

add_collection(job_id, value, task_add_collection_options=None, custom_headers=None, raw=False, threads=0, **operation_config)

Parameter

job_id

str

Diperlukan

ID pekerjaan tempat kumpulan tugas akan ditambahkan.

value

list of TaskAddParameter

Diperlukan

Kumpulan tugas yang akan ditambahkan. Ukuran total yang diserialisasikan dari koleksi ini harus kurang dari 4MB. Jika lebih besar dari 4MB (misalnya jika setiap tugas memiliki 100 file sumber daya atau variabel lingkungan), permintaan akan gagal dengan kode 'RequestBodyTooLarge' dan harus dicoba lagi dengan tugas yang lebih sedikit.

task_add_collection_options

TaskAddCollectionOptions

nilai default: None

Parameter tambahan untuk operasi

custom_headers

dict

nilai default: None

header yang akan ditambahkan ke permintaan

raw

bool

nilai default: False

mengembalikan respons langsung bersama respons yang dideserialisasi

threads

int

nilai default: 0

jumlah utas yang akan digunakan secara paralel saat menambahkan tugas. Jika ditentukan dan lebih besar dari 0, akan memulai utas tambahan untuk mengirimkan permintaan dan menunggunya selesai. Jika tidak, akan mengirimkan permintaan add_collection secara berurutan pada utas utama

Mengembalikan

TaskAddCollectionResult atau ClientRawResponse jika raw=true

Tipe hasil

TaskAddCollectionResult,

ClientRawResponse

Pengecualian

azure.batch.custom.CreateTasksErrorException

delete

Menghapus Tugas dari Pekerjaan yang ditentukan.

Saat Tugas dihapus, semua file di direktorinya pada Simpul Komputasi tempat tugas dijalankan juga dihapus (terlepas dari waktu retensi). Untuk Tugas multi-instans, operasi hapus Tugas berlaku secara sinkron ke tugas utama; subtugas dan filenya kemudian dihapus secara asinkron di latar belakang.

delete(job_id, task_id, task_delete_options=None, custom_headers=None, raw=False, **operation_config)

Parameter

job_id

str

Diperlukan

ID Pekerjaan tempat menghapus Tugas.

task_id

str

Diperlukan

ID Tugas yang akan dihapus.

task_delete_options

TaskDeleteOptions

nilai default: None

Parameter tambahan untuk operasi

custom_headers

dict

nilai default: None

header yang akan ditambahkan ke permintaan

raw

bool

nilai default: False

mengembalikan respons langsung bersama respons yang dideserialisasi

operation_config

Diperlukan

Penimpaan konfigurasi operasi.

Mengembalikan

Tidak ada atau ClientRawResponse jika raw=true

Tipe hasil

None,

ClientRawResponse

Pengecualian

BatchErrorException

get

Mendapatkan informasi tentang Tugas yang ditentukan.

Untuk Tugas multi-instans, informasi seperti affinityId, executionInfo, dan nodeInfo merujuk ke Tugas utama. Gunakan API subtugas daftar untuk mengambil informasi tentang subtugas.

get(job_id, task_id, task_get_options=None, custom_headers=None, raw=False, **operation_config)

Parameter

job_id

str

Diperlukan

ID Pekerjaan yang berisi Tugas.

task_id

str

Diperlukan

ID Tugas untuk mendapatkan informasi tentang.

task_get_options

TaskGetOptions

nilai default: None

Parameter tambahan untuk operasi

custom_headers

dict

nilai default: None

header yang akan ditambahkan ke permintaan

raw

bool

nilai default: False

mengembalikan respons langsung bersama respons yang dideserialisasi

operation_config

Diperlukan

Penimpaan konfigurasi operasi.

Mengembalikan

CloudTask atau ClientRawResponse jika raw=true

Tipe hasil

CloudTask,

ClientRawResponse

Pengecualian

BatchErrorException

list

Mencantumkan semua Tugas yang terkait dengan Pekerjaan yang ditentukan.

Untuk Tugas multi-instans, informasi seperti affinityId, executionInfo, dan nodeInfo merujuk ke Tugas utama. Gunakan API subtugas daftar untuk mengambil informasi tentang subtugas.

list(job_id, task_list_options=None, custom_headers=None, raw=False, **operation_config)

Parameter

job_id

str

Diperlukan

ID Pekerjaan.

task_list_options

TaskListOptions

nilai default: None

Parameter tambahan untuk operasi

custom_headers

dict

nilai default: None

header yang akan ditambahkan ke permintaan

raw

bool

nilai default: False

mengembalikan respons langsung bersama respons yang dideserialisasi

operation_config

Diperlukan

Penimpaan konfigurasi operasi.

Mengembalikan

Iterator seperti instans CloudTask

Tipe hasil

CloudTaskPaged[CloudTask]

Pengecualian

BatchErrorException

list_subtasks

Mencantumkan semua subtugas yang terkait dengan Tugas multi-instans yang ditentukan.

Jika Tugas bukan Tugas multi-instans, maka ini mengembalikan koleksi kosong.

list_subtasks(job_id, task_id, task_list_subtasks_options=None, custom_headers=None, raw=False, **operation_config)

Parameter

job_id

str

Diperlukan

ID Pekerjaan.

task_id

str

Diperlukan

ID Tugas.

task_list_subtasks_options

TaskListSubtasksOptions

nilai default: None

Parameter tambahan untuk operasi

custom_headers

dict

nilai default: None

header yang akan ditambahkan ke permintaan

raw

bool

nilai default: False

mengembalikan respons langsung bersama respons yang dideserialisasi

operation_config

Diperlukan

Penimpaan konfigurasi operasi.

Mengembalikan

CloudTaskListSubtasksResult atau ClientRawResponse jika raw=true

Tipe hasil

CloudTaskListSubtasksResult,

ClientRawResponse

Pengecualian

BatchErrorException

reactivate

Mengaktifkan kembali Tugas, memungkinkannya berjalan lagi meskipun jumlah coba lagi telah habis.

Pengaktifan ulang membuat Tugas memenuhi syarat untuk dicoba lagi hingga jumlah percobaan kembali maksimumnya. Status Tugas diubah menjadi aktif. Karena Tugas tidak lagi dalam status selesai, kode keluar atau informasi kegagalan sebelumnya tidak lagi tersedia setelah pengaktifan ulang. Setiap kali Tugas diaktifkan kembali, jumlah coba lagi direset ke 0. Pengaktifan ulang akan gagal untuk Tugas yang tidak selesai atau yang sebelumnya berhasil diselesaikan (dengan kode keluar 0). Selain itu, ini akan gagal jika Pekerjaan telah selesai (atau mengakhiri atau menghapus).

reactivate(job_id, task_id, task_reactivate_options=None, custom_headers=None, raw=False, **operation_config)

Parameter

job_id

str

Diperlukan

ID Pekerjaan yang berisi Tugas.

task_id

str

Diperlukan

ID Tugas yang akan diaktifkan kembali.

task_reactivate_options

TaskReactivateOptions

nilai default: None

Parameter tambahan untuk operasi

custom_headers

dict

nilai default: None

header yang akan ditambahkan ke permintaan

raw

bool

nilai default: False

mengembalikan respons langsung bersama respons yang dideserialisasi

operation_config

Diperlukan

Penimpaan konfigurasi operasi.

Mengembalikan

Tidak ada atau ClientRawResponse jika raw=true

Tipe hasil

None,

ClientRawResponse

Pengecualian

BatchErrorException

terminate

Mengakhiri Tugas yang ditentukan.

Ketika Tugas telah dihentikan, tugas akan berpindah ke status selesai. Untuk Tugas multi-instans, operasi hentikan Tugas berlaku secara sinkron ke tugas utama; subtugas kemudian dihentikan secara asinkron di latar belakang.

terminate(job_id, task_id, task_terminate_options=None, custom_headers=None, raw=False, **operation_config)

Parameter

job_id

str

Diperlukan

ID Pekerjaan yang berisi Tugas.

task_id

str

Diperlukan

ID Tugas yang akan dihentikan.

task_terminate_options

TaskTerminateOptions

nilai default: None

Parameter tambahan untuk operasi

custom_headers

dict

nilai default: None

header yang akan ditambahkan ke permintaan

raw

bool

nilai default: False

mengembalikan respons langsung bersama respons yang dideserialisasi

operation_config

Diperlukan

Penimpaan konfigurasi operasi.

Mengembalikan

Tidak ada atau ClientRawResponse jika raw=true

Tipe hasil

None,

ClientRawResponse

Pengecualian

BatchErrorException

update

Updates properti Tugas yang ditentukan.

update(job_id, task_id, constraints=None, task_update_options=None, custom_headers=None, raw=False, **operation_config)

Parameter

job_id

str

Diperlukan

ID Pekerjaan yang berisi Tugas.

task_id

str

Diperlukan

ID Tugas yang akan diperbarui.

constraints

TaskConstraints

nilai default: None

Batasan yang berlaku untuk Tugas ini. Jika dihilangkan, Tugas diberi batasan default. Untuk Tugas multi-instans, memperbarui waktu retensi hanya berlaku untuk Tugas utama dan bukan subtugas.

task_update_options

TaskUpdateOptions

nilai default: None

Parameter tambahan untuk operasi

custom_headers

dict

nilai default: None

header yang akan ditambahkan ke permintaan

raw

bool

nilai default: False

mengembalikan respons langsung bersama respons yang dideserialisasi

operation_config

Diperlukan

Pengabaian konfigurasi operasi.

Mengembalikan

Tidak ada atau ClientRawResponse jika raw=true

Tipe hasil

None,

ClientRawResponse

Pengecualian

BatchErrorException

Atribut

models

models = <module 'azure.batch.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\batch\\models\\__init__.py'>