Task - Add

对 Batch 服务的请求成功。

标头

• client-request-id: string
• request-id: string
• ETag: string
• Last-Modified: string
• DataServiceId: string

BatchError

Batch 服务中的错误。

string

表示计算节点的位置或以前运行的任务的不透明字符串。
可以传递 Node 的 affinityId，以指示此任务需要在该计算节点上运行。 请注意，这只是软相关性。 如果目标计算节点在计划任务时繁忙或不可用，则任务将在其他位置进行计划。

string

要部署的应用程序的 ID。
创建池时，包的应用程序 ID 必须完全限定（/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}）。

string

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

AccessScope[]

令牌向其授予访问权限的 Batch 资源。
身份验证令牌授予对一组有限 Batch 服务操作的访问权限。 目前，访问属性唯一支持的值是“job”，它授予对包含 Task 的作业相关的所有操作的访问权限。

ElevationLevel

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

AutoUserScope

自动用户的范围
默认值为池。 如果池正在运行 Windows，则应指定任务值（如果需要在任务之间进行更严格的隔离）。 例如，如果任务以可能影响其他任务的方式改变注册表，或者已在池中指定了证书，而该池中不应通过正常任务访问，但应可由 StartTasks 访问。

string

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

ErrorMessage

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

BatchErrorDetail[]

包含有关错误的更多详细信息的键值对的集合。

string

指定 Value 属性含义的标识符。

string

错误响应附带的其他信息。

string

用户分配标识的 ARM 资源 ID。

boolean

将此源路径装载为只读模式或不装载。 默认值为 false（读/写模式）。
对于 Linux，如果将此路径装载为读/写模式，这并不意味着容器中的所有用户都具有路径的读/写访问权限，这取决于主机 VM 中的访问。 如果此路径装载为只读，则容器中的所有用户将无法修改路径。

ContainerHostDataPath

装载到容器客户的路径可以选择。

ComputeNodeIdentityReference

对用于访问 Azure 容器注册表（而不是用户名和密码）的用户分配标识的引用。
对与计算节点将使用的 Batch 池关联的用户分配标识的引用。

string

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

string

注册表 URL。
如果省略，则默认值为“docker.io”。

string

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

string

环境变量的名称。

string

环境变量的值。

string

错误消息的语言代码

string

消息的文本。

integer (int32)

进程退出代码。

ExitOptions

如果任务使用此退出代码退出，Batch 服务应如何响应。

integer (int32)

范围中的最后一个退出代码。

ExitOptions

如果任务退出且范围中的退出代码开始到结束（含），Batch 服务应如何响应。

integer (int32)

区域中的第一个退出代码。

ExitOptions

如果任务失败且其他任何属性未涵盖退出条件，Batch 服务应如何响应。
如果在 exitCodes 或 exitCodeRanges 集合中未列出的任何非零退出代码退出任务退出，如果 preProcessingError 属性不存在，则使用预处理错误;如果 fileUploadError 属性不存在，则使用文件上传错误。 如果要对退出代码 0 执行非默认行为，则必须使用 exitCodes 或 exitCodeRanges 集合显式列出它。

ExitCodeRangeMapping[]

任务退出代码范围的列表以及 Batch 服务应如何响应它们。

ExitCodeMapping[]

单个任务退出代码的列表以及 Batch 服务应如何响应它们。

ExitOptions

如果发生文件上传错误，Batch 服务应如何响应。
如果任务使用通过 exitCodes 或 exitCodeRanges 指定的退出代码退出，然后遇到文件上传错误，则退出代码指定的操作优先。

ExitOptions

如果任务因错误而无法启动，Batch 服务应如何响应。

DependencyAction

Batch 服务对依赖于此任务的任务执行的操作。
可能的值为“满足”（允许依赖任务进行）和“阻止”（依赖任务继续等待）。 Batch 尚不支持取消依赖任务。

JobAction

