您现在访问的是微软AZURE全球版技术文档网站,若需要访问由世纪互联运营的MICROSOFT AZURE中国区技术文档网站,请访问 https://docs.azure.cn.

Job - Get

获取有关指定作业的信息。

GET {batchUrl}/jobs/{jobId}?api-version=2020-09-01.12.0
GET {batchUrl}/jobs/{jobId}?$select={$select}&$expand={$expand}&timeout={timeout}&api-version=2020-09-01.12.0

URI 参数

Name In Required Type Description
batchUrl
path True
  • string

所有 Azure Batch 服务请求的基 URL。

jobId
path True
  • string

作业的 ID。

api-version
query True
  • string

客户端 API 版本。

$expand
query
  • string

OData $expand 子句。

$select
query
  • string

OData $select 子句。

timeout
query
  • integer
int32

服务器可用于处理请求的最长时间(秒)。 默认为 30 秒。

请求头

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

Name Required Type Description
client-request-id
  • string
uuid

调用方生成的请求标识,采用不含修饰(如9C4D50EE-2D56-4CD3-8152-34347DC9F2B0)的 GUID 的形式。

return-client-request-id
  • boolean

服务器是否应在响应中返回客户端请求 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

指示客户端已知资源的上次修改时间的时间戳。 仅当服务上的资源自指定时间以来未修改时才会执行该操作。

响应

Name Type Description
200 OK

包含作业的响应。

Headers

  • client-request-id: string
  • request-id: string
  • ETag: string
  • Last-Modified: string
Other Status Codes

批处理服务中的错误。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation 模拟用户帐户

Authorization

Type: apiKey
In: header

示例

Job get

Sample Request

GET account.region.batch.azure.com/jobs/jobId?api-version=2020-09-01.12.0
client-request-id: 00000000-0000-0000-0000-000000000000
ocp-date: Fri, 17 Feb 2017 00:00:00 GMT

Sample Response

{
  "id": "jobId",
  "url": "https://account.region.batch.azure.com/jobs/jobId",
  "eTag": "0x8D4100FC49F0278",
  "lastModified": "2016-11-19T00:05:27.5391608Z",
  "creationTime": "2016-11-19T00:05:25.311915Z",
  "state": "completed",
  "stateTransitionTime": "2016-11-19T00:05:27.578581Z",
  "previousState": "active",
  "previousStateTransitionTime": "2016-11-19T00:05:27.2137716Z",
  "priority": 0,
  "usesTaskDependencies": false,
  "constraints": {
    "maxWallClockTime": "P10675199DT2H48M5.4775807S",
    "maxTaskRetryCount": 0
  },
  "poolInfo": {
    "poolId": "poolId"
  },
  "executionInfo": {
    "startTime": "2016-11-19T00:05:25.3309105Z",
    "endTime": "2016-11-19T00:05:27.578581Z",
    "poolId": "poolId",
    "terminateReason": "UserTerminate"
  },
  "onAllTasksComplete": "noaction",
  "onTaskFailure": "noaction"
}

定义

ApplicationPackageReference

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

AuthenticationTokenSettings

该任务可用于执行批处理服务操作的身份验证令牌的设置。

AutoPoolSpecification

指定临时 "自动池" 的特性。 提交作业时,Batch 服务将创建此自动池。

AutoUserScope

自动用户的作用域

AutoUserSpecification

指定在批处理服务上运行任务的自动用户的参数。

AzureBlobFileSystemConfiguration

用于通过 Blobfuse 连接到 Azure 存储容器的信息。

AzureFileShareConfiguration

用于连接到 Azure 文件共享的信息。

BatchError

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

BatchErrorDetail

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

CachingType

为磁盘启用的缓存类型。

CertificateReference

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

CertificateStoreLocation

计算节点上要安装证书的证书存储区的位置。

CIFSMountConfiguration

用于连接到 CIFS 文件系统的信息。

CloudJob

Azure Batch 作业。

CloudServiceConfiguration

基于 Azure 云服务平台的池中计算节点的配置。

ComputeNodeFillType

如何在池中的计算节点之间分配任务。

ContainerConfiguration

启用容器的池的配置。

ContainerRegistry

专用容器注册表。

ContainerType

要使用的容器技术。

ContainerWorkingDirectory

容器任务工作目录的位置。

DataDisk

与池中计算节点关联的数据磁盘将使用的设置。 使用附加的数据磁盘时,需要从 VM 中装载和格式化磁盘,才能使用它们。

DiskEncryptionConfiguration

磁盘加密配置应用于池中的计算节点。 用共享映像库映像创建的 Linux 池不支持磁盘加密配置。

DynamicVNetAssignmentScope

动态 vnet 分配的范围。

ElevationLevel

用户的提升级别。

EnvironmentSetting

要在任务进程上设置的环境变量。

ErrorCategory

错误的类别。

ErrorMessage

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

ImageReference

对 Azure 虚拟机 Marketplace 映像或共享映像库图像的引用。 若要获取 Azure Batch 验证的所有 Azure Marketplace 映像引用列表,请参阅 "列出支持的映像" 操作。

InboundEndpointProtocol

终结点的协议。

InboundNATPool

入站 NAT 池,可用于在外部的批处理池中处理计算节点上的特定端口。

IPAddressProvisioningType

池公共 IP 地址的设置类型。

JobConstraints

作业的执行约束。

JobExecutionInformation

包含有关在 Azure Batch 服务中执行作业的信息。

JobManagerTask

指定作业管理器任务的详细信息。

JobNetworkConfiguration

作业的网络配置。

JobPreparationTask

要在任何给定计算节点上的作业的任何任务之前运行的作业准备任务。

JobReleaseTask

在作业已运行的任何计算节点上,在作业完成时运行的作业释放任务。

JobSchedulingError

计划作业时批处理服务遇到错误。

JobState

作业的状态。

JobStatistics

作业的资源使用情况统计信息。

LinuxUserConfiguration

用于在 Linux 计算节点上创建用户帐户的属性。

LoginMode

用户的登录模式

MetadataItem

与 Batch 服务资源关联的名称-值对。

MountConfiguration

要在每个节点上装载的文件系统。

NameValuePair

表示一个名称-值对。

NetworkConfiguration

池的网络配置。

NetworkSecurityGroupRule

要应用于入站终结点的网络安全组规则。

NetworkSecurityGroupRuleAccess

应为指定的 IP 地址、子网范围或标记执行的操作。

NFSMountConfiguration

用于连接到 NFS 文件系统的信息。

OnAllTasksComplete

当作业中的所有任务都处于 "已完成" 状态时,批处理服务应执行的操作。

OnTaskFailure

当作业中的任何任务失败时,Batch 服务应采取的操作。

OutputFile

用于在批处理服务完成执行任务过程后将文件从 Azure Batch 计算节点上传到另一个位置的规范。

OutputFileBlobContainerDestination

指定 Azure blob 存储容器中的文件上传目标。

OutputFileDestination

应将文件上载到的目标。

OutputFileUploadCondition

应将任务输出文件或文件集上载到的条件。

OutputFileUploadOptions

有关输出文件上传操作的详细信息,包括在哪些条件下执行上传。

PoolEndpointConfiguration

池的终结点配置。

PoolInformation

指定应如何将作业分配到池。

PoolLifetimeOption

创建的自动池的最小生存期,以及如何将多个作业分配到池。

PoolSpecification

用于创建新池的规范。

PublicIPAddressConfiguration

池的网络配置的公共 IP 地址配置。

ResourceFile

要下载到计算节点的单个文件或多个文件。

StartTask

当节点加入 Azure Batch 服务中的池或重启计算节点或重置映像时运行的任务。

StorageAccountType

用于创建数据磁盘的存储帐户类型。

TaskConstraints

要应用于任务的执行约束。

TaskContainerSettings

任务的容器设置。

TaskSchedulingPolicy

指定应如何在计算节点之间分布任务。

UserAccount

用于创建用于在 Azure Batch 计算节点上执行任务的用户的属性。

UserIdentity

运行任务的用户标识的定义。

VirtualMachineConfiguration

基于 Azure 虚拟机基础结构的池中的计算节点的配置。

WindowsConfiguration

要应用于虚拟机的 Windows 操作系统设置。

WindowsUserConfiguration

用于在 Windows 计算节点上创建用户帐户的属性。

ApplicationPackageReference

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

Name Type Description
applicationId
  • string

要部署的应用程序的 ID。

version
  • string

要部署的应用程序的版本。 如果省略,则部署默认版本。
如果在池上省略此值,并且没有为此应用程序指定默认版本,则请求将失败,错误代码为 InvalidApplicationPackageReferences,HTTP 状态代码为409。 如果在任务中省略此值,并且没有为此应用程序指定默认版本,则该任务将失败,并出现预处理错误。

AuthenticationTokenSettings

该任务可用于执行批处理服务操作的身份验证令牌的设置。

Name Type Description
access
  • string[]

令牌授予访问权限的批处理资源。
身份验证令牌授予对一组有限的批处理服务操作的访问权限。 目前唯一支持的访问属性值为 "job",它授予与包含任务的作业相关的所有操作的访问权限。

AutoPoolSpecification

指定临时 "自动池" 的特性。 提交作业时,Batch 服务将创建此自动池。

Name Type Description
autoPoolIdPrefix
  • string

自动创建池时要添加到唯一标识符的前缀。
批处理服务在创建时为每个自动池分配一个唯一标识符。 若要区分出于不同目的创建的池,可以指定此元素,以将前缀添加到分配的 ID。 该前缀的长度最多是 20 个字符。

keepAlive
  • boolean

