你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

StartTask interface

参考

包:: @azure/arm-batch

在某些情况下，即使节点未重新启动，启动任务也可能重新运行。因此，启动任务应是幂等的，如果它们正在执行的设置已经完成，则应正常退出。应特别小心，避免启动任务创建分离进程或从启动任务工作目录安装/启动服务，因为这样会阻止 Batch 重新运行启动任务。

属性

commandLine	命令行不在 shell 下运行，因此无法利用 shell 功能，例如环境变量扩展。如果要利用此类功能，则应在命令行中调用 shell，例如在 Windows 中使用“cmd /c MyCommand”或在 Linux 中使用“/bin/sh -c MyCommand”。如果指定了 startTask 的任何其他属性，则为必需。
containerSettings	指定此项后，AZ_BATCH_NODE_ROOT_DIR (节点上) Azure Batch目录的根目录以递归方式映射到容器中，所有任务环境变量都映射到容器中，并在容器中执行任务命令行。
environmentSettings	启动任务的环境变量设置列表。
maxTaskRetryCount	批处理服务在其退出代码非零时重试任务。请注意，此值专门用于控制重试的次数。批处理服务将尝试任务一次，然后重试，直至达到此上限为止。例如，如果最大重试计数为 3 次，则 Batch (一次初始尝试最多尝试 4 次，) 重试 3 次。如果最大重试计数为 0，Batch 服务不会重试该任务。如果最大重试计数为 -1，Batch 服务将无限制地重试任务。默认值为 0
resourceFiles	在运行命令行之前，Batch 服务将下载到计算节点的文件列表。
userIdentity	如果省略，任务将作为任务唯一的非管理用户运行。
waitForSuccess	如果为 true，并且计算节点上的启动任务失败，Batch 服务会将启动任务重试到其最大重试次数 (maxTaskRetryCount) 。如果所有重试后任务仍未成功完成，Batch 服务会将计算节点标记为不可用，并且不会为其计划任务。可以通过节点状态和计划错误详细信息来检测此情况。如果为 false，则 Batch 服务不会等待启动任务完成。在这种情况下，当启动任务仍在运行时，其他任务可以在计算节点上开始执行;即使启动任务失败，也将继续在节点上安排新任务。默认值为 true。

属性详细信息

commandLine

命令行不在 shell 下运行，因此无法利用 shell 功能，例如环境变量扩展。如果要利用此类功能，则应在命令行中调用 shell，例如在 Windows 中使用“cmd /c MyCommand”或在 Linux 中使用“/bin/sh -c MyCommand”。如果指定了 startTask 的任何其他属性，则为必需。

commandLine?: string

属性值

string

containerSettings

指定此项后，AZ_BATCH_NODE_ROOT_DIR (节点上) Azure Batch目录的根目录以递归方式映射到容器中，所有任务环境变量都映射到容器中，并在容器中执行任务命令行。

containerSettings?: TaskContainerSettings

属性值

TaskContainerSettings

environmentSettings

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

environmentSettings?: EnvironmentSetting[]

属性值

EnvironmentSetting[]

maxTaskRetryCount

批处理服务在其退出代码非零时重试任务。请注意，此值专门用于控制重试的次数。批处理服务将尝试任务一次，然后重试，直至达到此上限为止。例如，如果最大重试计数为 3 次，则 Batch (一次初始尝试最多尝试 4 次，) 重试 3 次。如果最大重试计数为 0，Batch 服务不会重试该任务。如果最大重试计数为 -1，Batch 服务将无限制地重试任务。默认值为 0

maxTaskRetryCount?: number

属性值

number

resourceFiles

在运行命令行之前，Batch 服务将下载到计算节点的文件列表。

resourceFiles?: ResourceFile[]

属性值

ResourceFile[]

userIdentity

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

userIdentity?: UserIdentity

属性值

UserIdentity

waitForSuccess

如果为 true，并且计算节点上的启动任务失败，Batch 服务会将启动任务重试到其最大重试次数 (maxTaskRetryCount) 。如果所有重试后任务仍未成功完成，Batch 服务会将计算节点标记为不可用，并且不会为其计划任务。可以通过节点状态和计划错误详细信息来检测此情况。如果为 false，则 Batch 服务不会等待启动任务完成。在这种情况下，当启动任务仍在运行时，其他任务可以在计算节点上开始执行;即使启动任务失败，也将继续在节点上安排新任务。默认值为 true。

waitForSuccess?: boolean

属性值

boolean

通过