如果任务以给定退出条件完成且 Job 的 onTaskFailed 属性为“performExitOptionsJobAction”，则对包含任务的作业执行的操作。
对于退出代码 0，默认值为 none，并终止所有其他退出条件。 如果 Job 的 onTaskFailed 属性为 noaction，则指定此属性将返回错误，并且添加任务请求失败并显示无效的属性值错误;如果直接调用 REST API，则 HTTP 状态代码为 400（请求错误）。

string

上传输出文件时要使用的标头的不区分大小写的名称

string

上传输出文件时要使用的标头的值

ResourceFile[]

在运行协调命令行之前，Batch 服务将下载的文件列表。
常见资源文件和任务资源文件之间的差异是，所有子任务（包括主任务）都会下载通用资源文件，而任务资源文件仅为主要任务下载。 另请注意，这些资源文件不会下载到任务工作目录，而是下载到任务根目录（工作目录上方的一个目录）。 资源文件列表的最大大小。 超过最大大小时，请求将失败，响应错误代码将为 RequestEntityTooLarge。 如果发生这种情况，则必须减小 ResourceFiles 的集合大小。 这可以使用 .zip 文件、应用程序包或 Docker 容器来实现。

string

要在所有计算节点上运行的命令行，以便在主节点运行主任务命令时进行协调。
典型的协调命令行启动后台服务，并验证该服务是否已准备好处理节点间消息。

integer (int32)

任务所需的计算节点数。
如果省略，则默认值为 1。

OutputFileDestination

输出文件的目标。

string

指示要上传的文件的模式。
支持相对路径和绝对路径。 相对路径相对于 Task 工作目录。 支持以下通配符：* 匹配 0 个或多个字符（例如模式 abc* 将匹配 abc 或 abcdef），** 匹配任何目录？ 匹配任何单个字符，[abc] 匹配括号中的一个字符，[a-c] 匹配区域中的一个字符。 括号可以包含求反，以匹配未指定的任何字符（例如 [！abc] 匹配任何字符，但 b 或 c）。 如果文件名以“.”开头，则默认将其忽略，但可通过显式指定它进行匹配（例如，.gif 与 .a.gif不匹配，但会匹配。.gif）。 一个简单的示例：***.txt 匹配任何不以“.”开头的文件，并在任务工作目录中或任何子目录中以 .txt 结尾。 如果文件名包含通配符，则可以使用方括号进行转义（例如 abc[] 将匹配名为 abc的文件）。 请注意，\和/都被视为 Windows 上的目录分隔符，但只有 /在 Linux 上。 在应用模式之前，环境变量（在 Windows 上%var% 或 Linux 上的$var）会扩展。

OutputFileUploadOptions

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

string

要上传到文件的 Azure Blob 存储中的容器的 URL。
如果未使用托管标识，则 URL 必须包含向容器授予写入权限的共享访问签名（SAS）。

ComputeNodeIdentityReference

对用于访问 containerUrl 指定的 Azure Blob 存储的用户分配标识的引用
标识必须具有对 Azure Blob 存储容器的写入访问权限

string

Azure 存储容器中的目标 Blob 或虚拟目录。
如果 filePattern 引用特定文件（即不包含通配符），则路径是要上传到该文件的 blob 的名称。 如果 filePattern 包含一个或多个通配符（因此可能与多个文件匹配），则路径是 Blob 虚拟目录的名称（前面追加到每个 blob 名称），以便将文件上传到其中。 如果省略，文件将上传到容器的根目录，其 blob 名称与其文件名匹配。

HttpHeader[]

要用于上传输出文件的标头的名称/值对列表
将文件上传到 Azure 存储时，将指定这些标头。 上传 blob 时允许的标头的官方文档：https://free.blessedness.top/rest/api/storageservices/put-blob#request-headers-all-blob-types

OutputFileBlobContainerDestination

将文件上传到的 Azure Blob 存储中的一个位置。

OutputFileUploadCondition

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

string

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

string

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

string

以八进制格式的文件权限模式属性。
此属性仅适用于下载到 Linux 计算节点的文件。 如果为将下载到 Windows 计算节点的 resourceFile 指定，将忽略它。 如果未为 Linux 计算节点指定此属性，则会将默认值 0770 应用于该文件。

string

