通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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 参数

名称 在 必需 类型 说明
batchUrl
 path True

string

所有 Azure Batch 服务请求的基本 URL。
nodeId
 path True

string

要在其中创建用户帐户的计算机的 ID。
poolId
 path True

string

包含计算节点的池的 ID。
api-version
 query True

string

客户端 API 版本。
timeout
 query

integer (int32)

服务器处理请求的最长时间（以秒为单位）。 默认值为 30 秒。 如果该值大于 30，则改用默认值。

请求头

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

名称 必需 类型 说明
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"

名称 必需 类型 说明
name True

string

帐户的用户名。
expiryTime

string (date-time)

帐户应过期的时间。
如果省略，则默认值为从当前时间起的 1 天。 对于 Linux 计算节点，expiryTime 的精度高达一天。
isAdmin

boolean

帐户是否应是计算节点上的管理员。
默认值为 false。
password

string

帐户的密码。
Windows 计算节点需要密码。 对于 Linux 计算节点，可以选择指定密码以及 sshPublicKey 属性。
sshPublicKey

string

可用于远程登录到计算节点的 SSH 公钥。
公钥应与 OpenSSH 编码兼容，并且应进行 base 64 编码。 只能为 Linux 计算节点指定此属性。 如果为 Windows 计算节点指定了此项，则 Batch 服务将拒绝请求;如果直接调用 REST API，则 HTTP 状态代码为 400（请求错误）。

响应

名称 类型 说明
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
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
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

定义

名称 说明
BatchError

从 Azure Batch 服务收到的错误响应。
BatchErrorDetail

Azure Batch 错误响应中包含的附加信息项。
ComputeNodeUser

用于在计算节点上进行 RDP 或 SSH 访问的用户帐户。
ErrorMessage

Azure Batch 错误响应中收到的错误消息。

BatchError

Object

从 Azure Batch 服务收到的错误响应。

名称 类型 说明
code

string

错误的标识符。 代码是固定的，旨在以编程方式使用。
message

ErrorMessage

描述错误的消息，旨在适合在用户界面中显示。
values

BatchErrorDetail[]

包含有关错误的更多详细信息的键值对的集合。

BatchErrorDetail

Object

Azure Batch 错误响应中包含的附加信息项。

名称 类型 说明
key

string

指定 Value 属性含义的标识符。
value

string

错误响应附带的其他信息。

ComputeNodeUser

Object

用于在计算节点上进行 RDP 或 SSH 访问的用户帐户。

名称 类型 说明
expiryTime

string (date-time)

帐户应过期的时间。
如果省略，则默认值为从当前时间起的 1 天。 对于 Linux 计算节点，expiryTime 的精度高达一天。
isAdmin

boolean

帐户是否应是计算节点上的管理员。
默认值为 false。
name

string

帐户的用户名。
password

string

帐户的密码。
Windows 计算节点需要密码。 对于 Linux 计算节点，可以选择指定密码以及 sshPublicKey 属性。
sshPublicKey

string

可用于远程登录到计算节点的 SSH 公钥。
公钥应与 OpenSSH 编码兼容，并且应进行 base 64 编码。 只能为 Linux 计算节点指定此属性。 如果为 Windows 计算节点指定了此项，则 Batch 服务将拒绝请求;如果直接调用 REST API，则 HTTP 状态代码为 400（请求错误）。

ErrorMessage

Object

Azure Batch 错误响应中收到的错误消息。

名称 类型 说明
lang

string

错误消息的语言代码
value

string

消息的文本。