Nodes - Create Node User

Layanan:

Batch Service

Versi API:

2025-06-01

Menambahkan Akun pengguna ke Node Komputasi yang ditentukan.
Anda dapat menambahkan Akun pengguna ke Node Komputasi hanya saat dalam keadaan siaga atau berjalan. Sebelum Anda dapat masuk dari jarak jauh ke Node Komputasi, Anda harus mengonfigurasi port akses untuk SSH dan RDP. Untuk informasi lebih lanjut, lihat https://learn.microsoft.com/azure/batch/pool-endpoint-configuration

POST {endpoint}/pools/{poolId}/nodes/{nodeId}/users?api-version=2025-06-01

Dengan parameter opsional:

POST {endpoint}/pools/{poolId}/nodes/{nodeId}/users?api-version=2025-06-01&timeOut={timeOut}

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
endpoint	path	True	string (uri)	Titik akhir akun batch (misalnya: https://batchaccount.eastus2.batch.azure.com).
nodeId	path	True	string	ID mesin tempat Anda ingin membuat Akun pengguna.
poolId	path	True	string	ID Kumpulan yang berisi Simpul Komputasi.
api-version	query	True	string minLength: 1	Versi API yang digunakan untuk operasi ini.
timeOut	query		integer (int32)	Waktu maksimum yang dapat dihabiskan server untuk memproses permintaan, dalam hitung detik. Defaultnya adalah 30 detik. Jika nilainya lebih besar dari 30, defaultnya akan digunakan sebagai gantinya.".

Header Permintaan

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

Nama	Diperlukan	Jenis	Deskripsi
client-request-id		string	Identitas permintaan yang dihasilkan penelepon, 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-rfc7231)	Waktu permintaan dikeluarkan. Pustaka klien biasanya mengatur ini ke waktu jam sistem saat ini; atur secara eksplisit jika Anda memanggil REST API secara langsung.

Isi Permintaan

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

Nama	Diperlukan	Jenis	Deskripsi
name	True	string	Nama pengguna Akun.
expiryTime		string (date-time)	Waktu kedaluwarsa Akun. Jika dihilangkan, defaultnya adalah 1 hari dari waktu saat ini. Untuk Linux Compute Node, expiryTime memiliki presisi hingga satu hari.
isAdmin		boolean	Apakah Akun harus menjadi administrator pada Compute Node. Nilai defaultnya adalah false.
password		string (password)	Kata sandi Akun. Kata sandi diperlukan untuk Node Komputasi Windows. Untuk Node Komputasi Linux, kata sandi dapat ditentukan secara opsional bersama dengan properti sshPublicKey.
sshPublicKey		string	Kunci publik SSH yang dapat digunakan untuk login jarak jauh ke Node Komputasi. Kunci publik harus kompatibel dengan pengkodean OpenSSH dan harus dikodekan basis 64. Properti ini hanya dapat ditentukan untuk Node Komputasi Linux. Jika ini ditentukan untuk Node Komputasi Windows, maka layanan Batch menolak permintaan; jika Anda memanggil REST API secara langsung, kode status HTTP adalah 400 (Permintaan Buruk).

Respons

Nama	Jenis	Deskripsi
201 Created		Permintaan telah berhasil dan sumber daya baru telah dibuat sebagai hasilnya. Header DataServiceId: string ETag: string Last-Modified: string client-request-id: string request-id: string
Other Status Codes	BatchError	Respons kesalahan tak terduga.

Keamanan

OAuth2Auth

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Cakupan

Nama	Deskripsi
https://batch.core.windows.net//.default

Contoh

Node create user

Permintaan sampel

HTTP

POST {endpoint}/pools/poolId/nodes/tvm-1695681911_1-20161121t182739z/users?api-version=2025-06-01



{
  "name": "userName",
  "isAdmin": false,
  "expiryTime": "2025-08-01T00:00:00Z",
  "password": "Password"
}

Respon sampel

Kode status:

201

Definisi

Nama	Deskripsi
BatchError	Respons kesalahan diterima dari layanan Azure Batch.
BatchErrorDetail	Item informasi tambahan yang disertakan dalam respons kesalahan Azure Batch.
BatchErrorMessage	Pesan kesalahan diterima dalam respons kesalahan Azure Batch.
BatchNodeUserCreateOptions	Parameter untuk membuat akun pengguna untuk akses RDP atau SSH pada Simpul Komputasi Azure Batch.

BatchError

Objek

Respons kesalahan diterima dari layanan Azure Batch.

Nama	Jenis	Deskripsi
code	string	Pengidentifikasi untuk kesalahan. Kode invarian dan dimaksudkan untuk dikonsumsi secara terprogram.
message	BatchErrorMessage	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

Objek

Item informasi tambahan yang disertakan dalam respons kesalahan Azure Batch.

Nama	Jenis	Deskripsi
key	string	Pengidentifikasi yang menentukan arti properti Nilai.
value	string	Informasi tambahan yang disertakan dengan respons kesalahan.

BatchErrorMessage

Objek

Pesan kesalahan diterima dalam respons kesalahan Azure Batch.

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

BatchNodeUserCreateOptions

Objek

Parameter untuk membuat akun pengguna untuk akses RDP atau SSH pada Simpul Komputasi Azure Batch.

Nama	Jenis	Deskripsi
expiryTime	string (date-time)	Waktu kedaluwarsa Akun. Jika dihilangkan, defaultnya adalah 1 hari dari waktu saat ini. Untuk Linux Compute Node, expiryTime memiliki presisi hingga satu hari.
isAdmin	boolean	Apakah Akun harus menjadi administrator pada Compute Node. Nilai defaultnya adalah false.
name	string	Nama pengguna Akun.
password	string (password)	Kata sandi Akun. Kata sandi diperlukan untuk Node Komputasi Windows. Untuk Node Komputasi Linux, kata sandi dapat ditentukan secara opsional bersama dengan properti sshPublicKey.
sshPublicKey	string	Kunci publik SSH yang dapat digunakan untuk login jarak jauh ke Node Komputasi. Kunci publik harus kompatibel dengan pengkodean OpenSSH dan harus dikodekan basis 64. Properti ini hanya dapat ditentukan untuk Node Komputasi Linux. Jika ini ditentukan untuk Node Komputasi Windows, maka layanan Batch menolak permintaan; jika Anda memanggil REST API secara langsung, kode status HTTP adalah 400 (Permintaan Buruk).