Pool - Update Properties

Service:

Batch Service

API Version:

2023-11-01.18.0

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.

POST {batchUrl}/pools/{poolId}/updateproperties?api-version=2023-11-01.18.0

With optional parameters:

POST {batchUrl}/pools/{poolId}/updateproperties?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.
poolId	path	True	string	ID Kumpulan 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.

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.

Isi Permintaan

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

Nama	Diperlukan	Jenis	Deskripsi
applicationPackageReferences	True	ApplicationPackageReference[]	Daftar Paket Aplikasi yang akan diinstal pada setiap Simpul Komputasi di Kumpulan. Daftar menggantikan referensi Paket Aplikasi yang ada pada Kumpulan. Perubahan pada referensi Paket Aplikasi memengaruhi semua Simpul Komputasi baru yang bergabung dengan Kumpulan, tetapi tidak memengaruhi Simpul Komputasi yang sudah ada di Kumpulan hingga di-boot ulang atau digambut ulang. Ada maksimum 10 referensi Paket Aplikasi pada Kumpulan tertentu. Jika dihilangkan, atau jika Anda menentukan koleksi kosong, referensi Paket Aplikasi yang ada akan dihapus dari Kumpulan. Maksimal 10 referensi dapat ditentukan pada Kumpulan tertentu.
certificateReferences	True	CertificateReference[]	Daftar Sertifikat yang akan diinstal pada setiap Simpul Komputasi di Kumpulan. Daftar ini menggantikan referensi Sertifikat yang ada yang dikonfigurasi pada Kumpulan. Jika Anda menentukan koleksi kosong, referensi Sertifikat yang ada akan dihapus dari Kumpulan. Untuk Simpul Windows, layanan Batch menginstal Sertifikat ke penyimpanan dan lokasi Sertifikat yang ditentukan. Untuk Simpul Komputasi Linux, Sertifikat disimpan dalam direktori di dalam direktori kerja Tugas dan variabel lingkungan AZ_BATCH_CERTIFICATES_DIR disediakan ke Tugas untuk mengkueri lokasi ini. Untuk Sertifikat dengan visibilitas 'remoteUser', direktori 'certs' dibuat di direktori beranda pengguna (misalnya, /home/{user-name}/certs) dan Sertifikat ditempatkan di direktori tersebut. Peringatan: Properti ini tidak digunakan lagi dan akan dihapus setelah Februari 2024. Silakan gunakan Ekstensi Azure KeyVault sebagai gantinya.
metadata	True	MetadataItem[]	Daftar pasangan nilai nama yang terkait dengan Kumpulan sebagai metadata. Daftar ini menggantikan metadata yang ada yang dikonfigurasi pada Kumpulan. Jika dihilangkan, atau jika Anda menentukan koleksi kosong, metadata yang ada akan dihapus dari Kumpulan.
startTask		StartTask	Tugas yang akan dijalankan pada setiap Simpul Komputasi saat bergabung dengan Kumpulan. Tugas berjalan ketika Simpul Komputasi ditambahkan ke Kumpulan atau ketika Simpul Komputasi dimulai ulang. Jika elemen ini ada, elemen ini akan menimpa StartTask yang ada. Jika dihilangkan, StartTask yang ada akan dihapus dari Kumpulan.
targetNodeCommunicationMode		NodeCommunicationMode	Mode komunikasi simpul yang diinginkan untuk kumpulan. Pengaturan ini menggantikan pengaturan targetNodeCommunication yang ada pada Kumpulan. Jika dihilangkan, pengaturan yang ada adalah default.

Respons

Nama	Jenis	Deskripsi
204 No Content		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

Pool update

Sample Request

HTTP

POST account.region.batch.azure.com/pools/poolId/updateproperties?api-version=2023-11-01.18.0



{
  "startTask": {
    "commandLine": "/bin/bash -c 'echo start task'"
  },
  "certificateReferences": [],
  "applicationPackageReferences": [],
  "metadata": []
}

Sample Response

Status code:

204

Definisi

