共用方式為

Compute Node - Add User

  • 參考
服務:
Batch Service
API 版本:
2024-07-01.20.0

將用戶帳戶新增至指定的計算節點。
只有當使用者帳戶處於閑置或執行中狀態時，才可以將用戶帳戶新增至計算節點。

POST {batchUrl}/pools/{poolId}/nodes/{nodeId}/users?api-version=2024-07-01.20.0
含選擇性參數: 
POST {batchUrl}/pools/{poolId}/nodes/{nodeId}/users?timeout={timeout}&api-version=2024-07-01.20.0

URI 參數

名稱 位於 必要 類型 Description
batchUrl
 path True

string

所有 Azure Batch 服務要求的基底 URL。
nodeId
 path True

string

您要在其中建立使用者帳戶之計算機的標識碼。
poolId
 path True

string

包含計算節點的集區識別碼。
api-version
 query True

string

用戶端 API 版本。
timeout
 query

integer (int32)

伺服器可以花費數秒處理要求的時間上限。 預設值為30秒。 如果值大於 30，則會改用預設值。

要求標頭

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

名稱 必要 類型 Description
client-request-id

string (uuid)

呼叫端產生的要求身分識別，格式為 GUID，不含大括弧，例如 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0。
return-client-request-id

boolean

伺服器是否應該在回應中傳回 client-request-id。
ocp-date

string (date-time-rfc1123)

發出要求的時間。 用戶端連結庫通常會將此設定為目前的系統時鐘時間;如果您要直接呼叫 REST API，請明確設定它。

要求本文

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

名稱 必要 類型 Description
name True

string

帳戶的用戶名稱。
expiryTime

string (date-time)

帳戶到期的時間。
如果省略，預設值為從目前時間起的 1 天。 針對 Linux 計算節點，expiryTime 的精確度最多可達一天。
isAdmin

boolean

帳戶是否應該是計算節點上的系統管理員。
預設值為 False。
password

string

帳戶的密碼。
Windows 計算節點需要密碼。 針對 Linux 計算節點，可以選擇性地指定密碼以及 sshPublicKey 屬性。
sshPublicKey

string

可用於遠端登入計算節點的 SSH 公鑰。
公鑰應該與 OpenSSH 編碼相容，而且應該以 64 為基底編碼。 此屬性只能針對 Linux 計算節點指定。 如果這是針對 Windows 計算節點指定的，則 Batch 服務會拒絕要求;如果您直接呼叫 REST API，則 HTTP 狀態代碼為 400 （不正確的要求）。

回應

名稱 類型 Description
201 Created

Batch 服務的要求成功。

標題

  • client-request-id: string
  • request-id: string
  • ETag: string
  • Last-Modified: string
  • DataServiceId: string
Other Status Codes

BatchError

Batch 服務的錯誤。

安全性

azure_auth

Microsoft Entra OAuth 2.0 驗證碼流程

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱 Description
user_impersonation 模擬您的用戶帳戶

Authorization

類型: apiKey
位於: header

範例

Node add user

範例要求

POST account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_1-20161121t182739z/users?api-version=2024-07-01.20.0



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

範例回覆

狀態碼:
201

定義

名稱 Description
BatchError

從 Azure Batch 服務收到的錯誤回應。
BatchErrorDetail

Azure Batch 錯誤回應中包含的其他信息專案。
ComputeNodeUser

計算節點上 RDP 或 SSH 存取的用戶帳戶。
ErrorMessage

Azure Batch 錯誤回應中收到的錯誤訊息。

BatchError

Object

從 Azure Batch 服務收到的錯誤回應。

名稱 類型 Description
code

string

錯誤的識別碼。 程序代碼是不變的，而且是要以程序設計方式取用。
message

ErrorMessage

描述錯誤的訊息，適用於在使用者介面中顯示。
values

BatchErrorDetail[]

索引鍵/值組的集合，其中包含錯誤的其他詳細數據。

BatchErrorDetail

Object

Azure Batch 錯誤回應中包含的其他信息專案。

名稱 類型 Description
key

string

指定 Value 屬性意義的識別碼。
value

string

錯誤回應隨附的其他資訊。

ComputeNodeUser

Object

計算節點上 RDP 或 SSH 存取的用戶帳戶。

名稱 類型 Description
expiryTime

string (date-time)

帳戶到期的時間。
如果省略，預設值為從目前時間起的 1 天。 針對 Linux 計算節點，expiryTime 的精確度最多可達一天。
isAdmin

boolean

帳戶是否應該是計算節點上的系統管理員。
預設值為 False。
name

string

帳戶的用戶名稱。
password

string

帳戶的密碼。
Windows 計算節點需要密碼。 針對 Linux 計算節點，可以選擇性地指定密碼以及 sshPublicKey 屬性。
sshPublicKey

string

可用於遠端登入計算節點的 SSH 公鑰。
公鑰應該與 OpenSSH 編碼相容，而且應該以 64 為基底編碼。 此屬性只能針對 Linux 計算節點指定。 如果這是針對 Windows 計算節點指定的，則 Batch 服務會拒絕要求;如果您直接呼叫 REST API，則 HTTP 狀態代碼為 400 （不正確的要求）。

ErrorMessage

Object

Azure Batch 錯誤回應中收到的錯誤訊息。

名稱 類型 Description
lang

string

錯誤訊息的語言代碼
value

string

訊息的文字。