Job - List From Job Schedule

Mencantumkan Pekerjaan yang telah dibuat di bawah Jadwal Pekerjaan yang ditentukan.

GET {batchUrl}/jobschedules/{jobScheduleId}/jobs?api-version=2022-01-01.15.0
GET {batchUrl}/jobschedules/{jobScheduleId}/jobs?$filter={$filter}&$select={$select}&$expand={$expand}&maxresults={maxresults}&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.

jobScheduleId
path True
  • string

ID Jadwal Pekerjaan tempat Anda ingin mendapatkan daftar Pekerjaan.

api-version
query True
  • string

Versi API Klien.

$expand
query
  • string

Klausa $expand OData.

$filter
query
  • string

Klausa $filter OData. Untuk informasi selengkapnya tentang membuat filter ini, lihat https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-jobs-in-a-job-schedule.

$select
query
  • string

Klausa $select OData.

maxresults
query
  • integer
int32

Jumlah maksimum item yang akan dikembalikan dalam respons. Maksimal 1000 Pekerjaan dapat dikembalikan.

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.

Respons

Name Type Description
200 OK

Respons yang berisi daftar Pekerjaan.

Headers

  • client-request-id: string
  • request-id: string
  • ETag: string
  • Last-Modified: 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

List Job Under Job Schedule

Sample Request

GET account.region.batch.azure.com/jobschedules/jobScheduleId/jobs?api-version=2022-01-01.15.0


Sample Response

{
  "value": [
    {
      "id": "jobId",
      "url": "https://account.region.batch.azure.com/jobs/jobId",
      "eTag": "0x8D4100FC46D5BF4",
      "lastModified": "2016-11-19T00:05:27.2137716Z",
      "creationTime": "2016-11-19T00:05:25.311915Z",
      "state": "active",
      "stateTransitionTime": "2016-11-19T00:05:27.2137716Z",
      "previousState": "disabled",
      "previousStateTransitionTime": "2016-11-19T00:05:26.88777Z",
      "priority": 0,
      "usesTaskDependencies": false,
      "constraints": {
        "maxWallClockTime": "P10675199DT2H48M5.4775807S",
        "maxTaskRetryCount": 0
      },
      "poolInfo": {
        "poolId": "poolId"
      },
      "executionInfo": {
        "startTime": "2016-11-19T00:05:25.3309105Z",
        "poolId": "poolId"
      },
      "onAllTasksComplete": "noaction",
      "onTaskFailure": "noaction"
    }
  ]
}

Definisi

ApplicationPackageReference

Referensi ke Paket yang akan disebarkan ke Simpul Komputasi.

AuthenticationTokenSettings

Pengaturan untuk token autentikasi yang dapat digunakan Tugas untuk melakukan operasi layanan Batch.

AutoPoolSpecification

Menentukan karakteristik untuk 'kumpulan otomatis' sementara. Layanan Batch akan membuat Kumpulan otomatis ini saat Pekerjaan dikirimkan.

AutoUserScope

Cakupan untuk pengguna otomatis

AutoUserSpecification

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

AzureBlobFileSystemConfiguration

Informasi yang digunakan untuk menyambungkan ke Kontainer Azure Storage menggunakan Blobfuse.

AzureFileShareConfiguration

Informasi yang digunakan untuk menyambungkan ke Azure Fileshare.

BatchError

Respons kesalahan yang diterima dari layanan Azure Batch.

BatchErrorDetail

Item informasi tambahan yang disertakan dalam respons kesalahan Azure Batch.

CachingType

Jenis penembolokan yang akan diaktifkan untuk disk.

CertificateReference

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

CertificateStoreLocation

Lokasi penyimpanan Sertifikat pada Simpul Komputasi tempat menginstal Sertifikat.

CIFSMountConfiguration

Informasi yang digunakan untuk menyambungkan ke sistem file CIFS.

CloudJob

Pekerjaan Azure Batch.

CloudJobListResult

Hasil daftar Pekerjaan di Akun.

CloudServiceConfiguration

Konfigurasi untuk Simpul Komputasi dalam Kumpulan berdasarkan platform Azure Cloud Services.

ComputeNodeFillType

Bagaimana Tugas didistribusikan di seluruh Simpul Komputasi dalam Kumpulan.

ComputeNodeIdentityReference

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

ContainerConfiguration

Konfigurasi untuk Kumpulan yang mendukung kontainer.

ContainerRegistry

Registri kontainer privat.

ContainerType

Teknologi kontainer yang akan digunakan.

ContainerWorkingDirectory

Lokasi direktori kerja Tugas kontainer.

DataDisk

Pengaturan yang akan digunakan oleh disk data yang terkait dengan Simpul Komputasi di Kumpulan. Saat menggunakan diska data terlampir, Anda perlu memasang dan memformat diska dari dalam VM untuk menggunakannya.

DiffDiskPlacement

Menentukan penempatan disk ephemeral untuk disk sistem operasi untuk semua simpul komputasi (VM) di kumpulan.

DiffDiskSettings

Menentukan Pengaturan Disk ephemeral untuk disk sistem operasi yang digunakan oleh simpul komputasi (VM).

DiskEncryptionConfiguration

Konfigurasi enkripsi disk diterapkan pada simpul komputasi di kumpulan. Konfigurasi enkripsi disk tidak didukung pada kumpulan Linux yang dibuat dengan gambar Shared Image Gallery.

DynamicVNetAssignmentScope

Cakupan penugasan vnet dinamis.

ElevationLevel

Tingkat elevasi pengguna.

EnvironmentSetting

Variabel lingkungan yang akan diatur pada proses Tugas.

ErrorCategory

Kategori kesalahan.

ErrorMessage

Pesan kesalahan diterima dalam respons kesalahan Azure Batch.

HttpHeader

Pasangan nama-nilai header HTTP

ImageReference

Referensi ke Gambar Azure Virtual Machines Marketplace atau Gambar Shared Image Gallery. Untuk mendapatkan daftar semua referensi gambar Marketplace Azure diverifikasi oleh Azure Batch, lihat operasi 'Daftar Gambar yang Didukung'.

InboundEndpointProtocol

Protokol titik akhir.

InboundNATPool

Kumpulan NAT masuk yang dapat digunakan untuk mengatasi port tertentu pada Simpul Komputasi di Kumpulan Batch secara eksternal.

IPAddressProvisioningType

Jenis provisi untuk Alamat IP Publik untuk Kumpulan.

JobConstraints

Batasan eksekusi untuk Pekerjaan.

JobExecutionInformation

Berisi informasi tentang eksekusi Pekerjaan di layanan Azure Batch.

JobManagerTask

Menentukan detail Tugas Manajer Pekerjaan.

JobNetworkConfiguration

Konfigurasi jaringan untuk Pekerjaan.

JobPreparationTask

Tugas Persiapan Pekerjaan untuk dijalankan sebelum Tugas Pekerjaan apa pun pada Simpul Komputasi tertentu.

JobReleaseTask

Tugas Rilis Pekerjaan untuk dijalankan pada Penyelesaian pekerjaan pada Simpul Komputasi mana pun tempat Pekerjaan telah berjalan.

JobSchedulingError

Kesalahan yang ditemui oleh layanan Batch saat menjadwalkan Pekerjaan.

JobState

Status Pekerjaan.

JobStatistics

Statistik penggunaan sumber daya untuk Pekerjaan.

LinuxUserConfiguration

Properti yang digunakan untuk membuat Akun pengguna pada Simpul Komputasi Linux.

LoginMode

Mode masuk untuk pengguna

MetadataItem

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

MountConfiguration

Sistem file yang akan dipasang pada setiap simpul.

NameValuePair

Mewakili pasangan nama-nilai.

NetworkConfiguration

Konfigurasi jaringan untuk Kumpulan.

NetworkSecurityGroupRule

Aturan grup keamanan jaringan untuk diterapkan ke titik akhir masuk.

NetworkSecurityGroupRuleAccess

Tindakan yang harus diambil untuk alamat IP, rentang subnet, atau tag tertentu.

NFSMountConfiguration

Informasi yang digunakan untuk menyambungkan ke sistem file NFS.

NodePlacementConfiguration

Konfigurasi penempatan simpul untuk kumpulan.

NodePlacementPolicyType

Kebijakan penempatan untuk mengalokasikan simpul di kumpulan.

OnAllTasksComplete

Tindakan yang harus dilakukan layanan Batch ketika semua Tugas dalam Pekerjaan dalam status selesai.

OnTaskFailure

Tindakan yang harus diambil layanan Batch ketika Tugas apa pun dalam Pekerjaan gagal.

OSDisk

Pengaturan untuk disk sistem operasi simpul komputasi (VM).

OutputFile

Spesifikasi untuk mengunggah file dari Simpul Komputasi Azure Batch ke lokasi lain setelah layanan Batch selesai menjalankan proses Tugas.

OutputFileBlobContainerDestination

Menentukan tujuan unggahan file dalam kontainer penyimpanan blob Azure.

OutputFileDestination

Tujuan tempat file harus diunggah.

OutputFileUploadCondition

Kondisi di mana file output Tugas atau sekumpulan file harus diunggah.

OutputFileUploadOptions

Detail tentang operasi pengunggahan file output, termasuk dalam kondisi apa untuk melakukan unggahan.

PoolEndpointConfiguration

Konfigurasi titik akhir untuk Kumpulan.

PoolInformation

Menentukan bagaimana Pekerjaan harus ditetapkan ke Kumpulan.

PoolLifetimeOption

Masa pakai minimum Kumpulan otomatis yang dibuat, dan bagaimana beberapa Pekerjaan pada jadwal ditetapkan ke Kumpulan.

PoolSpecification

Spesifikasi untuk membuat Kumpulan baru.

PublicIPAddressConfiguration

Konfigurasi Alamat IP publik dari konfigurasi jaringan 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.

StorageAccountType

Jenis Akun penyimpanan untuk digunakan dalam membuat disk data.

TaskConstraints

Batasan eksekusi untuk diterapkan ke Tugas.

TaskContainerSettings

Pengaturan kontainer untuk Tugas.

TaskSchedulingPolicy

Menentukan bagaimana Tugas harus didistribusikan di seluruh Simpul Komputasi.

UserAccount

Properti yang digunakan untuk membuat pengguna yang digunakan untuk menjalankan Tugas pada Simpul Komputasi Azure Batch.

UserIdentity

Definisi identitas pengguna tempat Tugas dijalankan.

VirtualMachineConfiguration

Konfigurasi untuk Simpul Komputasi dalam Kumpulan berdasarkan infrastruktur Azure Virtual Machines.

VMExtension

Konfigurasi untuk ekstensi komputer virtual.

WindowsConfiguration

Windows pengaturan sistem operasi untuk diterapkan ke komputer virtual.

WindowsUserConfiguration

Properti yang digunakan untuk membuat Akun pengguna pada Simpul Komputasi Windows.

ApplicationPackageReference

Referensi ke Paket yang akan disebarkan ke Simpul Komputasi.

Name Type Description
applicationId
  • string

ID aplikasi yang akan disebarkan.

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.

AuthenticationTokenSettings

Pengaturan untuk token autentikasi yang dapat digunakan Tugas untuk melakukan operasi layanan Batch.

Name Type Description
access
  • string[]

Sumber daya Batch tempat token memberikan akses.
Token autentikasi memberikan akses ke serangkaian operasi layanan Batch terbatas. Saat ini satu-satunya nilai yang didukung untuk properti akses adalah 'pekerjaan', yang memberikan akses ke semua operasi yang terkait dengan Pekerjaan yang berisi Tugas.

AutoPoolSpecification

Menentukan karakteristik untuk 'kumpulan otomatis' sementara. Layanan Batch akan membuat Kumpulan otomatis ini saat Pekerjaan dikirimkan.

Name Type Description
autoPoolIdPrefix
  • string