Nama	Deskripsi
ApplicationPackageReference	Referensi ke Paket yang akan disebarkan ke Simpul Komputasi.
AutoUserScope	Cakupan untuk pengguna otomatis
AutoUserSpecification	Menentukan parameter untuk pengguna otomatis yang menjalankan Tugas pada layanan Batch.
BatchError	Respons kesalahan yang diterima dari layanan Azure Batch.
BatchErrorDetail	Item informasi tambahan yang disertakan dalam respons kesalahan Azure Batch.
CertificateReference	Referensi ke Sertifikat yang akan diinstal pada Simpul Komputasi di Kumpulan.
CertificateStoreLocation	Lokasi penyimpanan Sertifikat pada Simpul Komputasi tempat menginstal Sertifikat.
CertificateVisibility	Akun pengguna mana di Simpul Komputasi yang harus memiliki akses ke data privat Sertifikat.
ComputeNodeIdentityReference	Referensi ke identitas yang ditetapkan pengguna yang terkait dengan kumpulan Batch yang akan digunakan simpul komputasi.
ContainerRegistry	Registri kontainer privat.
ContainerWorkingDirectory	Lokasi direktori kerja Tugas kontainer.
ElevationLevel	Tingkat elevasi pengguna.
EnvironmentSetting	Variabel lingkungan yang akan diatur pada proses Tugas.
ErrorMessage	Pesan kesalahan yang diterima dalam respons kesalahan Azure Batch.
MetadataItem	Pasangan nama-nilai yang terkait dengan sumber daya layanan Batch.
NodeCommunicationMode	Menentukan bagaimana kumpulan berkomunikasi dengan layanan Batch.
PoolUpdatePropertiesParameter	Kumpulan perubahan yang akan dilakukan pada Kumpulan.
ResourceFile	Satu file atau beberapa file yang akan diunduh ke Simpul Komputasi.
StartTask	Tugas yang dijalankan saat Simpul bergabung dengan Kumpulan di layanan Azure Batch, atau saat Simpul Komputasi di-boot ulang atau digambut ulang.
TaskContainerSettings	Pengaturan kontainer untuk Tugas.
UserIdentity	Definisi identitas pengguna tempat Tugas dijalankan.

ApplicationPackageReference

Referensi ke Paket yang akan disebarkan ke Simpul Komputasi.

Nama	Jenis	Deskripsi
applicationId	string	ID aplikasi yang akan disebarkan. Saat membuat kumpulan, ID aplikasi paket harus sepenuhnya memenuhi syarat (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}).
version	string	Versi aplikasi yang akan disebarkan. Jika dihilangkan, versi default disebarkan. Jika ini dihilangkan pada Kumpulan, dan tidak ada versi default yang ditentukan untuk aplikasi ini, permintaan gagal dengan kode kesalahan InvalidApplicationPackageReferences dan kode status HTTP 409. Jika ini dihilangkan pada Tugas, dan tidak ada versi default yang ditentukan untuk aplikasi ini, Tugas gagal dengan kesalahan pra-pemrosesan.

AutoUserScope

Cakupan untuk pengguna otomatis

Nama	Jenis	Deskripsi
pool	string	Menentukan bahwa Tugas berjalan sebagai Akun pengguna otomatis umum yang dibuat pada setiap Simpul Komputasi dalam Kumpulan.
task	string	Menentukan bahwa layanan harus membuat pengguna baru untuk Tugas.

AutoUserSpecification

Menentukan parameter untuk pengguna otomatis yang menjalankan Tugas pada layanan Batch.

Nama	Jenis	Deskripsi
elevationLevel	ElevationLevel	Tingkat elevasi pengguna otomatis. Nilai defaultnya adalah nonAdmin.
scope	AutoUserScope	Cakupan untuk pengguna otomatis Nilai defaultnya adalah kumpulan. Jika kumpulan menjalankan Windows, nilai Tugas harus ditentukan jika isolasi yang lebih ketat antar tugas diperlukan. Misalnya, jika tugas memmutasi registri dengan cara yang dapat memengaruhi tugas lain, atau jika sertifikat telah ditentukan pada kumpulan yang seharusnya tidak dapat diakses oleh tugas normal tetapi harus dapat diakses oleh StartTasks.

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.

CertificateReference

Referensi ke Sertifikat yang akan diinstal pada Simpul Komputasi di Kumpulan.

