Compute Node - Get

Service:

Batch Service

API Version:

2022-01-01.15.0

Mendapatkan informasi tentang Simpul Komputasi yang ditentukan.

GET {batchUrl}/pools/{poolId}/nodes/{nodeId}?api-version=2022-01-01.15.0

With optional parameters:

GET {batchUrl}/pools/{poolId}/nodes/{nodeId}?$select={$select}&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.
nodeId	path	True	string	ID Simpul Komputasi yang ingin Anda dapatkan informasinya.
poolId	path	True	string	ID Kumpulan yang berisi Simpul Komputasi.
api-version	query	True	string	Versi API Klien.
$select	query		string	Klausa $select OData.
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	ComputeNode	Respons yang berisi Simpul Komputasi. Headers client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	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

Node get

Sample Request

HTTP

GET account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_2-20161122t193202z?api-version=2022-01-01.15.0

Sample Response

Status code:

200

{
  "id": "tvm-1695681911_2-20161122t193202z",
  "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_2-20161122t193202z",
  "state": "idle",
  "schedulingState": "enabled",
  "stateTransitionTime": "2016-11-22T19:37:31.4285526Z",
  "lastBootTime": "2016-11-22T19:37:28.623369Z",
  "allocationTime": "2016-11-22T19:32:02.8155319Z",
  "ipAddress": "1.1.1.1",
  "affinityId": "TVM:tvm-1695681911_2-20161122t193202z",
  "vmSize": "small",
  "totalTasksRun": 0,
  "totalTasksSucceeded": 0,
  "runningTasksCount": 0,
  "isDedicated": true,
  "startTask": {
    "commandLine": "cmd /c echo hello",
    "userIdentity": {
      "autoUser": {
        "scope": "task",
        "elevationLevel": "nonadmin"
      }
    },
    "maxTaskRetryCount": 0,
    "waitForSuccess": false
  },
  "startTaskInfo": {
    "state": "completed",
    "startTime": "2016-11-22T19:37:31.4285526Z",
    "endTime": "2016-11-22T19:37:31.838028Z",
    "exitCode": 0,
    "retryCount": 0
  },
  "nodeAgentInfo": {
    "version": "1.2.0.0",
    "lastUpdateTime": "2016-11-22T19:37:28.623369Z"
  }
}

Definisi

AutoUserScope	Cakupan untuk pengguna otomatis
AutoUserSpecification	Menentukan parameter untuk pengguna otomatis yang menjalankan Tugas pada layanan Batch.
BatchError	Respons kesalahan yang diterima dari layanan Azure Batch.
BatchErrorDetail	Item informasi tambahan yang disertakan dalam respons kesalahan Azure Batch.
CertificateReference	Referensi ke Sertifikat yang akan diinstal pada Simpul Komputasi di Kumpulan.
CertificateStoreLocation	Lokasi penyimpanan Sertifikat pada Simpul Komputasi tempat menginstal Sertifikat.
ComputeNode	Simpul Komputasi di layanan Batch.
ComputeNodeEndpointConfiguration	Konfigurasi titik akhir untuk Simpul Komputasi.
ComputeNodeError	Kesalahan yang ditemui oleh Simpul Komputasi.
ComputeNodeIdentityReference	Referensi ke identitas yang ditetapkan pengguna yang terkait dengan kumpulan Batch yang akan digunakan simpul komputasi.
ComputeNodeState	Status Simpul Komputasi saat ini.
ContainerRegistry	Registri kontainer privat.
ContainerWorkingDirectory	Lokasi direktori kerja Tugas kontainer.
ElevationLevel	Tingkat elevasi pengguna.
EnvironmentSetting	Variabel lingkungan yang akan diatur pada proses Tugas.
ErrorCategory	Kategori kesalahan.
ErrorMessage	Pesan kesalahan yang diterima dalam respons kesalahan Azure Batch.
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'.
InboundEndpoint	Titik akhir masuk pada Simpul Komputasi.
InboundEndpointProtocol	Protokol titik akhir.
NameValuePair	Mewakili pasangan nama-nilai.
NodeAgentInformation	Informasi tentang agen Simpul Komputasi.
ResourceFile	Satu file atau beberapa file yang akan diunduh ke Simpul Komputasi.
SchedulingState	Apakah Simpul Komputasi tersedia untuk Penjadwalan Tugas.
StartTask	Tugas yang dijalankan saat Simpul bergabung dengan Kumpulan di layanan Azure Batch, atau saat Simpul Komputasi di-boot ulang atau digambut ulang.
StartTaskInformation	Informasi tentang StartTask yang berjalan pada Simpul Komputasi.
StartTaskState	Status StartTask pada Simpul Komputasi.
TaskContainerExecutionInformation	Berisi informasi tentang kontainer yang dijalankan Tugas.
TaskContainerSettings	Pengaturan kontainer untuk Tugas.
TaskExecutionInformation	Informasi tentang eksekusi Tugas.
TaskExecutionResult	Hasil eksekusi Tugas.
TaskFailureInformation	Informasi tentang kegagalan Tugas.
TaskInformation	Informasi tentang Tugas yang berjalan pada Simpul Komputasi.
TaskState	Status Tugas.
UserIdentity	Definisi identitas pengguna tempat Tugas dijalankan.
VirtualMachineInfo	Info tentang status komputer virtual saat ini.

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	ElevationLevel	Tingkat elevasi pengguna otomatis. Nilai defaultnya adalah nonAdmin.
scope	AutoUserScope	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 membisukan registri dengan cara yang dapat memengaruhi tugas lain, atau jika sertifikat telah ditentukan pada kumpulan yang seharusnya tidak dapat diakses oleh tugas normal tetapi harus dapat diakses oleh StartTasks.