是否在自动池的生存期过期后使其保持活动状态。
如果为 false,则批处理服务会在其生存期 ((由 poolLifetimeOption 设置确定) 过期)后删除池;也就是说,作业或作业计划完成时。 如果为 true,则批处理服务不会自动删除池。 用户需要删除用此选项创建的自动池。

pool

自动池的池规范。

poolLifetimeOption

创建的自动池的最小生存期,以及如何将多个作业分配到池。

AutoUserScope

自动用户的作用域

Name Type Description
pool
  • string

指定任务作为公共自动用户帐户运行,该帐户是在池中的每个计算节点上创建的。

task
  • string

指定服务应为任务创建新用户。

AutoUserSpecification

指定在批处理服务上运行任务的自动用户的参数。

Name Type Description
elevationLevel

自动用户的提升级别。
默认值为 nonAdmin。

scope

自动用户的作用域
默认值为 pool。 如果池正在运行 Windows,则如果需要在任务之间进行更严格的隔离,则应指定任务的值。 例如,如果任务以可能影响其他任务的方式改变注册表,或者,如果已在池上指定了证书,而这些证书不应由正常任务访问,但应可由 StartTasks 访问。

AzureBlobFileSystemConfiguration

用于通过 Blobfuse 连接到 Azure 存储容器的信息。

Name Type Description
accountKey
  • string

Azure 存储帐户密钥。
此属性与 sasKey 互相排斥,必须指定一个。

accountName
  • string

Azure 存储帐户名称。

blobfuseOptions
  • string

要传递给 mount 命令的其他命令行选项。
这是 Windows 中的 "net use" 选项和 Linux 中的 "装载" 选项。

containerName
  • string

Azure Blob 存储容器名称。

relativeMountPath
  • string

计算节点上将装载文件系统的相对路径
所有文件系统都是相对于批处理装载目录装载的,可通过 AZ_BATCH_NODE_MOUNTS_DIR 环境变量访问。

sasKey
  • string

Azure 存储 SAS 令牌。
此属性与 accountKey 互相排斥,必须指定一个。

AzureFileShareConfiguration

用于连接到 Azure 文件共享的信息。

Name Type Description
accountKey
  • string

Azure 存储帐户密钥。

accountName
  • string

Azure 存储帐户名称。

azureFileUrl
  • string

Azure 文件 URL。
这的形式为 "https://{account}. .net/"。

mountOptions
  • string

要传递给 mount 命令的其他命令行选项。
这是 Windows 中的 "net use" 选项和 Linux 中的 "装载" 选项。

relativeMountPath
  • string

计算节点上将装载文件系统的相对路径
所有文件系统都是相对于批处理装载目录装载的,可通过 AZ_BATCH_NODE_MOUNTS_DIR 环境变量访问。

BatchError

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

Name Type Description
code
  • string

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

message

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

values

键值对的集合,其中包含有关错误的其他详细信息。

BatchErrorDetail

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

Name Type Description
key
  • string

一个标识符,它指定 Value 属性的含义。

value
  • string

错误响应附带的附加信息。

CachingType

为磁盘启用的缓存类型。

Name Type Description
none
  • string

未启用磁盘的缓存模式。

readonly
  • string

磁盘的缓存模式为只读。

readwrite
  • string

磁盘的缓存模式为 "读取" 和 "写入"。

CertificateReference

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

Name Type Description
storeLocation

计算节点上要安装证书的证书存储区的位置。
默认值为 currentuser。 此属性仅适用于使用 Windows 计算节点配置的池 (即使用 cloudServiceConfiguration 创建的池,或使用 Windows 映像引用) 创建的池。 对于 Linux 计算节点,证书存储在任务工作目录内的目录中,并且提供环境变量 AZ_BATCH_CERTIFICATES_DIR 向任务提供查询此位置。 对于 "remoteUser" 可见的证书,会在用户的主目录中创建 "证书" 目录, (例如,/home/{user-name}/certs) ,证书将放置在该目录中。

storeName
  • string

计算节点上要安装证书的证书存储区的名称。
此属性仅适用于使用 Windows 计算节点配置的池 (即使用 cloudServiceConfiguration 创建的池,或使用 Windows 映像引用) 创建的池。 常见的商店名称包括: My、Root、CA、Trust、禁止、TrustedPeople、TrustedPublisher、AuthRoot、通讯簿,但也可以使用任何自定义存储名称。 默认值为 My。

thumbprint
  • string

证书的指纹。

thumbprintAlgorithm
  • string

与指纹关联的算法。 这必须是 sha1。

visibility
  • string[]

计算节点上的哪些用户帐户应该有权访问证书的专用数据。
您可以在此集合中指定多个可见性。 默认值为 "所有帐户"。

CertificateStoreLocation

计算节点上要安装证书的证书存储区的位置。

Name Type Description
currentuser
  • string

应将证书安装到 CurrentUser 证书存储区。

localmachine
  • string

应将证书安装到 LocalMachine 证书存储区。

CIFSMountConfiguration

用于连接到 CIFS 文件系统的信息。

Name Type Description
mountOptions
  • string

要传递给 mount 命令的其他命令行选项。
这是 Windows 中的 "net use" 选项和 Linux 中的 "装载" 选项。

password
  • string

用于对 CIFS 文件系统进行身份验证的密码。

relativeMountPath
  • string

计算节点上将装载文件系统的相对路径
所有文件系统都是相对于批处理装载目录装载的,可通过 AZ_BATCH_NODE_MOUNTS_DIR 环境变量访问。

source
  • string

要装载的文件系统的 URI。

username
  • string

用于对 CIFS 文件系统进行身份验证的用户。

CloudJob

Azure Batch 作业。

Name Type Description
commonEnvironmentSettings

常见环境变量设置的列表。 为作业中的所有任务设置这些环境变量 (包括作业管理器、作业准备和作业释放任务) 。
各个任务可以通过指定具有不同值的相同设置名称来覆盖此处指定的环境设置。

constraints

作业的执行约束。

creationTime
  • string

作业的创建时间。

displayName
  • string

作业的显示名称。

eTag
  • string

作业的 ETag。
这是一个不透明的字符串。 可以使用它来检测请求之间的作业是否已更改。 具体而言,你可以在更新作业时传递 ETag,以指定仅当无人参与的情况下,你所做的更改才会生效。

executionInfo

作业的执行信息。

id
  • string

唯一标识帐户内作业的字符串。
ID 为保留大小写,但不区分大小写 (也就是说,帐户中不能有两个仅) 大小写不同的 Id。

jobManagerTask

启动作业时要启动的作业管理器任务的详细信息。
创建作业时,作业管理器任务会自动启动。 批处理服务将尝试计划作业管理器任务,然后再计划作业中的任何其他任务。 收缩池时,批处理服务会尝试保留作业管理器任务在其中运行的节点,尽可能长 (即,在运行作业管理器任务) 计算节点之前,将删除运行 "normal" 任务的计算节点。 当作业管理器任务失败并且需要重新启动时,系统会尝试按最高优先级计划该任务。 如果没有可用的空闲计算节点,则系统可能会终止池中正在运行的任务之一,并将其返回到队列,以便为作业管理器任务腾出空间来重新启动。 请注意,一个作业中的作业管理器任务的优先级不高于其他作业中的任务。 在作业间,只会观察到作业级别的优先级。 例如,如果需要重新启动优先级为0的作业管理器作业,则它不会取代优先级为1的作业的任务。 在节点上触发恢复操作时,Batch 会重试任务。 恢复操作的示例包括 (,但不限于) 不正常节点重新启动或计算节点由于主机故障而消失。 因恢复操作而发生的重试与无关,不会对 maxTaskRetryCount 进行计数。 即使 maxTaskRetryCount 为0,也可能发生恢复操作导致的内部重试。 因此,所有任务都应该是幂等的。 这意味着任务需要容忍中断和重新启动,而不会导致数据损坏或重复数据。 长时间运行任务的最佳做法是使用某种形式的检查点。

jobPreparationTask

作业准备任务。
在作业的任何其他任务之前,作业准备任务是在每个计算节点上运行的特殊任务。

jobReleaseTask

作业释放任务。
作业释放任务是在运行作业的任何其他任务的每个计算节点上的作业结束时运行的特殊任务。

lastModified
  • string

作业的上次修改时间。
这是作业级别数据(如作业状态或优先级)的最后时间发生更改。 它不考虑任务级更改,例如添加新任务或任务更改状态。

metadata

与作业关联的名称-值对的列表(作为元数据)。
Batch 服务不将任何意义分配给元数据;它仅用于用户代码。

networkConfiguration

作业的网络配置。

onAllTasksComplete

当作业中的所有任务都处于 "已完成" 状态时,批处理服务应执行的操作。
默认值为 noaction。

onTaskFailure

当作业中的任何任务失败时,Batch 服务应采取的操作。
如果具有 failureInfo,则任务被视为已失败。 如果任务在耗尽其重试计数后以非零退出代码完成,或者启动任务时出现错误(例如,由于资源文件下载错误),则设置 failureInfo。 默认值为 noaction。

poolInfo

与作业关联的池设置。

previousState

作业的前一状态。
如果作业处于其初始活动状态,则不设置此属性。

previousStateTransitionTime
  • string

作业进入其前一状态的时间。
如果作业处于其初始活动状态,则不设置此属性。

priority
  • integer

作业的优先级。
优先级值的范围为 -1000 到 1000,-1000 表示最低优先级,1000 表示最高优先级。 默认值为 0。

state

作业的当前状态。

stateTransitionTime
  • string