Nama	Jenis	Deskripsi
storeLocation	CertificateStoreLocation	Lokasi penyimpanan Sertifikat pada Simpul Komputasi tempat menginstal Sertifikat. Nilai defaultnya adalah currentuser. Properti ini hanya berlaku untuk Kumpulan yang dikonfigurasi dengan Simpul Komputasi Windows (yaitu, dibuat dengan cloudServiceConfiguration, atau dengan virtualMachineConfiguration menggunakan referensi Gambar Windows). Untuk Simpul Komputasi Linux, Sertifikat disimpan dalam direktori di dalam direktori kerja Tugas dan variabel lingkungan AZ_BATCH_CERTIFICATES_DIR disediakan ke Tugas untuk mengkueri lokasi ini. Untuk Sertifikat dengan visibilitas 'remoteUser', direktori 'certs' dibuat di direktori beranda pengguna (misalnya, /home/{user-name}/certs) dan Sertifikat ditempatkan di direktori tersebut.
storeName	string	Nama penyimpanan Sertifikat pada Simpul Komputasi tempat menginstal Sertifikat. Properti ini hanya berlaku untuk Kumpulan yang dikonfigurasi dengan Simpul Komputasi Windows (yaitu, dibuat dengan cloudServiceConfiguration, atau dengan virtualMachineConfiguration menggunakan referensi Gambar Windows). Nama penyimpanan umum meliputi: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, tetapi nama penyimpanan kustom apa pun juga dapat digunakan. Nilai defaultnya adalah My.
thumbprint	string	Thumbprint Sertifikat.
thumbprintAlgorithm	string	Algoritma yang terkait dengan thumbprint. Ini harus sha1.
visibility	CertificateVisibility[]	Akun pengguna mana di Simpul Komputasi yang harus memiliki akses ke data privat Sertifikat. Anda dapat menentukan lebih dari satu visibilitas dalam koleksi ini. Defaultnya adalah semua Akun.

CertificateStoreLocation

Lokasi penyimpanan Sertifikat pada Simpul Komputasi tempat menginstal Sertifikat.

Nama	Jenis	Deskripsi
currentuser	string	Sertifikat harus diinstal ke penyimpanan Sertifikat CurrentUser.
localmachine	string	Sertifikat harus diinstal ke penyimpanan Sertifikat LocalMachine.

CertificateVisibility

Akun pengguna mana di Simpul Komputasi yang harus memiliki akses ke data privat Sertifikat.

Nama	Jenis	Deskripsi
remoteuser	string	Sertifikat harus terlihat oleh akun pengguna tempat pengguna mengakses Simpul Komputasi dari jarak jauh.
starttask	string	Sertifikat harus terlihat oleh akun pengguna tempat StartTask dijalankan. Perhatikan bahwa jika Cakupan AutoUser adalah Kumpulan untuk StartTask dan Tugas, sertifikat ini juga akan terlihat oleh Tugas.
task	string	Sertifikat harus terlihat oleh akun pengguna tempat Tugas Pekerjaan dijalankan.

ComputeNodeIdentityReference

Referensi ke identitas yang ditetapkan pengguna yang terkait dengan kumpulan Batch yang akan digunakan simpul komputasi.

Nama	Jenis	Deskripsi
resourceId	string	Id sumber daya ARM dari identitas yang ditetapkan pengguna.

ContainerRegistry

Registri kontainer privat.

Nama	Jenis	Deskripsi
identityReference	ComputeNodeIdentityReference	Referensi ke identitas yang ditetapkan pengguna untuk digunakan untuk mengakses Azure Container Registry alih-alih nama pengguna dan kata sandi. Referensi ke identitas yang ditetapkan pengguna yang terkait dengan kumpulan Batch yang akan digunakan simpul komputasi.
password	string	Kata sandi untuk masuk ke server registri.
registryServer	string	URL registri. Jika dihilangkan, defaultnya adalah "docker.io".
username	string	Nama pengguna untuk masuk ke server registri.

ContainerWorkingDirectory

Lokasi direktori kerja Tugas kontainer.

Nama	Jenis	Deskripsi
containerImageDefault	string	Gunakan direktori kerja yang ditentukan dalam Gambar kontainer. Waspadalah bahwa direktori ini tidak akan berisi File Sumber Daya yang diunduh oleh Batch.
taskWorkingDirectory	string	Gunakan direktori kerja Tugas layanan Batch standar, yang akan berisi File Sumber Daya Tugas yang diisi oleh Batch.

ElevationLevel

Tingkat elevasi pengguna.

Nama	Jenis	Deskripsi
admin	string	Pengguna adalah pengguna dengan akses yang ditinggikan dan beroperasi dengan izin Administrator penuh.
nonadmin	string	Pengguna adalah pengguna standar tanpa akses yang ditingkatkan.

EnvironmentSetting

Variabel lingkungan yang akan diatur pada proses Tugas.

Nama	Jenis	Deskripsi
name	string	Nama variabel lingkungan.
value	string	Nilai variabel lingkungan.

ErrorMessage