BatchError

Respons kesalahan yang diterima dari layanan Azure Batch.

Name	Type	Description
code	string	Pengidentifikasi untuk kesalahan. Kode tidak berubah dan dimaksudkan untuk dikonsumsi secara terprogram.
message	ErrorMessage	Pesan yang menjelaskan kesalahan, dimaksudkan agar cocok untuk ditampilkan di antarmuka pengguna.
values	BatchErrorDetail[]	Kumpulan pasangan kunci-nilai yang berisi detail tambahan tentang kesalahan.

BatchErrorDetail

Item informasi tambahan yang disertakan dalam respons kesalahan Azure Batch.

Name	Type	Description
key	string	Pengidentifikasi yang menentukan arti properti Nilai.
value	string	Informasi tambahan disertakan dengan respons kesalahan.

CertificateReference

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

Name	Type	Description
storeLocation	CertificateStoreLocation	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 disediakan ke Tugas untuk mengkueri lokasi ini. Untuk Sertifikat dengan visibilitas 'remoteUser', direktori 'certs' dibuat di direktori beranda pengguna (misalnya, /home/{user-name}/certs) dan Sertifikat ditempatkan di direktori tersebut.
storeName	string	Nama penyimpanan Sertifikat pada Simpul Komputasi tempat menginstal Sertifikat. Properti ini hanya berlaku untuk Kumpulan yang dikonfigurasi dengan 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.

ComputeNode

Simpul Komputasi di layanan Batch.

