BatchTaskCreateOptions interface

包:

@azure-rest/batch

用于创建 Azure Batch 任务的参数。

属性

affinityInfo	Batch 服务可以使用的区域提示选择要启动新任务的计算节点。
applicationPackageReferences	Batch 服务在运行命令行之前将部署到计算节点的包列表。 应用程序包下载并部署到共享目录，而不是任务工作目录。 因此，如果引用的包已在节点上，并且是最新的，则不会重新下载它;使用计算节点上的现有副本。 如果无法安装引用的包，例如由于包已删除或下载失败，则任务将失败。
authenticationTokenSettings	任务可用于执行 Batch 服务作的身份验证令牌的设置。 如果设置了此属性，Batch 服务会向任务提供身份验证令牌，该令牌可用于对 Batch 服务作进行身份验证，而无需帐户访问密钥。 令牌通过AZ_BATCH_AUTHENTICATION_TOKEN环境变量提供。 任务可以使用令牌执行的作取决于设置。 例如，任务可以请求作业权限，以便将其他任务添加到作业，或检查作业的状态或作业下的其他任务的状态。
commandLine	任务的命令行。 对于多实例任务，在主任务和所有子任务完成执行协调命令行后，命令行将作为主任务执行。 命令行未在 shell 下运行，因此不能利用 shell 功能（如环境变量扩展）。 如果要利用这些功能，则应在命令行中调用 shell，例如在 Windows 中使用“cmd /c MyCommand”或在 Linux 中使用“/bin/sh -c MyCommand”。 如果命令行引用文件路径，则应使用相对路径（相对于任务工作目录），或使用 Batch 提供的环境变量（https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables）。
constraints	应用于此任务的执行约束。 如果未指定约束，maxTaskRetryCount 是为作业指定的 maxTaskRetryCount，maxWallClockTime 是无限的，并且 retentionTime 为 7 天。
containerSettings	任务在其中运行的容器的设置。 如果运行此任务的池已设置 containerConfiguration 集，则还必须设置该池。 如果运行此任务的池没有 containerConfiguration 集，则不能设置此设置。 指定此项后，AZ_BATCH_NODE_ROOT_DIR（节点上的 Azure Batch 目录的根目录）以递归方式映射到容器中，所有任务环境变量都映射到容器中，并在容器中执行 Task 命令行。 在AZ_BATCH_NODE_ROOT_DIR外部容器中生成的文件可能不会反映在主机磁盘上，这意味着 Batch 文件 API 将无法访问这些文件。
dependsOn	此任务所依赖的任务。 除非它依赖的所有任务都成功完成，否则不会计划此任务。 如果其中任一任务失败并耗尽其重试计数，则永远不会计划此任务。 如果作业没有将 UsesTaskDependencies 设置为 true，并且此元素存在，则请求将失败并显示错误代码 TaskDependenciesNotSpecifiedOnJob。
displayName	任务的显示名称。 显示名称不一定是唯一的，可以包含最大长度为 1024 的任何 Unicode 字符。
environmentSettings	任务的环境变量设置列表。
exitConditions	Batch 服务在任务完成时应如何响应。
id	唯一标识作业中的任务的字符串。 ID 可以包含字母数字字符（包括连字符和下划线）的任意组合，并且不能包含超过 64 个字符。 ID 是区分大小写和不区分大小写的（也就是说，你可能在一个作业中没有两个 ID，只因大小写而异）。
multiInstanceSettings	一个对象，指示任务是多实例任务，并包含有关如何运行多实例任务的信息。
outputFiles	运行命令行后，Batch 服务将从计算节点上传的文件列表。 对于多实例任务，文件将仅从执行主任务的计算节点上传。
requiredSlots	任务运行所需的计划槽数。 默认值为 1。 如果节点有足够的可用计划槽，则只能计划任务在计算节点上运行。 对于多实例任务，这必须是 1。
resourceFiles	Batch 服务在运行命令行之前将下载到计算节点的文件列表。 对于多实例任务，资源文件将仅下载到执行主任务的计算节点。 资源文件列表的最大大小。 超过最大大小时，请求将失败，响应错误代码将为 RequestEntityTooLarge。 如果发生这种情况，则必须减小 ResourceFiles 的集合大小。 这可以使用 .zip 文件、应用程序包或 Docker 容器来实现。
userIdentity	运行任务的用户标识。 如果省略，任务将作为任务唯一的非管理用户运行。

属性详细信息

affinityInfo

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

affinityInfo?: BatchAffinityInfo

属性值

BatchAffinityInfo

applicationPackageReferences

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

applicationPackageReferences?: BatchApplicationPackageReference[]

属性值

BatchApplicationPackageReference[]

authenticationTokenSettings

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

authenticationTokenSettings?: AuthenticationTokenSettings

属性值

AuthenticationTokenSettings

commandLine

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

commandLine: string

属性值

string

constraints

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

constraints?: BatchTaskConstraints

属性值

BatchTaskConstraints

containerSettings

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

containerSettings?: BatchTaskContainerSettings

属性值

BatchTaskContainerSettings

dependsOn

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

dependsOn?: BatchTaskDependencies

属性值

BatchTaskDependencies

displayName

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

displayName?: string

属性值

string

environmentSettings

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

environmentSettings?: EnvironmentSetting[]

属性值

EnvironmentSetting[]

exitConditions

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

exitConditions?: ExitConditions

属性值

ExitConditions

id

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

id: string

属性值

string

multiInstanceSettings

一个对象，指示任务是多实例任务，并包含有关如何运行多实例任务的信息。

multiInstanceSettings?: MultiInstanceSettings

属性值

MultiInstanceSettings

outputFiles

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

outputFiles?: OutputFile[]

属性值

OutputFile[]

requiredSlots

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

requiredSlots?: number

属性值

number

resourceFiles

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

resourceFiles?: ResourceFile[]

属性值

ResourceFile[]

userIdentity

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

userIdentity?: UserIdentity

属性值

UserIdentity