要下载文件（s）的计算节点上相对于任务的工作目录的位置。
如果指定了 httpUrl 属性，则需要 filePath，并描述文件将下载到的路径，包括文件名。 否则，如果指定 autoStorageContainerName 或 storageContainerUrl 属性，则 filePath 是可选的，并且是将文件下载到的目录。 如果 filePath 用作目录，则与输入数据关联的任何目录结构都将完整保留并追加到指定的 filePath 目录。 指定的相对路径不能脱离 Task 的工作目录（例如，使用'..'）。

string

要下载的文件的 URL。
autoStorageContainerName、storageContainerUrl 和 httpUrl 属性互斥，必须指定其中一个属性。 如果 URL 指向 Azure Blob 存储，则必须从计算节点读取该 URL。 可通过三种方法获取 Azure 存储中 Blob 的此类 URL：包括授予对 Blob 的读取权限的共享访问签名（SAS），使用具有读取权限的托管标识，或为 Blob 或其容器设置 ACL 以允许公共访问。

ComputeNodeIdentityReference

对用户分配的标识的引用，用于访问由 storageContainerUrl 或 httpUrl 指定的 Azure Blob 存储
对与计算节点将使用的 Batch 池关联的用户分配标识的引用。

string

Azure Blob 存储中 Blob 容器的 URL。
autoStorageContainerName、storageContainerUrl 和 httpUrl 属性互斥，必须指定其中一个属性。 此 URL 必须可从计算节点读取和列出。 可通过三种方法获取 Azure 存储中容器的此类 URL：包括授予对容器的读取和列表权限的共享访问签名（SAS），使用具有读取和列表权限的托管标识，或为容器设置 ACL 以允许公共访问。

AffinityInformation

Batch 服务可以使用的区域提示选择要启动新任务的计算节点。

ApplicationPackageReference[]

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

AuthenticationTokenSettings

任务可用于执行 Batch 服务操作的身份验证令牌的设置。
警告：此对象已弃用，将于 2024 年 9 月 30 日之后删除。 有关详细信息，请参阅https://azure.microsoft.com/updates?id=azure-batch-task-authentication-token-will-be-retired-on-30-september-2024

string

任务的命令行。
对于多实例任务，在主任务和所有子任务完成执行协调命令行后，命令行将作为主任务执行。 命令行未在 shell 下运行，因此不能利用 shell 功能（如环境变量扩展）。 如果要利用这些功能，则应在命令行中调用 shell，例如在 Windows 中使用“cmd /c MyCommand”或在 Linux 中使用“/bin/sh -c MyCommand”。 如果命令行引用文件路径，则应使用相对路径（相对于任务工作目录），或使用 Batch 提供的环境变量（https://free.blessedness.top/azure/batch/batch-compute-node-environment-variables）。

TaskConstraints

应用于此任务的执行约束。
如果未指定约束，maxTaskRetryCount 是为作业指定的 maxTaskRetryCount，maxWallClockTime 是无限的，并且 retentionTime 为 7 天。

TaskContainerSettings

任务在其中运行的容器的设置。
如果运行此任务的池已设置 containerConfiguration 集，则还必须设置该池。 如果运行此任务的池没有 containerConfiguration 集，则不能设置此设置。 指定此项后，AZ_BATCH_NODE_ROOT_DIR（节点上的 Azure Batch 目录的根目录）以递归方式映射到容器中，所有任务环境变量都映射到容器中，并在容器中执行 Task 命令行。 在AZ_BATCH_NODE_ROOT_DIR外部容器中生成的文件可能不会反映在主机磁盘上，这意味着 Batch 文件 API 将无法访问这些文件。

TaskDependencies

此任务所依赖的任务。
除非它依赖的所有任务都成功完成，否则不会计划此任务。 如果其中任一任务失败并耗尽其重试计数，则永远不会计划此任务。 如果作业没有将 UsesTaskDependencies 设置为 true，并且此元素存在，则请求将失败并显示错误代码 TaskDependenciesNotSpecifiedOnJob。

string

任务的显示名称。
显示名称不一定是唯一的，可以包含最大长度为 1024 的任何 Unicode 字符。