Name	Type	Description
affinityId	string	Pengidentifikasi yang dapat diteruskan saat menambahkan Tugas untuk meminta agar Tugas dijadwalkan pada Simpul Komputasi ini. Perhatikan bahwa ini hanya afinitas lunak. Jika Simpul Komputasi target sibuk atau tidak tersedia pada saat Tugas dijadwalkan, maka Tugas akan dijadwalkan di tempat lain.
allocationTime	string	Waktu di mana Simpul Komputasi ini dialokasikan ke Kumpulan. Ini adalah waktu ketika Simpul Komputasi awalnya dialokasikan dan tidak berubah sekali diatur. Ini tidak diperbarui ketika Simpul Komputasi disembuhkan atau didahulukan.
certificateReferences	CertificateReference[]	Daftar Sertifikat yang diinstal pada Simpul Komputasi. Untuk simpul Windows, layanan Batch menginstal Sertifikat ke penyimpanan dan lokasi Sertifikat yang ditentukan. Untuk Simpul Komputasi Linux, Sertifikat disimpan dalam direktori di dalam direktori kerja Tugas dan variabel lingkungan AZ_BATCH_CERTIFICATES_DIR disediakan ke Tugas untuk mengkueri lokasi ini. Untuk Sertifikat dengan visibilitas 'remoteUser', direktori 'certs' dibuat di direktori beranda pengguna (misalnya, /home/{user-name}/certs) dan Sertifikat ditempatkan di direktori tersebut.
endpointConfiguration	ComputeNodeEndpointConfiguration	Konfigurasi titik akhir untuk Simpul Komputasi.
errors	ComputeNodeError[]	Daftar kesalahan yang saat ini sedang ditemui oleh Simpul Komputasi.
id	string	ID Simpul Komputasi. Setiap Simpul Komputasi yang ditambahkan ke Kumpulan diberi ID unik. Setiap kali Simpul Komputasi dihapus dari Kumpulan, semua file lokalnya dihapus, dan ID diklaim kembali dan dapat digunakan kembali untuk Simpul Komputasi baru.
ipAddress	string	Alamat IP yang dapat digunakan Simpul lain untuk berkomunikasi dengan Simpul Komputasi ini. Setiap Simpul Komputasi yang ditambahkan ke Kumpulan diberi alamat IP unik. Setiap kali Simpul Komputasi dihapus dari Kumpulan, semua file lokalnya dihapus, dan alamat IP diklaim kembali dan dapat digunakan kembali untuk Simpul Komputasi baru.
isDedicated	boolean	Apakah Simpul Komputasi ini adalah Simpul Komputasi khusus. Jika false, Simpul Komputasi adalah Simpul Komputasi Berprioritas Rendah/Spot.
lastBootTime	string	Terakhir kali di mana Simpul Komputasi dimulai. Properti ini mungkin tidak ada jika status Simpul Komputasi tidak dapat digunakan.
nodeAgentInfo	NodeAgentInformation	Informasi tentang versi agen Simpul Komputasi dan waktu Simpul Komputasi ditingkatkan ke versi baru. Agen Simpul Komputasi Batch adalah program yang berjalan pada setiap Simpul Komputasi di Kumpulan dan menyediakan kemampuan Batch pada Simpul Komputasi.
recentTasks	TaskInformation[]	Daftar Tugas yang statusnya baru saja berubah. Properti ini hanya ada jika setidaknya satu Tugas telah berjalan pada Simpul Komputasi ini sejak ditetapkan ke Kumpulan.
runningTaskSlotsCount	integer	Jumlah total slot penjadwalan yang digunakan saat ini menjalankan Tugas Pekerjaan pada Simpul Komputasi. Ini termasuk Tugas Manajer Pekerjaan dan Tugas normal, tetapi bukan Persiapan Pekerjaan, Rilis Pekerjaan, atau Tugas Mulai.
runningTasksCount	integer	Jumlah total Tugas Pekerjaan yang sedang berjalan pada Simpul Komputasi. Ini termasuk Tugas Manajer Pekerjaan dan Tugas normal, tetapi bukan Persiapan Pekerjaan, Rilis Pekerjaan, atau Tugas Mulai.
schedulingState	SchedulingState	Apakah Simpul Komputasi tersedia untuk Penjadwalan Tugas.
startTask	StartTask	Tugas yang ditentukan untuk dijalankan pada Simpul Komputasi saat bergabung dengan Kumpulan. 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.
startTaskInfo	StartTaskInformation	Informasi runtime tentang eksekusi StartTask pada Simpul Komputasi.
state	ComputeNodeState	Status Simpul Komputasi saat ini. Simpul Komputasi Spot/Prioritas Rendah telah didahului. Tugas yang berjalan pada Simpul Komputasi ketika didahulukan akan dijadwalkan ulang ketika Simpul Komputasi lain tersedia.
stateTransitionTime	string	Waktu saat Simpul Komputasi memasuki statusnya saat ini.
totalTasksRun	integer	Jumlah total Tugas Pekerjaan yang diselesaikan pada Simpul Komputasi. Ini termasuk Tugas Manajer Pekerjaan dan Tugas normal, tetapi bukan Persiapan Pekerjaan, Rilis Pekerjaan, atau Tugas Mulai.
totalTasksSucceeded	integer	Jumlah total Tugas Pekerjaan yang berhasil diselesaikan (dengan exitCode 0) pada Simpul Komputasi. Ini termasuk Tugas Manajer Pekerjaan dan Tugas normal, tetapi bukan Persiapan Pekerjaan, Rilis Pekerjaan, atau Tugas Mulai.
url	string	URL Simpul Komputasi.
virtualMachineInfo	VirtualMachineInfo	Info tentang status komputer virtual saat ini.
vmSize	string	Ukuran komputer virtual yang menghosting Simpul Komputasi. 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).

ComputeNodeEndpointConfiguration

Konfigurasi titik akhir untuk Simpul Komputasi.