Awalan yang akan ditambahkan ke pengidentifikasi unik saat Kumpulan dibuat secara otomatis.
Layanan Batch menetapkan setiap Kumpulan otomatis pengidentifikasi unik pada pembuatan. Untuk membedakan antara Kumpulan yang dibuat untuk tujuan yang berbeda, Anda dapat menentukan elemen ini untuk menambahkan awalan ke ID yang ditetapkan. Panjang awalannya bisa hingga 20 karakter.

keepAlive
  • boolean

Apakah akan menjaga Kumpulan otomatis tetap hidup setelah masa pakainya kedaluwarsa.
Jika false, layanan Batch menghapus Kumpulan setelah masa pakainya (sebagaimana ditentukan oleh pengaturan poolLifetimeOption) kedaluwarsa; yaitu, ketika Pekerjaan atau Jadwal Pekerjaan selesai. Jika true, layanan Batch tidak menghapus Kumpulan secara otomatis. Terserah pengguna untuk menghapus Kumpulan otomatis yang dibuat dengan opsi ini.

pool

Spesifikasi Kumpulan untuk Kumpulan otomatis.

poolLifetimeOption

Masa pakai minimum Kumpulan otomatis yang dibuat, dan bagaimana beberapa Pekerjaan pada jadwal ditetapkan ke Kumpulan.

AutoUserScope

Cakupan untuk pengguna otomatis

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

Name Type Description
elevationLevel

Tingkat elevasi pengguna otomatis.
Nilai defaultnya adalah nonAdmin.

scope

Cakupan untuk pengguna otomatis
Nilai defaultnya adalah kumpulan. Jika kumpulan berjalan 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.

AzureBlobFileSystemConfiguration

Informasi yang digunakan untuk menyambungkan ke Kontainer Azure Storage menggunakan Blobfuse.

Name Type Description
accountKey
  • string

Kunci Akun Azure Storage.
Properti ini saling eksklusif dengan sasKey dan identitas; tepat satu harus ditentukan.

accountName
  • string

Nama Akun Azure Storage.

blobfuseOptions
  • string

Opsi baris perintah tambahan untuk diteruskan ke perintah pemasangan.
Ini adalah opsi 'penggunaan bersih' dalam opsi Windows dan 'mount' di Linux.

containerName
  • string

Nama Kontainer Azure Blob Storage.

identityReference

Referensi ke identitas yang ditetapkan pengguna untuk digunakan untuk mengakses containerName
Properti ini saling eksklusif dengan accountKey dan sasKey; tepat satu harus ditentukan.

relativeMountPath
  • string

Jalur relatif pada simpul komputasi tempat sistem file akan dipasang
Semua sistem file dipasang relatif terhadap direktori pemasangan Batch, dapat diakses melalui variabel lingkungan AZ_BATCH_NODE_MOUNTS_DIR.

sasKey
  • string

Token SAS Azure Storage.
Properti ini saling eksklusif dengan accountKey dan identitas; tepat satu harus ditentukan.

AzureFileShareConfiguration

Informasi yang digunakan untuk menyambungkan ke Azure Fileshare.

Name Type Description
accountKey
  • string

Kunci akun Azure Storage.

accountName
  • string

Nama akun Azure Storage.

azureFileUrl
  • string

URL Azure Files.
Ini adalah formulir 'https://{account}.file.core.windows.net/'.

mountOptions
  • string

Opsi baris perintah tambahan untuk diteruskan ke perintah pemasangan.
Ini adalah opsi 'penggunaan bersih' dalam opsi Windows dan 'mount' di Linux.

relativeMountPath
  • string

Jalur relatif pada simpul komputasi tempat sistem file akan dipasang
Semua sistem file dipasang relatif terhadap direktori pemasangan Batch, dapat diakses melalui variabel lingkungan AZ_BATCH_NODE_MOUNTS_DIR.

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.

CachingType

Jenis penembolokan yang akan diaktifkan untuk disk.

Name Type Description
none
  • string

Mode penembolokan untuk disk tidak diaktifkan.

readonly
  • string

Mode penembolokan untuk disk hanya dapat dibaca.

readwrite
  • string

Mode penembolokan untuk disk dibaca dan ditulis.

CertificateReference

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

Name Type Description
storeLocation

