PoolOperations Kelas
Operasi PoolOperations.
Anda tidak boleh membuat instans langsung kelas ini, tetapi membuat instans Klien yang akan membuatnya untuk Anda dan melampirkannya sebagai atribut.
- Warisan
-
builtins.objectPoolOperations
Konstruktor
PoolOperations(client, config, serializer, deserializer)Parameter
- client
Klien untuk permintaan layanan.
- config
Konfigurasi klien layanan.
- serializer
Serializer model objek.
- deserializer
Deserializer model objek.
Variabel
- api_version
Versi API yang digunakan untuk permintaan. Nilai konstanta: "2023-05-01.17.0".
Metode
| add |
Menambahkan Kumpulan ke Akun yang ditentukan. Saat menamai Kumpulan, hindari menyertakan informasi sensitif seperti nama pengguna atau nama proyek rahasia. Informasi ini mungkin muncul dalam log telemetri yang dapat diakses oleh teknisi Dukungan Microsoft. |
| delete |
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. |
| disable_auto_scale |
Menonaktifkan penskalaan otomatis untuk Kumpulan. |
| enable_auto_scale |
Mengaktifkan penskalaan otomatis untuk Kumpulan. Anda tidak dapat mengaktifkan penskalan otomatis pada Kumpulan jika operasi pengurangan ukuran sedang berlangsung pada Kumpulan. Jika penskalaan otomatis Kumpulan saat ini dinonaktifkan, Anda harus menentukan rumus skala otomatis yang valid sebagai bagian dari permintaan. Jika penskalaan otomatis Kumpulan sudah diaktifkan, Anda dapat menentukan rumus skala otomatis baru dan/atau interval evaluasi baru. Anda tidak dapat memanggil API ini untuk Kumpulan yang sama lebih dari sekali setiap 30 detik. |
| evaluate_auto_scale |
Mendapatkan hasil mengevaluasi rumus penskalaan otomatis pada Kumpulan. API ini terutama untuk memvalidasi rumus skala otomatis, karena hanya mengembalikan hasil tanpa menerapkan rumus ke Kumpulan. Kumpulan harus mengaktifkan penskalaan otomatis untuk mengevaluasi rumus. |
| exists |
Mendapatkan properti dasar Kumpulan. |
| get |
Mendapatkan informasi tentang Kumpulan yang ditentukan. |
| list |
Mencantumkan semua Kumpulan di Akun yang ditentukan. |
| list_usage_metrics |
Mencantumkan metrik penggunaan, yang dikumpulkan oleh Kumpulan di seluruh interval waktu individual, untuk Akun yang ditentukan. Jika Anda tidak menentukan klausa $filter termasuk poolId, respons menyertakan semua Kumpulan yang ada di Akun dalam rentang waktu interval agregasi yang dikembalikan. Jika Anda tidak menentukan klausa $filter termasuk startTime atau endTime, filter ini default ke waktu mulai dan berakhir dari interval agregasi terakhir yang saat ini tersedia; yaitu, hanya interval agregasi terakhir yang dikembalikan. |
| patch |
Updates properti Kumpulan yang ditentukan. Ini hanya menggantikan properti Kumpulan yang ditentukan dalam permintaan. Misalnya, jika Kumpulan memiliki StartTask yang terkait dengannya, dan permintaan tidak menentukan elemen StartTask, maka Kumpulan menyimpan StartTask yang ada. |
| remove_nodes |
Menghapus Simpul Komputasi dari Kumpulan yang ditentukan. Operasi ini hanya dapat berjalan ketika status alokasi Kumpulan stabil. Ketika operasi ini berjalan, status alokasi berubah dari stabil menjadi mengubah ukuran. Setiap permintaan dapat menghapus hingga 100 simpul. |
| resize |
Mengubah jumlah Simpul Komputasi yang ditetapkan ke Kumpulan. Anda hanya dapat mengubah ukuran Kumpulan saat status alokasinya stabil. Jika Kumpulan sudah mengubah ukuran, permintaan gagal dengan kode status 409. Saat Anda mengubah ukuran Kumpulan, status alokasi Kumpulan berubah dari stabil menjadi mengubah ukuran. Anda tidak dapat mengubah ukuran Kumpulan yang dikonfigurasi untuk penskalaan otomatis. Jika Anda mencoba melakukan ini, layanan Batch mengembalikan kesalahan 409. Jika Anda mengubah ukuran Kumpulan ke bawah, layanan Batch memilih Simpul Komputasi mana yang akan dihapus. Untuk menghapus Simpul Komputasi tertentu, gunakan POOL remove Compute Nodes API sebagai gantinya. |
| stop_resize |
Menghentikan operasi mengubah ukuran yang sedang berlangsung pada Kumpulan. Ini tidak memulihkan Kumpulan ke status sebelumnya sebelum operasi pengubahan ukuran: ini hanya menghentikan perubahan lebih lanjut yang dilakukan, dan Kumpulan mempertahankan statusnya saat ini. Setelah berhenti, Kumpulan stabil pada jumlah Simpul Komputasi saat operasi berhenti dilakukan. Selama operasi berhenti, status alokasi Kumpulan berubah terlebih dahulu menjadi berhenti dan kemudian stabil. Operasi pengubahan ukuran tidak perlu menjadi permintaan Kumpulan pengubahan ukuran eksplisit; API ini juga dapat digunakan untuk menghentikan ukuran awal Kumpulan saat dibuat. |
| update_properties |
Updates properti Kumpulan yang ditentukan. Ini sepenuhnya menggantikan semua properti Kumpulan yang dapat diperbarui. Misalnya, jika Kumpulan memiliki StartTask yang terkait dengannya dan jika StartTask tidak ditentukan dengan permintaan ini, maka layanan Batch akan menghapus StartTask yang ada. |
add
Menambahkan Kumpulan ke Akun yang ditentukan.
Saat menamai Kumpulan, hindari menyertakan informasi sensitif seperti nama pengguna atau nama proyek rahasia. Informasi ini mungkin muncul dalam log telemetri yang dapat diakses oleh teknisi Dukungan Microsoft.
add(pool, pool_add_options=None, custom_headers=None, raw=False, **operation_config)Parameter
- operation_config
Penimpaan konfigurasi operasi.
Mengembalikan
Tidak ada atau ClientRawResponse jika raw=true
Tipe hasil
Pengecualian
delete
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(pool_id, pool_delete_options=None, custom_headers=None, raw=False, **operation_config)Parameter
- operation_config
Penimpaan konfigurasi operasi.
Mengembalikan
Tidak ada atau ClientRawResponse jika raw=true
Tipe hasil
Pengecualian
disable_auto_scale
Menonaktifkan penskalaan otomatis untuk Kumpulan.
disable_auto_scale(pool_id, pool_disable_auto_scale_options=None, custom_headers=None, raw=False, **operation_config)Parameter
- pool_disable_auto_scale_options
- PoolDisableAutoScaleOptions
Parameter tambahan untuk operasi
- operation_config
Penimpaan konfigurasi operasi.
Mengembalikan
Tidak ada atau ClientRawResponse jika raw=true
Tipe hasil
Pengecualian
enable_auto_scale
Mengaktifkan penskalaan otomatis untuk Kumpulan.
Anda tidak dapat mengaktifkan penskalan otomatis pada Kumpulan jika operasi pengurangan ukuran sedang berlangsung pada Kumpulan. Jika penskalaan otomatis Kumpulan saat ini dinonaktifkan, Anda harus menentukan rumus skala otomatis yang valid sebagai bagian dari permintaan. Jika penskalaan otomatis Kumpulan sudah diaktifkan, Anda dapat menentukan rumus skala otomatis baru dan/atau interval evaluasi baru. Anda tidak dapat memanggil API ini untuk Kumpulan yang sama lebih dari sekali setiap 30 detik.
enable_auto_scale(pool_id, auto_scale_formula=None, auto_scale_evaluation_interval=None, pool_enable_auto_scale_options=None, custom_headers=None, raw=False, **operation_config)Parameter
- auto_scale_formula
- str
Rumus diperiksa validitasnya sebelum diterapkan ke Kumpulan. Jika rumus tidak valid, layanan Batch menolak permintaan dengan informasi kesalahan terperinci. Untuk informasi selengkapnya tentang menentukan rumus ini, lihat Menskalakan Simpul Komputasi secara otomatis dalam Kumpulan Azure Batch (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling).
- auto_scale_evaluation_interval
- <xref:timedelta>
Nilai defaultnya adalah 15 menit. Nilai minimum dan maksimum masing-masing adalah 5 menit dan 168 jam. Jika Anda menentukan nilai kurang dari 5 menit atau lebih besar dari 168 jam, layanan Batch menolak permintaan dengan kesalahan nilai properti yang tidak valid; jika Anda memanggil REST API secara langsung, kode status HTTP adalah 400 (Permintaan Buruk). Jika Anda menentukan interval baru, maka jadwal evaluasi skala otomatis yang ada akan dihentikan dan jadwal evaluasi skala otomatis baru akan dimulai, dengan waktu mulainya saat permintaan ini dikeluarkan.
- pool_enable_auto_scale_options
- PoolEnableAutoScaleOptions
Parameter tambahan untuk operasi
- operation_config
Penimpaan konfigurasi operasi.
Mengembalikan
Tidak ada atau ClientRawResponse jika raw=true
Tipe hasil
Pengecualian
evaluate_auto_scale
Mendapatkan hasil mengevaluasi rumus penskalaan otomatis pada Kumpulan.
API ini terutama untuk memvalidasi rumus skala otomatis, karena hanya mengembalikan hasil tanpa menerapkan rumus ke Kumpulan. Kumpulan harus mengaktifkan penskalaan otomatis untuk mengevaluasi rumus.
evaluate_auto_scale(pool_id, auto_scale_formula, pool_evaluate_auto_scale_options=None, custom_headers=None, raw=False, **operation_config)Parameter
- auto_scale_formula
- str
Rumus divalidasi dan hasilnya dihitung, tetapi tidak diterapkan ke Kumpulan. Untuk menerapkan rumus ke Kumpulan, 'Aktifkan penskalaan otomatis pada Kumpulan'. Untuk informasi selengkapnya tentang menentukan rumus ini, lihat Menskalakan Simpul Komputasi secara otomatis dalam Kumpulan Azure Batch (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling).
- pool_evaluate_auto_scale_options
- PoolEvaluateAutoScaleOptions
Parameter tambahan untuk operasi
- operation_config
Penimpaan konfigurasi operasi.
Mengembalikan
AutoScaleRun atau ClientRawResponse jika raw=true
Tipe hasil
Pengecualian
exists
Mendapatkan properti dasar Kumpulan.
exists(pool_id, pool_exists_options=None, custom_headers=None, raw=False, **operation_config)Parameter
- operation_config
Penimpaan konfigurasi operasi.
Mengembalikan
bool atau ClientRawResponse jika raw=true
Tipe hasil
Pengecualian
get
Mendapatkan informasi tentang Kumpulan yang ditentukan.
get(pool_id, pool_get_options=None, custom_headers=None, raw=False, **operation_config)Parameter
- operation_config
Penimpaan konfigurasi operasi.
Mengembalikan
CloudPool atau ClientRawResponse jika raw=true
Tipe hasil
Pengecualian
list
Mencantumkan semua Kumpulan di Akun yang ditentukan.
list(pool_list_options=None, custom_headers=None, raw=False, **operation_config)Parameter
- operation_config
Penimpaan konfigurasi operasi.
Mengembalikan
Iterator seperti instans CloudPool
Tipe hasil
Pengecualian
list_usage_metrics
Mencantumkan metrik penggunaan, yang dikumpulkan oleh Kumpulan di seluruh interval waktu individual, untuk Akun yang ditentukan.
Jika Anda tidak menentukan klausa $filter termasuk poolId, respons menyertakan semua Kumpulan yang ada di Akun dalam rentang waktu interval agregasi yang dikembalikan. Jika Anda tidak menentukan klausa $filter termasuk startTime atau endTime, filter ini default ke waktu mulai dan berakhir dari interval agregasi terakhir yang saat ini tersedia; yaitu, hanya interval agregasi terakhir yang dikembalikan.
list_usage_metrics(pool_list_usage_metrics_options=None, custom_headers=None, raw=False, **operation_config)Parameter
- pool_list_usage_metrics_options
- PoolListUsageMetricsOptions
Parameter tambahan untuk operasi
- operation_config
Penimpaan konfigurasi operasi.
Mengembalikan
Iterator seperti instans PoolUsageMetrics
Tipe hasil
Pengecualian
patch
Updates properti Kumpulan yang ditentukan.
Ini hanya menggantikan properti Kumpulan yang ditentukan dalam permintaan. Misalnya, jika Kumpulan memiliki StartTask yang terkait dengannya, dan permintaan tidak menentukan elemen StartTask, maka Kumpulan menyimpan StartTask yang ada.
patch(pool_id, pool_patch_parameter, pool_patch_options=None, custom_headers=None, raw=False, **operation_config)Parameter
- operation_config
Penimpaan konfigurasi operasi.
Mengembalikan
Tidak ada atau ClientRawResponse jika raw=true
Tipe hasil
Pengecualian
remove_nodes
Menghapus Simpul Komputasi dari Kumpulan yang ditentukan.
Operasi ini hanya dapat berjalan ketika status alokasi Kumpulan stabil. Ketika operasi ini berjalan, status alokasi berubah dari stabil menjadi mengubah ukuran. Setiap permintaan dapat menghapus hingga 100 simpul.
remove_nodes(pool_id, node_remove_parameter, pool_remove_nodes_options=None, custom_headers=None, raw=False, **operation_config)Parameter
- pool_remove_nodes_options
- PoolRemoveNodesOptions
Parameter tambahan untuk operasi
- operation_config
Penimpaan konfigurasi operasi.
Mengembalikan
Tidak ada atau ClientRawResponse jika raw=true
Tipe hasil
Pengecualian
resize
Mengubah jumlah Simpul Komputasi yang ditetapkan ke Kumpulan.
Anda hanya dapat mengubah ukuran Kumpulan saat status alokasinya stabil. Jika Kumpulan sudah mengubah ukuran, permintaan gagal dengan kode status 409. Saat Anda mengubah ukuran Kumpulan, status alokasi Kumpulan berubah dari stabil menjadi mengubah ukuran. Anda tidak dapat mengubah ukuran Kumpulan yang dikonfigurasi untuk penskalaan otomatis. Jika Anda mencoba melakukan ini, layanan Batch mengembalikan kesalahan 409. Jika Anda mengubah ukuran Kumpulan ke bawah, layanan Batch memilih Simpul Komputasi mana yang akan dihapus. Untuk menghapus Simpul Komputasi tertentu, gunakan POOL remove Compute Nodes API sebagai gantinya.
resize(pool_id, pool_resize_parameter, pool_resize_options=None, custom_headers=None, raw=False, **operation_config)Parameter
- operation_config
Penimpaan konfigurasi operasi.
Mengembalikan
Tidak ada atau ClientRawResponse jika raw=true
Tipe hasil
Pengecualian
stop_resize
Menghentikan operasi mengubah ukuran yang sedang berlangsung pada Kumpulan.
Ini tidak memulihkan Kumpulan ke status sebelumnya sebelum operasi pengubahan ukuran: ini hanya menghentikan perubahan lebih lanjut yang dilakukan, dan Kumpulan mempertahankan statusnya saat ini. Setelah berhenti, Kumpulan stabil pada jumlah Simpul Komputasi saat operasi berhenti dilakukan. Selama operasi berhenti, status alokasi Kumpulan berubah terlebih dahulu menjadi berhenti dan kemudian stabil. Operasi pengubahan ukuran tidak perlu menjadi permintaan Kumpulan pengubahan ukuran eksplisit; API ini juga dapat digunakan untuk menghentikan ukuran awal Kumpulan saat dibuat.
stop_resize(pool_id, pool_stop_resize_options=None, custom_headers=None, raw=False, **operation_config)Parameter
- operation_config
Penimpaan konfigurasi operasi.
Mengembalikan
Tidak ada atau ClientRawResponse jika raw=true
Tipe hasil
Pengecualian
update_properties
Updates properti Kumpulan yang ditentukan.
Ini sepenuhnya menggantikan semua properti Kumpulan yang dapat diperbarui. Misalnya, jika Kumpulan memiliki StartTask yang terkait dengannya dan jika StartTask tidak ditentukan dengan permintaan ini, maka layanan Batch akan menghapus StartTask yang ada.
update_properties(pool_id, pool_update_properties_parameter, pool_update_properties_options=None, custom_headers=None, raw=False, **operation_config)Parameter
- pool_update_properties_parameter
- PoolUpdatePropertiesParameter
Parameter untuk permintaan.
- pool_update_properties_options
- PoolUpdatePropertiesOptions
Parameter tambahan untuk operasi
- operation_config
Penimpaan konfigurasi operasi.
Mengembalikan
Tidak ada atau ClientRawResponse jika raw=true
Tipe hasil
Pengecualian
Atribut
models
models = <module 'azure.batch.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\batch\\models\\__init__.py'>
Azure SDK for Python
Saran dan Komentar
Segera hadir: Sepanjang tahun 2024 kami akan menghentikan penggunaan GitHub Issues sebagai mekanisme umpan balik untuk konten dan menggantinya dengan sistem umpan balik baru. Untuk mengetahui informasi selengkapnya, lihat: https://aka.ms/ContentUserFeedback.
Kirim dan lihat umpan balik untuk