作业进入当前状态的时间。

stats

作业的整个生存期的资源使用情况统计信息。
仅当使用包含 "stats" 特性的 expand 子句检索到 CloudJob 时,才填充此属性;否则为 null。 统计信息可能不会立即可用。 Batch 服务定期汇总统计信息。 典型延迟约为30分钟。

url
  • string

作业的 URL。

usesTaskDependencies
  • boolean

作业中的任务是否可定义彼此之间的依赖关系。 默认值为 false。

CloudServiceConfiguration

基于 Azure 云服务平台的池中计算节点的配置。

Name Type Description
osFamily
  • string

要安装在池中虚拟机上的 Azure 来宾 OS 系列。
可能的值为: 2-OS 系列2,等效于 Windows Server 2008 R2 SP1。 3 - OS 系列 3,等效于Windows Server 2012。 4 - OS 系列 4,等效于 Windows Server 2012 R2。 5-OS 系列5,相当于 Windows Server 2016。 6-OS 系列6,相当于 Windows Server 2019。 有关详细信息,请参阅 Azure 来宾 OS 版本 (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases) 。

osVersion
  • string

要安装在池中虚拟机上的 Azure 来宾 OS 版本。
默认值为 *,它指定指定操作系统系列的最新操作系统版本。

ComputeNodeFillType

如何在池中的计算节点之间分配任务。

Name Type Description
pack
  • string

) (应尽可能多的任务分配给池中的每个计算节点,然后再将任何任务分配给池中的下一个计算节点。

spread
  • string

应在池中的所有计算节点之间平均分配任务。

ContainerConfiguration

启用容器的池的配置。

Name Type Description
containerImageNames
  • string[]

容器映像名称的集合。
这是完整的映像引用,正如指定给 "docker pull"。 映像将源自默认 Docker 注册表,除非映像使用替代注册表进行完全限定。

containerRegistries

可以从中拉取容器的其他专用注册表。
如果必须从需要凭据的专用注册表下载任何映像,则必须在此处提供这些凭据。

type

要使用的容器技术。

ContainerRegistry

专用容器注册表。

Name Type Description
password
  • string

用于登录注册表服务器的密码。

registryServer
  • string

注册表 URL。
如果省略,则默认值为 "docker.io"。

username
  • string

用于登录注册表服务器的用户名。

ContainerType

要使用的容器技术。

Name Type Description
dockerCompatible
  • string

将使用 Docker 兼容的容器技术来启动容器。

ContainerWorkingDirectory

容器任务工作目录的位置。

Name Type Description
containerImageDefault
  • string

使用容器映像中定义的工作目录。 请注意,此目录不包含批处理下载的资源文件。

taskWorkingDirectory
  • string

使用标准 Batch 服务任务工作目录,该目录包含由 Batch 填充的任务资源文件。

DataDisk

与池中计算节点关联的数据磁盘将使用的设置。 使用附加的数据磁盘时,需要从 VM 中装载和格式化磁盘,才能使用它们。

Name Type Description
caching

要为数据磁盘启用的缓存类型。
缓存的默认值为 readwrite。 有关缓存选项的信息,请参阅: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/

diskSizeGB
  • integer

初始磁盘大小(gb)。

lun
  • integer

逻辑单元号。
Lun 用于唯一标识每个数据磁盘。 如果附加多个磁盘,则每个磁盘应具有不同的 lun。 该值必须介于0到63(含)之间。

storageAccountType

要用于数据磁盘的存储帐户类型。
如果省略,则默认值为 "standard_lrs"。

DiskEncryptionConfiguration

磁盘加密配置应用于池中的计算节点。 用共享映像库映像创建的 Linux 池不支持磁盘加密配置。

Name Type Description
targets
  • string[]

Batch 服务的磁盘目标列表将在计算节点上加密。
如果省略此项,则不会对池中计算节点上的磁盘进行加密。 在 Linux 池上,仅支持 "TemporaryDisk";在 Windows 池上,必须指定 "OsDisk" 和 "TemporaryDisk"。

DynamicVNetAssignmentScope

动态 vnet 分配的范围。

Name Type Description
job
  • string

动态 VNet 分配按作业完成。

none
  • string

未启用动态 VNet 分配。

ElevationLevel

用户的提升级别。

Name Type Description
admin
  • string

用户是具有提升访问权限的用户,并以完全权限管理员权限操作。

nonadmin
  • string

用户是没有提升访问权限的标准用户。

EnvironmentSetting

要在任务进程上设置的环境变量。

Name Type Description
name
  • string

环境变量名。

value
  • string

环境变量的值。

ErrorCategory

错误的类别。

Name Type Description
servererror
  • string

此错误是由内部服务器问题导致的。

usererror
  • string

此错误是由于用户问题(如配置错误)引起的。

ErrorMessage

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

Name Type Description
lang
  • string

错误消息的语言代码

value
  • string

消息的文本。

ImageReference

对 Azure 虚拟机 Marketplace 映像或共享映像库图像的引用。 若要获取 Azure Batch 验证的所有 Azure Marketplace 映像引用列表,请参阅 "列出支持的映像" 操作。

Name Type Description
offer
  • string

Azure 虚拟机 Marketplace 映像的产品/服务类型。
例如,UbuntuServer 或 WindowsServer。

publisher
  • string

Azure 虚拟机 Marketplace 映像的发布者。
例如,规范或 MicrosoftWindowsServer。

sku
  • string

Azure 虚拟机 Marketplace 映像的 SKU。
例如,18.04-LTS 或 2019-Datacenter。

version
  • string

Azure 虚拟机 Marketplace 映像的版本。
可以指定值 "最新" 以选择最新的映像版本。 如果省略,则默认值为 "最新"。

virtualMachineImageId
  • string

共享映像库映像的 ARM 资源标识符。 将使用此映像 Id 创建池中的计算节点。这是/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} 或/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName} 的形式,适用于始终默认为最新的映像版本。
此属性与其他 ImageReference 属性互相排斥。 共享映像库映像的副本必须在同一区域中,且必须与 Azure Batch 帐户位于同一订阅中。 如果未在 imageId 中指定映像版本,将使用最新版本。 有关批处理计算节点代理与 Batch 服务通信的防火墙设置的信息,请参阅 https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration

InboundEndpointProtocol

终结点的协议。

Name Type Description
tcp
  • string

为终结点使用 TCP。

udp
  • string

对终结点使用 UDP。

InboundNATPool

入站 NAT 池,可用于在外部的批处理池中处理计算节点上的特定端口。

Name Type Description
backendPort
  • integer

计算节点上的端口号。
这在批处理池中必须是唯一的。 可接受的值介于1到65535之间,但22、3389、29876和29877除外,因为这些值已保留。 如果提供任何保留值,请求会失败并出现 HTTP 状态代码400。

frontendPortRangeEnd
  • integer

外部端口范围内的最后一个端口号,将用于向单个计算节点上的 backendPort 提供入站访问。
可接受的值范围介于1到65534之间,从50000到55000的端口除外,后者由批处理服务保留。 池内的所有范围都必须是唯一的,且不能重叠。 每个范围必须至少包含40个端口。 如果提供任何保留值或重叠值,请求会失败并出现 HTTP 状态代码400。

frontendPortRangeStart
  • integer

外部端口范围中的第一个端口号,将用于向单个计算节点上的 backendPort 提供入站访问。
可接受的值范围介于1到65534之间,从50000到55000的端口除外。 池内的所有范围都必须是唯一的,且不能重叠。 每个范围必须至少包含40个端口。 如果提供任何保留值或重叠值,请求会失败并出现 HTTP 状态代码400。

name
  • string

终结点的名称。
该名称在批处理池中必须是唯一的,可以包含字母、数字、下划线、句点和连字符。 名称必须以字母或数字开头,且必须以字母、数字或下划线结尾,且不能超过77个字符。 如果提供了任何无效值,请求将失败并出现 HTTP 状态代码400。

networkSecurityGroupRules

将应用到终结点的网络安全组规则的列表。
可在批处理池上的所有终结点中指定的最大规则数为25。 如果未指定网络安全组规则,则将创建默认规则,以允许对指定的 backendPort 进行入站访问。 如果超过网络安全组规则的最大数目,请求会失败,并出现 HTTP 状态代码400。

protocol

终结点的协议。

IPAddressProvisioningType

池公共 IP 地址的设置类型。

Name Type Description
batchmanaged
  • string

公共 IP 将通过批处理来创建和管理。 根据池的大小,可能有多个公共 Ip。

nopublicipaddresses
  • string

不会创建公共 IP 地址。

usermanaged
  • string

公共 Ip 由用户提供,将用于预配计算节点。

JobConstraints

作业的执行约束。

Name Type Description
maxTaskRetryCount
  • integer

每个任务可以重试的最大次数。 如果任务的退出代码为非零,则 Batch 服务会重试该任务。
请注意,此值专门用于控制重试的次数。 批处理服务将尝试每个任务一次,然后可能重试到此限制。 例如,如果最大重试计数为3,则批处理会将任务最多尝试4次, (首次尝试和3次重试) 。 如果最大重试计数为0,则批处理服务不会重试任务。 如果最大重试计数为-1,则批处理服务将重试任务而不进行限制。 默认值为 0(不重试)。

maxWallClockTime
  • string

作业可以运行的最长运行时间,从创建作业的时间开始算起。
如果作业未在时间限制内完成,则批处理服务会将其终止,并且任何仍在运行的任务。 在这种情况下,终止原因将为 MaxWallClockTimeExpiry。 如果未指定此属性,则作业可以运行的时间不会限制。