Lokasi penyimpanan Sertifikat pada Simpul Komputasi tempat menginstal Sertifikat.
Nilai defaultnya adalah currentuser. Properti ini hanya berlaku untuk Kumpulan yang dikonfigurasi dengan Windows Simpul Komputasi (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 diberikan 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 Windows Simpul Komputasi (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
  • string[]

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.

Name Type Description
currentuser
  • string

Sertifikat harus diinstal ke penyimpanan Sertifikat CurrentUser.

localmachine
  • string

Sertifikat harus diinstal ke penyimpanan Sertifikat LocalMachine.

CIFSMountConfiguration

Informasi yang digunakan untuk menyambungkan ke sistem file CIFS.

Name Type Description
mountOptions
  • string

Opsi baris perintah tambahan untuk diteruskan ke perintah pemasangan.
Ini adalah opsi 'penggunaan bersih' dalam opsi Windows dan 'mount' di Linux.

password
  • string

Kata sandi yang digunakan untuk autentikasi terhadap sistem file CIFS.

relativeMountPath
  • string

Jalur relatif pada simpul komputasi tempat sistem file akan dipasang
Semua sistem file dipasang relatif terhadap direktori pemasangan Batch, dapat diakses melalui variabel lingkungan AZ_BATCH_NODE_MOUNTS_DIR.

source
  • string

URI sistem file yang akan dipasang.

username
  • string

Pengguna yang digunakan untuk autentikasi terhadap sistem file CIFS.

CloudJob

Pekerjaan Azure Batch.

Name Type Default Value Description
allowTaskPreemption
  • boolean

Apakah Tugas dalam pekerjaan ini dapat didahulukan oleh pekerjaan prioritas tinggi lainnya
Jika nilai diatur ke True, pekerjaan prioritas tinggi lainnya yang dikirimkan ke sistem akan diutamakan dan akan dapat mengantrekan kembali tugas dari pekerjaan ini. Anda dapat memperbarui allowTaskPreemption pekerjaan setelah dibuat menggunakan API pekerjaan pembaruan.

commonEnvironmentSettings

Daftar pengaturan variabel lingkungan umum. Variabel lingkungan ini diatur untuk semua Tugas dalam Pekerjaan (termasuk Manajer Pekerjaan, Persiapan Pekerjaan, dan Tugas Rilis Pekerjaan).
Tugas Individual dapat mengganti pengaturan lingkungan yang ditentukan di sini dengan menentukan nama pengaturan yang sama dengan nilai yang berbeda.

constraints

Batasan eksekusi untuk Pekerjaan.

creationTime
  • string

Waktu pembuatan Pekerjaan.

displayName
  • string

Nama tampilan untuk Pekerjaan.

eTag
  • string

ETag Pekerjaan.
Ini adalah string buram. Anda dapat menggunakannya untuk mendeteksi apakah Pekerjaan telah berubah di antara permintaan. Secara khusus, Anda dapat meneruskan ETag saat memperbarui Pekerjaan untuk menentukan bahwa perubahan Anda harus berlaku hanya jika tidak ada orang lain yang telah memodifikasi Pekerjaan sementara itu.

executionInfo

Informasi eksekusi untuk Pekerjaan.

id
  • string

String yang secara unik mengidentifikasi Pekerjaan dalam Akun.
ID ini mempertahankan huruf besar/kecil dan tidak peka huruf besar/kecil (artinya, Anda mungkin tidak memiliki dua ID dalam Akun yang hanya berbeda menurut kasus).

jobManagerTask

Detail Tugas Manajer Pekerjaan yang akan diluncurkan saat Pekerjaan dimulai.
Tugas Manajer Pekerjaan dimulai secara otomatis saat Pekerjaan dibuat. Layanan Batch mencoba menjadwalkan Tugas Manajer Pekerjaan sebelum Tugas lain dalam Pekerjaan. Saat menyusutkan Kumpulan, layanan Batch mencoba mempertahankan Simpul di mana Tugas Manajer Pekerjaan berjalan selama mungkin (yaitu, Simpul Komputasi yang menjalankan Tugas 'normal' dihapus sebelum Simpul Komputasi yang menjalankan Tugas Manajer Pekerjaan). Ketika Tugas Manajer Pekerjaan gagal dan perlu dimulai ulang, sistem mencoba menjadwalkannya pada prioritas tertinggi. Jika tidak ada Simpul Komputasi menganggur yang tersedia, sistem dapat mengakhiri salah satu Tugas yang sedang berjalan di Kumpulan dan mengembalikannya ke antrean untuk memberi ruang bagi Tugas Manajer Pekerjaan untuk memulai ulang. Perhatikan bahwa Tugas Manajer Pekerjaan dalam satu Pekerjaan tidak memiliki prioritas atas Tugas di Pekerjaan lain. Di seluruh Pekerjaan, hanya prioritas tingkat Pekerjaan yang diamati. Misalnya, jika Job Manager dalam prioritas 0 Pekerjaan perlu dimulai ulang, Tugas prioritas 1 tidak akan dialihkan. Batch akan mencoba kembali Tugas ketika operasi pemulihan dipicu pada Node. Contoh operasi pemulihan termasuk (tetapi tidak terbatas pada) ketika Simpul yang tidak sehat di-boot ulang atau Simpul Komputasi menghilang karena kegagalan host. Percobaan ulang karena operasi pemulihan tidak independen dan tidak dihitung terhadap maxTaskRetryCount. Bahkan jika maxTaskRetryCount adalah 0, coba lagi internal karena operasi pemulihan dapat terjadi. Karena itu, semua Tugas harus idempotensi. Ini berarti Tugas perlu mentolerir terganggu dan dimulai ulang tanpa menyebabkan kerusakan atau data duplikat. Praktik terbaik untuk Tugas yang berjalan lama adalah menggunakan beberapa bentuk titik pemeriksaan.

jobPreparationTask

Tugas persiapan pekerjaan.
Tugas Persiapan Pekerjaan adalah Tugas khusus yang dijalankan pada setiap Simpul Komputasi sebelum Tugas Pekerjaan lainnya.

jobReleaseTask

Tugas Pelepasan Kerja.
Tugas Pelepasan Kerja adalah Tugas khusus yang dijalankan di akhir Pekerjaan pada setiap Simpul Komputasi yang telah menjalankan Tugas Pekerjaan lainnya.

lastModified
  • string

Waktu terakhir dimodifikasi dari Pekerjaan.
Ini adalah terakhir kalinya data tingkat Pekerjaan, seperti status atau prioritas Pekerjaan, diubah. Ini tidak memperhitungkan perubahan tingkat tugas seperti menambahkan status Perubahan Tugas atau Tugas baru.

maxParallelTasks
  • integer
-1

Jumlah maksimum tugas yang dapat dijalankan secara paralel untuk pekerjaan tersebut.
Nilai maxParallelTasks harus -1 atau lebih besar dari 0 jika ditentukan. Jika tidak ditentukan, nilai defaultnya adalah -1, yang berarti tidak ada batasan jumlah tugas yang dapat dijalankan sekaligus. Anda dapat memperbarui maxParallelTasks pekerjaan setelah dibuat menggunakan API pekerjaan pembaruan.

metadata

Daftar pasangan nama-nilai yang terkait dengan Pekerjaan sebagai metadata.
Layanan Batch tidak menetapkan arti apa pun untuk metadata; hanya untuk penggunaan kode pengguna.

networkConfiguration

Konfigurasi jaringan untuk Pekerjaan.

onAllTasksComplete

Tindakan yang harus dilakukan layanan Batch ketika semua Tugas dalam Pekerjaan dalam status selesai.
Defaultnya adalah noaction.

onTaskFailure

Tindakan yang harus dilakukan layanan Batch ketika Tugas apa pun dalam Pekerjaan gagal.
Tugas dianggap gagal jika mengalami failureInfo. failureInfo diatur jika Tugas selesai dengan kode keluar bukan nol setelah menghabiskan jumlah coba lagi, atau jika ada kesalahan memulai Tugas, misalnya karena kesalahan pengunduhan file sumber daya. Defaultnya adalah noaction.

poolInfo

Pengaturan Kumpulan yang terkait dengan Pekerjaan.

previousState

Status Pekerjaan sebelumnya.
Properti ini tidak diatur jika Pekerjaan dalam status Aktif awalnya.

previousStateTransitionTime
  • string

Waktu di mana Pekerjaan memasuki status sebelumnya.
Properti ini tidak diatur jika Pekerjaan dalam status Aktif awalnya.

priority
  • integer

Prioritas Pekerjaan.
Nilai prioritas dapat berkisar dari -1000 hingga 1000, dengan -1000 menjadi prioritas terendah dan 1000 menjadi prioritas tertinggi. Nilai default adalah 0.

state

Status Pekerjaan saat ini.

stateTransitionTime
  • string

Waktu di mana Pekerjaan memasuki statusnya saat ini.

stats

Statistik penggunaan sumber daya untuk seluruh masa pakai Pekerjaan.
Properti ini diisi hanya jika CloudJob diambil dengan klausa perluas termasuk atribut 'statistik'; jika tidak, itu null. Statistik mungkin tidak segera tersedia. Layanan Batch melakukan roll-up statistik secara berkala. Penundaan umumnya adalah sekitar 30 menit.

url
  • string

URL Pekerjaan.

usesTaskDependencies
  • boolean

Apakah Tugas dalam Pekerjaan dapat menentukan dependensi satu sama lain. Defaultnya adalah false (salah).

CloudJobListResult

Hasil daftar Pekerjaan di Akun.

Name Type Description
odata.nextLink
  • string

URL untuk mendapatkan serangkaian hasil berikutnya.

value

Daftar Pekerjaan.

CloudServiceConfiguration

Konfigurasi untuk Simpul Komputasi dalam Kumpulan berdasarkan platform Azure Cloud Services.

Name Type Description
osFamily
  • string

Keluarga OS Tamu Azure yang akan diinstal pada komputer virtual di Kumpulan.
Nilai yang mungkin adalah: 2 - OS Family 2, setara dengan Windows Server 2008 R2 SP1. 3 - OS Family 3, setara dengan Windows Server 2012. 4 - OS Family 4, setara dengan Windows Server 2012 R2. 5 - OS Family 5, setara dengan Windows Server 2016. 6 - OS Family 6, setara dengan Windows Server 2019. Untuk informasi selengkapnya, lihat Rilis OS Tamu Azure (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases).

osVersion
  • string

Versi OS Tamu Azure yang akan diinstal pada komputer virtual di Kumpulan.
Nilai defaultnya adalah * yang menentukan versi sistem operasi terbaru untuk keluarga OS yang ditentukan.

ComputeNodeFillType

Bagaimana Tugas didistribusikan di seluruh Simpul Komputasi dalam Kumpulan.

Name Type Description
pack
  • string

Tugas sebanyak mungkin (taskSlotsPerNode) harus ditetapkan ke setiap Simpul Komputasi di Kumpulan sebelum Tugas ditetapkan ke Simpul Komputasi berikutnya di Kumpulan.

spread
  • string

Tugas harus ditetapkan secara merata di semua Simpul Komputasi di Kumpulan.

ComputeNodeIdentityReference

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

Name Type Description
resourceId
  • string

Id sumber daya ARM dari identitas yang ditetapkan pengguna.

ContainerConfiguration

Konfigurasi untuk Kumpulan yang mendukung kontainer.

Name Type Description
containerImageNames
  • string[]

Kumpulan nama Gambar kontainer.
Ini adalah referensi Gambar lengkap, seperti yang akan ditentukan ke "penarikan docker". Gambar akan bersumber dari registri Docker default kecuali Gambar sepenuhnya memenuhi syarat dengan registri alternatif.

containerRegistries

Registri privat tambahan tempat kontainer dapat ditarik.
Jika ada Gambar yang harus diunduh dari registri privat yang memerlukan kredensial, kredensial tersebut harus disediakan di sini.

type

Teknologi kontainer yang akan digunakan.

ContainerRegistry

Registri kontainer privat.

Name Type Description
identityReference

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.

ContainerType

Teknologi kontainer yang akan digunakan.

Name Type Description
dockerCompatible
  • string

Teknologi kontainer yang kompatibel dengan Docker akan digunakan untuk meluncurkan kontainer.

ContainerWorkingDirectory

Lokasi direktori kerja Tugas kontainer.

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

DataDisk

Pengaturan yang akan digunakan oleh disk data yang terkait dengan Simpul Komputasi di Kumpulan. Saat menggunakan diska data terlampir, Anda perlu memasang dan memformat diska dari dalam VM untuk menggunakannya.

Name Type Description
caching

Jenis penembolokan yang akan diaktifkan untuk disk data.
Nilai default untuk penembolokan adalah readwrite. Untuk informasi tentang opsi penembolokan, lihat: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/.

diskSizeGB
  • integer

Ukuran disk awal dalam gigabyte.

lun
  • integer

Nomor unit logis.
Lun digunakan untuk mengidentifikasi setiap disk data secara unik. Jika melampirkan beberapa disk, masing-masing harus memiliki lun yang berbeda. Nilai harus antara 0 dan 63, inklusif.

storageAccountType

Jenis Akun penyimpanan yang akan digunakan untuk disk data.
Jika dihilangkan, defaultnya adalah "standard_lrs".

DiffDiskPlacement

Menentukan penempatan disk ephemeral untuk disk sistem operasi untuk semua simpul komputasi (VM) di kumpulan.

Name Type Description
CacheDisk
  • string

Disk Ephemeral OS disimpan di cache VM.

DiffDiskSettings

Menentukan Pengaturan Disk ephemeral untuk disk sistem operasi yang digunakan oleh simpul komputasi (VM).

Name Type Description
placement

Menentukan penempatan disk ephemeral untuk disk sistem operasi untuk semua VM di kumpulan.
Properti ini dapat digunakan oleh pengguna dalam permintaan untuk memilih lokasi misalnya, ruang disk cache untuk provisi disk OS Ephemeral. Untuk informasi selengkapnya tentang persyaratan ukuran disk OS Ephemeral, silakan lihat persyaratan ukuran disk OS Ephemeral untuk VM Windows di https://docs.microsoft.com/en-us/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements dan VM Linux di https://docs.microsoft.com/en-us/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements.

DiskEncryptionConfiguration

Konfigurasi enkripsi disk diterapkan pada simpul komputasi di kumpulan. Konfigurasi enkripsi disk tidak didukung pada kumpulan Linux yang dibuat dengan gambar Shared Image Gallery.

Name Type Description
targets
  • string[]

Daftar target disk Layanan Batch akan dienkripsi pada simpul komputasi.
Jika dihilangkan, tidak ada disk pada simpul komputasi di kumpulan yang akan dienkripsi. Di kumpulan Linux, hanya "TemporaryDisk" yang didukung; pada kumpulan Windows, "OsDisk" dan "TemporaryDisk" harus ditentukan.

DynamicVNetAssignmentScope

Cakupan penugasan vnet dinamis.

Name Type Description
job
  • string

Penugasan VNet dinamis dilakukan per pekerjaan.

none
  • string

Tidak ada penetapan VNet dinamis yang diaktifkan.

ElevationLevel

Tingkat elevasi pengguna.

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

Name Type Description
name
  • string

Nama variabel lingkungan.

value
  • string

Nilai variabel lingkungan.

ErrorCategory

Kategori kesalahan.

Name Type Description
servererror
  • string

Kesalahan ini disebabkan oleh masalah server internal.

usererror
  • string

Kesalahan ini disebabkan oleh masalah pengguna, seperti kesalahan konfigurasi.

ErrorMessage

Pesan kesalahan diterima dalam respons kesalahan Azure Batch.

Name Type Description
lang
  • string

Kode bahasa pesan kesalahan

value
  • string

Teks pesan.

HttpHeader

Pasangan nama-nilai header HTTP

Name Type Description
name
  • string

Nama header yang tidak peka huruf besar/kecil yang akan digunakan saat mengunggah file output

value
  • string

Nilai header yang akan digunakan saat mengunggah file output

ImageReference

Referensi ke Gambar Azure Virtual Machines Marketplace atau Gambar Shared Image Gallery. Untuk mendapatkan daftar semua referensi gambar Marketplace Azure diverifikasi oleh Azure Batch, lihat operasi 'Daftar Gambar yang Didukung'.

Name Type Description
exactVersion
  • string

Versi spesifik gambar platform atau gambar marketplace yang digunakan untuk membuat simpul. Bidang baca-saja ini berbeda dari 'versi' hanya jika nilai yang ditentukan untuk 'versi' ketika kumpulan dibuat adalah 'terbaru'.

offer
  • string

Jenis penawaran Azure Virtual Machines Marketplace Image.
Misalnya, UbuntuServer atau WindowsServer.

publisher
  • string

Penerbit Azure Virtual Machines Marketplace Image.
Misalnya, Canonical atau MicrosoftWindowsServer.

sku
  • string

SKU Gambar Azure Virtual Machines Marketplace.
Misalnya, 18.04-LTS atau 2019-Datacenter.

version
  • string

Versi Azure Virtual Machines Marketplace Image.
Nilai 'terbaru' dapat ditentukan untuk memilih versi terbaru Gambar. Jika dihilangkan, defaultnya adalah 'terbaru'.

virtualMachineImageId
  • string

Pengidentifikasi sumber daya ARM dari Gambar Shared Image Gallery. Simpul Komputasi di Kumpulan akan dibuat menggunakan Id Gambar ini. Ini adalah formulir /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} atau /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName} untuk selalu default ke versi gambar terbaru.
Properti ini saling eksklusif dengan properti ImageReference lainnya. Gambar Shared Image Gallery harus memiliki replika di wilayah yang sama dan harus berada dalam langganan yang sama dengan akun Azure Batch. Jika versi gambar tidak ditentukan dalam imageId, versi terbaru akan digunakan. Untuk informasi tentang pengaturan firewall untuk agen Simpul Komputasi Batch untuk berkomunikasi dengan layanan Batch, lihat https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration.

InboundEndpointProtocol

Protokol titik akhir.

Name Type Description
tcp
  • string

Gunakan TCP untuk titik akhir.

udp
  • string

Gunakan UDP untuk titik akhir.

InboundNATPool

Kumpulan NAT masuk yang dapat digunakan untuk mengatasi port tertentu pada Simpul Komputasi di Kumpulan Batch secara eksternal.

Name Type Description
backendPort
  • integer

Nomor port pada Simpul Komputasi.
Ini harus unik dalam Kumpulan Batch. Nilai yang dapat diterima adalah antara 1 dan 65535 kecuali untuk 22, 3389, 29876 dan 29877 karena ini dicadangkan. Jika ada nilai yang dipesan yang disediakan, permintaan gagal dengan kode status HTTP 400.

frontendPortRangeEnd
  • integer

Nomor port terakhir dalam rentang port eksternal yang akan digunakan untuk menyediakan akses masuk ke backendPort pada Simpul Komputasi individual.
Nilai yang dapat diterima berkisar antara 1 dan 65534 kecuali port dari 50000 hingga 55000 yang dicadangkan oleh layanan Batch. Semua rentang dalam Kumpulan harus berbeda dan tidak dapat tumpang tindih. Setiap rentang harus berisi setidaknya 40 port. Jika ada nilai yang dicadangkan atau tumpang tindih disediakan permintaan gagal dengan kode status HTTP 400.

frontendPortRangeStart
  • integer

Nomor port pertama dalam rentang port eksternal yang akan digunakan untuk menyediakan akses masuk ke backendPort pada Simpul Komputasi individual.
Nilai yang dapat diterima berkisar antara 1 dan 65534 kecuali port dari 50000 hingga 55000 yang dicadangkan. Semua rentang dalam Kumpulan harus berbeda dan tidak dapat tumpang tindih. Setiap rentang harus berisi setidaknya 40 port. Jika ada nilai yang dicadangkan atau tumpang tindih disediakan permintaan gagal dengan kode status HTTP 400.

