你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Pool - List
列出装载的所有池
GET {batchUrl}/pools?api-version=2024-07-01.20.0
GET {batchUrl}/pools?$filter={$filter}&$select={$select}&$expand={$expand}&maxresults={maxresults}&timeout={timeout}&api-version=2024-07-01.20.0
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
batch
|
path | True |
string |
所有 Azure Batch 服务请求的基本 URL。 |
api-version
|
query | True |
string |
客户端 API 版本。 |
$expand
|
query |
string |
OData $expand 子句。 |
|
$filter
|
query |
string |
OData $filter 子句。 有关构造此筛选器的详细信息,请参阅 https://docs.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-pools。 |
|
$select
|
query |
string |
OData $select 子句。 |
|
maxresults
|
query |
integer int32 |
响应中要返回的最大项数。 最多可以返回 1000 个池。 |
|
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,请显式设置它。 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
包含池列表的响应。 标头
|
|
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 list
示例请求
GET account.region.batch.azure.com/pools?api-version=2024-07-01.20.0
示例响应
{
"value": [
{
"id": "testPool",
"url": "https://accountname.region.batch.azure.com/pools/testPool",
"eTag": "0x8D4123BEF87D233",
"lastModified": "2016-11-21T18:26:39.7108787Z",
"creationTime": "2016-11-21T18:26:39.7108787Z",
"state": "active",
"stateTransitionTime": "2016-11-21T18:26:39.7108787Z",
"allocationState": "steady",
"allocationStateTransitionTime": "2016-11-21T18:27:40.287803Z",
"vmSize": "small",
"resizeTimeout": "PT15M",
"currentDedicatedNodes": 3,
"currentLowPriorityNodes": 0,
"targetDedicatedNodes": 3,
"targetLowPriorityNodes": 0,
"enableAutoScale": false,
"enableInterNodeCommunication": false,
"startTask": {
"commandLine": "cmd /c echo hello",
"userIdentity": {
"autoUser": {
"scope": "task",
"elevationLevel": "nonadmin"
}
},
"maxTaskRetryCount": 0,
"waitForSuccess": false
},
"taskSlotsPerNode": 1,
"taskSchedulingPolicy": {
"nodeFillType": "spread"
},
"virtualMachineConfiguration": {
"imageReference": {
"publisher": "MicrosoftWindowsServer",
"offer": "WindowsServer",
"sku": "2016-datacenter-smalldisk",
"version": "latest"
},
"nodeAgentSKUId": "batch.node.windows amd64"
}
}
]
}
定义
名称 | 说明 |
---|---|
Allocation |
池是否调整大小。 |
Application |
对要部署到计算节点的包的引用。 |
Automatic |
用于执行自动 OS 升级的配置参数。 |
Auto |
池自动缩放公式执行的结果和错误。 |
Auto |
执行或评估池自动缩放公式时发生的错误。 |
Auto |
自动用户的范围 |
Auto |
指定在 Batch 服务上运行 Task 的自动用户的参数。 |
Azure |
用于使用 Blobfuse 连接到 Azure 存储容器的信息。 |
Azure |
用于连接到 Azure 文件共享的信息。 |
Batch |
从 Azure Batch 服务收到的错误响应。 |
Batch |
Azure Batch 错误响应中包含的附加信息项。 |
Batch |
Batch 池的标识(如果已配置)。 |
Caching |
要为磁盘启用的缓存类型。 |
Certificate |
对要安装在池中的计算节点上的证书的引用。 |
Certificate |
要在其中安装证书的计算节点上证书存储的位置。 |
Certificate |
计算节点上的哪些用户帐户应有权访问证书的专用数据。 |
CIFSMount |
用于连接到 CIFS 文件系统的信息。 |
Cloud |
Azure Batch 服务中的池。 |
Cloud |
列出帐户中的池的结果。 |
Compute |
任务如何在池中的计算节点之间分布。 |
Compute |
对与计算节点将使用的 Batch 池关联的用户分配标识的引用。 |
Container |
已启用容器的池的配置。 |
Container |
要装载到任务容器的路径和装载模式的条目。 |
Container |
将装载到容器任务的容器的路径。 |
Container |
专用容器注册表。 |
Container |
要使用的容器技术。 |
Container |
容器任务工作目录的位置。 |
Data |
与池中的计算节点关联的数据磁盘将使用的设置。 使用附加的数据磁盘时,需要从 VM 中装载磁盘并设置磁盘格式才能使用这些磁盘。 |
Diff |
指定池中所有计算节点(VM)操作系统磁盘的临时磁盘放置。 |
Diff |
指定计算节点(VM)使用的操作系统磁盘的临时磁盘设置。 |
Disk |
在池中的计算节点上应用的磁盘加密配置。 使用 Azure 计算库映像创建的 Linux 池不支持磁盘加密配置。 |
Disk |
磁盘目标 Batch 服务将在计算节点上加密。 |
Dynamic |
动态 vnet 分配的范围。 |
Elevation |
用户的提升级别。 |
Environment |
要对任务进程设置的环境变量。 |
Error |
Azure Batch 错误响应中收到的错误消息。 |
Image |
对 Azure 虚拟机市场映像或 Azure 计算库映像的引用。 若要获取 Azure Batch 验证的所有 Azure 市场映像引用的列表,请参阅“列出支持的映像”操作。 |
Inbound |
终结点的协议。 |
Inbound |
入站 NAT 池,可用于在外部处理 Batch 池中计算节点上的特定端口。 |
IPAddress |
池的公共 IP 地址的预配类型。 |
Linux |
用于在 Linux 计算节点上创建用户帐户的属性。 |
Login |
用户的登录模式 |
Managed |
|
Metadata |
与 Batch 服务资源关联的名称/值对。 |
Mount |
要在每个节点上装载的文件系统。 |
Name |
表示名称/值对。 |
Network |
池的网络配置。 |
Network |
要应用于入站终结点的网络安全组规则。 |
Network |
应对指定 IP 地址、子网范围或标记执行的操作。 |
NFSMount |
用于连接到 NFS 文件系统的信息。 |
Node |
确定池如何与 Batch 服务通信。 |
Node |
池的节点放置配置。 |
Node |
用于分配池中的节点的放置策略。 |
OSDisk |
计算节点(VM)操作系统磁盘的设置。 |
Pool |
池的终结点配置。 |
Pool |
Batch 池的标识(如果已配置)。 |
Pool |
池的当前状态。 |
Pool |
包含池生存期的利用率和资源使用情况统计信息。 |
Public |
池的网络配置的公共 IP 地址配置。 |
Resize |
调整池大小时发生的错误。 |
Resource |
要下载到计算节点的单个文件或多个文件。 |
Resource |
与池中的计算节点的资源消耗相关的统计信息。 |
Rolling |
执行滚动升级时使用的配置参数。 |
Security |
指定托管磁盘的 EncryptionType。 它设置为 VMGuestStateOnly 以仅加密 VMGuestState blob,而 NonPersistedTPM 用于不保留 VMGuestState blob 中的固件状态。 注意:只能为机密 VM 设置它,在使用机密 VM 时是必需的。 |
Security |
指定虚拟机或虚拟机规模集的安全配置文件设置。 |
Security |
指定虚拟机的 SecurityType。 必须将其设置为任何指定值才能启用 UefiSettings。 |
Service |
指定使用“latest”映像版本时,用于为规模集中的所有虚拟机设置相同映像版本的服务项目引用 ID。 |
Start |
当节点加入 Azure Batch 服务中的池或重新启动或重新映像计算节点时运行的任务。 |
Storage |
用于创建数据磁盘或 OS 磁盘的存储帐户类型。 |
Task |
任务的容器设置。 |
Task |
指定应如何跨计算节点分配任务。 |
Uefi |
指定在创建虚拟机时使用的安全启动和 vTPM 等安全设置。 |
Upgrade |
指定升级到规模集中虚拟机的模式。 |
Upgrade |
描述升级策略 - 自动、手动或滚动。 |
Usage |
与池使用情况信息相关的统计信息。 |
User |
用于创建用于在 Azure Batch 计算节点上执行任务的用户的属性。 |
User |
用户分配的标识 |
User |
运行任务的用户标识的定义。 |
Virtual |
基于 Azure 虚拟机基础结构的池中计算节点的配置。 |
VMDisk |
指定托管磁盘的安全配置文件设置。 注意:只能为机密 VM 设置它,在使用机密 VM 时是必需的。 |
VMExtension |
虚拟机扩展的配置。 |
Windows |
要应用于虚拟机的 Windows 操作系统设置。 |
Windows |
用于在 Windows 计算节点上创建用户帐户的属性。 |
AllocationState
池是否调整大小。
名称 | 类型 | 说明 |
---|---|---|
resizing |
string |
池正在调整大小;也就是说,正在向池中添加或删除计算节点。 |
steady |
string |
池未调整大小。 池中的计算节点数没有变化。 池在创建池时以及池上未执行任何操作以更改计算节点数时进入此状态。 |
stopping |
string |
池调整大小,但用户已请求停止调整大小,但停止请求尚未完成。 |
ApplicationPackageReference
对要部署到计算节点的包的引用。
名称 | 类型 | 说明 |
---|---|---|
applicationId |
string |
要部署的应用程序的 ID。 |
version |
string |
要部署的应用程序的版本。 如果省略,则部署默认版本。 |
AutomaticOSUpgradePolicy
用于执行自动 OS 升级的配置参数。
名称 | 类型 | 说明 |
---|---|---|
disableAutomaticRollback |
boolean |
是否应禁用 OS 映像回滚功能。 |
enableAutomaticOSUpgrade |
boolean |
指示当较新版本的 OS 映像可用时,是否应以滚动方式自动将 OS 升级应用于规模集实例。 |
osRollingUpgradeDeferral |
boolean |
如果 OS 升级正在运行任务,请延迟 TVM 上的 OS 升级。 |
useRollingUpgradePolicy |
boolean |
指示是否应在自动 OS 升级期间使用滚动升级策略。 如果未在 VMSS 上定义任何策略,则自动 OS 升级将回退到默认策略。 |
AutoScaleRun
池自动缩放公式执行的结果和错误。
名称 | 类型 | 说明 |
---|---|---|
error |
如果评估失败,在池中评估自动缩放公式时遇到错误的详细信息。 |
|
results |
string |
自动缩放公式计算中使用的所有变量的最终值。 |
timestamp |
string |
上次计算自动缩放公式的时间。 |
AutoScaleRunError
执行或评估池自动缩放公式时发生的错误。
名称 | 类型 | 说明 |
---|---|---|
code |
string |
自动缩放错误的标识符。 代码是固定的,旨在以编程方式使用。 |
message |
string |
描述自动缩放错误的消息,旨在适合在用户界面中显示。 |
values |
与自动缩放错误相关的其他错误详细信息的列表。 |
AutoUserScope
自动用户的范围
名称 | 类型 | 说明 |
---|---|---|
pool |
string |
指定任务作为在池中的每个计算节点上创建的通用自动用户帐户运行。 |
task |
string |
指定服务应为任务创建新用户。 |
AutoUserSpecification
指定在 Batch 服务上运行 Task 的自动用户的参数。
名称 | 类型 | 说明 |
---|---|---|
elevationLevel |
自动用户的提升级别。 |
|
scope |
自动用户的范围 |
AzureBlobFileSystemConfiguration
用于使用 Blobfuse 连接到 Azure 存储容器的信息。
名称 | 类型 | 说明 |
---|---|---|
accountKey |
string |
Azure 存储帐户密钥。 |
accountName |
string |
Azure 存储帐户名称。 |
blobfuseOptions |
string |
要传递给装载命令的其他命令行选项。 |
containerName |
string |
Azure Blob 存储容器名称。 |
identityReference |
对用于访问 containerName 的用户分配标识的引用 |
|
relativeMountPath |
string |
将装载文件系统的计算节点上的相对路径 |
sasKey |
string |
Azure 存储 SAS 令牌。 |
AzureFileShareConfiguration
用于连接到 Azure 文件共享的信息。
名称 | 类型 | 说明 |
---|---|---|
accountKey |
string |
Azure 存储帐户密钥。 |
accountName |
string |
Azure 存储帐户名称。 |
azureFileUrl |
string |
Azure 文件 URL。 |
mountOptions |
string |
要传递给装载命令的其他命令行选项。 |
relativeMountPath |
string |
将装载文件系统的计算节点上的相对路径 |
BatchError
从 Azure Batch 服务收到的错误响应。
名称 | 类型 | 说明 |
---|---|---|
code |
string |
错误的标识符。 代码是固定的,旨在以编程方式使用。 |
message |
描述错误的消息,旨在适合在用户界面中显示。 |
|
values |
包含有关错误的更多详细信息的键值对的集合。 |
BatchErrorDetail
Azure Batch 错误响应中包含的附加信息项。
名称 | 类型 | 说明 |
---|---|---|
key |
string |
指定 Value 属性含义的标识符。 |
value |
string |
错误响应附带的其他信息。 |
BatchPoolIdentity
Batch 池的标识(如果已配置)。
名称 | 类型 | 说明 |
---|---|---|
type |
Batch 池的标识(如果已配置)。 |
|
userAssignedIdentities |
与 Batch 帐户关联的用户标识列表。 |
CachingType
要为磁盘启用的缓存类型。
名称 | 类型 | 说明 |
---|---|---|
none |
string |
未启用磁盘的缓存模式。 |
readonly |
string |
磁盘的缓存模式是只读的。 |
readwrite |
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 |
证书应该对运行作业任务的用户帐户可见。 |
CIFSMountConfiguration
用于连接到 CIFS 文件系统的信息。
名称 | 类型 | 说明 |
---|---|---|
mountOptions |
string |
要传递给装载命令的其他命令行选项。 |
password |
string |
用于针对 CIFS 文件系统进行身份验证的密码。 |
relativeMountPath |
string |
将装载文件系统的计算节点上的相对路径 |
source |
string |
要装载的文件系统的 URI。 |
username |
string |
用于对 CIFS 文件系统进行身份验证的用户。 |
CloudPool
Azure Batch 服务中的池。
名称 | 类型 | 说明 |
---|---|---|
allocationState |
池是否调整大小。 |
|
allocationStateTransitionTime |
string |
池进入其当前分配状态的时间。 |
applicationPackageReferences |
要安装在池中每个计算节点上的包列表。 |
|
autoScaleEvaluationInterval |
string |
根据自动缩放公式自动调整池大小的时间间隔。 |
autoScaleFormula |
string |
池中所需计算节点数的公式。 |
autoScaleRun |
自动缩放公式上次执行的结果和错误。 |
|
certificateReferences |
要安装在池中每个计算节点上的证书列表。 警告:此属性已弃用,将在 2024 年 2 月之后删除。 请改用 Azure KeyVault 扩展。 |
|
creationTime |
string |
池的创建时间。 |
currentDedicatedNodes |
integer |
池中当前专用计算节点数。 |
currentLowPriorityNodes |
integer |
池中当前存在的现成/低优先级计算节点数。 |
currentNodeCommunicationMode |
池通信模式的当前状态。 |
|
displayName |
string |
池的显示名称。 |
eTag |
string |
池的 ETag。 |
enableAutoScale |
boolean |
池大小是否应随时间自动调整。 |
enableInterNodeCommunication |
boolean |
池是否允许在计算节点之间直接通信。 |
id |
string |
唯一标识帐户中的池的字符串。 |
identity |
Batch 池的标识(如果已配置)。 |
|
lastModified |
string |
池的上次修改时间。 |
metadata |
与池关联的名称/值对列表作为元数据。 |
|
mountConfiguration |
要安装在池中每个节点上的文件系统列表。 |
|
networkConfiguration |
池的网络配置。 |
|
resizeErrors |
在池上执行上一次重设大小时遇到的错误列表。 |
|
resizeTimeout |
string |
将计算节点分配给池的超时。 |
resourceTags |
object |
与池关联的用户指定的标记。 |
startTask |
指定在联接池时在每个计算节点上运行的任务。 |
|
state |
池的当前状态。 |
|
stateTransitionTime |
string |
池进入其当前状态的时间。 |
stats |
池整个生存期的利用率和资源使用情况统计信息。 |
|
targetDedicatedNodes |
integer |
池中所需的专用计算节点数。 |
targetLowPriorityNodes |
integer |
池中所需的现成/低优先级计算节点数。 |
targetNodeCommunicationMode |
池的所需节点通信模式。 |
|
taskSchedulingPolicy |
任务如何在池中的计算节点之间分布。 |
|
taskSlotsPerNode |
integer |
可用于在池中的单个计算节点上运行并发任务的任务槽数。 |
upgradePolicy |
池的升级策略。 |
|
url |
string |
池的 URL。 |
userAccounts |
将在池中的每个计算节点上创建的用户帐户列表。 |
|
virtualMachineConfiguration |
池的虚拟机配置。 |
|
vmSize |
string |
池中虚拟机的大小。 池中的所有虚拟机的大小都相同。 |
CloudPoolListResult
列出帐户中的池的结果。
名称 | 类型 | 说明 |
---|---|---|
odata.nextLink |
string |
用于获取下一组结果的 URL。 |
value |
池列表。 |
ComputeNodeFillType
任务如何在池中的计算节点之间分布。
名称 | 类型 | 说明 |
---|---|---|
pack |
string |
在将任何任务分配到池中的下一个计算节点之前,应向池中的每个计算节点分配尽可能多的任务(taskSlotsPerNode)。 |
spread |
string |
应跨池中的所有计算节点均匀分配任务。 |
ComputeNodeIdentityReference
对与计算节点将使用的 Batch 池关联的用户分配标识的引用。
名称 | 类型 | 说明 |
---|---|---|
resourceId |
string |
用户分配标识的 ARM 资源 ID。 |
ContainerConfiguration
已启用容器的池的配置。
名称 | 类型 | 说明 |
---|---|---|
containerImageNames |
string[] |
容器映像名称的集合。 |
containerRegistries |
可从中提取容器的其他专用注册表。 |
|
type |
要使用的容器技术。 |
ContainerHostBatchBindMountEntry
要装载到任务容器的路径和装载模式的条目。
名称 | 类型 | 说明 |
---|---|---|
isReadOnly |
boolean |
将此源路径装载为只读模式或不装载。 默认值为 false(读/写模式)。 |
source |
装载到容器客户的路径可以选择。 |
ContainerHostDataPath
将装载到容器任务的容器的路径。
名称 | 类型 | 说明 |
---|---|---|
Applications |
string |
应用程序路径。 |
JobPrep |
string |
作业准备任务路径。 |
Shared |
string |
用于共享其文件的多实例任务的路径。 |
Startup |
string |
启动任务的路径。 |
Task |
string |
任务路径。 |
VfsMounts |
string |
该路径包含此节点上装载的所有虚拟文件系统。 |
ContainerRegistry
专用容器注册表。
名称 | 类型 | 说明 |
---|---|---|
identityReference |
对用于访问 Azure 容器注册表(而不是用户名和密码)的用户分配标识的引用。 |
|
password |
string |
登录到注册表服务器的密码。 |
registryServer |
string |
注册表 URL。 |
username |
string |
要登录到注册表服务器的用户名。 |
ContainerType
要使用的容器技术。
名称 | 类型 | 说明 |
---|---|---|
criCompatible |
string |
基于 CRI 的技术将用于启动容器。 |
dockerCompatible |
string |
Docker 兼容的容器技术将用于启动容器。 |
ContainerWorkingDirectory
容器任务工作目录的位置。
名称 | 类型 | 说明 |
---|---|---|
containerImageDefault |
string |
使用容器映像中定义的工作目录。 请注意,此目录将不包含 Batch 下载的资源文件。 |
taskWorkingDirectory |
string |
使用标准 Batch 服务任务工作目录,其中包含由 Batch 填充的任务资源文件。 |
DataDisk
与池中的计算节点关联的数据磁盘将使用的设置。 使用附加的数据磁盘时,需要从 VM 中装载磁盘并设置磁盘格式才能使用这些磁盘。
名称 | 类型 | 说明 |
---|---|---|
caching |
要为数据磁盘启用的缓存类型。 |
|
diskSizeGB |
integer |
初始磁盘大小(以 GB 为单位)。 |
lun |
integer |
逻辑单元号。 |
storageAccountType |
要用于数据磁盘的存储帐户类型。 |
DiffDiskPlacement
指定池中所有计算节点(VM)操作系统磁盘的临时磁盘放置。
名称 | 类型 | 说明 |
---|---|---|
CacheDisk |
string |
临时 OS 磁盘存储在 VM 缓存中。 |
DiffDiskSettings
指定计算节点(VM)使用的操作系统磁盘的临时磁盘设置。
名称 | 类型 | 说明 |
---|---|---|
placement |
指定池中所有 VM 的操作系统磁盘的临时磁盘放置。 |
DiskEncryptionConfiguration
在池中的计算节点上应用的磁盘加密配置。 使用 Azure 计算库映像创建的 Linux 池不支持磁盘加密配置。
名称 | 类型 | 说明 |
---|---|---|
targets |
磁盘目标 Batch 服务将在计算节点上加密。 |
DiskEncryptionTarget
磁盘目标 Batch 服务将在计算节点上加密。
名称 | 类型 | 说明 |
---|---|---|
osdisk |
string |
计算节点上的 OS 磁盘已加密。 |
temporarydisk |
string |
计算节点上的临时磁盘已加密。 在 Linux 上,此加密适用于在启动时进行加密时的其他分区(例如装载的数据磁盘上的分区)。 |
DynamicVNetAssignmentScope
动态 vnet 分配的范围。
名称 | 类型 | 说明 |
---|---|---|
job |
string |
动态 VNet 分配按作业完成。 |
none |
string |
未启用动态 VNet 分配。 |
ElevationLevel
用户的提升级别。
名称 | 类型 | 说明 |
---|---|---|
admin |
string |
用户是具有提升访问权限并具有完全管理员权限的用户。 |
nonadmin |
string |
用户是没有提升访问权限的标准用户。 |
EnvironmentSetting
要对任务进程设置的环境变量。
名称 | 类型 | 说明 |
---|---|---|
name |
string |
环境变量的名称。 |
value |
string |
环境变量的值。 |
ErrorMessage
Azure Batch 错误响应中收到的错误消息。
名称 | 类型 | 说明 |
---|---|---|
lang |
string |
错误消息的语言代码 |
value |
string |
消息的文本。 |
ImageReference
对 Azure 虚拟机市场映像或 Azure 计算库映像的引用。 若要获取 Azure Batch 验证的所有 Azure 市场映像引用的列表,请参阅“列出支持的映像”操作。
名称 | 类型 | 说明 |
---|---|---|
communityGalleryImageId |
string |
社区库映像唯一标识符 |
exactVersion |
string |
用于创建节点的平台映像或市场映像的特定版本。 仅当创建池时为“version”指定的值为“latest”时,此只读字段与“version”不同。 |
offer |
string |
Azure 虚拟机市场映像的产品/服务类型。 |
publisher |
string |
Azure 虚拟机市场映像的发布者。 |
sharedGalleryImageId |
string |
共享库映像唯一标识符 |
sku |
string |
Azure 虚拟机市场映像的 SKU。 |
version |
string |
Azure 虚拟机市场映像的版本。 |
virtualMachineImageId |
string |
Azure 计算库映像的 ARM 资源标识符。 池中的计算节点将使用此映像 ID 创建。此格式为 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} 或 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/images/{imageDefinitionName},以始终默认为最新映像版本。 |
InboundEndpointProtocol
终结点的协议。
名称 | 类型 | 说明 |
---|---|---|
tcp |
string |
对终结点使用 TCP。 |
udp |
string |
对终结点使用 UDP。 |
InboundNATPool
入站 NAT 池,可用于在外部处理 Batch 池中计算节点上的特定端口。
名称 | 类型 | 说明 |
---|---|---|
backendPort |
integer |
计算节点上的端口号。 |
frontendPortRangeEnd |
integer |
外部端口范围中的最后一个端口号,用于在单个计算节点上提供对 backendPort 的入站访问。 |
frontendPortRangeStart |
integer |
外部端口范围中的第一个端口号,用于在单个计算节点上提供对 backendPort 的入站访问。 |
name |
string |
终结点的名称。 |
networkSecurityGroupRules |
将应用于终结点的网络安全组规则列表。 |
|
protocol |
终结点的协议。 |
IPAddressProvisioningType
池的公共 IP 地址的预配类型。
名称 | 类型 | 说明 |
---|---|---|
batchmanaged |
string |
公共 IP 将由 Batch 创建和管理。 可能有多个公共 IP,具体取决于池的大小。 |
nopublicipaddresses |
string |
不会创建任何公共 IP 地址。 |
usermanaged |
string |
公共 IP 由用户提供,用于预配计算节点。 |
LinuxUserConfiguration
用于在 Linux 计算节点上创建用户帐户的属性。
名称 | 类型 | 说明 |
---|---|---|
gid |
integer |
用户帐户的组 ID。 |
sshPrivateKey |
string |
用户帐户的 SSH 私钥。 |
uid |
integer |
用户帐户的用户 ID。 |
LoginMode
用户的登录模式
名称 | 类型 | 说明 |
---|---|---|
batch |
string |
LOGON32_LOGON_BATCH Win32 登录模式。 对于长时间运行的并行进程,建议使用批处理登录模式。 |
interactive |
string |
LOGON32_LOGON_INTERACTIVE Win32 登录模式。 UAC 在 Windows 池上启用。 如果将此选项与 Windows 池中提升的用户标识一起使用,则除非任务命令行执行的应用程序配置为始终需要管理权限或始终需要最大权限,否则不会提升用户会话。 |
ManagedDisk
名称 | 类型 | 说明 |
---|---|---|
securityProfile |
指定托管磁盘的安全配置文件设置。 |
|
storageAccountType |
托管磁盘的存储帐户类型。 |
MetadataItem
与 Batch 服务资源关联的名称/值对。
名称 | 类型 | 说明 |
---|---|---|
name |
string |
元数据项的名称。 |
value |
string |
元数据项的值。 |
MountConfiguration
要在每个节点上装载的文件系统。
名称 | 类型 | 说明 |
---|---|---|
azureBlobFileSystemConfiguration |
在每个节点上使用 blob FUSE 装载的 Azure 存储容器。 |
|
azureFileShareConfiguration |
要在每个节点上装载的 Azure 文件共享。 |
|
cifsMountConfiguration |
要在每个节点上装载的 CIFS/SMB 文件系统。 |
|
nfsMountConfiguration |
要在每个节点上装载的 NFS 文件系统。 |
NameValuePair
表示名称/值对。
名称 | 类型 | 说明 |
---|---|---|
name |
string |
名称值对中的名称。 |
value |
string |
名称值对中的值。 |
NetworkConfiguration
池的网络配置。
名称 | 类型 | 说明 |
---|---|---|
dynamicVNetAssignmentScope |
动态 vnet 分配的范围。 |
|
enableAcceleratedNetworking |
boolean |
此池是否应启用加速网络。 |
endpointConfiguration |
Batch 池中计算节点上终结点的配置。 |
|
publicIPAddressConfiguration |
Batch 池中计算节点的公共 IPAddress 配置。 |
|
subnetId |
string |
池的计算节点将加入的虚拟网络子网的 ARM 资源标识符。 此格式为 /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}。 |
NetworkSecurityGroupRule
要应用于入站终结点的网络安全组规则。
名称 | 类型 | 说明 |
---|---|---|
access |
应对指定 IP 地址、子网范围或标记执行的操作。 |
|
priority |
integer |
此规则的优先级。 |
sourceAddressPrefix |
string |
要匹配规则的源地址前缀或标记。 |
sourcePortRanges |
string[] |
要匹配规则的源端口范围。 |
NetworkSecurityGroupRuleAccess
应对指定 IP 地址、子网范围或标记执行的操作。
名称 | 类型 | 说明 |
---|---|---|
allow |
string |
允许访问。 |
deny |
string |
拒绝访问。 |
NFSMountConfiguration
用于连接到 NFS 文件系统的信息。
名称 | 类型 | 说明 |
---|---|---|
mountOptions |
string |
要传递给装载命令的其他命令行选项。 |
relativeMountPath |
string |
将装载文件系统的计算节点上的相对路径 |
source |
string |
要装载的文件系统的 URI。 |
NodeCommunicationMode
确定池如何与 Batch 服务通信。
名称 | 类型 | 说明 |
---|---|---|
classic |
string |
使用经典通信模式的节点需要在端口 29876 和 29877 上通过“BatchNodeManagement”进行入站 TCP 通信。{region}“ 服务标记和端口 443 上的出站 TCP 通信到”Storage.region“和”BatchNodeManagement”。{region}“ 服务标记。 |
default |
string |
节点通信模式由 Batch 服务自动设置。 |
simplified |
string |
使用简化通信模式的节点需要在端口 443 上与“BatchNodeManagement”进行出站 TCP 通信。{region}“ 服务标记。 不需要打开的入站端口。 |
NodePlacementConfiguration
池的节点放置配置。
名称 | 类型 | 说明 |
---|---|---|
policy |
Batch 池上的节点放置策略类型。 |
NodePlacementPolicyType
用于分配池中的节点的放置策略。
名称 | 类型 | 说明 |
---|---|---|
regional |
string |
池中的所有节点都将在同一区域中分配。 |
zonal |
string |
池中的节点将分布在不同的可用性区域,并尽最大努力进行平衡。 |
OSDisk
计算节点(VM)操作系统磁盘的设置。
名称 | 类型 | 说明 |
---|---|---|
caching |
指定缓存要求。 可能的值包括:None、ReadOnly、ReadWrite。 默认值为:标准存储无。 高级存储的 ReadOnly。 |
|
diskSizeGB |
integer |
创建新 OS 磁盘时的初始磁盘大小(以 GB 为单位)。 |
ephemeralOSDiskSettings |
指定计算节点(VM)使用的操作系统磁盘的临时磁盘设置。 |
|
managedDisk |
托管磁盘参数。 |
|
writeAcceleratorEnabled |
boolean |
指定是应在磁盘上启用或禁用 writeAccelerator。 |
PoolEndpointConfiguration
池的终结点配置。
名称 | 类型 | 说明 |
---|---|---|
inboundNATPools |
入站 NAT 池的列表,可用于在外部解决单个计算节点上的特定端口。 |
PoolIdentityType
Batch 池的标识(如果已配置)。
名称 | 类型 | 说明 |
---|---|---|
None |
string |
Batch 池没有与之关联的标识。 在更新池中设置 |
UserAssigned |
string |
Batch 池具有用户分配的标识。 |
PoolState
池的当前状态。
名称 | 类型 | 说明 |
---|---|---|
active |
string |
池可用于运行受计算节点可用性约束的任务。 |
deleting |
string |
用户已请求删除池,但删除操作尚未完成。 |
PoolStatistics
包含池生存期的利用率和资源使用情况统计信息。
名称 | 类型 | 说明 |
---|---|---|
lastUpdateTime |
string |
上次更新统计信息的时间。 所有统计信息仅限于 startTime 和 lastUpdateTime 之间的范围。 |
resourceStats |
与池中的计算节点的资源消耗相关的统计信息。 |
|
startTime |
string |
统计信息涵盖的时间范围的开始时间。 |
url |
string |
统计信息的 URL。 |
usageStats |
与池使用情况相关的统计信息,例如使用的核心时间量。 |
PublicIPAddressConfiguration
池的网络配置的公共 IP 地址配置。
名称 | 类型 | 说明 |
---|---|---|
ipAddressIds |
string[] |
预配计算节点时 Batch 服务将使用的公共 IP 列表。 |
provision |
池的公共 IP 地址的预配类型。 |
ResizeError
调整池大小时发生的错误。
名称 | 类型 | 说明 |
---|---|---|
code |
string |
池大小调整错误的标识符。 代码是固定的,旨在以编程方式使用。 |
message |
string |
描述池大小调整错误的消息,旨在适合在用户界面中显示。 |
values |
与池大小调整错误相关的其他错误详细信息的列表。 |
ResourceFile
要下载到计算节点的单个文件或多个文件。
名称 | 类型 | 说明 |
---|---|---|
autoStorageContainerName |
string |
自动存储帐户中的存储容器名称。 |
blobPrefix |
string |
从 Azure 存储容器下载 Blob 时要使用的 Blob 前缀。 仅下载名称以指定前缀开头的 blob。 |
fileMode |
string |
以八进制格式的文件权限模式属性。 |
filePath |
string |
要下载文件(s)的计算节点上相对于任务的工作目录的位置。 |
httpUrl |
string |
要下载的文件的 URL。 |
identityReference |
对用户分配的标识的引用,用于访问由 storageContainerUrl 或 httpUrl 指定的 Azure Blob 存储 |
|
storageContainerUrl |
string |
Azure Blob 存储中 Blob 容器的 URL。 |
ResourceStatistics
与池中的计算节点的资源消耗相关的统计信息。
名称 | 类型 | 说明 |
---|---|---|
avgCPUPercentage |
number |
池中所有计算节点的平均 CPU 使用率(每个节点的百分比)。 |
avgDiskGiB |
number |
池中所有计算节点的 GiB 平均已用磁盘空间。 |
avgMemoryGiB |
number |
池中所有计算节点的 GiB 的平均内存使用率。 |
diskReadGiB |
number |
池中所有计算节点读取磁盘 GiB 中的数据总量。 |
diskReadIOps |
integer |
池中所有计算节点的磁盘读取操作总数。 |
diskWriteGiB |
number |
池中所有计算节点的磁盘写入 GiB 中的数据总量。 |
diskWriteIOps |
integer |
池中所有计算节点的磁盘写入操作总数。 |
lastUpdateTime |
string |
上次更新统计信息的时间。 所有统计信息仅限于 startTime 和 lastUpdateTime 之间的范围。 |
networkReadGiB |
number |
池中所有计算节点的网络 GiB 中读取的总数据量。 |
networkWriteGiB |
number |
池中所有计算节点的网络写入 GiB 中的数据总量。 |
peakDiskGiB |
number |
池中所有计算节点的 GiB 中的峰值已用磁盘空间。 |
peakMemoryGiB |
number |
池中所有计算节点的 GiB 中的峰值内存使用率。 |
startTime |
string |
统计信息涵盖的时间范围的开始时间。 |
RollingUpgradePolicy
执行滚动升级时使用的配置参数。
名称 | 类型 | 说明 |
---|---|---|
enableCrossZoneUpgrade |
boolean |
允许 VMSS 在构造升级批处理时忽略 AZ 边界。 考虑 Update 域和 maxBatchInstancePercent 以确定批大小。 仅当将 NodePlacementConfiguration 用作 Zonal 时,此字段才可设置为 true 或 false。 |
maxBatchInstancePercent |
integer |
一批滚动升级同时升级的总虚拟机实例的最大百分比。 由于这是一个最大值,因此以前的或将来的批中的不正常实例可能会导致批处理中的实例百分比降低,以确保更高的可靠性。 此字段的值应介于 5 和 100 之间(含)。 如果 maxBatchInstancePercent 和 maxUnhealthyInstancePercent 都赋值,则 maxBatchInstancePercent 的值不应大于 maxUnhealthyInstancePercent。 |
maxUnhealthyInstancePercent |
integer |
规模集中可能同时运行不正常的虚拟机实例的最大百分比,无论是由于升级,还是虚拟机运行状况检查在滚动升级中止之前处于不正常状态。 在启动任何批处理之前,将检查此约束。 此字段的值应介于 5 和 100 之间(含)。 如果 maxBatchInstancePercent 和 maxUnhealthyInstancePercent 都赋值,则 maxBatchInstancePercent 的值不应大于 maxUnhealthyInstancePercent。 |
maxUnhealthyUpgradedInstancePercent |
integer |
可发现处于不正常状态的已升级虚拟机实例的最大百分比。 升级每个批处理后,将进行此检查。 如果超过此百分比,滚动更新将中止。 此字段的值应介于 0 和 100 之间(含)。 |
pauseTimeBetweenBatches |
string |
完成一批中所有虚拟机的更新和开始下一批之间的等待时间。 持续时间应采用 ISO 8601 格式指定。 |
prioritizeUnhealthyInstances |
boolean |
在任何正常运行的实例之前,升级规模集中的所有不正常实例。 |
rollbackFailedInstancesOnPolicyBreach |
boolean |
如果违反滚动升级策略,回滚失败实例到以前的模型。 |
SecurityEncryptionTypes
指定托管磁盘的 EncryptionType。 它设置为 VMGuestStateOnly 以仅加密 VMGuestState blob,而 NonPersistedTPM 用于不保留 VMGuestState blob 中的固件状态。 注意:只能为机密 VM 设置它,在使用机密 VM 时是必需的。
名称 | 类型 | 说明 |
---|---|---|
NonPersistedTPM |
string |
|
VMGuestStateOnly |
string |
SecurityProfile
指定虚拟机或虚拟机规模集的安全配置文件设置。
名称 | 类型 | 说明 |
---|---|---|
encryptionAtHost |
boolean |
用户可以在请求中使用此属性来启用或禁用虚拟机或虚拟机规模集的主机加密。 这将为所有磁盘启用加密,包括主机本身的资源/临时磁盘。 有关主机要求加密的详细信息,请参阅 https://learn.microsoft.com/azure/virtual-machines/disk-encryption#supported-vm-sizes。 |
securityType |
指定虚拟机的 SecurityType。 必须将其设置为任何指定值才能启用 UefiSettings。 |
|
uefiSettings |
指定在创建虚拟机时使用的安全启动和 vTPM 等安全设置。 |
SecurityTypes
指定虚拟机的 SecurityType。 必须将其设置为任何指定值才能启用 UefiSettings。
名称 | 类型 | 说明 |
---|---|---|
confidentialVM |
string |
Azure 机密计算为具有高安全性和机密性要求的租户提供机密 VM。 这些 VM 提供强大的硬件强制边界,以帮助满足安全需求。 可以使用机密 VM 进行迁移,而无需更改代码,而平台可保护 VM 的状态不被读取或修改。 |
trustedLaunch |
string |
受信任的启动可防范高级和持久性攻击技术。 |
ServiceArtifactReference
指定使用“latest”映像版本时,用于为规模集中的所有虚拟机设置相同映像版本的服务项目引用 ID。
名称 | 类型 | 说明 |
---|---|---|
id |
string |
ServiceArtifactReference 的服务项目引用 ID |
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)。 |
StorageAccountType
用于创建数据磁盘或 OS 磁盘的存储帐户类型。
名称 | 类型 | 说明 |
---|---|---|
premium_lrs |
string |
数据磁盘/OS 磁盘应使用高级本地冗余存储。 |
standard_lrs |
string |
数据磁盘/OS 磁盘应使用标准本地冗余存储。 |
standardssd_lrs |
string |
数据磁盘/OS 磁盘应使用标准 SSD 本地冗余存储。 |
TaskContainerSettings
任务的容器设置。
名称 | 类型 | 说明 |
---|---|---|
containerHostBatchBindMounts |
要装载到容器任务的路径。 |
|
containerRunOptions |
string |
容器创建命令的其他选项。 |
imageName |
string |
用于创建任务将在其中运行容器的映像。 |
registry |
包含容器映像的专用注册表。 |
|
workingDirectory |
容器任务工作目录的位置。 |
TaskSchedulingPolicy
指定应如何跨计算节点分配任务。
名称 | 类型 | 说明 |
---|---|---|
nodeFillType |
任务如何在池中的计算节点之间分布。 |
UefiSettings
指定在创建虚拟机时使用的安全启动和 vTPM 等安全设置。
名称 | 类型 | 说明 |
---|---|---|
secureBootEnabled |
boolean |
指定是否应在虚拟机上启用安全启动。 |
vTpmEnabled |
boolean |
指定是否应在虚拟机上启用 vTPM。 |
UpgradeMode
指定升级到规模集中虚拟机的模式。
可能的值包括:
手动 - 控制对规模集中虚拟机的更新的应用程序。 使用 manualUpgrade 操作执行此操作。
自动 - 规模集中的所有虚拟机同时自动更新。
滚动 - 规模集按批执行更新,并在两者之间有可选的暂停时间。
名称 | 类型 | 说明 |
---|---|---|
automatic |
string |
规模集中的所有虚拟机都会同时自动更新。 |
manual |
string |
可以控制对规模集中虚拟机的更新的应用程序。 使用 manualUpgrade 操作执行此操作。 |
rolling |
string |
规模集中的现有实例将分批关闭以升级。 升级后的批处理完成后,实例将再次开始获取流量,下一批将开始。 这一直持续到所有实例 up-to-date。 |
UpgradePolicy
描述升级策略 - 自动、手动或滚动。
名称 | 类型 | 说明 |
---|---|---|
automaticOSUpgradePolicy |
用于执行自动 OS 升级的配置参数。 |
|
mode |
指定升级到规模集中虚拟机的模式。 |
|
rollingUpgradePolicy |
执行滚动升级时使用的配置参数。 |
UsageStatistics
与池使用情况信息相关的统计信息。
名称 | 类型 | 说明 |
---|---|---|
dedicatedCoreTime |
string |
专用计算节点核心的聚合时钟时间是池的一部分。 |
lastUpdateTime |
string |
上次更新统计信息的时间。 所有统计信息仅限于 startTime 和 lastUpdateTime 之间的范围。 |
startTime |
string |
统计信息涵盖的时间范围的开始时间。 |
UserAccount
用于创建用于在 Azure Batch 计算节点上执行任务的用户的属性。
名称 | 类型 | 说明 |
---|---|---|
elevationLevel |
用户帐户的提升级别。 |
|
linuxUserConfiguration |
用户帐户的特定于 Linux 的用户配置。 |
|
name |
string |
用户帐户的名称。 名称可以包含最大长度为 20 的任何 Unicode 字符。 |
password |
string |
用户帐户的密码。 |
windowsUserConfiguration |
用户帐户的特定于 Windows 的用户配置。 |
UserAssignedIdentity
用户分配的标识
名称 | 类型 | 说明 |
---|---|---|
clientId |
string |
用户分配标识的客户端 ID。 |
principalId |
string |
用户分配标识的主体 ID。 |
resourceId |
string |
用户分配标识的 ARM 资源 ID |
UserIdentity
运行任务的用户标识的定义。
名称 | 类型 | 说明 |
---|---|---|
autoUser |
运行任务的自动用户。 |
|
username |
string |
运行任务的用户标识的名称。 |
VirtualMachineConfiguration
基于 Azure 虚拟机基础结构的池中计算节点的配置。
名称 | 类型 | 说明 |
---|---|---|
containerConfiguration |
池的容器配置。 |
|
dataDisks |
Data |
附加到池中计算节点的数据磁盘的配置。 |
diskEncryptionConfiguration |
池的磁盘加密配置。 |
|
extensions |
池的虚拟机扩展。 |
|
imageReference |
对 Azure 虚拟机市场映像或要使用的自定义虚拟机映像的引用。 |
|
licenseType |
string |
部署操作系统时要使用的本地许可证的类型。 Windows_Server - 本地许可证适用于 Windows Server。 Windows_Client - 本地许可证适用于 Windows 客户端。 |
nodeAgentSKUId |
string |
要在池中的计算节点上预配的 Batch 计算节点代理的 SKU。 |
nodePlacementConfiguration |
池的节点放置配置。 |
|
osDisk |
虚拟机操作系统磁盘的设置。 |
|
securityProfile |
指定虚拟机或虚拟机规模集的安全配置文件设置。 |
|
serviceArtifactReference |
指定使用“latest”映像版本时,用于为规模集中的所有虚拟机设置相同映像版本的服务项目引用 ID。 |
|
windowsConfiguration |
虚拟机上的 Windows 操作系统设置。 |
VMDiskSecurityProfile
指定托管磁盘的安全配置文件设置。 注意:只能为机密 VM 设置它,在使用机密 VM 时是必需的。
名称 | 类型 | 说明 |
---|---|---|
securityEncryptionType |
指定托管磁盘的 EncryptionType。 它设置为 VMGuestStateOnly 以仅加密 VMGuestState blob,而 NonPersistedTPM 用于不保留 VMGuestState blob 中的固件状态。 注意:只能为机密 VM 设置它,在使用机密 VM 时是必需的。 |
VMExtension
虚拟机扩展的配置。
名称 | 类型 | 说明 |
---|---|---|
autoUpgradeMinorVersion |
boolean |
指示扩展是否应在部署时使用较新的次要版本。 但是,部署后,除非重新部署,否则扩展不会升级次要版本,即使此属性设置为 true 也是如此。 |
enableAutomaticUpgrade |
boolean |
指示如果有较新版本的扩展可用,平台是否应自动升级扩展。 |
name |
string |
虚拟机扩展的名称。 |
protectedSettings |
object |
该扩展可以包含 protectedSettings 或 protectedSettingsFromKeyVault,或者根本不包含受保护的设置。 |
provisionAfterExtensions |
string[] |
扩展名称的集合。 |
publisher |
string |
扩展处理程序发布者的名称。 |
settings |
object |
扩展的 JSON 格式公共设置。 |
type |
string |
扩展的类型。 |
typeHandlerVersion |
string |
脚本处理程序的版本。 |
WindowsConfiguration
要应用于虚拟机的 Windows 操作系统设置。
名称 | 类型 | 说明 |
---|---|---|
enableAutomaticUpdates |
boolean |
是否在虚拟机上启用自动更新。 |
WindowsUserConfiguration
用于在 Windows 计算节点上创建用户帐户的属性。
名称 | 类型 | 说明 |
---|---|---|
loginMode |
用户的登录模式 |