JobExecutionInformation

包含有关在 Azure Batch 服务中执行作业的信息。

Name Type Description
endTime
  • string

作业的完成时间。
仅当作业处于 "已完成" 状态时,才设置此属性。

poolId
  • string

此作业分配到的池的 ID。
此元素包含分配作业的实际池。 当你从服务获取作业详细信息时,它们还包含一个 poolInfo 元素,其中包含添加或更新作业时的池中的配置数据。 该 poolInfo 元素可能还包含 poolId 元素。 如果是这样,则这两个 Id 是相同的。 如果不是,则表示作业在自动池上运行,并且此属性包含该自动池的 ID。

schedulingError

启动作业时服务遇到的任何错误的详细信息。
如果启动作业时没有出错,则不设置此属性。

startTime
  • string

作业的开始时间。
这是创建作业的时间。

terminateReason
  • string

描述作业结束原因的字符串。
仅当作业处于 "已完成" 状态时,才设置此属性。 如果批处理服务终止了该作业,则会按如下所示设置原因: JMComplete-作业管理器任务已完成,并且 killJobOnCompletion 已设置为 true。 MaxWallClockTimeExpiry-作业已达到其 maxWallClockTime 约束。 TerminateJobSchedule-作业作为计划的一部分运行,并且计划已终止。 AllTasksComplete-作业的 onAllTasksComplete 属性设置为 terminatejob,作业中的所有任务都已完成。 TaskFailed-作业的 onTaskFailure 属性设置为 performExitOptionsJobAction,作业中的任务失败,并出现退出条件,其中指定了 terminatejob 的 jobAction。 任何其他字符串是在调用 "终止作业" 操作时指定的用户定义原因。

JobManagerTask

指定作业管理器任务的详细信息。

Name Type Description
allowLowPriorityNode
  • boolean

作业管理器任务是否可以在低优先级计算节点上运行。
默认值为 true。

applicationPackageReferences

批处理服务在运行命令行之前将部署到计算节点的应用程序包的列表。
下载应用程序包并将其部署到共享目录,而不是任务工作目录。 因此,如果引用的应用程序包已在计算节点上,并且是最新的,则不会重新下载它;使用计算节点上的现有副本。 如果无法安装引用的应用程序包(例如,由于包已被删除或者下载失败,则该任务将失败)。

authenticationTokenSettings

该任务可用于执行批处理服务操作的身份验证令牌的设置。
如果设置了此属性,批处理服务将为该任务提供一个身份验证令牌,该令牌可用于对 Batch 服务操作进行身份验证,而无需帐户访问密钥。 令牌通过 AZ_BATCH_AUTHENTICATION_TOKEN 环境变量提供。 任务可以使用令牌执行的操作取决于设置。 例如,任务可以请求作业权限以便将其他任务添加到作业,或检查作业或作业下的其他任务的状态。

commandLine
  • string

作业管理器任务的命令行。
命令行不在 shell 下运行,因此无法利用 shell 功能,例如环境变量扩展。 如果要利用此类功能,应在命令行中调用 shell,例如,在 Windows 中使用 "cmd/c MyCommand" 或在 Linux 中使用 "/bin/sh-c MyCommand"。 如果命令行引用文件路径,则它应使用相对路径 (相对于任务工作目录) ,或使用 (批处理提供的环境变量 https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables) 。

constraints

适用于作业管理器任务的约束。

containerSettings

作业管理器任务在其下运行的容器的设置。
如果运行此任务的池已设置 containerConfiguration,则还必须设置。 如果运行此任务的池未设置 containerConfiguration,则不能设置此资源。 如果指定了此项,则所有目录都将在该) 节点上的 Azure Batch 目录的根目录下递归 (AZ_BATCH_NODE_ROOT_DIR,并将其映射到容器中,所有任务环境变量将映射到该容器中,并在容器中执行任务命令行。 在 AZ_BATCH_NODE_ROOT_DIR 之外的容器中生成的文件可能不会反映到主机磁盘,这意味着批处理文件 Api 将无法访问这些文件。

displayName
  • string

作业管理器任务的显示名称。
它不需要是唯一的,最大长度为1024的任何 Unicode 字符。

environmentSettings

作业管理器任务的环境变量设置列表。

id
  • string

一个字符串,用于唯一标识作业中的作业管理器任务。
ID 可以包含字母数字字符(包括连字符和下划线)的任意组合,且不能超过64个字符。

killJobOnCompletion
  • boolean

作业管理器任务是否完成表示整个作业的完成。
如果为 true,则在作业管理器任务完成时,批处理服务会将作业标记为已完成。 如果此时仍在运行任何任务 (不是作业版本) ,这些任务将终止。 如果为 false,则作业管理器任务的完成不影响作业状态。 在这种情况下,应使用 onAllTasksComplete 属性来终止作业,或让客户端或用户显式终止作业。 例如,如果作业管理器创建一组任务,但随后在执行过程中没有进一步的角色,则会出现这种情况。 默认值为 true。 如果要使用 onAllTasksComplete 和 onTaskFailure 属性控制作业生存期,并使用作业管理器任务仅为作业创建任务 (不监视进度) ,则必须将 killJobOnCompletion 设置为 false。

outputFiles

运行命令行后,批处理服务将从计算节点上载的文件的列表。
对于多实例任务,只会从执行主要任务的计算节点上传文件。

requiredSlots
  • integer

任务需要运行的计划槽数。
默认值为 1。 如果该节点具有足够的可用计划槽,则只能计划在计算节点上运行该任务。 对于多实例任务,此项必须为1。

resourceFiles

批处理服务在运行命令行之前将下载到计算节点的文件的列表。
此元素下列出的文件位于任务的工作目录中。 资源文件列表的大小有最大值。 超过最大大小时,请求将失败,并且响应错误代码将为 RequestEntityTooLarge。 如果出现这种情况,则必须减小 ResourceFiles 的集合大小。 可以使用 .zip 文件、应用程序包或 Docker 容器实现此目的。

runExclusive
  • boolean

作业管理器任务是否需要独占使用它运行的计算节点。
如果为 true,则在作业管理器正在运行的情况下,任何其他任务都不会在同一节点上运行。 如果为 false,则其他任务可与作业管理器一起在计算节点上同时运行。 作业管理器任务通常会根据计算节点的并发任务数限制进行计数,因此仅当计算节点允许多个并发任务时,这才是相关的。 默认值为 true。

userIdentity

作业管理器任务在其下运行的用户标识。
如果省略此项,任务将作为任务独有的非管理用户运行。

JobNetworkConfiguration

作业的网络配置。

Name Type Description
subnetId
  • string

虚拟网络子网的 ARM 资源标识符,从作业中运行任务的计算节点将在任务的持续时间内加入。 这仅适用于 VirtualMachineConfiguration 池。
虚拟网络必须与 Azure Batch 帐户位于同一区域和订阅中。 指定的子网应有足够的可用 IP 地址来容纳将从作业中运行任务的计算节点数。 此值可以为池中的计算节点数。 对于指定的 VNet,"MicrosoftAzureBatch" 服务主体必须具有 "经典虚拟机参与者" 基于角色的访问控制 (RBAC) 角色,以便 Azure Batch 服务可以在节点上计划任务。 可以通过检查指定的 VNet 是否有任何关联的网络安全组 (NSG) 来进行验证。 如果 NSG 拒绝与指定子网中的节点通信,则批处理服务会将计算节点的状态设置为 "不可用"。 格式为/subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}。 如果指定的 VNet 具有 (NSG) 的任何关联的网络安全组,则必须启用几个保留的系统端口才能从 Azure Batch 服务进行入站通信。 对于使用虚拟机配置创建的池,请启用端口29876和29877,以及端口22(适用于 Linux)和端口3389(适用于 Windows)。 还需要为连接到 Azure 存储的出站连接打开端口443。 有关更多详细信息,请参阅: https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration

JobPreparationTask

要在任何给定计算节点上的作业的任何任务之前运行的作业准备任务。

Name Type Description
commandLine
  • string

作业准备任务的命令行。
命令行不在 shell 下运行,因此无法利用 shell 功能,例如环境变量扩展。 如果要利用此类功能,应在命令行中调用 shell,例如,在 Windows 中使用 "cmd/c MyCommand" 或在 Linux 中使用 "/bin/sh-c MyCommand"。 如果命令行引用文件路径,则它应使用相对路径 (相对于任务工作目录) ,或使用 (批处理提供的环境变量 https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables) 。

constraints

适用于作业准备任务的约束。

containerSettings