name
  • string

Nama titik akhir.
Nama harus unik dalam Kumpulan Batch, dapat berisi huruf, angka, garis bawah, titik, dan tanda hubung. Nama harus dimulai dengan huruf atau angka, harus diakhir dengan huruf, angka, atau garis bawah, dan tidak boleh melebihi 77 karakter. Jika ada nilai yang tidak valid yang disediakan, permintaan gagal dengan kode status HTTP 400.

networkSecurityGroupRules

Daftar aturan grup keamanan jaringan yang akan diterapkan ke titik akhir.
Jumlah maksimum aturan yang dapat ditentukan di semua titik akhir pada Kumpulan Batch adalah 25. Jika tidak ada aturan grup keamanan jaringan yang ditentukan, aturan default akan dibuat untuk mengizinkan akses masuk ke backendPort yang ditentukan. Jika jumlah maksimum aturan grup keamanan jaringan melebihi permintaan gagal dengan kode status HTTP 400.

protocol

Protokol titik akhir.

IPAddressProvisioningType

Jenis provisi untuk Alamat IP Publik untuk Kumpulan.

Name Type Description
batchmanaged
  • string

IP publik akan dibuat dan dikelola oleh Batch. Mungkin ada beberapa IP publik tergantung pada ukuran Kumpulan.

nopublicipaddresses
  • string

Tidak ada Alamat IP publik yang akan dibuat.

usermanaged
  • string

IP publik disediakan oleh pengguna dan akan digunakan untuk memprovisikan Simpul Komputasi.

JobConstraints

Batasan eksekusi untuk Pekerjaan.

Name Type Description
maxTaskRetryCount
  • integer

Jumlah maksimum kali setiap 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 setiap Tugas sekali, dan kemudian dapat mencoba kembali hingga batas ini. Misalnya, jika jumlah coba lagi 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 ulang)

maxWallClockTime
  • string

Waktu maksimum yang berlalu yang dapat dijalankan Pekerjaan, diukur sejak Pekerjaan dibuat.
Jika Pekerjaan tidak selesai dalam batas waktu, layanan Batch mengakhirinya dan Tugas apa pun yang masih berjalan. Dalam hal ini, alasan penghentian adalah MaxWallClockTimeExpiry. Jika properti ini tidak ditentukan, tidak ada batas waktu berapa lama Pekerjaan dapat berjalan.

JobExecutionInformation

Berisi informasi tentang eksekusi Pekerjaan di layanan Azure Batch.

Name Type Description
endTime
  • string

Waktu penyelesaian Pekerjaan.
Properti ini diatur hanya jika Pekerjaan dalam status selesai.

poolId
  • string

ID Kumpulan tempat Pekerjaan ini ditetapkan.
Elemen ini berisi Kumpulan aktual tempat Pekerjaan ditetapkan. Saat Anda mendapatkan detail Pekerjaan dari layanan, detail tersebut juga berisi elemen poolInfo, yang berisi data konfigurasi Kumpulan dari saat Pekerjaan ditambahkan atau diperbarui. Elemen poolInfo itu juga dapat berisi elemen poolId. Jika ya, kedua ID tersebut sama. Jika tidak, itu berarti Pekerjaan berjalan pada Kumpulan otomatis, dan properti ini berisi ID Kumpulan otomatis tersebut.

schedulingError

Detail kesalahan apa pun yang ditemui oleh layanan dalam memulai Pekerjaan.
Properti ini tidak diatur jika tidak ada kesalahan saat memulai Pekerjaan.

startTime
  • string

Waktu mulai Pekerjaan.
Ini adalah waktu di mana Pekerjaan dibuat.

terminateReason
  • string

String yang menjelaskan alasan Pekerjaan berakhir.
Properti ini diatur hanya jika Pekerjaan dalam status selesai. Jika layanan Batch mengakhiri Pekerjaan, layanan tersebut menetapkan alasan sebagai berikut: JMComplete - Tugas Manajer Pekerjaan selesai, dan killJobOnCompletion diatur ke true. MaxWallClockTimeExpiry - Pekerjaan mencapai batasan maxWallClockTime-nya. TerminateJobSchedule - Pekerjaan berjalan sebagai bagian dari jadwal, dan jadwal dihentikan. AllTasksComplete - atribut onAllTasksComplete Pekerjaan diatur ke terminatejob, dan semua Tugas dalam Pekerjaan selesai. TaskFailed - atribut onTaskFailure Pekerjaan diatur ke performExitOptionsJobAction, dan Tugas dalam Pekerjaan gagal dengan kondisi keluar yang menentukan jobAction dari terminatejob. String lainnya adalah alasan yang ditentukan pengguna yang ditentukan dalam panggilan ke operasi 'Hentikan Pekerjaan'.

JobManagerTask

Menentukan detail Tugas Manajer Pekerjaan.

Name Type Description
allowLowPriorityNode
  • boolean

Apakah Tugas Manajer Pekerjaan dapat berjalan pada Simpul Komputasi Spot/Berprioritas rendah.
Nilai defaultnya adalah true.

applicationPackageReferences

Daftar Paket Aplikasi yang akan disebarkan layanan Batch ke Simpul Komputasi sebelum menjalankan baris perintah.
Paket Aplikasi diunduh dan disebarkan ke direktori bersama, bukan direktori kerja Tugas. Oleh karena itu, jika Paket Aplikasi yang direferensikan sudah ada di Simpul Komputasi, dan sudah diperbarui, maka paket tersebut tidak diunduh ulang; salinan yang ada pada Simpul Komputasi digunakan. Jika Paket Aplikasi yang direferensikan tidak dapat diinstal, misalnya karena paket telah dihapus atau karena pengunduhan gagal, Tugas gagal.

authenticationTokenSettings

Pengaturan untuk token autentikasi yang dapat digunakan Tugas untuk melakukan operasi layanan Batch.
Jika properti ini diatur, layanan Batch menyediakan Tugas dengan token autentikasi yang dapat digunakan untuk mengautentikasi operasi layanan Batch tanpa memerlukan kunci akses Akun. Token disediakan melalui variabel lingkungan AZ_BATCH_AUTHENTICATION_TOKEN. Operasi yang dapat dilakukan Tugas menggunakan token bergantung pada pengaturan. Misalnya, Tugas dapat meminta izin Pekerjaan untuk menambahkan Tugas lain ke Pekerjaan, atau memeriksa status Pekerjaan atau Tugas lain di bawah Pekerjaan.

commandLine
  • string

Baris perintah Tugas Manajer Pekerjaan.
Baris perintah tidak berjalan di bawah shell, dan oleh 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).

constraints

Batasan yang berlaku untuk Tugas Manajer Pekerjaan.

containerSettings

Pengaturan untuk kontainer tempat Tugas Manajer Pekerjaan berjalan.
Jika Kumpulan yang akan menjalankan Tugas ini memiliki kontainerConfiguration yang ditetapkan, ini juga harus diatur. Jika Kumpulan yang akan menjalankan Tugas ini tidak memiliki kumpulan containerConfiguration, ini tidak boleh diatur. 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 tersebut.

displayName
  • string

Nama tampilan Tugas Manajer Pekerjaan.
Ini tidak perlu unik dan dapat berisi karakter Unicode hingga panjang maksimum 1024.

environmentSettings

Daftar pengaturan variabel lingkungan untuk Tugas Manajer Pekerjaan.

id
  • string

String yang secara unik mengidentifikasi Tugas Manajer Pekerjaan dalam Pekerjaan.
ID dapat berisi kombinasi karakter alfanumerik termasuk tanda hubung dan garis bawah dan tidak boleh berisi lebih dari 64 karakter.

killJobOnCompletion
  • boolean

Apakah penyelesaian Tugas Manajer Pekerjaan menandakan penyelesaian seluruh Pekerjaan.
Jika true, ketika Tugas Job Manager selesai, layanan Batch menandai Pekerjaan sebagai selesai. Jika ada Tugas yang masih berjalan saat ini (selain Rilis Pekerjaan), Tugas tersebut dihentikan. Jika false, penyelesaian Tugas Manajer Pekerjaan tidak memengaruhi status Pekerjaan. Dalam hal ini, Anda harus menggunakan atribut onAllTasksComplete untuk mengakhiri Pekerjaan, atau meminta klien atau pengguna mengakhiri Pekerjaan secara eksplisit. Contohnya adalah jika Manajer Pekerjaan membuat sekumpulan Tugas tetapi kemudian tidak mengambil peran lebih lanjut dalam eksekusinya. Nilai defaultnya adalah true. Jika Anda menggunakan atribut onAllTasksComplete dan onTaskFailure untuk mengontrol masa pakai Pekerjaan, dan menggunakan Tugas Manajer Pekerjaan hanya untuk membuat Tugas untuk Pekerjaan (tidak memantau kemajuan), maka penting untuk mengatur killJobOnCompletion ke false.

outputFiles

Daftar file yang akan diunggah layanan Batch dari Simpul Komputasi setelah menjalankan baris perintah.
Untuk Tugas multi-instans, file hanya akan diunggah dari Simpul Komputasi tempat Tugas utama dijalankan.

requiredSlots
  • integer

Jumlah slot penjadwalan yang diperlukan Tugas untuk dijalankan.
Defaultnya adalah 1. Tugas hanya dapat dijadwalkan untuk dijalankan pada simpul komputasi jika simpul memiliki slot penjadwalan gratis yang cukup tersedia. Untuk Tugas multi-instans, properti ini tidak didukung dan tidak boleh ditentukan.

resourceFiles

Daftar file yang akan diunduh layanan Batch ke Simpul Komputasi sebelum menjalankan baris perintah.
File yang tercantum di bawah elemen ini terletak di direktori kerja Tugas. 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.

runExclusive
  • boolean

Apakah Tugas Manajer Pekerjaan memerlukan penggunaan eksklusif Simpul Komputasi tempatnya berjalan.
Jika true, tidak ada Tugas lain yang akan berjalan pada Simpul yang sama selama Manajer Pekerjaan berjalan. Jika false, Tugas lain dapat berjalan secara bersamaan dengan Manajer Pekerjaan pada Simpul Komputasi. Tugas Manajer Pekerjaan dihitung secara normal terhadap batas Tugas bersamaan Simpul Komputasi, jadi ini hanya relevan jika Simpul Komputasi memungkinkan beberapa Tugas bersamaan. Nilai defaultnya adalah true.

userIdentity

Identitas pengguna tempat Tugas Manajer Pekerjaan berjalan.
Jika dihilangkan, Tugas berjalan sebagai pengguna non-administratif yang unik untuk Tugas.

JobNetworkConfiguration

Konfigurasi jaringan untuk Pekerjaan.

Name Type Description
subnetId
  • string

Pengidentifikasi sumber daya ARM dari subnet jaringan virtual yang Simpul Komputasi yang menjalankan Tugas dari Pekerjaan akan bergabung selama Durasi Tugas. Ini hanya akan berfungsi dengan Kumpulan VirtualMachineConfiguration.
Jaringan virtual harus berada di wilayah dan langganan yang sama dengan Akun Azure Batch. Subnet yang ditentukan harus memiliki alamat IP gratis yang cukup untuk mengakomodasi jumlah Simpul Komputasi yang akan menjalankan Tugas dari Pekerjaan. Ini bisa hingga jumlah Simpul Komputasi di Kumpulan. Perwakilan layanan 'MicrosoftAzureBatch' harus memiliki peran 'Kontributor Komputer Virtual Klasik' Role-Based Access Control (RBAC) untuk VNet yang ditentukan sehingga layanan Azure Batch dapat menjadwalkan Tugas pada Simpul. Ini dapat diverifikasi dengan memeriksa apakah VNet yang ditentukan memiliki Kelompok Keamanan Jaringan (NSG) terkait. Jika komunikasi ke Simpul dalam subnet yang ditentukan ditolak oleh NSG, maka layanan Batch akan mengatur status Simpul Komputasi menjadi tidak dapat digunakan. Ini adalah formulir /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. Jika VNet yang ditentukan memiliki Kelompok Keamanan Jaringan (NSG) terkait, maka beberapa port sistem yang dipesan harus diaktifkan untuk komunikasi masuk dari layanan Azure Batch. Untuk Kumpulan yang dibuat dengan konfigurasi Komputer Virtual, aktifkan port 29876 dan 29877, serta port 22 untuk Linux dan port 3389 untuk Windows. Port 443 juga harus terbuka untuk koneksi keluar agar komunikasi Azure Storage. Untuk detail selengkapnya lihat: https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration

