你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Pool - Update Properties
汇报指定池的属性。
这将完全替换池的所有可更新属性。 例如,如果池具有与之关联的 StartTask,并且未使用此请求指定 StartTask,则 Batch 服务将删除现有的 StartTask。
POST {batchUrl}/pools/{poolId}/updateproperties?api-version=2023-11-01.18.0
POST {batchUrl}/pools/{poolId}/updateproperties?timeout={timeout}&api-version=2023-11-01.18.0
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
batch
|
path | True |
string |
所有Azure Batch服务请求的基 URL。 |
pool
|
path | True |
string |
要更新的池的 ID。 |
api-version
|
query | True |
string |
客户端 API 版本。 |
timeout
|
query |
integer int32 |
服务器可以花费处理请求的最长时间(以秒为单位)。 默认为 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"
名称 | 必需 | 类型 | 说明 |
---|---|---|---|
applicationPackageReferences | True |
要安装在池中每个计算节点上的应用程序包的列表。 |
|
certificateReferences | True |
要安装在池中每个计算节点上的证书列表。 警告:此属性已弃用,将在 2024 年 2 月之后删除。 请改用 Azure KeyVault 扩展 。 |
|
metadata | True |
与作为元数据的池关联的名称/值对列表。 |
|
startTask |
加入池时要在每个计算节点上运行的任务。 将计算节点添加到池或重启计算节点时,任务将运行。 |
||
targetNodeCommunicationMode |
池的所需节点通信模式。 |
响应
名称 | 类型 | 说明 |
---|---|---|
204 No Content |
对 Batch 服务的请求已成功。 标头
|
|
Other Status Codes |
Batch 服务中的错误。 |
安全性
azure_auth
Microsoft Entra OAuth 2.0 身份验证代码流
类型:
oauth2
流向:
implicit
授权 URL:
https://login.microsoftonline.com/common/oauth2/authorize
作用域
名称 | 说明 |
---|---|
user_impersonation | 模拟用户帐户 |
Authorization
类型:
apiKey
在:
header
示例
Pool update
示例请求
POST account.region.batch.azure.com/pools/poolId/updateproperties?api-version=2023-11-01.18.0
{
"startTask": {
"commandLine": "/bin/bash -c 'echo start task'"
},
"certificateReferences": [],
"applicationPackageReferences": [],
"metadata": []
}
示例响应
定义
名称 | 说明 |
---|---|
Application |
对要部署到计算节点的包的引用。 |
Auto |
自动用户的作用域 |
Auto |
为在 Batch 服务上运行 Task 的自动用户指定参数。 |
Batch |
从Azure Batch服务收到的错误响应。 |
Batch |
Azure Batch错误响应中包含的其他信息项。 |
Certificate |
对要安装在池中的计算节点上的证书的引用。 |
Certificate |
要在其中安装证书的计算节点上的证书存储位置。 |
Certificate |
计算节点上的哪些用户帐户应有权访问证书的专用数据。 |
Compute |
对与计算节点将使用的 Batch 池关联的用户分配标识的引用。 |
Container |
专用容器注册表。 |
Container |
容器任务工作目录的位置。 |
Elevation |
用户的提升级别。 |
Environment |
要对任务进程设置的环境变量。 |
Error |
Azure Batch错误响应中收到的错误消息。 |
Metadata |
与 Batch 服务资源关联的名称/值对。 |
Node |
确定池如何与 Batch 服务通信。 |
Pool |
要对池进行的更改集。 |
Resource |
要下载到计算节点的单个文件或多个文件。 |
Start |
当节点加入Azure Batch服务中的池时,或者在重新启动或重置计算节点映像时运行的任务。 |
Task |
任务的容器设置。 |
User |
运行 Task 时所依据的用户标识的定义。 |
ApplicationPackageReference
对要部署到计算节点的包的引用。
名称 | 类型 | 说明 |
---|---|---|
applicationId |
string |
要部署的应用程序的 ID。 |
version |
string |
要部署的应用程序的版本。 如果省略,则部署默认版本。 |
AutoUserScope
自动用户的作用域
名称 | 类型 | 说明 |
---|---|---|
pool |
string |
指定任务作为在池中的每个计算节点上创建的公共自动用户帐户运行。 |
task |
string |
指定服务应为 Task 创建新用户。 |
AutoUserSpecification
为在 Batch 服务上运行 Task 的自动用户指定参数。
名称 | 类型 | 说明 |
---|---|---|
elevationLevel |
自动用户的提升级别。 |
|
scope |
自动用户的作用域 |
BatchError
从Azure Batch服务收到的错误响应。
名称 | 类型 | 说明 |
---|---|---|
code |
string |
错误的标识符。 代码是固定的,旨在以编程方式使用。 |
message |
描述错误的消息,该消息适用于在用户界面中显示。 |
|
values |
包含有关错误的其他详细信息的键值对的集合。 |
BatchErrorDetail
Azure Batch错误响应中包含的其他信息项。
名称 | 类型 | 说明 |
---|---|---|
key |
string |
指定 Value 属性的含义的标识符。 |
value |
string |
错误响应附带的其他信息。 |
CertificateReference
对要安装在池中的计算节点上的证书的引用。
名称 | 类型 | 说明 |
---|---|---|
storeLocation |
要在其中安装证书的计算节点上的证书存储位置。 |
|
storeName |
string |
要在其中安装证书的计算节点上的证书存储的名称。 |
thumbprint |
string |
证书的指纹。 |
thumbprintAlgorithm |
string |
与指纹关联的算法。 这必须是 sha1。 |
visibility |
计算节点上的哪些用户帐户应有权访问证书的专用数据。 |
CertificateStoreLocation
要在其中安装证书的计算节点上的证书存储位置。
名称 | 类型 | 说明 |
---|---|---|
currentuser |
string |
应将证书安装到 CurrentUser 证书存储区。 |
localmachine |
string |
应将证书安装到 LocalMachine 证书存储区。 |
CertificateVisibility
计算节点上的哪些用户帐户应有权访问证书的专用数据。
名称 | 类型 | 说明 |
---|---|---|
remoteuser |
string |
证书应该对用户远程访问计算节点的用户帐户可见。 |
starttask |
string |
证书应该对运行 StartTask 的用户帐户可见。 请注意,如果 AutoUser 作用域是 StartTask 和 Task 的池,则此证书也将对任务可见。 |
task |
string |
证书应该对运行作业任务的用户帐户可见。 |
ComputeNodeIdentityReference
对与计算节点将使用的 Batch 池关联的用户分配标识的引用。
名称 | 类型 | 说明 |
---|---|---|
resourceId |
string |
用户分配的标识的 ARM 资源 ID。 |
ContainerRegistry
专用容器注册表。
名称 | 类型 | 说明 |
---|---|---|
identityReference |
对用户分配的标识的引用,该标识用于访问Azure 容器注册表,而不是用户名和密码。 |
|
password |
string |
用于登录到注册表服务器的密码。 |
registryServer |
string |
注册表 URL。 |
username |
string |
要登录到注册表服务器的用户名。 |
ContainerWorkingDirectory
容器任务工作目录的位置。
名称 | 类型 | 说明 |
---|---|---|
containerImageDefault |
string |
使用容器映像中定义的工作目录。 请注意,此目录不包含 Batch 下载的资源文件。 |
taskWorkingDirectory |
string |
使用标准 Batch 服务任务工作目录,其中包含由 Batch 填充的任务资源文件。 |
ElevationLevel
用户的提升级别。
名称 | 类型 | 说明 |
---|---|---|
admin |
string |
用户是具有提升访问权限的用户,使用完全管理员权限进行操作。 |
nonadmin |
string |
用户是没有提升访问权限的标准用户。 |
EnvironmentSetting
要对任务进程设置的环境变量。
名称 | 类型 | 说明 |
---|---|---|
name |
string |
环境变量的名称。 |
value |
string |
环境变量的值。 |
ErrorMessage
Azure Batch错误响应中收到的错误消息。
名称 | 类型 | 说明 |
---|---|---|
lang |
string |
错误消息的语言代码 |
value |
string |
消息的文本。 |
MetadataItem
与 Batch 服务资源关联的名称/值对。
名称 | 类型 | 说明 |
---|---|---|
name |
string |
元数据项的名称。 |
value |
string |
元数据项的值。 |
NodeCommunicationMode
确定池如何与 Batch 服务通信。
名称 | 类型 | 说明 |
---|---|---|
classic |
string |
使用经典通信模式的节点需要来自“BatchNodeManagement”的端口 29876 和 29877 上的入站 TCP 通信。{region}“服务标记和端口 443 上与”Storage.region“和”BatchNodeManagement“的出站 TCP 通信。{region}“ 服务标记。 |
default |
string |
节点通信模式由 Batch 服务自动设置。 |
simplified |
string |
使用简化通信模式的节点需要在端口 443 上与“BatchNodeManagement”进行出站 TCP 通信。{region}“ 服务标记。 不需要打开的入站端口。 |
PoolUpdatePropertiesParameter
要对池进行的更改集。
名称 | 类型 | 说明 |
---|---|---|
applicationPackageReferences |
要安装在池中每个计算节点上的应用程序包列表。 |
|
certificateReferences |
要安装在池中每个计算节点上的证书列表。 警告:此属性已弃用,将在 2024 年 2 月之后删除。 请改用 Azure KeyVault 扩展 。 |
|
metadata |
与作为元数据的池关联的名称/值对的列表。 |
|
startTask |
加入池时在每个计算节点上运行的任务。 将计算节点添加到池或重启计算节点时,任务将运行。 |
|
targetNodeCommunicationMode |
池的所需节点通信模式。 |
ResourceFile
要下载到计算节点的单个文件或多个文件。
名称 | 类型 | 说明 |
---|---|---|
autoStorageContainerName |
string |
自动存储帐户中的存储容器名称。 |
blobPrefix |
string |
从 Azure 存储容器下载 Blob 时要使用的 Blob 前缀。 仅下载名称以指定前缀开头的 blob。 |
fileMode |
string |
八进制格式的文件权限模式属性。 |
filePath |
string |
计算节点上下载文件的位置, () 相对于任务的工作目录。 |
httpUrl |
string |
要下载的文件的 URL。 |
identityReference |
对用户分配的标识的引用,用于访问 storageContainerUrl 或 httpUrl 指定的Azure Blob 存储 |
|
storageContainerUrl |
string |
Azure Blob 存储中 Blob 容器的 URL。 |
StartTask
当节点加入Azure Batch服务中的池时,或者在重新启动或重置计算节点映像时运行的任务。
名称 | 类型 | 说明 |
---|---|---|
commandLine |
string |
StartTask 的命令行。 |
containerSettings |
运行 StartTask 的容器的设置。 |
|
environmentSettings |
StartTask 的环境变量设置列表。 |
|
maxTaskRetryCount |
integer |
可以重试任务的最大次数。 |
resourceFiles |
运行命令行之前 Batch 服务将下载到计算节点的文件列表。 资源文件列表有最大大小。 超过最大大小时,请求将失败,响应错误代码为 RequestEntityTooLarge。 如果发生这种情况,必须减小 ResourceFiles 集合的大小。 这可以通过 .zip 文件、应用程序包或 Docker 容器来实现。 |
|
userIdentity |
运行 StartTask 时所依据的用户标识。 |
|
waitForSuccess |
boolean |
Batch 服务是否应等待 StartTask 成功完成 (即退出代码 0) 退出,然后再计划计算节点上的任何任务。 |
TaskContainerSettings
任务的容器设置。
名称 | 类型 | 说明 |
---|---|---|
containerRunOptions |
string |
容器创建命令的其他选项。 |
imageName |
string |
用于创建运行 Task 的容器的映像。 |
registry |
包含容器映像的专用注册表。 |
|
workingDirectory |
容器任务工作目录的位置。 |
UserIdentity
运行 Task 时所依据的用户标识的定义。
名称 | 类型 | 说明 |
---|---|---|
autoUser |
运行 Task 的自动用户。 |
|
username |
string |
运行 Task 时所依据的用户标识的名称。 |