作业准备任务在其下运行的容器的设置。
如果指定了此项,则所有目录都将在该) 节点上的 Azure Batch 目录的根目录下递归 (AZ_BATCH_NODE_ROOT_DIR,并将其映射到容器中,所有任务环境变量将映射到该容器中,并在容器中执行任务命令行。 在 AZ_BATCH_NODE_ROOT_DIR 之外的容器中生成的文件可能不会反映到主机磁盘,这意味着批处理文件 Api 将无法访问这些文件。

environmentSettings

作业准备任务的环境变量设置列表。

id
  • string

一个字符串,用于唯一标识作业中的作业准备任务。
ID 可以包含字母数字字符(包括连字符和下划线)的任意组合,且不能超过64个字符。 如果未指定此属性,批处理服务将分配默认值 "jobpreparation"。 作业中的任何其他任务都不能与作业准备任务具有相同的 ID。 如果尝试提交具有相同 id 的任务,批处理服务将拒绝该请求并返回错误代码 TaskIdSameAsJobPreparationTask;如果直接调用 REST API,则 HTTP 状态代码为 409 () 冲突。

rerunOnNodeRebootAfterSuccess
  • boolean

在计算节点重启后批处理服务是否应重新运行作业准备任务。
如果计算节点重置映像,或者作业准备任务未 (完成(例如,因为) 运行任务时进行了重新启动),则始终会重新运行作业准备任务。 因此,应始终将作业准备任务编写为幂等,并在多次运行的情况下正常运行。 默认值为 true。

resourceFiles

批处理服务在运行命令行之前将下载到计算节点的文件的列表。
此元素下列出的文件位于任务的工作目录中。 资源文件列表的大小有最大值。 超过最大大小时,请求将失败,并且响应错误代码将为 RequestEntityTooLarge。 如果出现这种情况,则必须减小 ResourceFiles 的集合大小。 可以使用 .zip 文件、应用程序包或 Docker 容器实现此目的。

userIdentity

运行作业准备任务所用的用户标识。
如果省略此项,则该任务将以非管理用户身份运行,该用户对 Windows 计算节点上的任务或 Linux 计算节点上的池唯一的非管理用户是唯一的。

waitForSuccess
  • boolean

批处理服务在计划计算节点上作业的任何其他任务之前,是否应等待作业准备任务成功完成。 如果作业准备任务退出后退出代码为0,则该任务已成功完成。
如果为 true,并且作业准备任务在节点上失败,则批处理服务会将作业准备任务重试最大重试计数( (在约束元素) 中指定)。 如果在所有重试后任务仍未成功完成,则批处理服务不会将作业的任务安排到节点。 节点保持活动状态,并且有资格运行其他作业的任务。 如果为 false,则批处理服务将不等待作业准备任务完成。 在这种情况下,作业的其他任务可以在 "计算" 节点上开始执行,而作业准备任务仍在运行;即使作业准备任务失败,也会继续在计算节点上计划新的任务。 默认值为 true。

JobReleaseTask

在作业已运行的任何计算节点上,在作业完成时运行的作业释放任务。

Name Type Description
commandLine
  • string

作业释放任务的命令行。
命令行不在 shell 下运行,因此无法利用 shell 功能,例如环境变量扩展。 如果要利用此类功能,应在命令行中调用 shell,例如,在 Windows 中使用 "cmd/c MyCommand" 或在 Linux 中使用 "/bin/sh-c MyCommand"。 如果命令行引用文件路径,则它应使用相对路径 (相对于任务工作目录) ,或使用 (批处理提供的环境变量 https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables) 。

containerSettings

作业释放任务在其下运行的容器的设置。
如果指定了此项,则所有目录都将在该) 节点上的 Azure Batch 目录的根目录下递归 (AZ_BATCH_NODE_ROOT_DIR,并将其映射到容器中,所有任务环境变量将映射到该容器中,并在容器中执行任务命令行。 在 AZ_BATCH_NODE_ROOT_DIR 之外的容器中生成的文件可能不会反映到主机磁盘,这意味着批处理文件 Api 将无法访问这些文件。

environmentSettings

作业释放任务的环境变量设置列表。

id
  • string

一个字符串,用于唯一标识作业内的作业释放任务。
ID 可以包含字母数字字符(包括连字符和下划线)的任意组合,且不能超过64个字符。 如果未指定此属性,批处理服务将分配默认值 "jobrelease"。 作业中的任何其他任务都不能与作业释放任务具有相同的 ID。 如果尝试提交具有相同 id 的任务,批处理服务将拒绝该请求并返回错误代码 TaskIdSameAsJobReleaseTask;如果直接调用 REST API,则 HTTP 状态代码为 409 () 冲突。

maxWallClockTime
  • string

作业释放任务可在给定计算节点上运行的最长运行时间,从任务开始的时间开始算起。 如果该任务未在时间限制内完成,批处理服务将终止该任务。 默认值为 15 分钟。 你不能指定超过15分钟的超时时间。 如果执行此操作,Batch 服务会拒绝它并返回错误;如果直接调用 REST API,HTTP 状态代码为 400 (请求) 错误。

resourceFiles

批处理服务在运行命令行之前将下载到计算节点的文件的列表。 资源文件列表的大小有最大值。 超过最大大小时,请求将失败,并且响应错误代码将为 RequestEntityTooLarge。 如果出现这种情况,则必须减小 ResourceFiles 的集合大小。 可以使用 .zip 文件、应用程序包或 Docker 容器实现此目的。
此元素下列出的文件位于任务的工作目录中。

retentionTime
  • string

为计算节点上的作业释放任务保留任务目录的最短时间。 此时间过后,Batch 服务可能会删除任务目录及其所有内容。
默认值为7天,即,任务目录将保留7天,除非删除计算节点或删除作业。

userIdentity

运行作业释放任务所用的用户标识。
如果省略此项,任务将作为任务独有的非管理用户运行。

JobSchedulingError

计划作业时批处理服务遇到错误。

Name Type Description
category

作业计划错误的类别。

code
  • string

作业计划错误的标识符。 代码是固定的,旨在以编程方式使用。

details

与计划错误相关的其他错误详细信息的列表。

message
  • string

描述作业计划错误的消息,旨在适合在用户界面中显示。

JobState

作业的状态。

Name Type Description
active
  • string

作业可用来计划任务。

completed
  • string

所有任务都已终止,系统不会接受任何其他任务或对作业的任何进一步更改。

deleting
  • string

用户已请求删除该作业,但删除操作仍在进行中 (例如,因为系统仍在) 终止正在运行的任务。

disabled
  • string

用户已禁用该作业。 没有任务正在运行,将不计划任何新任务。

disabling
  • string

用户已请求禁用作业,但仍在执行禁用操作 (例如,等待任务终止) 。

enabling
  • string

用户已请求启用作业,但启用操作仍在进行中。

terminating
  • string

作业即将完成,原因是作业管理器任务已完成,或者因为用户已终止作业,但终止操作仍在进行中 (例如,因为作业释放任务) 运行。

JobStatistics

作业的资源使用情况统计信息。

Name Type Description
kernelCPUTime
  • string

所有内核和所有计算节点的总内核模式 CPU 时间 (总和) 该作业中的所有任务使用。

lastUpdateTime
  • string

上次更新统计信息的时间。 所有统计信息限制为 startTime 和 lastUpdateTime 之间的范围。

numFailedTasks
  • integer

在给定时间范围内失败的作业中的任务总数。
如果任务用完其最大重试次数,而不返回退出代码0,则该任务失败。

numSucceededTasks
  • integer

在给定时间范围内作业中成功完成的任务总数。
如果任务返回退出代码0,则该任务成功完成。

numTaskRetries
  • integer

在给定时间范围内对作业中的所有任务进行重试的总次数。

readIOGiB
  • number

作业中的所有任务从磁盘读取的数据总量(以 GiB 为依据)。

readIOps
  • integer

作业中的所有任务所进行的磁盘读取操作总数。

startTime
  • string

统计信息所涵盖的时间范围的开始时间。

url
  • string

统计信息的 URL。

userCPUTime
  • string

所有内核和所有计算节点的总用户模式 CPU 时间 (总计) 该作业中的所有任务使用。

waitTime
  • string

作业中所有任务的总等待时间。
任务的等待时间定义为创建任务和开始执行任务之间经过的时间。 (如果由于故障而重试任务,则等待时间是指最近任务执行的时间。 ) 此值仅在帐户生存期统计信息中报告;作业统计信息中不包括此信息。

wallClockTime
  • string

作业中所有任务的总时钟时间。
时钟时间是指任务在计算节点上开始运行到完成的时间, (或最后一次更新统计信息时,如果任务尚未完成,则) 。 如果重试了任务,则这包括所有任务重试的时钟时间。

writeIOGiB
  • number

作业中的所有任务写入磁盘的 GiB 中的总数据量。

writeIOps
  • integer

作业中的所有任务所进行的磁盘写入操作总数。

LinuxUserConfiguration

用于在 Linux 计算节点上创建用户帐户的属性。

Name Type Description
gid
  • integer

用户帐户的组 ID。
必须一起指定 uid 和 gid 属性,或者根本不指定。 如果未指定,则基础操作系统会选取 gid。

sshPrivateKey
  • string

用户帐户的 SSH 私钥。
私钥不得受密码保护。 私钥用于在池的 enableInterNodeCommunication 属性为 true 时,为 Linux 池中的计算节点自动配置基于非对称密钥的身份验证 (如果 enableInterNodeCommunication 为 false) ,则会将其忽略。 它通过将密钥对放入用户的 ssh 目录来实现此功能。 如果未指定,则不会在计算节点之间配置密码不足的 SSH (修改用户的 ssh 目录) 完成。

uid
  • integer

用户帐户的用户 ID。
必须一起指定 uid 和 gid 属性,或者根本不指定。 如果未指定,则基础操作系统会选取 uid。

LoginMode

用户的登录模式

Name Type Description
batch
  • string

LOGON32_LOGON_BATCH Win32 登录模式。 建议将批处理登录模式用于长时间运行的并行进程。

interactive
  • string

LOGON32_LOGON_INTERACTIVE Win32 登录模式。 在 Windows VirtualMachineConfiguration 池中启用了 UAC。 如果将此选项用于 Windows VirtualMachineConfiguration 池中的提升的用户标识,则将不会提升用户会话,除非任务命令行执行的应用程序配置为始终需要管理权限或始终需要最大权限。

MetadataItem

与 Batch 服务资源关联的名称-值对。

Name Type Description
name
  • string

元数据项的名称。

value
  • string

元数据项的值。

MountConfiguration

要在每个节点上装载的文件系统。

Name Type Description
azureBlobFileSystemConfiguration

要在每个节点上使用 blob 保险丝装载的 Azure 存储容器。
此属性与所有其他属性互相排斥。

azureFileShareConfiguration

要在每个节点上装载的 Azure 文件共享。
此属性与所有其他属性互相排斥。

cifsMountConfiguration

要在每个节点上装载的 CIFS/SMB 文件系统。
此属性与所有其他属性互相排斥。

nfsMountConfiguration

要在每个节点上装载的 NFS 文件系统。
此属性与所有其他属性互相排斥。

NameValuePair

表示一个名称-值对。

Name Type Description
name
  • string

名称-值对中的名称。

value
  • string

名称-值对中的值。

NetworkConfiguration

池的网络配置。

Name Type Description
dynamicVNetAssignmentScope

动态 vnet 分配的范围。

endpointConfiguration

批处理池中计算节点上的终结点的配置。
池终结点配置仅支持具有 virtualMachineConfiguration 属性的池。

publicIPAddressConfiguration

批处理池中计算节点的公共 Ip 地址配置。
只有具有 virtualMachineConfiguration 属性的池支持 "公共 IP 配置" 属性。

subnetId
  • string

池的计算节点将加入的虚拟网络子网的 ARM 资源标识符。 格式为/subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}。
虚拟网络必须与 Azure Batch 帐户位于同一区域和订阅中。 指定的子网应有足够的可用 IP 地址来容纳池中的计算节点数。 如果子网没有足够的可用 IP 地址,则该池将部分分配节点,并发生调整大小错误。 对于指定的 VNet,"MicrosoftAzureBatch" 服务主体必须具有 "经典虚拟机参与者" 基于角色的访问控制 (RBAC) 角色。 指定的子网必须允许来自 Azure Batch 服务的通信,才能计划节点上的任务。 可以通过检查指定的 VNet 是否有任何关联的网络安全组 (NSG) 来进行验证。 如果 NSG 拒绝与指定子网中的节点通信,则批处理服务会将计算节点的状态设置为 "不可用"。 对于用 virtualMachineConfiguration 创建的池,仅支持 ARM 虚拟网络 ( "/virtualNetworks" ) 支持,但对于通过 cloudServiceConfiguration 创建的池,支持 ARM 和经典虚拟网络。 如果指定的 VNet 存在关联的网络安全组 (NSG),则必须为入站通信启用数个保留的系统端口。 对于使用虚拟机配置创建的池,请启用端口29876和29877,以及端口22(适用于 Linux)和端口3389(适用于 Windows)。 对于使用云服务配置创建的池,请启用端口10100、20100和30100。 还可在端口443上启用到 Azure 存储的出站连接。 有关更多详细信息,请参阅: https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration

