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

Pool - Update Properties

参考

服务:: Batch Service

API 版本:: 2023-11-01.18.0

汇报指定池的属性。
这将完全替换池的所有可更新属性。例如，如果池具有与之关联的 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 参数

名称	在	必需	类型	说明
batchUrl	path	True	string	所有Azure Batch服务请求的基 URL。
poolId	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	ApplicationPackageReference[]	要安装在池中每个计算节点上的应用程序包的列表。该列表替换池上的任何现有应用程序包引用。对应用程序包引用的更改会影响加入池的所有新计算节点，但在重新启动或重置映像之前，不会影响池中已有的计算节点。任何给定池上最多有 10 个应用程序包引用。如果省略或指定空集合，则会从池中删除所有现有的应用程序包引用。在给定的池上最多可以指定 10 个引用。
certificateReferences	True	CertificateReference[]	要安装在池中每个计算节点上的证书列表。此列表替换池上配置的任何现有证书引用。如果指定空集合，则会从池中删除所有现有的证书引用。对于 Windows 节点，Batch 服务会将证书安装到指定的证书存储和位置。对于 Linux 计算节点，证书存储在 Task 工作目录内的目录中，并向 Task 提供环境变量AZ_BATCH_CERTIFICATES_DIR以查询此位置。对于具有“remoteUser”可见性的证书，在用户的主目录中创建一个“certs”目录， (例如/home/{user-name}/certs) ，证书放置在该目录中。警告：此属性已弃用，将在 2024 年 2 月之后删除。请改用 Azure KeyVault 扩展。
metadata	True	MetadataItem[]	与作为元数据的池关联的名称/值对列表。此列表替换池上配置的任何现有元数据。如果省略，或者指定空集合，将从池中删除任何现有元数据。
startTask		StartTask	加入池时要在每个计算节点上运行的任务。将计算节点添加到池或重启计算节点时，任务将运行。如果存在此元素，它将覆盖任何现有的 StartTask。如果省略，则会从池中删除任何现有的 StartTask。
targetNodeCommunicationMode		NodeCommunicationMode	池的所需节点通信模式。此设置替换池上任何现有的 targetNodeCommunication 设置。如果省略，则默认为现有设置。

响应

名称	类型	说明
204 No Content		对 Batch 服务的请求已成功。标头 client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: string
Other Status Codes	BatchError	Batch 服务中的错误。

名称

类型

说明

204 No Content

对 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

示例

Pool update

示例请求

HTTP

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": []
}

示例响应

状态代码:: 204

定义

名称	说明
ApplicationPackageReference	对要部署到计算节点的包的引用。
AutoUserScope	自动用户的作用域
AutoUserSpecification	为在 Batch 服务上运行 Task 的自动用户指定参数。
BatchError	从Azure Batch服务收到的错误响应。
BatchErrorDetail	Azure Batch错误响应中包含的其他信息项。
CertificateReference	对要安装在池中的计算节点上的证书的引用。
CertificateStoreLocation	要在其中安装证书的计算节点上的证书存储位置。
CertificateVisibility	计算节点上的哪些用户帐户应有权访问证书的专用数据。
ComputeNodeIdentityReference	对与计算节点将使用的 Batch 池关联的用户分配标识的引用。
ContainerRegistry	专用容器注册表。
ContainerWorkingDirectory	容器任务工作目录的位置。
ElevationLevel	用户的提升级别。
EnvironmentSetting	要对任务进程设置的环境变量。
ErrorMessage	Azure Batch错误响应中收到的错误消息。
MetadataItem	与 Batch 服务资源关联的名称/值对。
NodeCommunicationMode	确定池如何与 Batch 服务通信。
PoolUpdatePropertiesParameter	要对池进行的更改集。
ResourceFile	要下载到计算节点的单个文件或多个文件。
StartTask	当节点加入Azure Batch服务中的池时，或者在重新启动或重置计算节点映像时运行的任务。
TaskContainerSettings	任务的容器设置。
UserIdentity	运行 Task 时所依据的用户标识的定义。