Pesan kesalahan yang diterima dalam respons kesalahan Azure Batch.

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

MetadataItem

Pasangan nama-nilai yang terkait dengan sumber daya layanan Batch.

Nama	Jenis	Deskripsi
name	string	Nama item metadata.
value	string	Nilai item metadata.

NodeCommunicationMode

Menentukan bagaimana kumpulan berkomunikasi dengan layanan Batch.

Nama	Jenis	Deskripsi
classic	string	Simpul yang menggunakan mode komunikasi klasik memerlukan komunikasi TCP masuk pada port 29876 dan 29877 dari "BatchNodeManagement. Tag layanan {region}" dan komunikasi TCP keluar pada port 443 ke "Storage.region" dan "BatchNodeManagement. Tag layanan {region}".
default	string	Mode komunikasi simpul secara otomatis diatur oleh layanan Batch.
simplified	string	Simpul yang menggunakan mode komunikasi yang disederhanakan memerlukan komunikasi TCP keluar pada port 443 ke "BatchNodeManagement. Tag layanan {region}". Tidak diperlukan port masuk terbuka.

PoolUpdatePropertiesParameter

Kumpulan perubahan yang akan dilakukan pada Kumpulan.

Nama	Jenis	Deskripsi
applicationPackageReferences	ApplicationPackageReference[]	Daftar Paket Aplikasi yang akan diinstal pada setiap Simpul Komputasi di Kumpulan. Daftar menggantikan referensi Paket Aplikasi yang ada pada Kumpulan. Perubahan pada referensi Paket Aplikasi memengaruhi semua Simpul Komputasi baru yang bergabung dengan Kumpulan, tetapi tidak memengaruhi Simpul Komputasi yang sudah ada di Kumpulan hingga di-boot ulang atau digambut ulang. Ada maksimum 10 referensi Paket Aplikasi pada Kumpulan tertentu. Jika dihilangkan, atau jika Anda menentukan koleksi kosong, referensi Paket Aplikasi yang ada akan dihapus dari Kumpulan. Maksimal 10 referensi dapat ditentukan pada Kumpulan tertentu.
certificateReferences	CertificateReference[]	Daftar Sertifikat yang akan diinstal pada setiap Simpul Komputasi di Kumpulan. Daftar ini menggantikan referensi Sertifikat yang ada yang dikonfigurasi pada Kumpulan. Jika Anda menentukan koleksi kosong, referensi Sertifikat yang ada akan dihapus dari Kumpulan. Untuk Simpul Windows, layanan Batch menginstal Sertifikat ke penyimpanan dan lokasi Sertifikat yang ditentukan. Untuk Simpul Komputasi Linux, Sertifikat disimpan dalam direktori di dalam direktori kerja Tugas dan variabel lingkungan AZ_BATCH_CERTIFICATES_DIR disediakan ke Tugas untuk mengkueri lokasi ini. Untuk Sertifikat dengan visibilitas 'remoteUser', direktori 'certs' dibuat di direktori beranda pengguna (misalnya, /home/{user-name}/certs) dan Sertifikat ditempatkan di direktori tersebut. Peringatan: Properti ini tidak digunakan lagi dan akan dihapus setelah Februari 2024. Silakan gunakan Ekstensi Azure KeyVault sebagai gantinya.
metadata	MetadataItem[]	Daftar pasangan nilai nama yang terkait dengan Kumpulan sebagai metadata. Daftar ini menggantikan metadata yang ada yang dikonfigurasi pada Kumpulan. Jika dihilangkan, atau jika Anda menentukan koleksi kosong, metadata yang ada akan dihapus dari Kumpulan.
startTask	StartTask	Tugas yang akan dijalankan pada setiap Simpul Komputasi saat bergabung dengan Kumpulan. Tugas berjalan ketika Simpul Komputasi ditambahkan ke Kumpulan atau ketika Simpul Komputasi dimulai ulang. Jika elemen ini ada, elemen ini akan menimpa StartTask yang ada. Jika dihilangkan, StartTask yang ada akan dihapus dari Kumpulan.
targetNodeCommunicationMode	NodeCommunicationMode	Mode komunikasi simpul yang diinginkan untuk kumpulan. Pengaturan ini menggantikan pengaturan targetNodeCommunication yang ada pada Kumpulan. Jika dihilangkan, pengaturan yang ada adalah default.

ResourceFile

Satu file atau beberapa file yang akan diunduh ke Simpul Komputasi.