Name	Type	Description
inboundEndpoints	InboundEndpoint[]	Daftar titik akhir masuk yang dapat diakses pada Simpul Komputasi.

ComputeNodeError

Kesalahan yang ditemui oleh Simpul Komputasi.

Name	Type	Description
code	string	Pengidentifikasi untuk kesalahan Simpul Komputasi. Kode tidak berubah dan dimaksudkan untuk dikonsumsi secara terprogram.
errorDetails	NameValuePair[]	Daftar detail kesalahan tambahan yang terkait dengan kesalahan Simpul Komputasi.
message	string	Pesan yang menjelaskan kesalahan Simpul Komputasi, dimaksudkan agar cocok untuk ditampilkan di antarmuka pengguna.

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.

ComputeNodeState

Status Simpul Komputasi saat ini.

Name	Type	Description
creating	string	Layanan Batch telah memperoleh komputer virtual yang mendasar dari Azure Compute, tetapi belum mulai bergabung dengan Kumpulan.
idle	string	Simpul Komputasi saat ini tidak menjalankan Tugas.
leavingpool	string	Simpul Komputasi meninggalkan Kumpulan, baik karena pengguna secara eksplisit menghapusnya atau karena Kumpulan mengubah ukuran atau menurunkan skala otomatis.
offline	string	Simpul Komputasi saat ini tidak menjalankan Tugas, dan penjadwalan Tugas baru ke Simpul Komputasi dinonaktifkan.
preempted	string	Simpul Komputasi Spot/Prioritas Rendah telah didahului. Tugas yang berjalan pada Simpul Komputasi ketika didahulukan akan dijadwalkan ulang ketika Simpul Komputasi lain tersedia.
rebooting	string	Simpul Komputasi sedang di-boot ulang.
reimaging	string	Simpul Komputasi digambatkan ulang.
running	string	Simpul Komputasi menjalankan satu atau beberapa Tugas (selain StartTask).
starting	string	Layanan Batch dimulai pada komputer virtual yang mendasar.
starttaskfailed	string	StartTask telah gagal pada Simpul Komputasi (dan kelelahan semua percobaan ulang), dan waitForSuccess diatur. Simpul Komputasi tidak dapat digunakan untuk menjalankan Tugas.
unknown	string	Layanan Batch telah kehilangan kontak dengan Simpul Komputasi, dan tidak tahu keadaan sebenarnya.
unusable	string	Simpul Komputasi tidak dapat digunakan untuk Eksekusi tugas karena kesalahan.
waitingforstarttask	string	StartTask telah mulai berjalan pada Simpul Komputasi, tetapi waitForSuccess diatur dan StartTask belum selesai.

ContainerRegistry

Registri kontainer privat.

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

ContainerWorkingDirectory

Lokasi direktori kerja Tugas kontainer.

Name	Type	Description
containerImageDefault	string	Gunakan direktori kerja yang ditentukan dalam Gambar kontainer. Berhati-hatilah bahwa direktori ini tidak akan berisi File Sumber Daya yang diunduh oleh Batch.
taskWorkingDirectory	string	Gunakan direktori kerja Tugas layanan Batch standar, yang akan berisi File Sumber Daya Tugas yang diisi oleh Batch.

ElevationLevel

Tingkat elevasi pengguna.

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 yang diterima dalam respons kesalahan Azure Batch.

Name	Type	Description
lang	string	Kode bahasa pesan kesalahan
value	string	Teks pesan.

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.

InboundEndpoint

Titik akhir masuk pada Simpul Komputasi.

Name	Type	Description
backendPort	integer	Nomor port ujung belakang titik akhir.
frontendPort	integer	Nomor port publik titik akhir.
name	string	Nama titik akhir.
protocol	InboundEndpointProtocol	Protokol titik akhir.
publicFQDN	string	Nama domain publik yang sepenuhnya memenuhi syarat untuk Simpul Komputasi.
publicIPAddress	string	Alamat IP publik Simpul Komputasi.

InboundEndpointProtocol

Protokol titik akhir.

Name	Type	Description
tcp	string	Gunakan TCP untuk titik akhir.
udp	string	Gunakan UDP untuk titik akhir.

NameValuePair

Mewakili pasangan nama-nilai.

Name	Type	Description
name	string	Nama dalam pasangan nama-nilai.
value	string	Nilai dalam pasangan nama-nilai.

