Compute Node - Add User
將用戶帳戶新增至指定的計算節點。
只有在使用者帳戶處於閑置或執行中狀態時,才可以將用戶帳戶新增至計算節點。
POST {batchUrl}/pools/{poolId}/nodes/{nodeId}/users?api-version=2023-11-01.18.0
POST {batchUrl}/pools/{poolId}/nodes/{nodeId}/users?timeout={timeout}&api-version=2023-11-01.18.0
URI 參數
名稱 | 位於 | 必要 | 類型 | Description |
---|---|---|---|---|
batch
|
path | True |
string |
所有 Azure Batch 服務要求的基底 URL。 |
node
|
path | True |
string |
您要在其中建立使用者帳戶的電腦標識碼。 |
pool
|
path | True |
string |
包含計算節點的集區識別碼。 |
api-version
|
query | True |
string |
用戶端 API 版本。 |
timeout
|
query |
integer int32 |
伺服器可以花費在處理要求的最大時間,以秒為單位。 預設值為 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 |
帳戶到期的時間。 |
|
isAdmin |
boolean |
帳戶是否應該是計算節點上的系統管理員。 |
|
password |
string |
帳戶的密碼。 |
|
sshPublicKey |
string |
可用於遠端登錄計算節點的 SSH 公鑰。 |
回應
名稱 | 類型 | Description |
---|---|---|
201 Created |
Batch 服務的要求成功。 標題
|
|
Other Status Codes |
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=2023-11-01.18.0
{
"name": "userName",
"isAdmin": false,
"expiryTime": "2017-08-01T00:00:00Z",
"password": "Password"
}
範例回覆
定義
名稱 | Description |
---|---|
Batch |
從 Azure Batch 服務收到的錯誤回應。 |
Batch |
Azure Batch 錯誤回應中包含的其他信息專案。 |
Compute |
計算節點上 RDP 或 SSH 存取的用戶帳戶。 |
Error |
Azure Batch 錯誤回應中收到的錯誤訊息。 |
BatchError
從 Azure Batch 服務收到的錯誤回應。
名稱 | 類型 | Description |
---|---|---|
code |
string |
錯誤的識別碼。 程式碼不變,且要以程式設計方式使用。 |
message |
描述錯誤的訊息,適用於在使用者介面中顯示。 |
|
values |
索引鍵/值組的集合,其中包含錯誤的其他詳細數據。 |
BatchErrorDetail
Azure Batch 錯誤回應中包含的其他信息專案。
名稱 | 類型 | Description |
---|---|---|
key |
string |
指定 Value 屬性意義的識別碼。 |
value |
string |
錯誤回應中包含的其他資訊。 |
ComputeNodeUser
計算節點上 RDP 或 SSH 存取的用戶帳戶。
名稱 | 類型 | Description |
---|---|---|
expiryTime |
string |
帳戶到期的時間。 |
isAdmin |
boolean |
帳戶是否應該是計算節點上的系統管理員。 |
name |
string |
帳戶的用戶名稱。 |
password |
string |
帳戶的密碼。 |
sshPublicKey |
string |
可用於遠端登錄計算節點的 SSH 公鑰。 |
ErrorMessage
Azure Batch 錯誤回應中收到的錯誤訊息。
名稱 | 類型 | Description |
---|---|---|
lang |
string |
錯誤訊息的語言代碼 |
value |
string |
訊息的文字。 |