JobPreparationTask

Tugas Persiapan Pekerjaan untuk dijalankan sebelum Tugas Pekerjaan apa pun pada Simpul Komputasi tertentu.

Name Type Description
commandLine
  • string

Baris perintah Tugas Persiapan Pekerjaan.
Baris perintah tidak berjalan di bawah shell, dan oleh 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).

constraints

Batasan yang berlaku untuk Tugas Persiapan Pekerjaan.

containerSettings

Pengaturan untuk kontainer tempat Tugas Persiapan Pekerjaan 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 tersebut.

environmentSettings

Daftar pengaturan variabel lingkungan untuk Tugas Persiapan Pekerjaan.

id
  • string

String yang secara unik mengidentifikasi Tugas Persiapan Pekerjaan dalam Pekerjaan.
ID dapat berisi kombinasi karakter alfanumerik termasuk tanda hubung dan garis bawah dan tidak boleh berisi lebih dari 64 karakter. Jika Anda tidak menentukan properti ini, layanan Batch menetapkan nilai default 'jobpreparation'. Tidak ada Tugas lain dalam Pekerjaan yang dapat memiliki ID yang sama dengan Tugas Persiapan Pekerjaan. Jika Anda mencoba mengirimkan Tugas dengan id yang sama, layanan Batch menolak permintaan dengan kode kesalahan TaskIdSameAsJobPreparationTask; jika Anda memanggil REST API secara langsung, kode status HTTP adalah 409 (Konflik).

rerunOnNodeRebootAfterSuccess
  • boolean

Apakah layanan Batch harus menjalankan ulang Tugas Persiapan Pekerjaan setelah Reboot Simpul Komputasi.
Tugas Persiapan Pekerjaan selalu dijalankan ulang jika Simpul Komputasi dicitrakan ulang, atau jika Tugas Persiapan Pekerjaan tidak selesai (misalnya karena reboot terjadi saat Tugas sedang berjalan). Oleh karena itu, Anda harus selalu menulis Tugas Persiapan Pekerjaan agar idempotensi dan berperilaku benar jika dijalankan beberapa kali. Nilai defaultnya adalah true.

resourceFiles

Daftar file yang akan diunduh layanan Batch ke Simpul Komputasi sebelum menjalankan baris perintah.
File yang tercantum di bawah elemen ini terletak di direktori kerja Tugas. 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.

userIdentity

Identitas pengguna tempat Tugas Persiapan Pekerjaan berjalan.
Jika dihilangkan, Tugas berjalan sebagai pengguna non-administratif yang unik untuk Tugas pada Simpul Komputasi Windows, atau pengguna non-administratif yang unik untuk Kumpulan pada Simpul Komputasi Linux.

waitForSuccess
  • boolean

Apakah layanan Batch harus menunggu Tugas Persiapan Pekerjaan berhasil diselesaikan sebelum menjadwalkan Tugas Pekerjaan lainnya pada Simpul Komputasi. Tugas Persiapan Pekerjaan telah berhasil diselesaikan jika keluar dengan kode keluar 0.
Jika true dan Tugas Persiapan Pekerjaan gagal pada Node, layanan Batch mencoba kembali Tugas Persiapan Pekerjaan hingga jumlah coba lagi maksimumnya (seperti yang ditentukan dalam elemen batasan). Jika Tugas masih belum berhasil diselesaikan setelah semua percobaan ulang, maka layanan Batch tidak akan menjadwalkan Tugas Pekerjaan ke Simpul. Simpul tetap aktif dan memenuhi syarat untuk menjalankan Tugas Pekerjaan lain. Jika false, layanan Batch tidak akan menunggu Tugas Persiapan Pekerjaan selesai. Dalam hal ini, Tugas Pekerjaan lainnya dapat mulai dijalankan pada Simpul Komputasi saat Tugas Persiapan Pekerjaan masih berjalan; dan bahkan jika Tugas Persiapan Pekerjaan gagal, Tugas baru akan terus dijadwalkan pada Simpul Komputasi. Nilai defaultnya adalah true.

JobReleaseTask

Tugas Rilis Pekerjaan untuk dijalankan pada Penyelesaian pekerjaan pada Simpul Komputasi mana pun tempat Pekerjaan telah berjalan.

Name Type Description
commandLine
  • string

Baris perintah Tugas Pelepasan Pekerjaan.
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

Pengaturan untuk kontainer tempat Tugas Pelepasan Pekerjaan 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

Daftar pengaturan variabel lingkungan untuk Tugas Rilis Pekerjaan.

id
  • string

String yang secara unik mengidentifikasi Tugas Rilis Pekerjaan dalam Pekerjaan.
ID dapat berisi kombinasi karakter alfanumerik termasuk tanda hubung dan garis bawah dan tidak boleh berisi lebih dari 64 karakter. Jika Anda tidak menentukan properti ini, layanan Batch menetapkan nilai default 'jobrelease'. Tidak ada Tugas lain dalam Pekerjaan yang dapat memiliki ID yang sama dengan Tugas Rilis Pekerjaan. Jika Anda mencoba mengirimkan Tugas dengan id yang sama, layanan Batch menolak permintaan dengan kode kesalahan TaskIdSameAsJobReleaseTask; jika Anda memanggil REST API secara langsung, kode status HTTP adalah 409 (Konflik).

maxWallClockTime
  • string

Waktu maksimum yang berlalu yang dapat dijalankan Tugas Rilis Pekerjaan pada Simpul Komputasi tertentu, diukur sejak Tugas dimulai. Jika Tugas tidak selesai dalam batas waktu, layanan Batch akan mengakhirinya. Nilai defaultnya adalah 15 menit. Anda mungkin tidak menentukan batas waktu lebih dari 15 menit. Jika Anda melakukannya, layanan Batch menolaknya dengan kesalahan; jika Anda memanggil REST API secara langsung, kode status HTTP adalah 400 (Permintaan Buruk).

resourceFiles

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.

retentionTime
  • string

Waktu minimum untuk mempertahankan direktori Tugas untuk Tugas Rilis Pekerjaan pada Simpul Komputasi. Setelah waktu ini, layanan Batch dapat menghapus direktori Tugas dan semua kontennya.
Defaultnya adalah 7 hari, yaitu direktori Tugas akan dipertahankan selama 7 hari kecuali Simpul Komputasi dihapus atau Pekerjaan dihapus.

userIdentity

Identitas pengguna tempat Tugas Rilis Pekerjaan berjalan.
Jika dihilangkan, Tugas berjalan sebagai pengguna non-administratif yang unik untuk Tugas.

JobSchedulingError

Kesalahan yang ditemui oleh layanan Batch saat menjadwalkan Pekerjaan.

Name Type Description
category

Kategori kesalahan Penjadwalan pekerjaan.

code
  • string

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

details

Daftar detail kesalahan tambahan yang terkait dengan kesalahan penjadwalan.

message
  • string

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

JobState

Status Pekerjaan.

Name Type Description
active
  • string

Pekerjaan tersedia untuk menjadwalkan Tugas.

completed
  • string

Semua Tugas telah dihentikan, dan sistem tidak akan menerima Tugas lagi atau perubahan lebih lanjut pada Pekerjaan.

deleting
  • string

Pengguna telah meminta agar Pekerjaan dihapus, tetapi operasi penghapusan masih berlangsung (misalnya, karena sistem masih mengakhiri Tugas yang sedang berjalan).

disabled
  • string

Pengguna telah menonaktifkan Pekerjaan. Tidak ada Tugas yang berjalan, dan tidak ada Tugas baru yang akan dijadwalkan.

disabling
  • string

Pengguna telah meminta agar Pekerjaan dinonaktifkan, tetapi operasi penonaktifan masih berlangsung (misalnya, menunggu Tugas dihentikan).

enabling
  • string

Pengguna telah meminta agar Pekerjaan diaktifkan, tetapi operasi pengaktifan masih berlangsung.

terminating
  • string

Pekerjaan akan selesai, baik karena Tugas Manajer Pekerjaan telah selesai atau karena pengguna telah mengakhiri Pekerjaan, tetapi operasi penghentian masih berlangsung (misalnya, karena Tugas Rilis Pekerjaan sedang berjalan).

JobStatistics

Statistik penggunaan sumber daya untuk Pekerjaan.

Name Type Description
kernelCPUTime
  • string

Total waktu CPU mode kernel (dijumlahkan di semua inti dan semua Simpul Komputasi) yang digunakan oleh semua Tugas dalam Pekerjaan.

lastUpdateTime
  • string

Waktu di mana statistik terakhir diperbarui. Semua statistik terbatas pada rentang antara startTime dan lastUpdateTime.

numFailedTasks
  • integer

Jumlah total Tugas dalam Pekerjaan yang gagal selama rentang waktu tertentu.
Tugas gagal jika habis jumlah coba lagi maksimumnya tanpa mengembalikan kode keluar 0.

numSucceededTasks
  • integer

Jumlah total Tugas berhasil diselesaikan dalam Pekerjaan selama rentang waktu tertentu.
Tugas berhasil diselesaikan jika mengembalikan kode keluar 0.

numTaskRetries
  • integer

Jumlah total percobaan ulang pada semua Tugas dalam Pekerjaan selama rentang waktu tertentu.

readIOGiB
  • number

Jumlah total data dalam GiB yang dibaca dari disk oleh semua Tugas dalam Pekerjaan.

readIOps
  • integer

Jumlah total operasi baca disk yang dibuat oleh semua Tugas dalam Pekerjaan.

startTime
  • string

Waktu mulai rentang waktu yang dicakup oleh statistik.

url
  • string

URL statistik.

userCPUTime
  • string

Total waktu CPU mode pengguna (dijumlahkan di semua inti dan semua Simpul Komputasi) yang digunakan oleh semua Tugas dalam Pekerjaan.

waitTime
  • string

Total waktu tunggu semua Tugas dalam Pekerjaan.
Waktu tunggu untuk Tugas didefinisikan sebagai waktu yang berlalu antara pembuatan Tugas dan awal eksekusi Tugas. (Jika Tugas dicoba kembali karena kegagalan, waktu tunggu adalah waktu ke eksekusi Tugas terbaru.) Nilai ini hanya dilaporkan dalam statistik seumur hidup Akun; ini tidak termasuk dalam statistik Pekerjaan.

wallClockTime
  • string

Total waktu jam dinding dari semua Tugas dalam Pekerjaan.
Waktu jam dinding adalah waktu yang berlalu dari ketika Tugas mulai berjalan pada Simpul Komputasi hingga ketika selesai (atau hingga terakhir kali statistik diperbarui, jika Tugas belum selesai saat itu). Jika Tugas dicoba ulang, ini mencakup waktu jam dinding dari semua percobaan ulang Tugas.

writeIOGiB
  • number

Jumlah total data dalam GiB yang ditulis ke disk oleh semua Tugas dalam Pekerjaan.

writeIOps
  • integer

Jumlah total operasi penulisan disk yang dibuat oleh semua Tugas dalam Pekerjaan.

LinuxUserConfiguration

Properti yang digunakan untuk membuat Akun pengguna pada Simpul Komputasi Linux.

Name Type Description
gid
  • integer

ID grup untuk Akun pengguna.
Properti uid dan gid harus ditentukan bersama-sama atau tidak sama sekali. Jika tidak ditentukan, sistem operasi yang mendasar akan memilih gid.