NodeAgentInformation

Informasi tentang agen Simpul Komputasi.

Name	Type	Description
lastUpdateTime	string	Waktu ketika agen Simpul Komputasi diperbarui pada Simpul Komputasi. Ini adalah waktu terbaru agen Simpul Komputasi diperbarui ke versi baru.
version	string	Versi agen Simpul Komputasi Batch yang berjalan pada Simpul Komputasi. Nomor versi ini dapat diperiksa terhadap catatan rilis agen Simpul Komputasi yang terletak di https://github.com/Azure/Batch/blob/master/changelogs/nodeagent/CHANGELOG.md.

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	ComputeNodeIdentityReference	Referensi ke identitas yang ditetapkan pengguna untuk digunakan untuk mengakses Azure Blob Storage yang ditentukan oleh storageContainerUrl atau httpUrl Referensi ke identitas yang ditetapkan pengguna yang terkait dengan kumpulan Batch yang akan digunakan simpul komputasi.
storageContainerUrl	string	URL kontainer blob dalam Azure Blob Storage. Properti autoStorageContainerName, storageContainerUrl, dan httpUrl saling eksklusif dan salah satunya harus ditentukan. URL ini harus dapat dibaca dan dapat dicantumkan dari simpul komputasi. Ada tiga cara untuk mendapatkan URL seperti itu untuk kontainer di penyimpanan Azure: sertakan Tanda Tangan Akses Bersama (SAS) yang memberikan izin baca dan daftar pada kontainer, gunakan identitas terkelola dengan izin baca dan daftar, atau atur ACL untuk kontainer guna mengizinkan akses publik.

SchedulingState

Apakah Simpul Komputasi tersedia untuk Penjadwalan Tugas.

Name	Type	Description
disabled	string	Tidak ada Tugas baru yang akan dijadwalkan pada Simpul Komputasi. Tugas yang sudah berjalan pada Simpul Komputasi mungkin masih berjalan hingga selesai. Semua Simpul Komputasi dimulai dengan penjadwalan diaktifkan.
enabled	string	Tugas dapat dijadwalkan pada 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.

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

StartTaskInformation

Informasi tentang StartTask yang berjalan pada Simpul Komputasi.

Name	Type	Description
containerInfo	TaskContainerExecutionInformation	Informasi tentang kontainer tempat Tugas dijalankan. Properti ini diatur hanya jika Tugas berjalan dalam konteks kontainer.
endTime	string	Waktu di mana StartTask berhenti berjalan. Ini adalah waktu akhir dari proses StartTask terbaru, jika eksekusi tersebut telah selesai (bahkan jika eksekusi tersebut gagal dan percobaan ulang tertunda). Elemen ini tidak ada jika StartTask saat ini berjalan.
exitCode	integer	Kode keluar program yang ditentukan pada baris perintah StartTask. Properti ini diatur hanya jika StartTask dalam status selesai. Secara umum, kode keluar untuk proses mencerminkan konvensi tertentu yang diterapkan oleh pengembang aplikasi untuk proses tersebut. Jika Anda menggunakan nilai kode keluar untuk membuat keputusan dalam kode Anda, pastikan Anda mengetahui konvensi kode keluar yang digunakan oleh proses aplikasi. Namun, jika layanan Batch mengakhiri StartTask (karena waktu habis, atau penghentian pengguna melalui API) Anda mungkin melihat kode keluar yang ditentukan sistem operasi.
failureInfo	TaskFailureInformation	Informasi yang menjelaskan kegagalan Tugas, jika ada. Properti ini diatur hanya jika Tugas dalam status selesai dan mengalami kegagalan.
lastRetryTime	string	Waktu terbaru saat coba lagi Tugas mulai berjalan. Elemen ini hanya ada jika Tugas dicoba ulang (yaitu retryCount bukan nol). Jika ada, ini biasanya sama dengan startTime, tetapi mungkin berbeda jika Tugas telah dimulai ulang karena alasan selain mencoba kembali; misalnya, jika Simpul Komputasi di-boot ulang selama coba lagi, maka startTime diperbarui tetapi lastRetryTime tidak.
result	TaskExecutionResult	Hasil dari eksekusi Tugas. Jika nilainya 'gagal', maka detail kegagalan dapat ditemukan di properti failureInfo.
retryCount	integer	Berapa kali Tugas telah dicoba kembali oleh layanan Batch. Kegagalan aplikasi tugas (kode keluar bukan nol) dicoba kembali, kesalahan pra-pemrosesan (Tugas tidak dapat dijalankan) dan kesalahan pengunggahan file tidak dicoba kembali. Layanan Batch akan mencoba kembali Tugas hingga batas yang ditentukan oleh batasan.
startTime	string	Waktu saat StartTask mulai berjalan. Nilai ini direset setiap kali Tugas dimulai ulang atau dicoba ulang (artinya, ini adalah waktu terbaru saat StartTask mulai berjalan).
state	StartTaskState	Status StartTask pada Simpul Komputasi.