Nama	Jenis	Deskripsi
autoStorageContainerName	string	Nama kontainer penyimpanan di Akun penyimpanan otomatis. Properti autoStorageContainerName, storageContainerUrl, dan httpUrl saling eksklusif dan salah satunya harus ditentukan.
blobPrefix	string	Awalan blob yang digunakan saat mengunduh blob dari kontainer Azure Storage. Hanya blob yang namanya dimulai dengan awalan yang ditentukan yang akan diunduh. Properti hanya valid ketika autoStorageContainerName atau storageContainerUrl digunakan. Awalan ini dapat berupa nama file parsial atau subdirektori. Jika awalan tidak ditentukan, semua file dalam kontainer akan diunduh.
fileMode	string	Atribut mode izin file dalam format oktal. Properti ini hanya berlaku untuk file yang diunduh ke Simpul Komputasi Linux. Ini akan diabaikan jika ditentukan untuk resourceFile yang akan diunduh ke Simpul Komputasi Windows. Jika properti ini tidak ditentukan untuk Simpul Komputasi Linux, maka nilai default 0770 diterapkan ke file.
filePath	string	Lokasi pada Simpul Komputasi tempat mengunduh file, relatif terhadap direktori kerja Tugas. Jika properti httpUrl ditentukan, filePath diperlukan dan menjelaskan jalur tempat file akan diunduh, termasuk nama file. Jika tidak, jika properti autoStorageContainerName atau storageContainerUrl ditentukan, filePath bersifat opsional dan merupakan direktori untuk mengunduh file. Dalam kasus di mana filePath digunakan sebagai direktori, struktur direktori apa pun yang sudah terkait dengan data input akan disimpan secara penuh dan ditambahkan ke direktori filePath yang ditentukan. Jalur relatif yang ditentukan tidak dapat keluar dari direktori kerja Tugas (misalnya dengan menggunakan '..').
httpUrl	string	URL file yang akan diunduh. Properti autoStorageContainerName, storageContainerUrl, dan httpUrl saling eksklusif dan salah satunya harus ditentukan. Jika URL menunjuk ke Azure Blob Storage, URL harus dapat dibaca dari simpul komputasi. Ada tiga cara untuk mendapatkan URL seperti itu untuk blob di penyimpanan Azure: menyertakan Tanda Tangan Akses Bersama (SAS) yang memberikan izin baca pada blob, menggunakan identitas terkelola dengan izin baca, atau mengatur ACL untuk blob atau kontainernya untuk memungkinkan akses publik.
identityReference	ComputeNodeIdentityReference	Referensi ke identitas yang ditetapkan pengguna untuk digunakan untuk mengakses Azure Blob Storage yang ditentukan oleh storageContainerUrl atau httpUrl Referensi ke identitas yang ditetapkan pengguna yang terkait dengan kumpulan Batch yang akan digunakan simpul komputasi.
storageContainerUrl	string	URL kontainer blob dalam Azure Blob Storage. Properti autoStorageContainerName, storageContainerUrl, dan httpUrl saling eksklusif dan salah satunya harus ditentukan. URL ini harus dapat dibaca dan dapat dicantumkan dari simpul komputasi. Ada tiga cara untuk mendapatkan URL seperti itu untuk kontainer di penyimpanan Azure: sertakan Tanda Tangan Akses Bersama (SAS) yang memberikan izin baca dan daftar pada kontainer, gunakan identitas terkelola dengan izin baca dan daftar, atau atur ACL untuk kontainer guna mengizinkan akses publik.

StartTask

Tugas yang dijalankan saat Simpul bergabung dengan Kumpulan di layanan Azure Batch, atau saat Simpul Komputasi di-boot ulang atau digambut ulang.

