Nodes - Create Node User

服務:: Batch Service

API 版本:: 2025-06-01

將使用者帳號加入指定的運算節點。
你只能在運算節點處於閒置或執行狀態時，將使用者帳號加入。在遠端登入運算節點之前，必須先設定 SSH 和 RDP 的存取埠。如需詳細資訊，請參閱 https://learn.microsoft.com/azure/batch/pool-endpoint-configuration

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

含選擇性參數:

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

URI 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string (uri)	Batch 帳戶端點（例如：https://batchaccount.eastus2.batch.azure.com）。
nodeId	path	True	string	你想建立使用者帳號的機器 ID。
poolId	path	True	string	包含計算節點的集區識別碼。
api-version	query	True	string minLength: 1	要用於這項作業的 API 版本。
timeOut	query		integer (int32)	伺服器可以花費數秒處理要求的時間上限。預設值為 30 秒。若值大於30，則會使用預設值。」

要求標頭

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

名稱	類型	Description
client-request-id	string	呼叫端產生的要求身分識別，格式為 GUID，不含大括弧，例如 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0。
return-client-request-id	boolean	伺服器是否應該在回應中傳回 client-request-id。
ocp-date	string (date-time-rfc7231)	發出要求的時間。用戶端連結庫通常會將此設定為目前的系統時鐘時間;如果您要直接呼叫 REST API，請明確設定它。

要求本文

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

名稱	必要	類型	Description
name	True	string	帳號的使用者名稱。
expiryTime		string (date-time)	帳戶應在的到期時間。若省略，預設時間為當前時間起1天。對於 Linux 運算節點，到期時間的精確度可達一天。
isAdmin		boolean	帳號是否應該是計算節點的管理員。預設值為 false。
password		string (password)	帳號密碼。 Windows 運算節點必須使用此密碼。對於 Linux 運算節點，密碼可選擇性地與 sshPublicKey 屬性一起指定。
sshPublicKey		string	可用於遠端登入計算節點的 SSH 公鑰。公鑰應與 OpenSSH 編碼相容，且應採用 base 64 編碼。此特性僅能針對 Linux 運算節點指定。若此設定為 Windows 運算節點，則批次服務會拒絕該請求;如果你直接呼叫 REST API，HTTP 狀態碼是 400（錯誤請求）。

回應

名稱	類型	Description
201 Created		要求已成功，因此已建立新的資源。標題 DataServiceId: string ETag: string Last-Modified: string client-request-id: string request-id: string
Other Status Codes	BatchError	未預期的錯誤回應。

名稱

類型

Description

201 Created

要求已成功，因此已建立新的資源。

標題

DataServiceId: string
ETag: string
Last-Modified: string
client-request-id: string
request-id: string

Other Status Codes

BatchError

未預期的錯誤回應。

安全性

OAuth2Auth

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

範圍

名稱	Description
https://batch.core.windows.net//.default

範例

Node create user

範例要求

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"
}

範例回覆

狀態碼:: 201

定義

名稱	Description
BatchError	從 Azure Batch 服務收到的錯誤回應。
BatchErrorDetail	Azure Batch 錯誤回應中包含的其他信息專案。
BatchErrorMessage	Azure Batch 錯誤回應中收到的錯誤訊息。
BatchNodeUserCreateOptions	在 Azure Batch 計算節點上建立 RDP 或 SSH 存取使用者帳戶的參數。

BatchError

Object

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

名稱	類型	Description
code	string	錯誤的識別碼。程序代碼是不變的，而且是要以程序設計方式取用。
message	BatchErrorMessage	描述錯誤的訊息，適用於在使用者介面中顯示。
values	BatchErrorDetail[]	索引鍵/值組的集合，其中包含錯誤的其他詳細數據。

BatchErrorDetail

Object

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

名稱	類型	Description
key	string	指定 Value 屬性意義的識別碼。
value	string	錯誤回應隨附的其他資訊。

BatchErrorMessage

Object

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

名稱	類型	Description
lang	string	錯誤訊息的語言代碼。
value	string	訊息的文字。

BatchNodeUserCreateOptions

Object

在 Azure Batch 計算節點上建立 RDP 或 SSH 存取使用者帳戶的參數。

名稱	類型	Description
expiryTime	string (date-time)	帳戶應在的到期時間。若省略，預設時間為當前時間起1天。對於 Linux 運算節點，到期時間的精確度可達一天。
isAdmin	boolean	帳號是否應該是計算節點的管理員。預設值為 false。
name	string	帳號的使用者名稱。
password	string (password)	帳號密碼。 Windows 運算節點必須使用此密碼。對於 Linux 運算節點，密碼可選擇性地與 sshPublicKey 屬性一起指定。
sshPublicKey	string	可用於遠端登入計算節點的 SSH 公鑰。公鑰應與 OpenSSH 編碼相容，且應採用 base 64 編碼。此特性僅能針對 Linux 運算節點指定。若此設定為 Windows 運算節點，則批次服務會拒絕該請求;如果你直接呼叫 REST API，HTTP 狀態碼是 400（錯誤請求）。

共用方式為

Nodes - Create Node User

URI 參數

要求標頭

要求本文

回應

安全性

OAuth2Auth

範圍

範例

Node create user

範例要求

範例回覆

定義

BatchError

BatchErrorDetail

BatchErrorMessage

BatchNodeUserCreateOptions