StartTaskState

Status StartTask pada Simpul Komputasi.

Name	Type	Description
completed	string	StartTask telah keluar dengan kode keluar 0, atau StartTask telah gagal dan batas coba lagi telah tercapai, atau proses StartTask tidak berjalan karena kesalahan persiapan Tugas (seperti kegagalan pengunduhan file sumber daya).
running	string	StartTask saat ini sedang berjalan.

TaskContainerExecutionInformation

Berisi informasi tentang kontainer yang dijalankan Tugas.

Name	Type	Description
containerId	string	ID kontainer.
error	string	Informasi kesalahan terperinci tentang kontainer. Ini adalah string kesalahan terperinci dari layanan Docker, jika tersedia. Ini setara dengan bidang kesalahan yang dikembalikan oleh "inspeksi docker".
state	string	Status kontainer. Ini adalah status kontainer sesuai dengan layanan Docker. Ini setara dengan bidang status yang dikembalikan oleh "inspeksi docker".

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	ContainerRegistry	Registri privat yang berisi Gambar kontainer. Pengaturan ini dapat dihilangkan jika sudah disediakan di pembuatan Pool.
workingDirectory	ContainerWorkingDirectory	Lokasi direktori kerja Tugas kontainer. Defaultnya adalah 'taskWorkingDirectory'.

TaskExecutionInformation

Informasi tentang eksekusi Tugas.

Name	Type	Description
containerInfo	TaskContainerExecutionInformation	Informasi tentang kontainer tempat Tugas dijalankan. Properti ini diatur hanya jika Tugas berjalan dalam konteks kontainer.
endTime	string	Waktu tugas selesai. Properti ini diatur hanya jika Tugas dalam status Selesai.
exitCode	integer	Kode keluar program yang ditentukan pada baris perintah Tugas. Properti ini diatur hanya jika Tugas dalam status selesai. Secara umum, kode keluar untuk proses mencerminkan konvensi tertentu yang diterapkan oleh pengembang aplikasi untuk proses tersebut. Jika Anda menggunakan nilai kode keluar untuk membuat keputusan dalam kode Anda, pastikan Anda mengetahui konvensi kode keluar yang digunakan oleh proses aplikasi. Namun, jika layanan Batch mengakhiri Tugas (karena waktu habis, atau penghentian pengguna melalui API), Anda mungkin melihat kode keluar yang ditentukan sistem operasi.
failureInfo	TaskFailureInformation	Informasi yang menjelaskan kegagalan Tugas, jika ada. Properti ini diatur hanya jika Tugas dalam status selesai dan mengalami kegagalan.
lastRequeueTime	string	Waktu terbaru di mana Tugas telah diantrekan ulang oleh layanan Batch sebagai hasil dari permintaan pengguna. Properti ini diatur hanya jika requeueCount bukan nol.
lastRetryTime	string	Waktu terbaru saat coba lagi Tugas mulai berjalan. Elemen ini hanya ada jika Tugas dicoba ulang (yaitu retryCount bukan nol). Jika ada, ini biasanya sama dengan startTime, tetapi mungkin berbeda jika Tugas telah dimulai ulang karena alasan selain mencoba kembali; misalnya, jika Simpul Komputasi di-boot ulang selama coba lagi, maka startTime diperbarui tetapi lastRetryTime tidak.
requeueCount	integer	Berapa kali Tugas telah diantrekan kembali oleh layanan Batch sebagai hasil dari permintaan pengguna. Saat pengguna menghapus Simpul Komputasi dari Kumpulan (dengan mengubah ukuran/menyusutkan kumpulan) atau ketika Pekerjaan dinonaktifkan, pengguna dapat menentukan bahwa tugas yang berjalan pada Simpul Komputasi akan diantrekan ulang untuk eksekusi. Jumlah ini melacak berapa kali Tugas telah diantrekan kembali karena alasan ini.
result	TaskExecutionResult	Hasil dari eksekusi Tugas. Jika nilainya 'gagal', maka detail kegagalan dapat ditemukan di properti failureInfo.
retryCount	integer	Berapa kali Tugas telah dicoba kembali oleh layanan Batch. Kegagalan aplikasi tugas (kode keluar bukan nol) dicoba kembali, kesalahan pra-pemrosesan (Tugas tidak dapat dijalankan) dan kesalahan pengunggahan file tidak dicoba kembali. Layanan Batch akan mencoba kembali Tugas hingga batas yang ditentukan oleh batasan.
startTime	string	Waktu di mana Tugas mulai berjalan. 'Berjalan' sesuai dengan status berjalan, jadi jika Tugas menentukan file sumber daya atau Paket, maka waktu mulai mencerminkan waktu di mana Tugas mulai mengunduh atau menyebarkannya. Jika Tugas telah dimulai ulang atau dicoba ulang, ini adalah waktu terbaru di mana Tugas mulai berjalan. Properti ini hanya ada untuk Tugas yang dalam status berjalan atau selesai.