Nama	Jenis	Deskripsi
commandLine	string	Baris perintah StartTask. Baris perintah tidak berjalan di bawah shell, dan karena itu tidak dapat memanfaatkan fitur shell seperti ekspansi variabel lingkungan. Jika Anda ingin memanfaatkan fitur tersebut, Anda harus memanggil shell di baris perintah, misalnya menggunakan "cmd /c MyCommand" di Windows atau "/bin/sh -c MyCommand" di Linux. Jika baris perintah mengacu pada jalur file, baris tersebut harus menggunakan jalur relatif (relatif terhadap direktori kerja Tugas), atau menggunakan variabel lingkungan yang disediakan Batch (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).
containerSettings	TaskContainerSettings	Pengaturan untuk kontainer tempat StartTask berjalan. Ketika ini ditentukan, semua direktori secara rekursif di bawah AZ_BATCH_NODE_ROOT_DIR (akar direktori Azure Batch pada simpul) dipetakan ke dalam kontainer, semua variabel lingkungan Tugas dipetakan ke dalam kontainer, dan baris perintah Tugas dijalankan dalam kontainer. File yang diproduksi dalam kontainer di luar AZ_BATCH_NODE_ROOT_DIR mungkin tidak tercermin ke disk host, yang berarti bahwa API file Batch tidak akan dapat mengakses file-file tersebut.
environmentSettings	EnvironmentSetting[]	Daftar pengaturan variabel lingkungan untuk StartTask.
maxTaskRetryCount	integer	Berapa kali maksimum Tugas dapat dicoba kembali. Layanan Batch mencoba kembali Tugas jika kode keluarnya bukan nol. Perhatikan bahwa nilai ini secara khusus mengontrol jumlah percobaan kembali. Layanan Batch akan mencoba Tugas sekali, dan kemudian dapat mencoba kembali hingga batas ini. Misalnya, jika jumlah percobaan kembali 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. 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 kembali).
resourceFiles	ResourceFile[]	Daftar file yang akan diunduh layanan Batch ke Simpul Komputasi sebelum menjalankan baris perintah. Ada ukuran maksimum untuk daftar file sumber daya. Ketika ukuran maksimum terlampaui, permintaan akan gagal dan kode kesalahan respons akan menjadi RequestEntityTooLarge. Jika ini terjadi, pengumpulan ResourceFiles harus dikurangi ukurannya. Ini dapat dicapai menggunakan file .zip, Paket Aplikasi, atau Kontainer Docker. File yang tercantum di bawah elemen ini terletak di direktori kerja Tugas.
userIdentity	UserIdentity	Identitas pengguna tempat StartTask berjalan. Jika dihilangkan, Tugas berjalan sebagai pengguna non-administratif yang unik untuk Tugas.
waitForSuccess	boolean	Apakah layanan Batch harus menunggu StartTask berhasil diselesaikan (yaitu, untuk keluar dengan kode keluar 0) sebelum menjadwalkan Tugas apa pun pada Simpul Komputasi. Jika true dan StartTask gagal pada Node, layanan Batch mencoba kembali StartTask hingga jumlah coba lagi maksimumnya (maxTaskRetryCount). Jika Tugas masih belum berhasil diselesaikan setelah semua percobaan ulang, maka layanan Batch menandai Simpul yang tidak dapat digunakan, dan tidak akan menjadwalkan Tugas ke dalamnya. Kondisi ini dapat dideteksi melalui status Simpul Komputasi dan detail info kegagalan. Jika false, layanan Batch tidak akan menunggu StartTask selesai. Dalam hal ini, Tugas lain dapat mulai dijalankan pada Simpul Komputasi saat StartTask masih berjalan; dan bahkan jika StartTask gagal, Tugas baru akan terus dijadwalkan pada Simpul Komputasi. Secara default adalah benar.

TaskContainerSettings

Pengaturan kontainer untuk Tugas.

Nama	Jenis	Deskripsi
containerRunOptions	string	Opsi tambahan untuk perintah buat kontainer. Opsi tambahan ini disediakan sebagai argumen ke perintah "docker create", selain yang dikontrol oleh Layanan Batch.
imageName	string	Gambar yang digunakan untuk membuat kontainer tempat Tugas akan berjalan. Ini adalah referensi Gambar lengkap, seperti yang akan ditentukan ke "penarikan docker". Jika tidak ada tag yang disediakan sebagai bagian dari Nama gambar, tag ":latest" digunakan sebagai default.
registry	ContainerRegistry	Registri privat yang berisi Gambar kontainer. Pengaturan ini dapat dihilangkan jika sudah disediakan di pembuatan Pool.
workingDirectory	ContainerWorkingDirectory	Lokasi direktori kerja Tugas kontainer. Defaultnya adalah 'taskWorkingDirectory'.

UserIdentity

Definisi identitas pengguna tempat Tugas dijalankan.

Nama	Jenis	Deskripsi
autoUser	AutoUserSpecification	Pengguna otomatis tempat Tugas dijalankan. Properti userName dan autoUser saling eksklusif; Anda harus menentukan satu tetapi tidak keduanya.
username	string	Nama identitas pengguna tempat Tugas dijalankan. Properti userName dan autoUser saling eksklusif; Anda harus menentukan satu tetapi tidak keduanya.