sshPrivateKey
  • string

Kunci privat SSH untuk Akun pengguna.
Kunci privat tidak boleh dilindungi kata sandi. Kunci privat digunakan untuk mengonfigurasi autentikasi berbasis kunci asimetris secara otomatis untuk SSH antara Simpul Komputasi di Kumpulan Linux ketika properti enableInterNodeCommunication Pool benar (diabaikan jika enableInterNodeCommunication salah). Ini dilakukan dengan menempatkan pasangan kunci ke direktori .ssh pengguna. Jika tidak ditentukan, SSH tanpa kata sandi tidak dikonfigurasi antara Simpul Komputasi (tidak ada modifikasi direktori .ssh pengguna yang dilakukan).

uid
  • integer

ID pengguna Akun pengguna.
Properti uid dan gid harus ditentukan bersama-sama atau tidak sama sekali. Jika tidak ditentukan, sistem operasi yang mendasar akan memilih uid.

LoginMode

Mode masuk untuk pengguna

Name Type Description
batch
  • string

Mode masuk LOGON32_LOGON_BATCH Win32. Mode masuk batch direkomendasikan untuk proses paralel yang berjalan lama.

interactive
  • string

Mode masuk LOGON32_LOGON_INTERACTIVE Win32. UAC diaktifkan pada Windows Kumpulan VirtualMachineConfiguration. Jika opsi ini digunakan dengan identitas pengguna yang ditinggikan di kumpulan Windows VirtualMachineConfiguration, sesi pengguna tidak akan ditinggikan kecuali aplikasi yang dijalankan oleh baris perintah Tugas dikonfigurasi untuk selalu memerlukan hak administratif atau untuk selalu memerlukan hak istimewa maksimum.

MetadataItem

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

Name Type Description
name
  • string

Nama item metadata.

value
  • string

Nilai item metadata.

MountConfiguration

Sistem file yang akan dipasang pada setiap simpul.

Name Type Description
azureBlobFileSystemConfiguration

Kontainer Azure Storage untuk dipasang menggunakan FUSE blob pada setiap simpul.
Properti ini saling eksklusif dengan semua properti lainnya.

azureFileShareConfiguration

Azure File Share untuk dipasang pada setiap simpul.
Properti ini saling eksklusif dengan semua properti lainnya.

cifsMountConfiguration

Sistem file CIFS/SMB untuk dipasang pada setiap simpul.
Properti ini saling eksklusif dengan semua properti lainnya.

nfsMountConfiguration

Sistem file NFS untuk dipasang pada setiap simpul.
Properti ini saling eksklusif dengan semua properti lainnya.

NameValuePair

Mewakili pasangan nama-nilai.

Name Type Description
name
  • string

Nama dalam pasangan nama-nilai.

value
  • string

Nilai dalam pasangan nama-nilai.

NetworkConfiguration

Konfigurasi jaringan untuk Kumpulan.

Name Type Description
dynamicVNetAssignmentScope

Cakupan penugasan vnet dinamis.

endpointConfiguration

Konfigurasi untuk titik akhir pada Simpul Komputasi di Kumpulan Batch.
Konfigurasi titik akhir kumpulan hanya didukung pada Kumpulan dengan properti virtualMachineConfiguration.

publicIPAddressConfiguration

Konfigurasi IPAddress Publik untuk Simpul Komputasi di Kumpulan Batch.
Properti konfigurasi IP publik hanya didukung pada Kumpulan dengan properti virtualMachineConfiguration.

subnetId
  • string

Pengidentifikasi sumber daya ARM dari subnet jaringan virtual tempat Simpul Komputasi Kumpulan akan bergabung. Ini adalah formulir /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}.
Jaringan virtual harus berada di wilayah dan langganan yang sama dengan Akun Azure Batch. Subnet yang ditentukan harus memiliki alamat IP gratis yang cukup untuk mengakomodasi jumlah Simpul Komputasi di Kumpulan. Jika subnet tidak memiliki alamat IP gratis yang cukup, Kumpulan akan mengalokasikan sebagian Node dan kesalahan pengubahan ukuran akan terjadi. Perwakilan layanan 'MicrosoftAzureBatch' harus memiliki peran 'Kontributor Komputer Virtual Klasik' Role-Based Access Control (RBAC) untuk VNet yang ditentukan. Subnet yang ditentukan harus mengizinkan komunikasi dari layanan Azure Batch untuk dapat menjadwalkan Tugas pada Simpul. Ini dapat diverifikasi dengan memeriksa apakah VNet yang ditentukan memiliki Kelompok Keamanan Jaringan (NSG) terkait. Jika komunikasi ke Simpul dalam subnet yang ditentukan ditolak oleh NSG, maka layanan Batch akan mengatur status Simpul Komputasi menjadi tidak dapat digunakan. Untuk Kumpulan yang dibuat dengan virtualMachineConfiguration hanya jaringan virtual ARM ('Microsoft.Network/virtualNetworks') yang didukung, tetapi untuk Pool yang dibuat dengan cloudServiceConfiguration baik JARINGAN virtual ARM maupun klasik didukung. Jika VNet yang ditentukan memiliki Grup Keamanan Jaringan (NSG) terkait, maka beberapa port sistem yang dipesan harus diaktifkan untuk komunikasi masuk. Untuk Pool yang dibuat dengan konfigurasi komputer virtual, aktifkan port 29876 dan 29877, serta port 22 untuk Linux dan port 3389 untuk Windows. Untuk Kumpulan yang dibuat dengan konfigurasi layanan cloud, aktifkan port 10100, 20100, dan 30100. Aktifkan juga koneksi keluar untuk Azure Storage pada port 443. Untuk detail selengkapnya, lihat: https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration

NetworkSecurityGroupRule

Aturan grup keamanan jaringan untuk diterapkan ke titik akhir masuk.

Name Type Description
access

Tindakan yang harus diambil untuk alamat IP, rentang subnet, atau tag tertentu.

priority
  • integer

Prioritas untuk aturan ini.
Prioritas dalam Kumpulan harus unik dan dievaluasi dalam urutan prioritas. Semakin rendah angka semakin tinggi prioritasnya. Misalnya, aturan dapat ditentukan dengan nomor pesanan 150, 250, dan 350. Aturan dengan jumlah pesanan 150 lebih diutamakan daripada aturan yang memiliki urutan 250. Prioritas yang diizinkan adalah 150 hingga 4096. Jika ada nilai yang dipesan atau duplikat yang disediakan permintaan gagal dengan kode status HTTP 400.

sourceAddressPrefix
  • string

Awalan atau tag alamat sumber yang cocok dengan aturan.
Nilai yang valid adalah satu alamat IP (yaitu 10.10.10.10), subnet IP (yaitu 192.168.1.0/24), tag default, atau * (untuk semua alamat). Jika ada nilai lain yang disediakan, permintaan gagal dengan kode status HTTP 400.

sourcePortRanges
  • string[]

Rentang port sumber yang cocok dengan aturan.
Nilai yang valid adalah '' (untuk semua port 0 - 65535), port tertentu (yaitu 22), atau rentang port (yaitu 100-200). Port harus berada di kisaran 0 hingga 65535. Setiap entri dalam koleksi ini tidak boleh tumpang tindih dengan entri lain (baik rentang atau port individual). Jika ada nilai lain yang disediakan, permintaan gagal dengan kode status HTTP 400. Nilai defaultnya adalah ''.

NetworkSecurityGroupRuleAccess

Tindakan yang harus diambil untuk alamat IP, rentang subnet, atau tag tertentu.

Name Type Description
allow
  • string

Izinkan akses.

deny
  • string

Tolak akses.

NFSMountConfiguration

Informasi yang digunakan untuk menyambungkan ke sistem file NFS.

Name Type Description
mountOptions
  • string

Opsi baris perintah tambahan untuk diteruskan ke perintah pemasangan.
Ini adalah opsi 'penggunaan bersih' dalam opsi Windows dan 'mount' di Linux.

relativeMountPath
  • string

Jalur relatif pada simpul komputasi tempat sistem file akan dipasang
Semua sistem file dipasang relatif terhadap direktori pemasangan Batch, dapat diakses melalui variabel lingkungan AZ_BATCH_NODE_MOUNTS_DIR.

source
  • string

URI sistem file yang akan dipasang.

NodePlacementConfiguration

Konfigurasi penempatan simpul untuk kumpulan.

Name Type Description
policy

Jenis Kebijakan penempatan simpul pada Kumpulan Batch.
Kebijakan alokasi yang digunakan oleh Layanan Batch untuk menyediakan simpul. Jika tidak ditentukan, Batch akan menggunakan kebijakan regional.

NodePlacementPolicyType

Kebijakan penempatan untuk mengalokasikan simpul di kumpulan.

Name Type Description
regional
  • string

Semua simpul dalam kumpulan akan dialokasikan di wilayah yang sama.

zonal
  • string

Simpul di kumpulan akan tersebar di berbagai zona ketersediaan dengan penyeimbangan upaya terbaik.

OnAllTasksComplete

Tindakan yang harus dilakukan layanan Batch ketika semua Tugas dalam Pekerjaan dalam status selesai.

Name Type Description
noaction
  • string

Tidak melakukan apa pun. Pekerjaan tetap aktif kecuali dihentikan atau dinonaktifkan dengan beberapa cara lain.

terminatejob
  • string

Hentikan Pekerjaan. TerminateReason Pekerjaan diatur ke 'AllTasksComplete'.

OnTaskFailure

Tindakan yang harus diambil layanan Batch ketika Tugas apa pun dalam Pekerjaan gagal.

Name Type Description
noaction
  • string

Tidak melakukan apa pun. Pekerjaan tetap aktif kecuali dihentikan atau dinonaktifkan dengan beberapa cara lain.

performexitoptionsjobaction
  • string

Ambil tindakan yang terkait dengan kondisi keluar Tugas di kumpulan exitConditions Tugas. (Ini mungkin masih mengakibatkan tidak ada tindakan yang diambil, jika itu yang ditentukan Tugas.)

OSDisk

Pengaturan untuk disk sistem operasi simpul komputasi (VM).

Name Type Description
ephemeralOSDiskSettings

Menentukan Pengaturan Disk ephemeral untuk disk sistem operasi yang digunakan oleh simpul komputasi (VM).

OutputFile

Spesifikasi untuk mengunggah file dari Simpul Komputasi Azure Batch ke lokasi lain setelah layanan Batch selesai menjalankan proses Tugas.

Name Type Description
destination

Tujuan untuk file output.

filePattern
  • string

Pola yang menunjukkan file mana yang akan diunggah.
Jalur relatif dan absolut didukung. Jalur relatif relatif terhadap direktori kerja Tugas. Kartubebas berikut didukung: * cocok dengan 0 karakter atau lebih (misalnya pola abc* akan cocok dengan abc atau abcdef), ** cocok dengan direktori apa pun, ? cocok dengan karakter tunggal apa pun, [abc] cocok dengan satu karakter dalam tanda kurung siku, dan [a-c] cocok dengan satu karakter dalam rentang. Tanda kurung dapat menyertakan negasi untuk mencocokkan karakter apa pun yang tidak ditentukan (misalnya [!abc] cocok dengan karakter apa pun tetapi a, b, atau c). Jika nama file dimulai dengan "." nama file diabaikan secara default tetapi dapat dicocokkan dengan menentukannya secara eksplisit (misalnya .gif tidak akan cocok dengan .a.gif, tetapi ..gif akan). Contoh sederhana: ***.txt cocok dengan file apa pun yang tidak dimulai di '.' dan berakhir dengan .txt di direktori kerja Tugas atau subdirektori apa pun. Jika nama file berisi karakter kartubebas, itu dapat diloloskan menggunakan tanda kurung siku (misalnya abc[] akan cocok dengan file bernama abc). Perhatikan bahwa \ dan / diperlakukan sebagai pemisah direktori pada Windows, tetapi hanya / ada di Linux. Variabel lingkungan (%var% pada Windows atau $var di Linux) diperluas sebelum pola diterapkan.