TaskExecutionResult

Hasil eksekusi Tugas.

Name	Type	Description
failure	string	Terjadi kesalahan selama pemrosesan Tugas. Kegagalan mungkin terjadi sebelum proses Tugas diluncurkan, saat proses Tugas sedang dijalankan, atau setelah proses Tugas keluar.
success	string	Tugas berhasil dijalankan.

TaskFailureInformation

Informasi tentang kegagalan Tugas.

Name	Type	Description
category	ErrorCategory	Kategori kesalahan Tugas.
code	string	Pengidentifikasi untuk kesalahan Tugas. Kode tidak berubah dan dimaksudkan untuk dikonsumsi secara terprogram.
details	NameValuePair[]	Daftar detail tambahan yang terkait dengan kesalahan.
message	string	Pesan yang menjelaskan kesalahan Tugas, dimaksudkan agar cocok untuk ditampilkan di antarmuka pengguna.

TaskInformation

Informasi tentang Tugas yang berjalan pada Simpul Komputasi.

Name	Type	Description
executionInfo	TaskExecutionInformation	Informasi tentang eksekusi Tugas.
jobId	string	ID Pekerjaan tempat Tugas berada.
subtaskId	integer	ID subtugas jika Tugas adalah Tugas multi-instans.
taskId	string	ID Tugas.
taskState	TaskState	Status Tugas saat ini.
taskUrl	string	URL Tugas.

TaskState

Status Tugas.

Name	Type	Description
active	string	Tugas diantrekan dan dapat dijalankan, tetapi saat ini tidak ditetapkan ke Simpul Komputasi. Tugas memasuki status ini ketika dibuat, ketika diaktifkan setelah dinonaktifkan, atau ketika menunggu percobaan kembali setelah eksekusi gagal.
completed	string	Tugas tidak lagi memenuhi syarat untuk dijalankan, biasanya karena Tugas telah berhasil diselesaikan, atau Tugas telah selesai dengan tidak berhasil dan telah kehabisan batas coba lagi. Tugas juga ditandai sebagai selesai jika terjadi kesalahan saat meluncurkan Tugas, atau ketika Tugas telah dihentikan.
preparing	string	Tugas telah ditetapkan ke Simpul Komputasi, tetapi menunggu Tugas Persiapan Pekerjaan yang diperlukan selesai pada Simpul Komputasi. Jika Tugas Persiapan Pekerjaan berhasil, Tugas akan dipindahkan ke berjalan. Jika Tugas Persiapan Pekerjaan gagal, Tugas akan kembali aktif dan akan memenuhi syarat untuk ditetapkan ke Simpul Komputasi yang berbeda.
running	string	Tugas berjalan pada Simpul Komputasi. Ini termasuk persiapan tingkat tugas seperti mengunduh file sumber daya atau menyebarkan Paket yang ditentukan pada Tugas - itu tidak selalu berarti bahwa baris perintah Tugas telah mulai dijalankan.

UserIdentity

Definisi identitas pengguna tempat Tugas dijalankan.

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

VirtualMachineInfo

Info tentang status komputer virtual saat ini.

Name	Type	Description
imageReference	ImageReference	Referensi ke Gambar Marketplace Azure Virtual Machine.