NetworkSecurityGroupRule

要应用于入站终结点的网络安全组规则。

Name Type Description
access

应为指定的 IP 地址、子网范围或标记执行的操作。

priority
  • integer

此规则的优先级。
池内的优先级必须唯一,并按优先级顺序进行评估。 编号越低,优先级越高。 例如,可以指定顺序号为150、250和350的规则。 订单号为150的规则优先于顺序为250的规则。 允许的优先级为150到4096。 如果提供任何保留值或重复值,请求会失败并出现 HTTP 状态代码400。

sourceAddressPrefix
  • string

要与规则匹配的源地址前缀或标记。
有效值为单个 IP 地址 (例如,10.10.10.10) 、IP 子网 (,例如 192.168.1.0/24) 、默认标记或 * (的所有地址。 如果提供了其他任何值,请求将失败,并出现 HTTP 状态代码400。

sourcePortRanges
  • string[]

要与规则匹配的源端口范围。
有效值为 "" (适用于所有端口 0-65535) 、特定端口 (如 22) 或端口范围 (100-200) 。端口必须介于0到65535之间。此集合中的每个条目不得与范围或单个端口) (的任何其他条目重叠。如果提供了其他任何值,请求将失败,并出现 HTTP 状态代码400。默认值为 ""。

NetworkSecurityGroupRuleAccess

应为指定的 IP 地址、子网范围或标记执行的操作。

Name Type Description
allow
  • string

允许访问。

deny
  • string

拒绝访问。

NFSMountConfiguration

用于连接到 NFS 文件系统的信息。

Name Type Description
mountOptions
  • string

要传递给 mount 命令的其他命令行选项。
这是 Windows 中的 "net use" 选项和 Linux 中的 "装载" 选项。

relativeMountPath
  • string

计算节点上将装载文件系统的相对路径
所有文件系统都是相对于批处理装载目录装载的,可通过 AZ_BATCH_NODE_MOUNTS_DIR 环境变量访问。

source
  • string

要装载的文件系统的 URI。

OnAllTasksComplete

当作业中的所有任务都处于 "已完成" 状态时,批处理服务应执行的操作。

Name Type Description
noaction
  • string

不执行任何操作。 作业将保持活动状态,除非通过其他方式终止或禁用。

terminatejob
  • string

终止作业。 作业的 terminateReason 设置为 "AllTasksComplete"。

OnTaskFailure

当作业中的任何任务失败时,Batch 服务应采取的操作。

Name Type Description
noaction
  • string

不执行任何操作。 作业将保持活动状态,除非通过其他方式终止或禁用。

performexitoptionsjobaction
  • string

执行任务的 exitConditions 集合中与任务退出条件相关联的操作。 (这可能仍会导致不执行任何操作(如果这是任务指定的)。 )

OutputFile

用于在批处理服务完成执行任务过程后将文件从 Azure Batch 计算节点上传到另一个位置的规范。

Name Type Description
destination

输出文件 () 的目标。

filePattern
  • string

指示要上传) (的文件的模式。
支持相对路径和绝对路径。 相对路径是相对于任务工作目录的路径。 支持以下通配符: * 匹配0个或多个字符 (例如,模式 abc * 将匹配 abc 或 abcdef) ,* * 匹配任何目录,? 匹配任何单个字符,[abc] 匹配括号中的一个字符,[c] 匹配范围中的一个字符。 方括号可以包含与未指定的任何字符匹配的反引号 (例如 [! abc] 匹配任何字符,而不是 a、b 或 c) 。 如果文件名以 "." 开头,则默认情况下它会被忽略,但它可以通过显式指定来进行匹配 (例如 ,gif 将不匹配 .a.gif,而是。 gif 将) 。 一个简单的示例: ** * .txt 与不以 "." 开头并且在任务工作目录或任何子目录中以 .txt 结尾的任何文件相匹配。如果文件名包含通配符,则可以使用方括号对其进行转义 (例如 abc [*] 将匹配名为 abc * ) 的文件。 请注意,在 Windows 上,和/均被视为目录分隔符,但仅在 Linux 上是/。 Windows 上的 (% var% 的环境变量或 Linux) 上的 $var 在应用模式之前扩展。

uploadOptions

用于上传操作的其他选项,包括执行上传的条件。

OutputFileBlobContainerDestination

指定 Azure blob 存储容器中的文件上传目标。

Name Type Description
containerUrl
  • string

要将文件上传到的 Azure Blob 存储中的容器的 URL) (。
URL 必须包含共享访问签名 (SAS) 授予对容器的写入权限。

path
  • string

Azure 存储容器中的目标 blob 或虚拟目录。
如果 filePattern 引用特定的文件 (即) 不包含通配符,则 path 是要将该文件上传到的 blob 的名称。 如果 filePattern 包含一个或多个 (的通配符,因此可能会将多个文件与) 相匹配,则 path 为 blob 虚拟目录的名称 (,该名称将附加到要上传 () 的文件) 。 如果省略,则会将文件 (s) 上传到 blob 名称与文件名称匹配的容器的根目录。

OutputFileDestination

应将文件上载到的目标。

Name Type Description
container

Azure blob 存储中要将文件上传到的位置。

OutputFileUploadCondition

应将任务输出文件或文件集上载到的条件。

Name Type Description
taskcompletion
  • string

在任务进程退出后,不管退出代码是什么,都将 (上传) 文件。

taskfailure
  • string

仅在任务进程以非零退出代码退出后,将文件 () 上传。

tasksuccess
  • string

仅在任务进程退出但退出代码为0的情况后,才) 上传 (的文件。

OutputFileUploadOptions

有关输出文件上传操作的详细信息,包括在哪些条件下执行上传。

Name Type Description
uploadCondition

任务输出文件或文件集应上载到的条件。
默认值为 taskcompletion。

PoolEndpointConfiguration

池的终结点配置。

Name Type Description
inboundNATPools

可用于在外部计算单独计算节点上的特定端口的入站 NAT 池列表。
每个批处理池的最大入站 NAT 池数为5。 如果超出最大入站 NAT 池数,请求将失败,并出现 HTTP 状态代码400。 如果 IPAddressProvisioningType 为 NoPublicIPAddresses,则不能指定此。

PoolInformation

指定应如何将作业分配到池。

Name Type Description
autoPoolSpecification

临时 "自动池" 的特征。 提交作业时,Batch 服务将创建此自动池。
如果自动创建池失败,批处理服务会将作业移到 "已完成" 状态,并在作业的 "计划错误" 属性中设置池创建错误。 批处理服务将管理生存期 (创建和,除非指定了 keepAlive,并删除了自动池) 。 当作业处于活动状态时,任何影响自动池生存期的用户操作都将导致意外行为。 你必须指定池 ID 或自动池规范,但不能同时指定两者。

poolId
  • string

现有池的 ID。 作业的所有任务将在指定的池上运行。
必须确保此属性引用的池存在。 如果在 Batch 服务尝试计划作业时池不存在,则在使用该 id 创建池之前,不会运行该作业的任务。请注意,Batch 服务不会拒绝作业请求;它只是在池存在之前不运行任务。 你必须指定池 ID 或自动池规范,但不能同时指定两者。

PoolLifetimeOption

创建的自动池的最小生存期,以及如何将多个作业分配到池。

Name Type Description
job
  • string

池存在于其专用作业的生存期内。 Batch 服务在创建该作业时创建池。 如果 "作业" 选项应用于作业计划,则批处理服务会为按计划创建的每个作业创建一个新的自动池。

jobschedule
  • string

此池存在于作业计划的生存期内。 批处理服务在创建该池的第一个作业时创建池。 只能将此选项应用于作业计划,而不能应用于作业。

PoolSpecification

用于创建新池的规范。

Name Type Description
applicationLicenses
  • string[]

Batch 服务将在池中的每个计算节点上提供的应用程序许可证列表。
应用程序许可证列表必须是可用 Batch 服务应用程序许可证的子集。 如果请求的许可证不受支持,则池的创建将失败。 池上可用的允许许可证为 "maya"、"vray"、"3dsmax"、"arnold"。 额外收费适用于添加到池中的每个应用程序许可证。

applicationPackageReferences

要安装在池中每个计算节点上的包的列表。
对包引用所做的更改将影响加入池的所有新节点,但不会影响池中已存在的计算节点,直到重新启动或重置映像。 对于任何给定的池,最多有10个包引用。

autoScaleEvaluationInterval
  • string

根据自动缩放公式自动调整池大小的时间间隔。
默认值为 15 分钟。 最小值和最大值分别为5分钟和168小时。 如果指定的值小于5分钟或大于168小时,批处理服务将拒绝具有无效属性值错误的请求;如果直接调用 REST API,HTTP 状态代码为 400 (请求) 错误。

autoScaleFormula
  • string

池中所需计算节点数的公式。
如果 enableAutoScale 设置为 false,则不能指定此属性。 如果将 enableAutoScale 设置为 true,则此参数是必需的。 在创建池之前,将检查该公式的有效性。 如果该公式无效,批处理服务将拒绝该请求,并提供详细的错误信息。

certificateReferences

要在池中的每个计算节点上安装的证书列表。
对于 Windows 节点,Batch 服务会将证书安装到指定的证书存储和位置。 对于 Linux 计算节点,证书存储在任务工作目录内的目录中,并且提供环境变量 AZ_BATCH_CERTIFICATES_DIR 向任务提供查询此位置。 对于 "remoteUser" 可见的证书,会在用户的主目录中创建 "证书" 目录, (例如,/home/{user-name}/certs) ,证书将放置在该目录中。

cloudServiceConfiguration

池的云服务配置。
如果需要创建 Azure PaaS Vm,则必须指定此属性。 此属性和 virtualMachineConfiguration 互相排斥,必须指定其中的一个属性。 如果两者都未指定,则批处理服务将返回错误;如果直接调用 REST API,HTTP 状态代码为 400 (请求) 错误。 如果在创建 Batch 帐户时将其 poolAllocationMode 属性设置为 "UserSubscription",则不能指定此属性。

displayName
  • string

池的显示名称。
显示名称无需唯一,并且最大长度为1024的任何 Unicode 字符。

enableAutoScale
  • boolean

池大小是否应随时间自动调整。
如果为 false,则必须至少指定 targetDedicateNodes 和 targetLowPriorityNodes 中的一个。 如果为 true,则 autoScaleFormula 元素是必需的。 池会根据公式自动调整大小。 默认值是 False。

enableInterNodeCommunication
  • boolean

池是否允许在计算节点之间进行直接通信。
启用节点间通信将限制池的最大大小,因为池的计算节点上存在部署限制。 这可能会导致池无法达到所需的大小。 默认值是 False。

metadata

作为元数据与池关联的名称-值对的列表。
Batch 服务不将任何意义分配给元数据;它仅用于用户代码。

mountConfiguration

要在池中的每个节点上装载的文件系统的列表。
这支持 Azure 文件、NFS、CIFS/SMB 和 Blobfuse。

networkConfiguration

池的网络配置。
池的网络配置。

resizeTimeout
  • string

将计算节点分配到池的超时时间。
此超时仅适用于手动缩放;当 enableAutoScale 设置为 true 时,它不起作用。 默认值为 15 分钟。 最小值为5分钟。 如果指定的值小于5分钟,则批处理服务会拒绝该请求并返回错误;如果直接调用 REST API,HTTP 状态代码为 400 (请求) 错误。

startTask

要在每个计算节点上运行的任务,因为它加入了池。 当计算节点添加到池或重启计算节点时,任务将运行。
在节点上触发恢复操作时,Batch 会重试任务。 恢复操作的示例包括 (,但不限于) 不正常节点重新启动或计算节点由于主机故障而消失。 因恢复操作而发生的重试与无关,不会对 maxTaskRetryCount 进行计数。 即使 maxTaskRetryCount 为0,也可能发生恢复操作导致的内部重试。 因此,所有任务都应该是幂等的。 这意味着任务需要容忍中断和重新启动,而不会导致数据损坏或重复数据。 长时间运行任务的最佳做法是使用某种形式的检查点。 在某些情况下,即使计算节点没有重新启动,也可以重新运行 StartTask。 应特别注意避免从 StartTask 工作目录创建 breakaway 进程或安装/启动服务的 StartTasks,因为这会阻止批处理重新运行 StartTask。

targetDedicatedNodes
  • integer

池中的专用计算节点数。
如果 enableAutoScale 设置为 true,则不能指定此属性。 如果 enableAutoScale 设置为 false,则必须设置 targetDedicatedNodes 和/或 targetLowPriorityNodes。

targetLowPriorityNodes
  • integer

池中所需的低优先级计算节点数。
如果 enableAutoScale 设置为 true,则不能指定此属性。 如果 enableAutoScale 设置为 false,则必须设置 targetDedicatedNodes 和/或 targetLowPriorityNodes。

taskSchedulingPolicy

如何在池中的计算节点之间分配任务。
如果未指定,则默认值为 "扩展"。

taskSlotsPerNode
  • integer

可用于在池中单个计算节点上运行并发任务的任务槽数。
默认值为 1。 最大值是 vmSize 的内核数的4倍或256。

userAccounts

要在池中的每个计算节点上创建的用户帐户的列表。

virtualMachineConfiguration

池的虚拟机配置。
如果需要通过 Azure IaaS Vm 创建池,则必须指定此属性。 此属性和 cloudServiceConfiguration 互相排斥,必须指定其中的一个属性。 如果两者都未指定,则批处理服务将返回错误;如果直接调用 REST API,HTTP 状态代码为 400 (请求) 错误。

vmSize
  • string

池中虚拟机的大小。 池中的所有虚拟机的大小相同。
有关池中虚拟机的可用大小的信息,请参阅在 Azure Batch 池中选择计算节点的 VM 大小 (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes) 。

PublicIPAddressConfiguration

池的网络配置的公共 IP 地址配置。

Name Type Description
ipAddressIds
  • string[]

批处理服务在预配计算节点时将使用的公共 Ip 的列表。
此处指定的 Ip 数目限制了可以为每个公共 IP 分配的最大池大小-100 专用节点或100低优先级节点。 例如,需要250专用 Vm 的池需要指定至少3个公共 Ip。 此集合中的每个元素的形式为:/subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}。