uploadOptions

Opsi tambahan untuk operasi unggahan, termasuk dalam kondisi apa untuk melakukan unggahan.

OutputFileBlobContainerDestination

Menentukan tujuan unggahan file dalam kontainer penyimpanan blob Azure.

Name Type Description
containerUrl
  • string

URL kontainer dalam Azure Blob Storage untuk mengunggah file.
Jika tidak menggunakan identitas terkelola, URL harus menyertakan Tanda Tangan Akses Bersama (SAS) yang memberikan izin tulis ke kontainer.

identityReference

Referensi ke identitas yang ditetapkan pengguna untuk digunakan untuk mengakses Azure Blob Storage yang ditentukan oleh containerUrl
Identitas harus memiliki akses tulis ke kontainer Azure Blob Storage

path
  • string

Blob tujuan atau direktori virtual dalam kontainer Azure Storage.
Jika filePattern mengacu pada file tertentu (yaitu tidak berisi kartubebas), maka jalur adalah nama blob untuk mengunggah file tersebut. Jika filePattern berisi satu atau beberapa kartubebas (dan oleh karena itu mungkin cocok dengan beberapa file), maka jalur adalah nama direktori virtual blob (yang ditambahkan ke setiap nama blob) untuk mengunggah file. Jika dihilangkan, file diunggah ke akar kontainer dengan nama blob yang cocok dengan nama file mereka.

uploadHeaders

Daftar pasangan nama-nilai untuk header yang akan digunakan dalam mengunggah file output
Header ini akan ditentukan saat mengunggah file ke Azure Storage. Untuk informasi selengkapnya, lihat Header Permintaan (Semua Jenis Blob).

OutputFileDestination

Tujuan tempat file harus diunggah.

Name Type Description
container

Lokasi di penyimpanan blob Azure tempat file diunggah.

OutputFileUploadCondition

Kondisi di mana file output Tugas atau sekumpulan file harus diunggah.

Name Type Description
taskcompletion
  • string

Upload file setelah proses Tugas keluar, apa pun kode keluarnya.

taskfailure
  • string

Upload file hanya setelah proses Tugas keluar dengan kode keluar bukan nol.

tasksuccess
  • string

Upload file hanya setelah proses Tugas keluar dengan kode keluar 0.

OutputFileUploadOptions

Detail tentang operasi pengunggahan file output, termasuk dalam kondisi apa untuk melakukan unggahan.

Name Type Description
uploadCondition

Kondisi di mana file output Tugas atau sekumpulan file harus diunggah.
Defaultnya adalah penyelesaian tugas.

PoolEndpointConfiguration

Konfigurasi titik akhir untuk Kumpulan.

Name Type Description
inboundNATPools

Daftar Kumpulan NAT masuk yang dapat digunakan untuk mengatasi port tertentu pada Simpul Komputasi individual secara eksternal.
Jumlah maksimum Kumpulan NAT masuk per Kumpulan Batch adalah 5. Jika jumlah maksimum Kumpulan NAT masuk melebihi permintaan gagal dengan kode status HTTP 400. Ini tidak dapat ditentukan jika IPAddressProvisioningType adalah NoPublicIPAddresses.

PoolInformation

Menentukan bagaimana Pekerjaan harus ditetapkan ke Kumpulan.

Name Type Description
autoPoolSpecification

Karakteristik untuk 'kumpulan otomatis' sementara. Layanan Batch akan membuat Kumpulan otomatis ini saat Pekerjaan dikirimkan.
Jika pembuatan Kumpulan otomatis gagal, layanan Batch memindahkan Pekerjaan ke status selesai, dan kesalahan pembuatan Kumpulan diatur dalam properti kesalahan penjadwalan Pekerjaan. Layanan Batch mengelola masa pakai (baik pembuatan maupun, kecuali keepAlive ditentukan, penghapusan) dari Kumpulan otomatis. Setiap tindakan pengguna yang memengaruhi masa pakai Kumpulan otomatis saat Pekerjaan aktif akan mengakibatkan perilaku yang tidak terduga. Anda harus menentukan ID Kumpulan atau spesifikasi Kumpulan otomatis, tetapi tidak keduanya.

poolId
  • string

ID Kumpulan yang ada. Semua Tugas Pekerjaan akan berjalan pada Kumpulan yang ditentukan.
Anda harus memastikan bahwa Kumpulan yang dirujuk oleh properti ini ada. Jika Kumpulan tidak ada pada saat layanan Batch mencoba menjadwalkan Pekerjaan, tidak ada Tugas untuk Pekerjaan yang akan berjalan hingga Anda membuat Kumpulan dengan id tersebut. Perhatikan bahwa layanan Batch tidak akan menolak permintaan Pekerjaan; itu tidak hanya akan menjalankan Tugas sampai Kumpulan ada. Anda harus menentukan ID Kumpulan atau spesifikasi Kumpulan otomatis, tetapi tidak keduanya.

PoolLifetimeOption

Masa pakai minimum Kumpulan otomatis yang dibuat, dan bagaimana beberapa Pekerjaan pada jadwal ditetapkan ke Kumpulan.

Name Type Description
job
  • string

Kumpulan ada untuk masa pakai Pekerjaan yang didedikasikan. Layanan Batch membuat Kumpulan saat membuat Pekerjaan. Jika opsi 'pekerjaan' diterapkan ke Jadwal Pekerjaan, layanan Batch membuat Kumpulan otomatis baru untuk setiap Pekerjaan yang dibuat sesuai jadwal.

jobschedule
  • string

Kumpulan ada selama masa pakai Jadwal Pekerjaan. Layanan Batch membuat Kumpulan saat membuat Pekerjaan pertama sesuai jadwal. Anda dapat menerapkan opsi ini hanya untuk Jadwal Pekerjaan, bukan ke Pekerjaan.

PoolSpecification

Spesifikasi untuk membuat Kumpulan baru.

Name Type Description
applicationLicenses
  • string[]

Daftar lisensi aplikasi yang akan disediakan layanan Batch pada setiap Simpul Komputasi di Kumpulan.
Daftar lisensi aplikasi harus merupakan subset dari lisensi aplikasi layanan Batch yang tersedia. Jika lisensi diminta yang tidak didukung, pembuatan Kumpulan akan gagal. Lisensi yang diizinkan yang tersedia di Kumpulan adalah 'maya', 'vray', '3dsmax', 'arnold'. Biaya tambahan berlaku untuk setiap lisensi aplikasi yang ditambahkan ke Kumpulan.

applicationPackageReferences

Daftar Paket yang akan diinstal pada setiap Simpul Komputasi di Kumpulan.
Perubahan pada referensi Paket memengaruhi semua Simpul baru yang bergabung dengan Kumpulan, tetapi tidak memengaruhi Simpul Komputasi yang sudah ada di Kumpulan hingga di-boot ulang atau digambatkan ulang. Ada maksimum 10 referensi Paket pada Kumpulan tertentu.

autoScaleEvaluationInterval
  • string

Interval waktu untuk menyesuaikan ukuran Kumpulan secara otomatis sesuai dengan rumus skala otomatis.
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).

autoScaleFormula
  • string

Rumus untuk jumlah Simpul Komputasi yang diinginkan di Kumpulan.
Properti ini tidak boleh ditentukan jika enableAutoScale diatur ke false. Diperlukan jika enableAutoScale diatur ke true. Rumus diperiksa validitasnya sebelum Kumpulan dibuat. Jika rumus tidak valid, layanan Batch menolak permintaan dengan informasi kesalahan terperinci.

certificateReferences

Daftar Sertifikat yang akan diinstal pada setiap Simpul Komputasi di 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 diberikan 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.

cloudServiceConfiguration

Konfigurasi layanan cloud untuk Kumpulan.
Properti ini harus ditentukan jika Kumpulan perlu dibuat dengan Azure PaaS VM. Properti ini dan virtualMachineConfiguration saling eksklusif dan salah satu properti harus ditentukan. Jika tidak ada yang ditentukan, maka layanan Batch mengembalikan kesalahan; jika Anda memanggil REST API secara langsung, kode status HTTP adalah 400 (Permintaan Buruk). Properti ini tidak dapat ditentukan jika Akun Batch dibuat dengan properti poolAllocationMode yang diatur ke 'UserSubscription'.

displayName
  • string

Nama tampilan untuk Kumpulan.
Nama tampilan tidak perlu unik dan dapat berisi karakter Unicode hingga panjang maksimum 1024.

enableAutoScale
  • boolean

Apakah ukuran Kumpulan harus secara otomatis menyesuaikan dari waktu ke waktu.
Jika false, setidaknya salah satu targetDedicatedNodes dan targetLowPriorityNodes harus ditentukan. Jika true, elemen autoScaleFormula diperlukan. Kumpulan secara otomatis mengubah ukuran sesuai dengan rumus. Nilai defaultnya adalah false.

enableInterNodeCommunication
  • boolean

Apakah Kumpulan mengizinkan komunikasi langsung antara Simpul Komputasi.
Mengaktifkan komunikasi antar-simpul membatasi ukuran maksimum Kumpulan karena pembatasan penyebaran pada Simpul Komputasi Kumpulan. Ini dapat mengakibatkan Kumpulan tidak mencapai ukuran yang diinginkan. Nilai defaultnya adalah false.

metadata

Daftar pasangan nama-nilai yang terkait dengan Kumpulan sebagai metadata.
Layanan Batch tidak menetapkan arti apa pun untuk metadata; hanya untuk penggunaan kode pengguna.

mountConfiguration

Daftar sistem file yang akan dipasang pada setiap simpul di kumpulan.
Ini mendukung Azure Files, NFS, CIFS/SMB, dan Blobfuse.

networkConfiguration

Konfigurasi jaringan untuk Kumpulan.
Konfigurasi jaringan untuk Kumpulan.

resizeTimeout
  • string

Waktu habis untuk alokasi Simpul Komputasi ke Kumpulan.
Batas waktu ini hanya berlaku untuk penskalakan manual; tidak berpengaruh ketika enableAutoScale diatur ke true. Nilai defaultnya adalah 15 menit. Nilai minimum adalah 5 menit. Jika Anda menentukan nilai kurang dari 5 menit, layanan Batch menolak permintaan dengan kesalahan; jika Anda memanggil REST API secara langsung, kode status HTTP adalah 400 (Permintaan Buruk).

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.
Batch akan mencoba kembali Tugas ketika operasi pemulihan dipicu pada Node. Contoh operasi pemulihan termasuk (tetapi tidak terbatas pada) ketika Node yang tidak sehat di-boot ulang atau Simpul Komputasi menghilang karena kegagalan host. Percobaan ulang karena operasi pemulihan tidak bergantung pada dan tidak dihitung terhadap maxTaskRetryCount. Bahkan jika maxTaskRetryCount adalah 0, coba lagi internal karena operasi pemulihan dapat terjadi. Karena itu, semua Tugas harus idempotensi. Ini berarti Tugas perlu mentolerir terganggu dan dimulai ulang tanpa menyebabkan kerusakan atau data duplikat. Praktik terbaik untuk Tugas yang berjalan lama adalah menggunakan beberapa bentuk titik pemeriksaan. Dalam beberapa kasus, StartTask mungkin dijalankan kembali meskipun Simpul Komputasi tidak di-boot ulang. Perawatan khusus harus dilakukan untuk menghindari StartTasks yang membuat proses breakaway atau menginstal/meluncurkan layanan dari direktori kerja StartTask, karena ini akan memblokir Batch agar tidak dapat menjalankan kembali StartTask.

targetDedicatedNodes
  • integer

Jumlah Simpul Komputasi khusus yang diinginkan di Kumpulan.
Properti ini tidak boleh ditentukan jika enableAutoScale diatur ke true. Jika enableAutoScale diatur ke false, maka Anda harus mengatur targetDedicatedNodes, targetLowPriorityNodes, atau keduanya.