ApplicationPackageReference

对要部署到计算节点的包的引用。

名称	类型	说明
applicationId	string	要部署的应用程序的 ID。创建池时，包的应用程序 ID 必须完全限定 (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}) 。
version	string	要部署的应用程序的版本。如果省略，则部署默认版本。如果在池中省略了此值，并且未为此应用程序指定默认版本，则请求将失败并显示错误代码 InvalidApplicationPackageReferences 和 HTTP 状态代码 409。如果在 Task 上省略此项，并且没有为此应用程序指定默认版本，则任务将失败并出现预处理错误。

AutoUserScope

自动用户的作用域

名称	类型	说明
pool	string	指定任务作为在池中的每个计算节点上创建的公共自动用户帐户运行。
task	string	指定服务应为 Task 创建新用户。

AutoUserSpecification

为在 Batch 服务上运行 Task 的自动用户指定参数。

名称	类型	说明
elevationLevel	ElevationLevel	自动用户的提升级别。默认值为 nonAdmin。
scope	AutoUserScope	自动用户的作用域默认值为 pool。如果池运行的是 Windows，则当任务之间需要更严格的隔离时，应指定 Task 值。例如，如果任务以可能影响其他任务的方式改变注册表，或者已在池上指定了证书，而普通任务不应访问，但应由 StartTasks 访问。

BatchError

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

名称	类型	说明
code	string	错误的标识符。代码是固定的，旨在以编程方式使用。
message	ErrorMessage	描述错误的消息，该消息适用于在用户界面中显示。
values	BatchErrorDetail[]	包含有关错误的其他详细信息的键值对的集合。

BatchErrorDetail

Azure Batch错误响应中包含的其他信息项。

名称	类型	说明
key	string	指定 Value 属性的含义的标识符。
value	string	错误响应附带的其他信息。

CertificateReference

对要安装在池中的计算节点上的证书的引用。

名称	类型	说明
storeLocation	CertificateStoreLocation	要在其中安装证书的计算节点上的证书存储位置。默认值为 currentuser。此属性仅适用于使用 Windows 计算节点配置的池， (即使用 cloudServiceConfiguration 创建的池，或使用 windows 映像引用) 通过 virtualMachineConfiguration 创建的池。对于 Linux 计算节点，证书存储在 Task 工作目录内的目录中，并向 Task 提供一个环境变量AZ_BATCH_CERTIFICATES_DIR来查询此位置。对于“remoteUser”可见性的证书，在用户的主目录中创建一个“certs”目录， (例如 /home/{user-name}/certs) ，证书位于该目录中。
storeName	string	要在其中安装证书的计算节点上的证书存储的名称。此属性仅适用于使用 Windows 计算节点配置的池， (即使用 cloudServiceConfiguration 创建的池，或使用 windows 映像引用) 通过 virtualMachineConfiguration 创建的池。常见的存储名称包括：My、Root、CA、Trust、Disallowed、TrustedPeople、TrustedPublisher、AuthRoot、AddressBook，但也可以使用任何自定义存储名称。默认值为 My。
thumbprint	string	证书的指纹。
thumbprintAlgorithm	string	与指纹关联的算法。这必须是 sha1。
visibility	CertificateVisibility[]	计算节点上的哪些用户帐户应有权访问证书的专用数据。可以在此集合中指定多个可见性。默认值为“所有帐户”。

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	ComputeNodeIdentityReference	对用户分配的标识的引用，该标识用于访问Azure 容器注册表，而不是用户名和密码。对与计算节点将使用的 Batch 池关联的用户分配标识的引用。
password	string	用于登录到注册表服务器的密码。
registryServer	string	注册表 URL。如果省略，则默认值为“docker.io”。
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}“ 服务标记。不需要打开的入站端口。