provision

池公共 IP 地址的设置类型。
默认值为 BatchManaged。

ResourceFile

要下载到计算节点的单个文件或多个文件。

Name Type Description
autoStorageContainerName
  • string

自动存储帐户中的存储容器名称。
AutoStorageContainerName、storageContainerUrl 和 httpUrl 属性互相排斥,必须指定其中的一个。

blobPrefix
  • string

从 Azure 存储容器下载 blob 时要使用的 blob 前缀。 只会下载名称以指定前缀开头的 blob。
仅当使用 autoStorageContainerName 或 storageContainerUrl 时,该属性才有效。 此前缀可以是部分文件名或子目录。 如果未指定前缀,则会下载容器中的所有文件。

fileMode
  • string

八进制格式的文件权限模式特性。
此属性仅适用于下载到 Linux 计算节点的文件。 如果为将下载到 Windows 计算节点的 resourceFile 指定了此方法,则会将其忽略。 如果没有为 Linux 计算节点指定此属性,则默认值0770将应用于该文件。

filePath
  • string

计算节点上要将文件下载到其中的位置(相对于任务的工作目录) () 。
如果指定了 httpUrl 属性,则需要 filePath,并描述文件将下载到的路径(包括文件名)。 否则,如果指定了 autoStorageContainerName 或 storageContainerUrl 属性,则 filePath 是可选的,是要将文件下载到的目录。 如果使用 filePath 作为目录,则已与输入数据关联的所有目录结构都将保留完整并追加到指定的 filePath 目录。 指定的相对路径不能从任务的工作目录中断开 (例如,使用 "...") 。

httpUrl
  • string

要下载的文件的 URL。
AutoStorageContainerName、storageContainerUrl 和 httpUrl 属性互相排斥,必须指定其中的一个。 如果 URL 指向 Azure Blob 存储,则必须使用匿名访问进行读取;也就是说,在下载 blob 时,批处理服务不会提供任何凭据。 可通过两种方式获取 Azure 存储中的 blob 的 URL:包含共享访问签名 (SAS) 授予对 blob 的读取权限,或设置 blob 或其容器的 ACL 以允许公共访问。