targetLowPriorityNodes
  • integer

Jumlah Simpul Komputasi Spot/Prioritas rendah yang diinginkan di Kumpulan.
Properti ini tidak boleh ditentukan jika enableAutoScale diatur ke true. Jika enableAutoScale diatur ke false, maka Anda harus mengatur targetDedicatedNodes, targetLowPriorityNodes, atau keduanya.

taskSchedulingPolicy

Bagaimana Tugas didistribusikan di seluruh Simpul Komputasi dalam Kumpulan.
Jika tidak ditentukan, defaultnya adalah spread.

taskSlotsPerNode
  • integer

Jumlah slot tugas yang dapat digunakan untuk menjalankan tugas bersamaan pada satu simpul komputasi dalam kumpulan.
Nilai default adalah 1. Nilai maksimum adalah lebih kecil dari 4 kali jumlah inti vmSize kumpulan atau 256.

userAccounts

Daftar Akun pengguna yang akan dibuat pada setiap Simpul Komputasi di Kumpulan.

virtualMachineConfiguration

Konfigurasi komputer virtual untuk Kumpulan.
Properti ini harus ditentukan jika Kumpulan perlu dibuat dengan Azure IaaS VM. Properti dan cloudServiceConfiguration ini saling eksklusif dan salah satu properti harus ditentukan. Jika tidak ada yang ditentukan, maka layanan Batch mengembalikan kesalahan; jika Anda memanggil REST API secara langsung, kode status HTTP adalah 400 (Permintaan Buruk).

vmSize
  • string

Ukuran komputer virtual di Kumpulan. Semua komputer virtual dalam Kumpulan berukuran sama.
Untuk informasi tentang ukuran komputer virtual yang tersedia di Kumpulan, lihat Memilih ukuran VM untuk Simpul Komputasi dalam Kumpulan Azure Batch (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes).

PublicIPAddressConfiguration

Konfigurasi Alamat IP publik dari konfigurasi jaringan Kumpulan.

Name Type Description
ipAddressIds
  • string[]

Daftar IP publik yang akan digunakan layanan Batch saat menyediakan Simpul Komputasi.
Jumlah IP yang ditentukan di sini membatasi ukuran maksimum Kumpulan - 100 simpul khusus atau 100 simpul Spot/Prioritas rendah dapat dialokasikan untuk setiap IP publik. Misalnya, kumpulan yang membutuhkan 250 VM khusus akan membutuhkan setidaknya 3 IP publik yang ditentukan. Setiap elemen koleksi ini berbentuk: /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}.

provision

Jenis provisi untuk Alamat IP Publik untuk Kumpulan.
Nilai defaultnya adalah BatchManaged.

ResourceFile

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

Name Type Description
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 Windows Compute Node. 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: sertakan Tanda Tangan Akses Bersama (SAS) yang memberikan izin baca pada blob, menggunakan identitas terkelola dengan izin baca, atau atur ACL untuk blob atau kontainernya untuk memungkinkan akses publik.

identityReference

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.

Name Type Description
commandLine
  • string

Baris perintah StartTask.
Baris perintah tidak berjalan di bawah shell, dan oleh 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

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 tersebut.

environmentSettings

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 ulang)

resourceFiles

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

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, 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 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.

StorageAccountType

Jenis Akun penyimpanan untuk digunakan dalam membuat disk data.

Name Type Description
premium_lrs
  • string

Disk data harus menggunakan penyimpanan redundan lokal premium.

standard_lrs
  • string

Disk data harus menggunakan penyimpanan redundan lokal standar.

TaskConstraints

Batasan eksekusi untuk diterapkan ke Tugas.

Name Type Description
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 ulang untuk Tugas yang dapat dieksekusi karena kode keluar bukan nol. Layanan Batch akan mencoba Tugas sekali, dan kemudian dapat mencoba kembali hingga batas ini. Misalnya, jika jumlah coba lagi 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 setelah upaya pertama. 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 ulang)

maxWallClockTime
  • string

Waktu maksimum yang berlalu yang dapat dijalankan Tugas, diukur sejak Tugas dimulai. Jika Tugas tidak selesai dalam batas waktu, layanan Batch akan mengakhirinya.
Jika ini tidak ditentukan, tidak ada batas waktu berapa lama Tugas dapat berjalan.

retentionTime
  • string

Waktu minimum untuk mempertahankan direktori Tugas pada Simpul Komputasi tempatnya berjalan, sejak selesai dieksekusi. Setelah waktu ini, layanan Batch dapat menghapus direktori Tugas dan semua kontennya.
Defaultnya adalah 7 hari, yaitu direktori Tugas akan dipertahankan selama 7 hari kecuali Simpul Komputasi dihapus atau Pekerjaan dihapus.

TaskContainerSettings

Pengaturan kontainer untuk Tugas.

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

Registri privat yang berisi Gambar kontainer.
Pengaturan ini dapat dihilangkan jika sudah disediakan di pembuatan Pool.

workingDirectory

Lokasi direktori kerja Tugas kontainer.
Defaultnya adalah 'taskWorkingDirectory'.

TaskSchedulingPolicy

Menentukan bagaimana Tugas harus didistribusikan di seluruh Simpul Komputasi.

Name Type Description
nodeFillType

Bagaimana Tugas didistribusikan di seluruh Simpul Komputasi dalam Kumpulan.
Jika tidak ditentukan, defaultnya adalah spread.

UserAccount

Properti yang digunakan untuk membuat pengguna yang digunakan untuk menjalankan Tugas pada Simpul Komputasi Azure Batch.

Name Type Description
elevationLevel

Tingkat elevasi Akun pengguna.
Nilai defaultnya adalah nonAdmin.

linuxUserConfiguration

Konfigurasi pengguna khusus Linux untuk Akun pengguna.
Properti ini diabaikan jika ditentukan pada Kumpulan Windows. Jika tidak ditentukan, pengguna dibuat dengan opsi default.

name
  • string

Nama Akun pengguna.

password
  • string

Kata sandi untuk Akun pengguna.

windowsUserConfiguration

Konfigurasi pengguna khusus Windows untuk Akun pengguna.
Properti ini hanya dapat ditentukan jika pengguna berada di kumpulan Windows. Jika tidak ditentukan dan pada kumpulan Windows, pengguna dibuat dengan opsi default.

UserIdentity

Definisi identitas pengguna tempat Tugas dijalankan.

Name Type Description
autoUser

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.

VirtualMachineConfiguration

Konfigurasi untuk Simpul Komputasi dalam Kumpulan berdasarkan infrastruktur Azure Virtual Machines.

Name Type Description
containerConfiguration

Konfigurasi kontainer untuk Kumpulan.
Jika ditentukan, penyiapan dilakukan pada setiap Simpul Komputasi di Kumpulan untuk memungkinkan Tugas dijalankan dalam kontainer. Semua Tugas reguler dan Tugas manajer Pekerjaan yang dijalankan pada Kumpulan ini harus menentukan properti containerSettings, dan semua Tugas lainnya dapat menentukannya.

dataDisks

Konfigurasi untuk disk data yang dilampirkan ke Simpul Komputasi di Kumpulan.
Properti ini harus ditentukan jika Simpul Komputasi di Kumpulan harus memiliki disk data kosong yang melekat padanya. Ini tidak dapat diperbarui. Setiap Simpul Komputasi mendapatkan disknya sendiri (disk bukan berbagi file). Disk yang ada tidak dapat dilampirkan, setiap disk yang terpasang kosong. Ketika Simpul Komputasi dihapus dari Kumpulan, disk dan semua data yang terkait dengannya juga dihapus. Disk tidak diformat setelah dilampirkan, disk harus diformat sebelum digunakan - untuk informasi selengkapnya lihat https://docs.microsoft.com/en-us/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux dan https://docs.microsoft.com/en-us/azure/virtual-machines/windows/attach-disk-ps#add-an-empty-data-disk-to-a-virtual-machine.

diskEncryptionConfiguration

Konfigurasi enkripsi disk untuk kumpulan.
Jika ditentukan, enkripsi dilakukan pada setiap simpul di kumpulan selama provisi simpul.

extensions

Ekstensi komputer virtual untuk kumpulan.
Jika ditentukan, ekstensi yang disebutkan dalam konfigurasi ini akan diinstal pada setiap simpul.

imageReference

Referensi ke Azure Virtual Machines Marketplace Image atau Gambar Komputer Virtual kustom untuk digunakan.

licenseType
  • string

Jenis lisensi lokal yang akan digunakan saat menyebarkan sistem operasi.
Ini hanya berlaku untuk Gambar yang berisi sistem operasi Windows, dan hanya boleh digunakan saat Anda menyimpan lisensi lokal yang valid untuk Simpul Komputasi yang akan disebarkan. Jika dihilangkan, tidak ada diskon lisensi lokal yang diterapkan. Nilainya adalah:

Windows_Server - Lisensi lokal adalah untuk Windows Server. Windows_Client - Lisensi lokal adalah untuk Klien Windows.

nodeAgentSKUId
  • string

SKU agen Simpul Komputasi Batch yang akan disediakan pada Simpul Komputasi di Kumpulan.
Agen Simpul Komputasi Batch adalah program yang berjalan pada setiap Simpul Komputasi di Kumpulan, dan menyediakan antarmuka perintah dan kontrol antara Simpul Komputasi dan layanan Batch. Ada berbagai implementasi agen Simpul Komputasi, yang dikenal sebagai SKU, untuk sistem operasi yang berbeda. Anda harus menentukan SKU agen Simpul Komputasi yang cocok dengan referensi Gambar yang dipilih. Untuk mendapatkan daftar SKU agen Simpul Komputasi yang didukung bersama dengan daftar referensi Gambar terverifikasi mereka, lihat operasi 'Daftar SKU agen Simpul Komputasi yang didukung'.

nodePlacementConfiguration

Konfigurasi penempatan simpul untuk kumpulan.
Konfigurasi ini akan menentukan aturan tentang bagaimana simpul dalam kumpulan akan dialokasikan secara fisik.

osDisk

Pengaturan untuk disk sistem operasi Komputer Virtual.

windowsConfiguration

Windows pengaturan sistem operasi pada komputer virtual.
Properti ini tidak boleh ditentukan jika properti imageReference menentukan Gambar OS Linux.

VMExtension

Konfigurasi untuk ekstensi komputer virtual.

Name Type Description
autoUpgradeMinorVersion
  • boolean

Menunjukkan apakah ekstensi harus menggunakan versi minor yang lebih baru jika tersedia pada waktu penyebaran. Setelah disebarkan, bagaimanapun, ekstensi tidak akan meningkatkan versi kecil kecuali dipekerjakan kembali, bahkan jika properti ini diatur ke true.

name
  • string

Nama ekstensi komputer virtual.

protectedSettings
  • object

Ekstensi dapat berisi protectedSettings atau protectedSettingsFromKeyVault atau tidak ada pengaturan yang dilindungi sama sekali.

provisionAfterExtensions
  • string[]

Kumpulan nama ekstensi.
Kumpulan nama ekstensi setelah itu ekstensi ini perlu disediakan.

publisher
  • string

Nama penerbit handler ekstensi.

settings
  • object

Pengaturan publik berformat JSON untuk ekstensi.

type
  • string

Jenis ekstensi.

typeHandlerVersion
  • string

Versi handler skrip.

WindowsConfiguration

Windows pengaturan sistem operasi untuk diterapkan ke komputer virtual.

Name Type Description
enableAutomaticUpdates
  • boolean

Apakah pembaruan otomatis diaktifkan pada komputer virtual.
Jika dihilangkan, nilai defaultnya adalah true.

WindowsUserConfiguration

Properti yang digunakan untuk membuat Akun pengguna pada Simpul Komputasi Windows.

Name Type Description
loginMode

Mode masuk untuk pengguna
Nilai default untuk Kumpulan VirtualMachineConfiguration adalah 'batch' dan untuk Kumpulan CloudServiceConfiguration adalah 'interaktif'.