Compute Node - Add User

  • Referensi
Service:
Batch Service
API Version:
2022-01-01.15.0

Menambahkan Akun pengguna ke Simpul Komputasi yang ditentukan.
Anda dapat menambahkan Akun pengguna ke Simpul Komputasi hanya saat berada dalam status menganggur atau berjalan.

POST {batchUrl}/pools/{poolId}/nodes/{nodeId}/users?api-version=2022-01-01.15.0
With optional parameters: 
POST {batchUrl}/pools/{poolId}/nodes/{nodeId}/users?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 komputer tempat Anda ingin membuat Akun pengguna.
poolId
 path True
  • string

ID Kumpulan yang berisi Simpul Komputasi.
api-version
 query True
  • string

Versi API Klien.
timeout
 query
  • integer
int32

Waktu maksimum yang dapat dihabiskan server untuk memproses permintaan, dalam hitung detik. Defaultnya adalah 30 detik.

Header Permintaan

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

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.

Isi Permintaan

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

Name Required Type Description
name True
  • string

Nama pengguna Akun.
expiryTime
  • string

Waktu kedaluwarsa Akun.
Jika dihilangkan, defaultnya adalah 1 hari dari waktu saat ini. Untuk Simpul Komputasi Linux, expiryTime memiliki presisi hingga sehari.
isAdmin
  • boolean

Apakah Akun harus menjadi administrator pada Simpul Komputasi.
Nilai defaultnya adalah false.
password
  • string

Kata sandi Akun.
Kata sandi diperlukan untuk Windows Simpul Komputasi (yang dibuat dengan 'cloudServiceConfiguration', atau dibuat dengan 'virtualMachineConfiguration' menggunakan referensi Gambar Windows). Untuk Simpul Komputasi Linux, kata sandi dapat secara opsional ditentukan bersama dengan properti sshPublicKey.
sshPublicKey
  • string

Kunci umum SSH yang dapat digunakan untuk login jarak jauh ke Simpul Komputasi.
Kunci publik harus kompatibel dengan pengodean OpenSSH dan harus dikodekan base 64. Properti ini hanya dapat ditentukan untuk Simpul Komputasi Linux. Jika ini ditentukan untuk Simpul Komputasi Windows, maka layanan Batch menolak permintaan; jika Anda memanggil REST API secara langsung, kode status HTTP adalah 400 (Permintaan Buruk).

Respons

Name Type Description
201 Created

Permintaan ke layanan Batch berhasil.

Headers

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

Node add user

Sample Request

POST account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_1-20161121t182739z/users?api-version=2022-01-01.15.0



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

Sample Response

Status code:
201

Definisi

BatchError

Respons kesalahan yang diterima dari layanan Azure Batch.
BatchErrorDetail

Item informasi tambahan yang disertakan dalam respons kesalahan Azure Batch.
ComputeNodeUser

Akun pengguna untuk akses RDP atau SSH pada Simpul Komputasi.
ErrorMessage

Pesan kesalahan diterima dalam respons kesalahan Azure Batch.

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.

ComputeNodeUser

Akun pengguna untuk akses RDP atau SSH pada Simpul Komputasi.

Name Type Description
expiryTime
  • string

Waktu kedaluwarsa Akun.
Jika dihilangkan, defaultnya adalah 1 hari dari waktu saat ini. Untuk Simpul Komputasi Linux, expiryTime memiliki presisi hingga sehari.
isAdmin
  • boolean

Apakah Akun harus menjadi administrator pada Simpul Komputasi.
Nilai defaultnya adalah false.
name
  • string

Nama pengguna Akun.
password
  • string

Kata sandi Akun.
Kata sandi diperlukan untuk Windows Simpul Komputasi (yang dibuat dengan 'cloudServiceConfiguration', atau dibuat dengan 'virtualMachineConfiguration' menggunakan referensi Gambar Windows). Untuk Simpul Komputasi Linux, kata sandi dapat secara opsional ditentukan bersama dengan properti sshPublicKey.
sshPublicKey
  • string

Kunci umum SSH yang dapat digunakan untuk login jarak jauh ke Simpul Komputasi.
Kunci publik harus kompatibel dengan pengodean OpenSSH dan harus dikodekan base 64. Properti ini hanya dapat ditentukan untuk Simpul Komputasi Linux. Jika ini ditentukan untuk Simpul Komputasi Windows, maka layanan Batch menolak permintaan; jika Anda memanggil REST API secara langsung, kode status HTTP adalah 400 (Permintaan Buruk).

ErrorMessage

Pesan kesalahan diterima dalam respons kesalahan Azure Batch.

Name Type Description
lang
  • string

Kode bahasa pesan kesalahan
value
  • string

Teks pesan.