storageContainerUrl
  • string

Azure Blob 存储中的 blob 容器的 URL。
AutoStorageContainerName、storageContainerUrl 和 httpUrl 属性互相排斥,必须指定其中的一个。 此 URL 必须是可读的,并且可以使用匿名访问 listable;也就是说,从容器下载 blob 时,批处理服务不会提供任何凭据。 可通过两种方式获取 Azure 存储中容器的此类 URL:包含共享访问签名 (SAS) 授予对容器的读取和列出权限,或将容器的 ACL 设置为允许公共访问。

StartTask

当节点加入 Azure Batch 服务中的池或重启计算节点或重置映像时运行的任务。

Name Type Description
commandLine
  • string

StartTask 的命令行。
命令行不在 shell 下运行,因此无法利用 shell 功能,例如环境变量扩展。 如果要利用此类功能,应在命令行中调用 shell,例如,在 Windows 中使用 "cmd/c MyCommand" 或在 Linux 中使用 "/bin/sh-c MyCommand"。 如果命令行引用文件路径,则它应使用相对路径 (相对于任务工作目录) ,或使用 (批处理提供的环境变量 https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables) 。

containerSettings

StartTask 在其下运行的容器的设置。
如果指定了此项,则所有目录都将在该) 节点上的 Azure Batch 目录的根目录下递归 (AZ_BATCH_NODE_ROOT_DIR,并将其映射到容器中,所有任务环境变量将映射到该容器中,并在容器中执行任务命令行。 在 AZ_BATCH_NODE_ROOT_DIR 之外的容器中生成的文件可能不会反映到主机磁盘,这意味着批处理文件 Api 将无法访问这些文件。

environmentSettings

StartTask 的环境变量设置列表。

maxTaskRetryCount
  • integer

可以重试任务的最大次数。
如果任务的退出代码为非零,则 Batch 服务会重试该任务。 请注意,此值专门用于控制重试的次数。 批处理服务将尝试任务一次,然后可以重试此限制。 例如,如果最大重试计数为3,则批处理会将任务最多尝试4次, (首次尝试) 。 如果最大重试计数为0,则批处理服务不会重试任务。 如果最大重试计数为-1,则批处理服务将重试该任务,而不会受到限制。

resourceFiles

批处理服务在运行命令行之前将下载到计算节点的文件的列表。 资源文件列表的大小有最大值。 超过最大大小时,请求将失败,并且响应错误代码将为 RequestEntityTooLarge。 如果出现这种情况,则必须减小 ResourceFiles 的集合大小。 可以使用 .zip 文件、应用程序包或 Docker 容器实现此目的。
此元素下列出的文件位于任务的工作目录中。

userIdentity

StartTask 运行时所用的用户标识。
如果省略此项,任务将作为任务独有的非管理用户运行。

waitForSuccess
  • boolean

在计划计算节点上的任何任务之前,批处理服务是否应等待 StartTask 成功完成 (即,退出代码为 0) 。
如果为 true,并且 StartTask 在节点上失败,则批处理服务将重试 StartTask 最大重试计数 (maxTaskRetryCount) 。 如果在所有重试后任务仍未成功完成,则批处理服务会将该节点标记为不可用,而不会将任务计划给该节点。 可以通过计算节点状态和故障信息详细信息检测此条件。 如果为 false,则批处理服务将不等待 StartTask 完成。 在这种情况下,在 StartTask 仍在运行时,其他任务可以在计算节点上开始执行;即使 StartTask 发生故障,也仍会在计算节点上计划新的任务。 默认值为 true。

StorageAccountType

用于创建数据磁盘的存储帐户类型。

Name Type Description
premium_lrs
  • string

数据磁盘应使用高级本地冗余存储。

standard_lrs
  • string

数据磁盘应使用标准的本地冗余存储。

TaskConstraints

要应用于任务的执行约束。

Name Type Description
maxTaskRetryCount
  • integer

可以重试任务的最大次数。 如果任务的退出代码为非零,则 Batch 服务会重试该任务。
请注意,此值专门控制由于非零退出代码而导致任务可执行文件的重试次数。 批处理服务将尝试任务一次,然后可以重试此限制。 例如,如果最大重试计数为3,则批处理会将任务最多尝试4次, (首次尝试) 。 如果最大重试计数为0,则批处理服务在第一次尝试后不会重试任务。 如果最大重试计数为-1,则批处理服务将重试该任务,而不会受到限制。

maxWallClockTime
  • string

任务可运行的最长运行时间,从任务开始时间开始算起。 如果该任务未在时间限制内完成,批处理服务将终止该任务。
如果未指定此值,则任务可运行的时间长度没有限制。

retentionTime
  • string

将任务目录保留在运行时所在的计算节点上的最短时间(从执行完成时)。 此时间过后,Batch 服务可能会删除任务目录及其所有内容。
默认值为7天,即,任务目录将保留7天,除非删除计算节点或删除作业。

TaskContainerSettings

任务的容器设置。

Name Type Description
containerRunOptions
  • string

容器 create 命令的其他选项。
除了由 Batch 服务控制的参数外,还会将这些附加选项作为参数提供给 "docker create" 命令。

imageName
  • string

用于创建将在其中运行任务的容器的图像。
这是完整的映像引用,正如指定给 "docker pull"。 如果图像名称中不提供标记,则使用标记 ":最新的" 作为默认值。

registry

包含容器映像的专用注册表。
如果在创建池时已提供此设置,则可以将其省略。

workingDirectory

容器任务工作目录的位置。
默认值为 "taskWorkingDirectory"。

TaskSchedulingPolicy

指定应如何在计算节点之间分布任务。

Name Type Description
nodeFillType

如何在池中的计算节点之间分配任务。
如果未指定,则默认值为 "扩展"。

UserAccount

用于创建用于在 Azure Batch 计算节点上执行任务的用户的属性。

Name Type Description
elevationLevel

用户帐户的提升级别。
默认值为 nonAdmin。

linuxUserConfiguration

用户帐户的特定于 Linux 的用户配置。
如果在 Windows 池上指定,则忽略此属性。 如果未指定,则将用默认选项创建用户。

name
  • string

用户帐户的名称。

password
  • string

用户帐户的密码。

windowsUserConfiguration

用户帐户的特定于 Windows 的用户配置。
仅当用户在 Windows 池上时,才能指定此属性。 如果未指定,并且在 Windows 池上,则使用默认选项创建用户。

UserIdentity

运行任务的用户标识的定义。

Name Type Description
autoUser

运行任务的自动用户。
UserName 和 autoUser 属性互相排斥;您必须指定一个,但不能同时指定两者。

username
  • string

运行任务的用户标识的名称。
UserName 和 autoUser 属性互相排斥;您必须指定一个,但不能同时指定两者。

VirtualMachineConfiguration

基于 Azure 虚拟机基础结构的池中的计算节点的配置。

Name Type Description
containerConfiguration

池的容器配置。
如果指定,则会在池中的每个计算节点上执行安装程序,以允许在容器中运行任务。 在此池上运行的所有常规任务和作业管理器任务必须指定 containerSettings 属性,并且所有其他任务都可以指定它。

dataDisks

附加到池中的计算节点的数据磁盘的配置。
如果池中的计算节点需要附加空数据磁盘,则必须指定此属性。 这不能更新。 每个计算节点都获取自己的磁盘, (磁盘不是) 的文件共享。 无法附加现有磁盘,每个附加磁盘都为空。 从池中删除计算节点后,还会删除该磁盘及其关联的所有数据。 磁盘在附加后不会格式化,必须在使用之前对其进行格式化-有关详细信息,请参阅 https://docs.microsoft.com/en-us/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linuxhttps://docs.microsoft.com/en-us/azure/virtual-machines/windows/attach-disk-ps#add-an-empty-data-disk-to-a-virtual-machine

diskEncryptionConfiguration

池的磁盘加密配置。
如果已指定,则在节点预配期间,在池中的每个节点上执行加密。

imageReference

引用要使用的 Azure 虚拟机 Marketplace 映像或自定义虚拟机映像。

licenseType
  • string

部署操作系统时使用的本地许可证的类型。
这仅适用于包含 Windows 操作系统的映像,只应在为要部署的计算节点保留有效的本地许可证时使用。 如果省略,则不应用任何本地许可折扣。 值为:

Windows_Server-本地许可证适用于 Windows Server。 Windows_Client-本地许可证适用于 Windows 客户端。

nodeAgentSKUId
  • string

要在池中的计算节点上预配的批处理计算节点代理的 SKU。
Batch 计算节点代理是在池中的每个计算节点上运行的程序,并提供计算节点与 Batch 服务之间的命令和控制接口。 对于不同操作系统,计算节点代理有不同的实现(称为 Sku)。 您必须指定与所选图像引用匹配的计算节点代理 SKU。 若要获取支持的计算节点代理 Sku 列表及其验证的映像引用列表,请参阅 "列出支持的计算节点代理 Sku" 操作。

windowsConfiguration

虚拟机上的 Windows 操作系统设置。
如果 imageReference 属性指定 Linux OS 映像,则不能指定此属性。

WindowsConfiguration

要应用于虚拟机的 Windows 操作系统设置。

Name Type Description
enableAutomaticUpdates
  • boolean

是否在虚拟机上启用了自动更新。
如果省略,则默认值为 true。

WindowsUserConfiguration

用于在 Windows 计算节点上创建用户帐户的属性。

Name Type Description
loginMode

用户的登录模式
VirtualMachineConfiguration 池的默认值为 "batch",CloudServiceConfiguration 池的默认值为 "interactive"。