你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Job - Patch
汇报指定作业的属性。
这将仅替换请求中指定的作业属性。 例如,如果作业具有约束,并且请求未指定约束元素,则 Job 将保留现有约束。
PATCH {batchUrl}/jobs/{jobId}?api-version=2023-11-01.18.0
PATCH {batchUrl}/jobs/{jobId}?timeout={timeout}&api-version=2023-11-01.18.0
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
batch
|
path | True |
string |
所有Azure Batch服务请求的基 URL。 |
job
|
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,请显式设置它。 |
|
If-Match |
string |
与客户端已知的资源版本关联的 ETag 值。 仅当服务上的资源当前 ETag 与客户端指定的值完全匹配时,才会执行该操作。 |
|
If-None-Match |
string |
与客户端已知的资源版本关联的 ETag 值。 仅当服务上的资源当前 ETag 与客户端指定的值不匹配时,才会执行该操作。 |
|
If-Modified-Since |
string date-time-rfc1123 |
一个时间戳,指示客户端已知的资源的上次修改时间。 仅当服务上的资源自指定时间以来已修改时,才会执行该操作。 |
|
If-Unmodified-Since |
string date-time-rfc1123 |
一个时间戳,指示客户端已知的资源的上次修改时间。 仅当服务上的资源自指定时间以来未修改时,才会执行该操作。 |
请求正文
Media Types: "application/json; odata=minimalmetadata"
名称 | 类型 | 说明 |
---|---|---|
allowTaskPreemption |
boolean |
此作业中的任务是否可以被其他高优先级作业抢占 |
constraints |
作业的执行约束。 |
|
maxParallelTasks |
integer |
可为作业并行执行的最大任务数。 |
metadata |
与作为元数据的作业关联的名称/值对列表。 |
|
onAllTasksComplete |
当作业中的所有任务都处于已完成状态时,Batch 服务应采取的操作。 |
|
poolInfo |
Batch 服务在其中运行作业任务的池。 |
|
priority |
integer |
作业的优先级。 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
对 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
示例
Job patch
示例请求
PATCH account.region.batch.azure.com/jobs/jobId?api-version=2023-11-01.18.0
{
"priority": 100,
"constraints": {
"maxWallClockTime": "PT1H",
"maxTaskRetryCount": -1
},
"poolInfo": {
"poolId": "poolId"
}
}
示例响应
定义
名称 | 说明 |
---|---|
Application |
对要部署到计算节点的包的引用。 |
Auto |
指定临时“自动池”的特征。 提交作业时,Batch 服务将创建此自动池。 |
Auto |
自动用户的范围 |
Auto |
指定在 Batch 服务上运行 Task 的自动用户的参数。 |
Azure |
用于使用 Blobfuse 连接到 Azure 存储容器的信息。 |
Azure |
用于连接到 Azure 文件共享的信息。 |
Batch |
从Azure Batch服务收到的错误响应。 |
Batch |
Azure Batch错误响应中包含的其他信息项。 |
Caching |
要为磁盘启用的缓存类型。 |
Certificate |
对要安装在池中的计算节点上的证书的引用。 |
Certificate |
要在其中安装证书的计算节点上的证书存储位置。 |
Certificate |
计算节点上的哪些用户帐户应有权访问证书的专用数据。 |
CIFSMount |
用于连接到 CIFS 文件系统的信息。 |
Cloud |
基于 Azure 云服务平台的池中计算节点的配置。 |
Compute |
任务如何跨池中的计算节点分布。 |
Compute |
对与计算节点将使用的 Batch 池关联的用户分配标识的引用。 |
Container |
已启用容器的池的配置。 |
Container |
专用容器注册表。 |
Container |
要使用的容器技术。 |
Container |
容器任务工作目录的位置。 |
Data |
与池中的计算节点关联的数据磁盘将使用的设置。 使用附加的数据磁盘时,需要从 VM 中装载和格式化磁盘,才能使用它们。 |
Diff |
指定池中所有计算节点 (VM) 操作系统磁盘的临时磁盘放置。 |
Diff |
指定计算节点 (VM) 使用的操作系统磁盘的临时磁盘设置。 |
Disk |
在池中的计算节点上应用的磁盘加密配置。 使用 Azure Compute Gallery Image 创建的 Linux 池不支持磁盘加密配置。 |
Disk |
批处理服务将在计算节点上加密的磁盘目标列表。 |
Dynamic |
动态 vnet 分配的范围。 |
Elevation |
用户的提升级别。 |
Environment |
要对任务进程设置的环境变量。 |
Error |
Azure Batch错误响应中收到的错误消息。 |
Image |
对 Azure 虚拟机 市场映像或 Azure Compute Gallery 映像的引用。 若要获取Azure Batch验证的所有Azure 市场图像引用的列表,请参阅“列出支持的映像”操作。 |
Inbound |
终结点的协议。 |
Inbound |
入站 NAT 池,可用于在外部批处理池中对计算节点上的特定端口进行寻址。 |
IPAddress |
池的公共 IP 地址的预配类型。 |
Job |
作业的执行约束。 |
Job |
要对作业进行的更改集。 |
Linux |
用于在 Linux 计算节点上创建用户帐户的属性。 |
Login |
用户的登录模式 |
Managed |
|
Metadata |
与 Batch 服务资源关联的名称/值对。 |
Mount |
要在每个节点上装载的文件系统。 |
Network |
池的网络配置。 |
Network |
要应用于入站终结点的网络安全组规则。 |
Network |
应对指定的 IP 地址、子网范围或标记执行的操作。 |
NFSMount |
用于连接到 NFS 文件系统的信息。 |
Node |
确定池如何与 Batch 服务通信。 |
Node |
池的节点放置配置。 |
Node |
用于在池中分配节点的放置策略。 |
On |
当作业中的所有任务都处于已完成状态时,Batch 服务应采取的操作。 |
OSDisk |
计算节点的操作系统磁盘设置 (VM) 。 |
Pool |
池的终结点配置。 |
Pool |
指定作业应如何分配给池。 |
Pool |
创建的自动池的最短生存期,以及如何按计划将多个作业分配给池。 |
Pool |
创建新池的规范。 |
Public |
池网络配置的公共 IP 地址配置。 |
Resource |
要下载到计算节点的单个文件或多个文件。 |
Security |
指定虚拟机或虚拟机规模集的安全配置文件设置。 |
Security |
指定虚拟机的 SecurityType。 必须将其设置为任何指定的值才能启用 UefiSettings。 |
Service |
指定使用“最新”映像版本时,用于为规模集中的所有虚拟机设置相同映像版本的服务项目引用 ID。 |
Start |
当节点加入Azure Batch服务中的池时,或者在重新启动或重置计算节点映像时运行的任务。 |
Storage |
用于创建数据磁盘或 OS 磁盘的存储帐户类型。 |
Task |
任务的容器设置。 |
Task |
指定任务应如何跨计算节点分布。 |
Uefi |
指定创建虚拟机时使用的安全启动和 vTPM 等安全设置。 |
User |
用于创建用于在Azure Batch计算节点上执行任务的用户的属性。 |
User |
运行任务时所依据的用户标识的定义。 |
Virtual |
基于 Azure 虚拟机基础结构的池中计算节点的配置。 |
VMExtension |
虚拟机扩展的配置。 |
Windows |
要应用于虚拟机的 Windows 操作系统设置。 |
Windows |
用于在 Windows 计算节点上创建用户帐户的属性。 |
ApplicationPackageReference
对要部署到计算节点的包的引用。
名称 | 类型 | 说明 |
---|---|---|
applicationId |
string |
要部署的应用程序的 ID。 |
version |
string |
要部署的应用程序的版本。 如果省略,则部署默认版本。 |
AutoPoolSpecification
指定临时“自动池”的特征。 提交作业时,Batch 服务将创建此自动池。
名称 | 类型 | 说明 |
---|---|---|
autoPoolIdPrefix |
string |
自动创建池时要添加到唯一标识符的前缀。 |
keepAlive |
boolean |
自动池的生存期到期后是否保持活动状态。 |
pool |
自动池的池规范。 |
|
poolLifetimeOption |
创建的自动池的最短生存期,以及如何按计划将多个作业分配给池。 |
AutoUserScope
自动用户的范围
名称 | 类型 | 说明 |
---|---|---|
pool |
string |
指定任务作为在池中的每个计算节点上创建的通用自动用户帐户运行。 |
task |
string |
指定服务应为 Task 创建新用户。 |
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 |
错误响应附带的其他信息。 |
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 文件系统进行身份验证的用户。 |
CloudServiceConfiguration
基于 Azure 云服务平台的池中计算节点的配置。
名称 | 类型 | 说明 |
---|---|---|
osFamily |
string |
要安装在池中的虚拟机上的 Azure 来宾 OS 系列。 |
osVersion |
string |
要安装在池中的虚拟机上的 Azure 来宾 OS 版本。 |
ComputeNodeFillType
任务如何跨池中的计算节点分布。
名称 | 类型 | 说明 |
---|---|---|
pack |
string |
在将任何任务分配给池中的下一个计算节点之前,应将尽可能多的任务 (taskSlotsPerNode) 分配给池中的每个计算节点。 |
spread |
string |
应跨池中的所有计算节点均匀分配任务。 |
ComputeNodeIdentityReference
对与计算节点将使用的 Batch 池关联的用户分配标识的引用。
名称 | 类型 | 说明 |
---|---|---|
resourceId |
string |
用户分配的标识的 ARM 资源 ID。 |
ContainerConfiguration
已启用容器的池的配置。
名称 | 类型 | 说明 |
---|---|---|
containerImageNames |
string[] |
容器映像名称的集合。 |
containerRegistries |
可以从中提取容器的其他专用注册表。 |
|
type |
要使用的容器技术。 |
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 Compute Gallery Image 创建的 Linux 池不支持磁盘加密配置。
名称 | 类型 | 说明 |
---|---|---|
targets |
批处理服务将在计算节点上加密的磁盘目标列表。 |
DiskEncryptionTarget
批处理服务将在计算节点上加密的磁盘目标列表。
名称 | 类型 | 说明 |
---|---|---|
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 Compute Gallery 映像的引用。 若要获取Azure Batch验证的所有Azure 市场图像引用的列表,请参阅“列出支持的映像”操作。
名称 | 类型 | 说明 |
---|---|---|
exactVersion |
string |
用于创建节点的平台映像或市场映像的特定版本。 仅当创建池时为“version”指定的值为“latest”时,此只读字段才与“version”不同。 |
offer |
string |
Azure 虚拟机市场映像的产品/服务类型。 |
publisher |
string |
Azure 虚拟机市场映像的发布者。 |
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/{resourceGroups/providers/Microsoft.Compute/galleryName/{galleryName}/images/{imageDefinitionName},始终默认为最新映像版本。 |
InboundEndpointProtocol
终结点的协议。
名称 | 类型 | 说明 |
---|---|---|
tcp |
string |
对终结点使用 TCP。 |
udp |
string |
对终结点使用 UDP。 |
InboundNATPool
入站 NAT 池,可用于在外部批处理池中对计算节点上的特定端口进行寻址。
名称 | 类型 | 说明 |
---|---|---|
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 由用户提供,将用于预配计算节点。 |
JobConstraints
作业的执行约束。
名称 | 类型 | 说明 |
---|---|---|
maxTaskRetryCount |
integer |
每个任务可以重试的最大次数。 如果任务退出代码为非零,Batch 服务会重试任务。 |
maxWallClockTime |
string |
作业可能运行的最长时间,从创建作业的时间开始测量。 |
JobPatchParameter
要对作业进行的更改集。
名称 | 类型 | 说明 |
---|---|---|
allowTaskPreemption |
boolean |
此作业中的任务是否可以被其他高优先级作业抢占 |
constraints |
作业的执行约束。 |
|
maxParallelTasks |
integer |
可为作业并行执行的最大任务数。 |
metadata |
与作为元数据的作业关联的名称/值对列表。 |
|
onAllTasksComplete |
当作业中的所有任务都处于已完成状态时,Batch 服务应采取的操作。 |
|
poolInfo |
Batch 服务在其中运行作业任务的池。 |
|
priority |
integer |
作业的优先级。 |
LinuxUserConfiguration
用于在 Linux 计算节点上创建用户帐户的属性。
名称 | 类型 | 说明 |
---|---|---|
gid |
integer |
用户帐户的组 ID。 |
sshPrivateKey |
string |
用户帐户的 SSH 私钥。 |
uid |
integer |
用户帐户的用户 ID。 |
LoginMode
用户的登录模式
名称 | 类型 | 说明 |
---|---|---|
batch |
string |
LOGON32_LOGON_BATCH Win32 登录模式。 对于长时间运行的并行进程,建议使用批处理登录模式。 |
interactive |
string |
LOGON32_LOGON_INTERACTIVE Win32 登录模式。 在 Windows VirtualMachineConfiguration 池上启用了 UAC。 如果将此选项与 Windows VirtualMachineConfiguration 池中提升的用户标识一起使用,则用户会话将不会提升,除非任务命令行执行的应用程序配置为始终需要管理权限或始终需要最大特权。 |
ManagedDisk
名称 | 类型 | 说明 |
---|---|---|
storageAccountType |
托管磁盘的存储帐户类型。 |
MetadataItem
与 Batch 服务资源关联的名称/值对。
名称 | 类型 | 说明 |
---|---|---|
name |
string |
元数据项的名称。 |
value |
string |
元数据项的值。 |
MountConfiguration
要在每个节点上装载的文件系统。
名称 | 类型 | 说明 |
---|---|---|
azureBlobFileSystemConfiguration |
在每个节点上使用 Blob FUSE 装载的 Azure 存储容器。 |
|
azureFileShareConfiguration |
要在每个节点上装载的 Azure 文件共享。 |
|
cifsMountConfiguration |
要在每个节点上装载的 CIFS/SMB 文件系统。 |
|
nfsMountConfiguration |
要在每个节点上装载的 NFS 文件系统。 |
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 |
使用经典通信模式的节点需要来自“BatchNodeManagement”的端口 29876 和 29877 上的入站 TCP 通信。{region}“服务标记和端口 443 上与”Storage.region“和”BatchNodeManagement“的出站 TCP 通信。{region}“服务标记。 |
default |
string |
节点通信模式由 Batch 服务自动设置。 |
simplified |
string |
使用简化通信模式的节点需要在端口 443 上与“BatchNodeManagement”进行出站 TCP 通信。{region}“服务标记。 不需要打开的入站端口。 |
NodePlacementConfiguration
池的节点放置配置。
名称 | 类型 | 说明 |
---|---|---|
policy |
Batch 池上的节点放置策略类型。 |
NodePlacementPolicyType
用于在池中分配节点的放置策略。
名称 | 类型 | 说明 |
---|---|---|
regional |
string |
池中的所有节点都将在同一区域中分配。 |
zonal |
string |
池中的节点将分布在不同的可用性区域中,并尽量进行工作量均衡。 |
OnAllTasksComplete
当作业中的所有任务都处于已完成状态时,Batch 服务应采取的操作。
名称 | 类型 | 说明 |
---|---|---|
noaction |
string |
不执行任何操作。 除非通过某种其他方式终止或禁用作业,否则作业将保持活动状态。 |
terminatejob |
string |
终止作业。 作业的 terminateReason 设置为“AllTasksComplete”。 |
OSDisk
计算节点的操作系统磁盘设置 (VM) 。
名称 | 类型 | 说明 |
---|---|---|
caching |
指定缓存要求。 可能的值为:None、ReadOnly、ReadWrite。 对于标准存储,默认值为:None。 高级存储的 ReadOnly。 |
|
diskSizeGB |
integer |
创建新 OS 磁盘时的初始磁盘大小(以 GB 为单位)。 |
ephemeralOSDiskSettings |
指定计算节点 (VM) 使用的操作系统磁盘的临时磁盘设置。 |
|
managedDisk |
托管磁盘参数。 |
|
writeAcceleratorEnabled |
boolean |
指定是在磁盘上启用或禁用 writeAccelerator。 |
PoolEndpointConfiguration
池的终结点配置。
名称 | 类型 | 说明 |
---|---|---|
inboundNATPools |
入站 NAT 池的列表,可用于在外部处理单个计算节点上的特定端口。 |
PoolInformation
指定作业应如何分配给池。
名称 | 类型 | 说明 |
---|---|---|
autoPoolSpecification |
临时“自动池”的特征。 提交作业时,Batch 服务将创建此自动池。 |
|
poolId |
string |
现有池的 ID。 作业的所有任务都将在指定的池上运行。 |
PoolLifetimeOption
创建的自动池的最短生存期,以及如何按计划将多个作业分配给池。
名称 | 类型 | 说明 |
---|---|---|
job |
string |
池在专用作业的生存期内存在。 Batch 服务在创建作业时创建池。 如果“作业”选项应用于作业计划,Batch 服务会为每个按计划创建的作业创建新的自动池。 |
jobschedule |
string |
池在作业计划的生存期内存在。 Batch 服务在按计划创建第一个作业时创建池。 此选项只能应用于作业计划,而不能应用于作业。 |
PoolSpecification
创建新池的规范。
名称 | 类型 | 说明 |
---|---|---|
applicationLicenses |
string[] |
Batch 服务将在池中的每个计算节点上提供的应用程序许可证列表。 |
applicationPackageReferences |
要安装在池中每个计算节点上的包列表。 |
|
autoScaleEvaluationInterval |
string |
根据自动缩放公式自动调整池大小的时间间隔。 |
autoScaleFormula |
string |
池中所需计算节点数的公式。 |
certificateReferences |
要安装在池中每个计算节点上的证书列表。 警告:此属性已弃用,将在 2024 年 2 月之后删除。 请改用 Azure KeyVault 扩展 。 |
|
cloudServiceConfiguration |
池的云服务配置。 |
|
displayName |
string |
池的显示名称。 |
enableAutoScale |
boolean |
池大小是否应随时间自动调整。 |
enableInterNodeCommunication |
boolean |
池是否允许计算节点之间的直接通信。 |
metadata |
与作为元数据的池关联的名称/值对的列表。 |
|
mountConfiguration |
要装载在池中的每个节点上的文件系统列表。 |
|
networkConfiguration |
池的网络配置。 |
|
resizeTimeout |
string |
将计算节点分配到池的超时。 |
resourceTags |
object |
与池关联的用户指定的标记。 |
startTask |
加入池时在每个计算节点上运行的任务。 将计算节点添加到池或重启计算节点时,任务将运行。 |
|
targetDedicatedNodes |
integer |
池中所需专用计算节点数。 |
targetLowPriorityNodes |
integer |
池中所需的现成/低优先级计算节点数。 |
targetNodeCommunicationMode |
池的所需节点通信模式。 |
|
taskSchedulingPolicy |
任务如何跨池中的计算节点分布。 |
|
taskSlotsPerNode |
integer |
可用于在池中单个计算节点上运行并发任务的任务槽数。 |
userAccounts |
将在池中的每个计算节点上创建的用户帐户列表。 |
|
virtualMachineConfiguration |
池的虚拟机配置。 |
|
vmSize |
string |
池中虚拟机的大小。 池中的所有虚拟机大小相同。 |
PublicIPAddressConfiguration
池网络配置的公共 IP 地址配置。
名称 | 类型 | 说明 |
---|---|---|
ipAddressIds |
string[] |
Batch 服务在预配计算节点时将使用的公共 IP 列表。 |
provision |
池的公共 IP 地址的预配类型。 |
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。 |
SecurityProfile
指定虚拟机或虚拟机规模集的安全配置文件设置。
名称 | 类型 | 说明 |
---|---|---|
encryptionAtHost |
boolean |
用户可以在请求中使用此属性来启用或禁用虚拟机或虚拟机规模集的主机加密。 这将为所有磁盘启用加密,包括主机本身的资源/临时磁盘。 |
securityType |
指定虚拟机的 SecurityType。 必须将其设置为任何指定的值才能启用 UefiSettings。 |
|
uefiSettings |
指定创建虚拟机时使用的安全启动和 vTPM 等安全设置。 |
SecurityTypes
指定虚拟机的 SecurityType。 必须将其设置为任何指定的值才能启用 UefiSettings。
名称 | 类型 | 说明 |
---|---|---|
trustedLaunch |
string |
受信任启动能够防范具有持续性的高级攻击手法。 |
ServiceArtifactReference
指定使用“最新”映像版本时,用于为规模集中的所有虚拟机设置相同映像版本的服务项目引用 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
任务的容器设置。
名称 | 类型 | 说明 |
---|---|---|
containerRunOptions |
string |
容器创建命令的其他选项。 |
imageName |
string |
用于创建运行 Task 的容器的映像。 |
registry |
包含容器映像的专用注册表。 |
|
workingDirectory |
容器任务工作目录的位置。 |
TaskSchedulingPolicy
指定任务应如何跨计算节点分布。
名称 | 类型 | 说明 |
---|---|---|
nodeFillType |
任务如何跨池中的计算节点分布。 |
UefiSettings
指定创建虚拟机时使用的安全启动和 vTPM 等安全设置。
名称 | 类型 | 说明 |
---|---|---|
secureBootEnabled |
boolean |
指定是否应在虚拟机上启用安全启动。 |
vTpmEnabled |
boolean |
指定是否应在虚拟机上启用 vTPM。 |
UserAccount
用于创建用于在Azure Batch计算节点上执行任务的用户的属性。
名称 | 类型 | 说明 |
---|---|---|
elevationLevel |
用户帐户的提升级别。 |
|
linuxUserConfiguration |
用户帐户的 Linux 特定用户配置。 |
|
name |
string |
用户帐户的名称。 名称可以包含最大长度为 20 的任何 Unicode 字符。 |
password |
string |
用户帐户的密码。 |
windowsUserConfiguration |
用户帐户的 Windows 特定用户配置。 |
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 |
指定使用“最新”映像版本时,用于为规模集中的所有虚拟机设置相同映像版本的服务项目引用 ID。 |
|
windowsConfiguration |
虚拟机上的 Windows 操作系统设置。 |
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 |
用户的登录模式 |