EnvironmentSetting[]

任务的环境变量设置列表。

ExitConditions

指定 Batch 服务在任务完成时应如何响应。
Batch 服务在任务完成时应如何响应。

string

唯一标识作业中的任务的字符串。
ID 可以包含字母数字字符（包括连字符和下划线）的任意组合，并且不能包含超过 64 个字符。 ID 是区分大小写和不区分大小写的（也就是说，你可能在一个作业中没有两个 ID，只因大小写而异）。

MultiInstanceSettings

一个对象，指示任务是多实例任务，并包含有关如何运行多实例任务的信息。
多实例任务通常用于支持 MPI 任务。 在 MPI 情况下，如果任何子任务都失败（例如由于退出并包含非零退出代码），则整个多实例任务会失败。 然后终止并重试多实例任务，达到其重试限制。

OutputFile[]

运行命令行后，Batch 服务将从计算节点上传的文件列表。
对于多实例任务，文件将仅从执行主任务的计算节点上传。

integer (int32)

任务运行所需的计划槽数。
默认值为 1。 如果节点有足够的可用计划槽，则只能计划任务在计算节点上运行。 对于多实例任务，这必须是 1。

ResourceFile[]

Batch 服务在运行命令行之前将下载到计算节点的文件列表。
对于多实例任务，资源文件将仅下载到执行主任务的计算节点。 资源文件列表的最大大小。 超过最大大小时，请求将失败，响应错误代码将为 RequestEntityTooLarge。 如果发生这种情况，则必须减小 ResourceFiles 的集合大小。 这可以使用 .zip 文件、应用程序包或 Docker 容器来实现。

UserIdentity

运行任务的用户标识。
如果省略，任务将作为任务唯一的非管理用户运行。

integer (int32)

可以重试任务的最大次数。 如果 Batch 服务退出代码为非零，则重试任务。
请注意，由于非零退出代码，此值专门控制任务可执行文件的重试次数。 Batch 服务将尝试一次任务，然后可能会重试到此限制。 例如，如果最大重试计数为 3，Batch 将尝试任务最多 4 次（一次初始尝试和 3 次重试）。 如果最大重试计数为 0，则 Batch 服务不会在第一次尝试后重试任务。 如果最大重试计数为 -1，Batch 服务将重试任务，但不建议用于启动任务或任何任务。 默认值为 0（无重试）。

string (duration)

任务可能运行的最大运行时间，从任务开始时间开始测量。 如果任务未在时间限制内完成，Batch 服务将终止它。
如果未指定此项，则任务可能运行的时间没有时间限制。

string (duration)

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

ContainerHostBatchBindMountEntry[]

要装载到容器任务的路径。
如果此数组为 null 或不存在，容器任务将在 Windows 中装载整个临时磁盘驱动器（或 Linux 中的AZ_BATCH_NODE_ROOT_DIR）。 如果此数组设置为空，则不会将任何数据路径装载到容器中。

string

容器创建命令的其他选项。
除了 Batch 服务控制的选项外，这些附加选项还作为“docker create”命令的参数提供。

string

用于创建任务将在其中运行容器的映像。
这是完整的映像引用，如指定为“docker pull”。 如果未将标记作为映像名称的一部分提供，则标记“：latest”将用作默认值。

ContainerRegistry

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

ContainerWorkingDirectory

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

TaskIdRange[]

此任务所依赖的任务 ID 范围列表。 在计划依赖任务之前，所有范围中的所有任务都必须成功完成。

string[]

此任务所依赖的任务 ID 列表。 此列表中的所有任务都必须成功完成，然后才能计划依赖任务。
taskIds 集合的总数限制为 64000 个字符（即所有任务 ID 的组合长度）。 如果 taskIds 集合超出最大长度，则添加任务请求失败，错误代码为 TaskDependencyListTooLong。 在这种情况下，请考虑改用任务 ID 范围。

integer (int32)

区域中的最后一个任务 ID。

integer (int32)

区域中的第一个任务 ID。

AutoUserSpecification

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

string

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