BatchClient class

Client class for accessing Azure Batch service.

构造函数

BatchClient(string, TokenCredential | AzureNamedKeyCredential, BatchClientOptionalParams)

方法

createJob(BatchJobCreateOptions, CreateJobOptionalParams)	批处理服务支持两种控制作业中完成工作的方式。第一种方法是用户指定一个作业管理器任务。批处理服务在准备开始作业时启动该任务。作业管理器任务通过任务API控制所有在该作业下运行的其他任务。在第二种方法中，用户通过任务API直接控制活跃作业下的任务执行。另外请注意：命名作业时，避免包含用户名或秘密项目名称等敏感信息。这些信息可能出现在 Microsoft 支持部门工程师可访问的遥测日志中。
createJobSchedule(BatchJobScheduleCreateOptions, CreateJobScheduleOptionalParams)	为指定的账户创建工作计划。
createNodeUser(string, string, BatchNodeUserCreateOptions, CreateNodeUserOptionalParams)	只有在计算节点处于空闲或运行状态时，你才能向其添加用户账户。在远程登录计算节点之前，必须配置SSH和RDP的访问端口。有关详细信息，请参阅 https://learn.microsoft.com/azure/batch/pool-endpoint-configuration
createPool(BatchPoolCreateOptions, CreatePoolOptionalParams)	命名池时，请避免包括敏感信息，例如用户名或机密项目名称。这些信息可能出现在 Microsoft 支持部门工程师可访问的遥测日志中。
createTask(string, BatchTaskCreateOptions, CreateTaskOptionalParams)	任务从添加到完成的最长寿命为180天。如果任务在添加后180天内未完成，批处理服务将终止该任务，并保持当时的状态。
createTaskCollection(string, BatchTaskGroup, CreateTaskCollectionOptionalParams)	注意每个任务必须有一个唯一的ID。批处理服务不得按照任务提交顺序返回每个任务的结果。如果服务器超时或请求过程中连接关闭，请求可能已部分或全部处理，甚至根本未被处理。在这种情况下，用户应重新发出请求。请注意，用户在重新发送请求时需自行正确处理失败。例如，你应在重试时使用相同的任务ID，这样如果上一次作成功，重试时不会意外生成额外的任务。如果响应中包含任何未添加的任务，客户端可以重新尝试该请求。在重试中，最高效的做法是只重新提交那些未能添加的任务，省略首次尝试时成功添加的任务。任务从添加到完成的最长寿命为180天。如果任务在添加后180天内未完成，批处理服务将终止该任务，并保持当时的状态。
deallocateNode(string, string, DeallocateNodeOptionalParams)	仅当计算节点处于空闲或正在运行状态时，才能解除分配。
deleteJob(string, DeleteJobOptionalParams)	删除一个作业还会删除该工作中所有的任务和所有工作统计数据。这也会覆盖任务数据的保留期;也就是说，如果作业包含仍保留在计算节点上的任务，批处理服务会删除这些任务的工作目录及其所有内容。当收到删除作业请求时，批处理服务会将作业设置为删除状态。所有处于删除状态的作业更新作都会失败，状态代码为409（冲突），并会有额外信息表明该任务正在被删除。
deleteJobSchedule(string, DeleteJobScheduleOptionalParams)	删除作业计划时，这也会删除该计划下的所有作业和任务。删除任务后，也会删除计算节点上工作目录中的所有文件（将忽略保留期）。删除作业计划后，作业计划统计信息将不再可访问，尽管这些统计信息仍计入帐户生存期统计信息。
deleteNodeFile(string, string, string, DeleteNodeFileOptionalParams)	从计算节点中删除指定文件。
deleteNodeUser(string, string, string, DeleteNodeUserOptionalParams)	仅当用户帐户处于空闲或正在运行状态时，才能将其删除到计算节点。在远程登录计算节点之前，必须配置SSH和RDP的访问端口。有关详细信息，请参阅 https://learn.microsoft.com/azure/batch/pool-endpoint-configuration
deletePool(string, DeletePoolOptionalParams)	请求删除池时，会发生以下作：池状态设置为删除;正在对池执行的任何调整大小作将停止;Batch 服务开始将池大小调整为零个计算节点;在现有计算节点上运行的任何任务将终止并重新排队（就好像使用默认重新排队选项请求了调整池大小作一样）：最后，将从系统中删除池。由于重新排队运行的任务，因此用户可以通过将作业更新为面向其他池来重新运行这些任务。然后，任务可以在新的池上运行。如果要重写重新排队行为，则应在删除池之前显式调用调整池大小以将池收缩为零大小。如果在删除状态下对池调用更新、修补或删除 API，它将失败并显示 HTTP 状态代码 409，错误代码为 PoolBeingDeleted。
deleteTask(string, string, DeleteTaskOptionalParams)	删除任务后，也会删除运行任务的计算节点上目录中的所有文件（无论保留时间如何）。对于多实例任务，删除任务作将同步应用于主任务;子任务及其文件随后在后台异步删除。
deleteTaskFile(string, string, string, DeleteTaskFileOptionalParams)	从运行任务的计算节点中删除指定的任务文件。
disableJob(string, BatchJobDisableOptions, DisableJobOptionalParams)	批处理服务会立即将作业移至禁用状态。 Batch 随后使用 disableTasks 参数来决定当前作业中正在运行的任务的处理方式。作业保持禁用状态，直到禁用作完成且所有任务都按照 disableTasks 选项处理完毕;工作随后转为残疾状态。在工作恢复为激活状态之前，不会启动新的任务。如果你尝试禁用一个处于非激活、禁用或禁用状态的作业，请求会以状态代码409失败。
disableJobSchedule(string, DisableJobScheduleOptionalParams)	在再次启用作业计划之前，不会创建新作业。
disableNodeScheduling(string, string, DisableNodeSchedulingOptionalParams)	只有当计算节点当前调度状态被启用时，才能禁用任务调度。
disablePoolAutoScale(string, DisablePoolAutoScaleOptionalParams)	禁用池的自动缩放。
enableJob(string, EnableJobOptionalParams)	当你调用这个 API 时，批处理服务会将一个被禁用的作业设置为启用状态。完成此作后，作业进入活跃状态，作业下的新任务调度恢复。批处理服务不允许任务在活跃状态中停留超过180天。因此，如果你启用包含180天以上新增的活跃任务的作业，这些任务将无法运行。
enableJobSchedule(string, EnableJobScheduleOptionalParams)	启用作业计划。
enableNodeScheduling(string, string, EnableNodeSchedulingOptionalParams)	只有当计算节点当前调度状态被禁用时，你才能启用任务调度
enablePoolAutoScale(string, BatchPoolEnableAutoScaleOptions, EnablePoolAutoScaleOptionalParams)	如果池上的调整大小操作正在进行中，则无法对池启用自动缩放。如果当前禁用了池的自动缩放，则必须将有效的自动缩放公式指定为请求的一部分。如果已启用池的自动缩放，可以指定新的自动缩放公式和/或新的评估间隔。不能每隔 30 秒多次为同一池调用此 API。
evaluatePoolAutoScale(string, BatchPoolEvaluateAutoScaleOptions, EvaluatePoolAutoScaleOptionalParams)	此 API 主要用于验证自动缩放公式，因为它只是返回结果而不将公式应用于池。池必须启用自动缩放才能评估公式。
getApplication(string, GetApplicationOptionalParams)	此作仅返回可用于计算节点的应用程序和版本;也就是说，可以用于包引用。如需管理员了解尚未向计算节点开放的应用和版本，请使用Azure门户或Azure资源管理器API。
getJob(string, GetJobOptionalParams)	获取关于指定职位的信息。
getJobSchedule(string, GetJobScheduleOptionalParams)	获取关于指定工作时间表的信息。
getJobTaskCounts(string, GetJobTaskCountsOptionalParams)	任务计数按活动、正在运行或已完成的任务状态以及成功或失败的任务计数提供任务计数。处于准备状态的任务计为正在运行。请注意，返回的数字可能并不总是最新的。如果需要确切的任务计数，请使用列表查询。
getNode(string, string, GetNodeOptionalParams)	获取有关指定计算节点的信息。
getNodeExtension(string, string, string, GetNodeExtensionOptionalParams)	获取关于指定计算节点扩展的信息。
getNodeFile(string, string, string, GetNodeFileOptionalParams)	返回指定的计算节点文件内容。
getNodeFileProperties(string, string, string, GetNodeFilePropertiesOptionalParams)	获取指定计算节点文件的属性。
getNodeRemoteLoginSettings(string, string, GetNodeRemoteLoginSettingsOptionalParams)	在通过远程登录设置远程登录计算节点之前，必须在计算节点创建用户账户，并配置SSH和RDP的访问端口。有关详细信息，请参阅 https://learn.microsoft.com/azure/batch/pool-endpoint-configuration
getPool(string, GetPoolOptionalParams)	获取有关指定池的信息。
getTask(string, string, GetTaskOptionalParams)	对于多实例任务，affinityId、executionInfo 和 nodeInfo 等信息指代主任务。使用列表子任务 API 来获取子任务的信息。
getTaskFile(string, string, string, GetTaskFileOptionalParams)	返回指定的任务文件内容。
getTaskFileProperties(string, string, string, GetTaskFilePropertiesOptionalParams)	获取指定任务文件的属性。
jobScheduleExists(string, JobScheduleExistsOptionalParams)	检查指定的作业排程是否存在。
listApplications(ListApplicationsOptionalParams)	此作仅返回可用于计算节点的应用程序和版本;也就是说，可以用于包引用。如需获取尚未向计算节点开放的应用和版本的管理员信息，请使用Azure门户或Azure资源管理器API。
listJobPreparationAndReleaseTaskStatus(string, ListJobPreparationAndReleaseTaskStatusOptionalParams)	此 API 返回运行作业准备或作业发布任务的所有计算节点上的作业准备和作业发布任务状态。这包括从池中删除的计算节点。如果在没有作业准备或作业发布任务的作业上调用此 API，Batch 服务将返回 HTTP 状态代码 409（冲突），并返回 JobPreparationTaskNotSpecified 的错误代码。
listJobs(ListJobsOptionalParams)	列出指定账户中的所有职位。
listJobSchedules(ListJobSchedulesOptionalParams)	列出指定账户中的所有工作计划。
listJobsFromSchedule(string, ListJobsFromScheduleOptionalParams)	列出根据指定作业计划创建的职位。
listNodeExtensions(string, string, ListNodeExtensionsOptionalParams)	列出指定池中的计算节点扩展。
listNodeFiles(string, string, ListNodeFilesOptionalParams)	列出指定计算节点上的任务目录中的所有文件。
listNodes(string, ListNodesOptionalParams)	列出指定池中的计算节点。
listPoolNodeCounts(ListPoolNodeCountsOptionalParams)	获取按池分组的每个状态中的计算节点数。请注意，返回的数字可能并不总是最新的。如果需要确切的节点计数，请使用列表查询。
listPools(ListPoolsOptionalParams)	列出指定帐户中的所有池。
listPoolUsageMetrics(ListPoolUsageMetricsOptionalParams)	如果未指定包含 poolId 的$filter子句，响应将包括帐户中存在的所有池，这些池在返回的聚合间隔的时间范围内存在。如果未指定$filter子句（包括 startTime 或 endTime），则这些筛选器默认为当前可用的最后一个聚合间隔的开始和结束时间;即，仅返回最后一个聚合间隔。
listSubTasks(string, string, ListSubTasksOptionalParams)	如果任务不是多实例任务，则返回空集合。
listSupportedImages(ListSupportedImagesOptionalParams)	列出Azure Batch服务支持的所有虚拟机映像。
listTaskFiles(string, string, ListTaskFilesOptionalParams)	列出任务目录中的计算节点上的文件。
listTasks(string, ListTasksOptionalParams)	对于多实例任务，affinityId、executionInfo 和 nodeInfo 等信息指代主任务。使用列表子任务 API 来获取子任务的信息。
poolExists(string, PoolExistsOptionalParams)	获得池的基本属性。
reactivateTask(string, string, ReactivateTaskOptionalParams)	重新激活使任务有资格再次重试，最大重试计数。任务的状态更改为活动状态。由于任务不再处于已完成状态，因此重新激活后不再提供任何以前的退出代码或失败信息。每次重新激活任务时，其重试计数将重置为 0。对于未完成或以前成功完成的任务，重新激活将失败（退出代码为 0）。此外，如果作业已完成（或正在终止或删除），它将失败。
rebootNode(string, string, RebootNodeOptionalParams)	仅当计算节点处于空闲或正在运行状态时，才能重启计算节点。
reimageNode(string, string, ReimageNodeOptionalParams)	仅当操作系统处于空闲或正在运行状态时，才能在计算节点上重新安装操作系统。该 API 只能在基于云服务配置属性创建的池中调用。
removeNodes(string, BatchNodeRemoveOptions, RemoveNodesOptionalParams)	此作只能在池的分配状态稳定时运行。此作运行时，分配状态将从稳定更改为调整大小。每个请求最多可以删除 100 个节点。
replaceJob(string, BatchJob, ReplaceJobOptionalParams)	这完全取代了工作中所有可更新的属性。例如，如果作业与其关联约束，且请求中未指定约束，那么批处理服务将移除现有约束。
replaceJobSchedule(string, BatchJobSchedule, ReplaceJobScheduleOptionalParams)	这完全取代了工作计划中所有可更新的属性。例如，如果该请求未指定调度属性，批处理服务将删除现有的调度。对作业计划的更改只会影响更新后由该计划创建的作业;目前运行的职位不受影响。
replaceNodeUser(string, string, string, BatchNodeUserUpdateOptions, ReplaceNodeUserOptionalParams)	此作替换了账户中所有可更新的属性。例如，如果未指定到期时间元素，当前值会被替换为默认值，而不会保持不修改。只有在计算节点处于空闲或运行状态时，你才能更新计算节点上的用户账户。
replacePoolProperties(string, BatchPoolReplaceOptions, ReplacePoolPropertiesOptionalParams)	这完全取代了池中所有可更新的属性。例如，如果池中有关联的 StartTask，且该请求未指定 StartTask，那么批处理服务将删除现有的 StartTask。
replaceTask(string, string, BatchTask, ReplaceTaskOptionalParams)	更新指定任务的属性。
resizePool(string, BatchPoolResizeOptions, ResizePoolOptionalParams)	仅当池的分配状态稳定时，才能调整池的大小。如果池已调整大小，则请求失败，状态代码为 409。调整池大小时，池的分配状态会从稳定更改为调整大小。无法调整为自动缩放配置的池的大小。如果尝试执行此作，Batch 服务将返回错误 409。如果向下调整池的大小，Batch 服务会选择要删除的计算节点。若要删除特定的计算节点，请使用池删除计算节点 API。
startNode(string, string, StartNodeOptionalParams)	只有当计算节点已被释放时，才能启动它。
stopPoolResize(string, StopPoolResizeOptionalParams)	这不会将池恢复到调整大小作前的状态：它只是停止了后续的更改，池保持当前状态。停止作后，池会稳定在停止作时的计算节点数。在停止作过程中，池分配状态先变为停止，再变为稳。调整大小作不一定是显式的调整容量池请求;该 API 还可以在创建池时停止初始大小。
terminateJob(string, TerminateJobOptionalParams)	当收到终止作业请求时，批处理服务会将作业设置为终止状态。批处理服务随后终止与作业相关的正在运行任务，并执行所需的作业释放任务。然后工作进入完成状态。如果工作中有任何任务处于活跃状态，它们将保持在活跃状态。一旦作业终止，就无法添加新的任务，且剩余的活跃任务也不会被安排。
terminateJobSchedule(string, TerminateJobScheduleOptionalParams)	终止作业计划。
terminateTask(string, string, TerminateTaskOptionalParams)	任务终止后，它会移动到已完成状态。对于多实例任务，终止任务作将同步应用于主任务;子任务随后在后台异步终止。
updateJob(string, BatchJobUpdateOptions, UpdateJobOptionalParams)	这只替换请求中指定的工作属性。例如，如果作业有约束，且请求未指定约束元素，则作业保留现有约束。
updateJobSchedule(string, BatchJobScheduleUpdateOptions, UpdateJobScheduleOptionalParams)	这只替换了请求中指定的作业计划属性。例如，如果该请求未指定调度属性，批处理服务将保留现有的调度。对作业计划的更改只会影响更新后由该计划创建的作业;目前运行的职位不受影响。
updatePool(string, BatchPoolUpdateOptions, UpdatePoolOptionalParams)	这只替换了请求中指定的池属性。例如，如果池中关联了一个 StartTask，而请求没有指定 StartTask 元素，那么池会保留现有的 StartTask。
uploadNodeLogs(string, string, UploadBatchServiceLogsOptions, UploadNodeLogsOptionalParams)	这是为了在你遇到错误并希望升级到Azure支持时，自动从计算节点收集Azure批处理服务日志文件。应与Azure 支持共享Azure Batch服务日志文件，以帮助调试 Batch 服务的问题。

BatchClient(string, TokenCredential | AzureNamedKeyCredential, BatchClientOptionalParams)

new BatchClient(endpointParam: string, credential: TokenCredential | AzureNamedKeyCredential, options?: BatchClientOptionalParams)

参数

endpointParam: string

credential: TokenCredential | AzureNamedKeyCredential

options: BatchClientOptionalParams

createJob(BatchJobCreateOptions, CreateJobOptionalParams)

批处理服务支持两种控制作业中完成工作的方式。第一种方法是用户指定一个作业管理器任务。批处理服务在准备开始作业时启动该任务。作业管理器任务通过任务API控制所有在该作业下运行的其他任务。在第二种方法中，用户通过任务API直接控制活跃作业下的任务执行。另外请注意：命名作业时，避免包含用户名或秘密项目名称等敏感信息。这些信息可能出现在 Microsoft 支持部门工程师可访问的遥测日志中。

function createJob(job: BatchJobCreateOptions, options?: CreateJobOptionalParams): Promise<void>

参数

job: BatchJobCreateOptions

options: CreateJobOptionalParams

返回

Promise<void>

createJobSchedule(BatchJobScheduleCreateOptions, CreateJobScheduleOptionalParams)

为指定的账户创建工作计划。

function createJobSchedule(jobSchedule: BatchJobScheduleCreateOptions, options?: CreateJobScheduleOptionalParams): Promise<void>

参数

jobSchedule: BatchJobScheduleCreateOptions

options: CreateJobScheduleOptionalParams

返回

Promise<void>

createNodeUser(string, string, BatchNodeUserCreateOptions, CreateNodeUserOptionalParams)

只有在计算节点处于空闲或运行状态时，你才能向其添加用户账户。在远程登录计算节点之前，必须配置SSH和RDP的访问端口。有关详细信息，请参阅 https://learn.microsoft.com/azure/batch/pool-endpoint-configuration

function createNodeUser(poolId: string, nodeId: string, user: BatchNodeUserCreateOptions, options?: CreateNodeUserOptionalParams): Promise<void>

参数

poolId: string

nodeId: string

user: BatchNodeUserCreateOptions

options: CreateNodeUserOptionalParams

返回

Promise<void>

createPool(BatchPoolCreateOptions, CreatePoolOptionalParams)

命名池时，请避免包括敏感信息，例如用户名或机密项目名称。这些信息可能出现在 Microsoft 支持部门工程师可访问的遥测日志中。

function createPool(pool: BatchPoolCreateOptions, options?: CreatePoolOptionalParams): Promise<void>

参数

pool: BatchPoolCreateOptions

options: CreatePoolOptionalParams

返回

Promise<void>

createTask(string, BatchTaskCreateOptions, CreateTaskOptionalParams)

任务从添加到完成的最长寿命为180天。如果任务在添加后180天内未完成，批处理服务将终止该任务，并保持当时的状态。

function createTask(jobId: string, task: BatchTaskCreateOptions, options?: CreateTaskOptionalParams): Promise<void>

参数

jobId: string

task: BatchTaskCreateOptions

options: CreateTaskOptionalParams

返回

Promise<void>

createTaskCollection(string, BatchTaskGroup, CreateTaskCollectionOptionalParams)

注意每个任务必须有一个唯一的ID。批处理服务不得按照任务提交顺序返回每个任务的结果。如果服务器超时或请求过程中连接关闭，请求可能已部分或全部处理，甚至根本未被处理。在这种情况下，用户应重新发出请求。请注意，用户在重新发送请求时需自行正确处理失败。例如，你应在重试时使用相同的任务ID，这样如果上一次作成功，重试时不会意外生成额外的任务。如果响应中包含任何未添加的任务，客户端可以重新尝试该请求。在重试中，最高效的做法是只重新提交那些未能添加的任务，省略首次尝试时成功添加的任务。任务从添加到完成的最长寿命为180天。如果任务在添加后180天内未完成，批处理服务将终止该任务，并保持当时的状态。

function createTaskCollection(jobId: string, taskCollection: BatchTaskGroup, options?: CreateTaskCollectionOptionalParams): Promise<BatchCreateTaskCollectionResult>

参数

jobId: string

taskCollection: BatchTaskGroup

options: CreateTaskCollectionOptionalParams

返回

Promise<BatchCreateTaskCollectionResult>

deallocateNode(string, string, DeallocateNodeOptionalParams)

仅当计算节点处于空闲或正在运行状态时，才能解除分配。

function deallocateNode(poolId: string, nodeId: string, options?: DeallocateNodeOptionalParams): PollerLike<OperationState<void>, void>

参数

poolId: string

nodeId: string

options: DeallocateNodeOptionalParams

返回

PollerLike<OperationState<void>, void>

deleteJob(string, DeleteJobOptionalParams)

删除一个作业还会删除该工作中所有的任务和所有工作统计数据。这也会覆盖任务数据的保留期;也就是说，如果作业包含仍保留在计算节点上的任务，批处理服务会删除这些任务的工作目录及其所有内容。当收到删除作业请求时，批处理服务会将作业设置为删除状态。所有处于删除状态的作业更新作都会失败，状态代码为409（冲突），并会有额外信息表明该任务正在被删除。

function deleteJob(jobId: string, options?: DeleteJobOptionalParams): PollerLike<OperationState<void>, void>

参数

jobId: string

options: DeleteJobOptionalParams

返回

PollerLike<OperationState<void>, void>

deleteJobSchedule(string, DeleteJobScheduleOptionalParams)

删除作业计划时，这也会删除该计划下的所有作业和任务。删除任务后，也会删除计算节点上工作目录中的所有文件（将忽略保留期）。删除作业计划后，作业计划统计信息将不再可访问，尽管这些统计信息仍计入帐户生存期统计信息。

function deleteJobSchedule(jobScheduleId: string, options?: DeleteJobScheduleOptionalParams): PollerLike<OperationState<void>, void>

参数

jobScheduleId: string

options: DeleteJobScheduleOptionalParams

返回

PollerLike<OperationState<void>, void>

deleteNodeFile(string, string, string, DeleteNodeFileOptionalParams)

从计算节点中删除指定文件。

function deleteNodeFile(poolId: string, nodeId: string, filePath: string, options?: DeleteNodeFileOptionalParams): Promise<void>

参数

poolId: string

nodeId: string

filePath: string

options: DeleteNodeFileOptionalParams

返回

Promise<void>

deleteNodeUser(string, string, string, DeleteNodeUserOptionalParams)

仅当用户帐户处于空闲或正在运行状态时，才能将其删除到计算节点。在远程登录计算节点之前，必须配置SSH和RDP的访问端口。有关详细信息，请参阅 https://learn.microsoft.com/azure/batch/pool-endpoint-configuration

function deleteNodeUser(poolId: string, nodeId: string, userName: string, options?: DeleteNodeUserOptionalParams): Promise<void>

参数

poolId: string

nodeId: string

userName: string

options: DeleteNodeUserOptionalParams

返回

Promise<void>

deletePool(string, DeletePoolOptionalParams)

请求删除池时，会发生以下作：池状态设置为删除;正在对池执行的任何调整大小作将停止;Batch 服务开始将池大小调整为零个计算节点;在现有计算节点上运行的任何任务将终止并重新排队（就好像使用默认重新排队选项请求了调整池大小作一样）：最后，将从系统中删除池。由于重新排队运行的任务，因此用户可以通过将作业更新为面向其他池来重新运行这些任务。然后，任务可以在新的池上运行。如果要重写重新排队行为，则应在删除池之前显式调用调整池大小以将池收缩为零大小。如果在删除状态下对池调用更新、修补或删除 API，它将失败并显示 HTTP 状态代码 409，错误代码为 PoolBeingDeleted。

function deletePool(poolId: string, options?: DeletePoolOptionalParams): PollerLike<OperationState<void>, void>

参数

poolId: string

options: DeletePoolOptionalParams

返回

PollerLike<OperationState<void>, void>

deleteTask(string, string, DeleteTaskOptionalParams)

删除任务后，也会删除运行任务的计算节点上目录中的所有文件（无论保留时间如何）。对于多实例任务，删除任务作将同步应用于主任务;子任务及其文件随后在后台异步删除。

function deleteTask(jobId: string, taskId: string, options?: DeleteTaskOptionalParams): Promise<void>

参数

jobId: string

taskId: string

options: DeleteTaskOptionalParams

返回

Promise<void>

deleteTaskFile(string, string, string, DeleteTaskFileOptionalParams)

从运行任务的计算节点中删除指定的任务文件。

function deleteTaskFile(jobId: string, taskId: string, filePath: string, options?: DeleteTaskFileOptionalParams): Promise<void>

参数

jobId: string

taskId: string

filePath: string

options: DeleteTaskFileOptionalParams

返回

Promise<void>

disableJob(string, BatchJobDisableOptions, DisableJobOptionalParams)

批处理服务会立即将作业移至禁用状态。 Batch 随后使用 disableTasks 参数来决定当前作业中正在运行的任务的处理方式。作业保持禁用状态，直到禁用作完成且所有任务都按照 disableTasks 选项处理完毕;工作随后转为残疾状态。在工作恢复为激活状态之前，不会启动新的任务。如果你尝试禁用一个处于非激活、禁用或禁用状态的作业，请求会以状态代码409失败。

function disableJob(jobId: string, disableOptions: BatchJobDisableOptions, options?: DisableJobOptionalParams): PollerLike<OperationState<void>, void>

参数

jobId: string

disableOptions: BatchJobDisableOptions

options: DisableJobOptionalParams

返回

PollerLike<OperationState<void>, void>

disableJobSchedule(string, DisableJobScheduleOptionalParams)

在再次启用作业计划之前，不会创建新作业。

function disableJobSchedule(jobScheduleId: string, options?: DisableJobScheduleOptionalParams): Promise<void>

参数

jobScheduleId: string

options: DisableJobScheduleOptionalParams

返回

Promise<void>

disableNodeScheduling(string, string, DisableNodeSchedulingOptionalParams)

只有当计算节点当前调度状态被启用时，才能禁用任务调度。

function disableNodeScheduling(poolId: string, nodeId: string, options?: DisableNodeSchedulingOptionalParams): Promise<void>

参数

poolId: string

nodeId: string

options: DisableNodeSchedulingOptionalParams

返回

Promise<void>

disablePoolAutoScale(string, DisablePoolAutoScaleOptionalParams)

禁用池的自动缩放。

function disablePoolAutoScale(poolId: string, options?: DisablePoolAutoScaleOptionalParams): Promise<void>

参数

poolId: string

options: DisablePoolAutoScaleOptionalParams

返回

Promise<void>

enableJob(string, EnableJobOptionalParams)

当你调用这个 API 时，批处理服务会将一个被禁用的作业设置为启用状态。完成此作后，作业进入活跃状态，作业下的新任务调度恢复。批处理服务不允许任务在活跃状态中停留超过180天。因此，如果你启用包含180天以上新增的活跃任务的作业，这些任务将无法运行。

function enableJob(jobId: string, options?: EnableJobOptionalParams): PollerLike<OperationState<void>, void>

参数

jobId: string

options: EnableJobOptionalParams

返回

PollerLike<OperationState<void>, void>

enableJobSchedule(string, EnableJobScheduleOptionalParams)

启用作业计划。

function enableJobSchedule(jobScheduleId: string, options?: EnableJobScheduleOptionalParams): Promise<void>

参数

jobScheduleId: string

options: EnableJobScheduleOptionalParams

返回

Promise<void>

enableNodeScheduling(string, string, EnableNodeSchedulingOptionalParams)

只有当计算节点当前调度状态被禁用时，你才能启用任务调度

function enableNodeScheduling(poolId: string, nodeId: string, options?: EnableNodeSchedulingOptionalParams): Promise<void>

参数

poolId: string

nodeId: string

options: EnableNodeSchedulingOptionalParams

返回

Promise<void>

enablePoolAutoScale(string, BatchPoolEnableAutoScaleOptions, EnablePoolAutoScaleOptionalParams)

如果池上的调整大小操作正在进行中，则无法对池启用自动缩放。如果当前禁用了池的自动缩放，则必须将有效的自动缩放公式指定为请求的一部分。如果已启用池的自动缩放，可以指定新的自动缩放公式和/或新的评估间隔。不能每隔 30 秒多次为同一池调用此 API。

function enablePoolAutoScale(poolId: string, enableAutoScaleOptions: BatchPoolEnableAutoScaleOptions, options?: EnablePoolAutoScaleOptionalParams): Promise<void>

参数

poolId: string

enableAutoScaleOptions: BatchPoolEnableAutoScaleOptions

options: EnablePoolAutoScaleOptionalParams

返回

Promise<void>

evaluatePoolAutoScale(string, BatchPoolEvaluateAutoScaleOptions, EvaluatePoolAutoScaleOptionalParams)

此 API 主要用于验证自动缩放公式，因为它只是返回结果而不将公式应用于池。池必须启用自动缩放才能评估公式。

function evaluatePoolAutoScale(poolId: string, evaluateAutoScaleOptions: BatchPoolEvaluateAutoScaleOptions, options?: EvaluatePoolAutoScaleOptionalParams): Promise<AutoScaleRun>

参数

poolId: string

evaluateAutoScaleOptions: BatchPoolEvaluateAutoScaleOptions

options: EvaluatePoolAutoScaleOptionalParams

返回

Promise<AutoScaleRun>

getApplication(string, GetApplicationOptionalParams)

此作仅返回可用于计算节点的应用程序和版本;也就是说，可以用于包引用。如需管理员了解尚未向计算节点开放的应用和版本，请使用Azure门户或Azure资源管理器API。

function getApplication(applicationId: string, options?: GetApplicationOptionalParams): Promise<BatchApplication>

参数

applicationId: string

options: GetApplicationOptionalParams

返回

Promise<BatchApplication>

getJob(string, GetJobOptionalParams)

获取关于指定职位的信息。

function getJob(jobId: string, options?: GetJobOptionalParams): Promise<BatchJob>

参数

jobId: string

options: GetJobOptionalParams

返回

Promise<BatchJob>

getJobSchedule(string, GetJobScheduleOptionalParams)

获取关于指定工作时间表的信息。

function getJobSchedule(jobScheduleId: string, options?: GetJobScheduleOptionalParams): Promise<BatchJobSchedule>

参数

jobScheduleId: string

options: GetJobScheduleOptionalParams

返回

Promise<BatchJobSchedule>

getJobTaskCounts(string, GetJobTaskCountsOptionalParams)

任务计数按活动、正在运行或已完成的任务状态以及成功或失败的任务计数提供任务计数。处于准备状态的任务计为正在运行。请注意，返回的数字可能并不总是最新的。如果需要确切的任务计数，请使用列表查询。

function getJobTaskCounts(jobId: string, options?: GetJobTaskCountsOptionalParams): Promise<BatchTaskCountsResult>

参数

jobId: string

options: GetJobTaskCountsOptionalParams

返回

Promise<BatchTaskCountsResult>

getNode(string, string, GetNodeOptionalParams)

获取有关指定计算节点的信息。

function getNode(poolId: string, nodeId: string, options?: GetNodeOptionalParams): Promise<BatchNode>

参数

poolId: string

nodeId: string

options: GetNodeOptionalParams

返回

Promise<BatchNode>

getNodeExtension(string, string, string, GetNodeExtensionOptionalParams)

获取关于指定计算节点扩展的信息。

function getNodeExtension(poolId: string, nodeId: string, extensionName: string, options?: GetNodeExtensionOptionalParams): Promise<BatchNodeVMExtension>

参数

poolId: string

nodeId: string

extensionName: string

options: GetNodeExtensionOptionalParams

返回

Promise<BatchNodeVMExtension>

getNodeFile(string, string, string, GetNodeFileOptionalParams)

返回指定的计算节点文件内容。

function getNodeFile(poolId: string, nodeId: string, filePath: string, options?: GetNodeFileOptionalParams): Promise<Uint8Array>

参数

poolId: string

nodeId: string

filePath: string

options: GetNodeFileOptionalParams

返回

Promise<Uint8Array>

getNodeFileProperties(string, string, string, GetNodeFilePropertiesOptionalParams)

获取指定计算节点文件的属性。

function getNodeFileProperties(poolId: string, nodeId: string, filePath: string, options?: GetNodeFilePropertiesOptionalParams): Promise<BatchNodeFile>

参数

poolId: string

nodeId: string

filePath: string

options: GetNodeFilePropertiesOptionalParams

返回

Promise<BatchNodeFile>

getNodeRemoteLoginSettings(string, string, GetNodeRemoteLoginSettingsOptionalParams)

在通过远程登录设置远程登录计算节点之前，必须在计算节点创建用户账户，并配置SSH和RDP的访问端口。有关详细信息，请参阅 https://learn.microsoft.com/azure/batch/pool-endpoint-configuration

function getNodeRemoteLoginSettings(poolId: string, nodeId: string, options?: GetNodeRemoteLoginSettingsOptionalParams): Promise<BatchNodeRemoteLoginSettings>

参数

poolId: string

nodeId: string

options: GetNodeRemoteLoginSettingsOptionalParams

返回

Promise<BatchNodeRemoteLoginSettings>

getPool(string, GetPoolOptionalParams)

获取有关指定池的信息。

function getPool(poolId: string, options?: GetPoolOptionalParams): Promise<BatchPool>

参数

poolId: string

options: GetPoolOptionalParams

返回

Promise<BatchPool>

getTask(string, string, GetTaskOptionalParams)

对于多实例任务，affinityId、executionInfo 和 nodeInfo 等信息指代主任务。使用列表子任务 API 来获取子任务的信息。

function getTask(jobId: string, taskId: string, options?: GetTaskOptionalParams): Promise<BatchTask>

参数

jobId: string

taskId: string

options: GetTaskOptionalParams

返回

Promise<BatchTask>

getTaskFile(string, string, string, GetTaskFileOptionalParams)

返回指定的任务文件内容。

function getTaskFile(jobId: string, taskId: string, filePath: string, options?: GetTaskFileOptionalParams): Promise<Uint8Array>

参数

jobId: string

taskId: string

filePath: string

options: GetTaskFileOptionalParams

返回

Promise<Uint8Array>

getTaskFileProperties(string, string, string, GetTaskFilePropertiesOptionalParams)

获取指定任务文件的属性。

function getTaskFileProperties(jobId: string, taskId: string, filePath: string, options?: GetTaskFilePropertiesOptionalParams): Promise<BatchNodeFile>

参数

jobId: string

taskId: string

filePath: string

options: GetTaskFilePropertiesOptionalParams

返回

Promise<BatchNodeFile>

jobScheduleExists(string, JobScheduleExistsOptionalParams)

检查指定的作业排程是否存在。

function jobScheduleExists(jobScheduleId: string, options?: JobScheduleExistsOptionalParams): Promise<boolean>

参数

jobScheduleId: string

options: JobScheduleExistsOptionalParams

返回

Promise<boolean>

listApplications(ListApplicationsOptionalParams)

此作仅返回可用于计算节点的应用程序和版本;也就是说，可以用于包引用。如需获取尚未向计算节点开放的应用和版本的管理员信息，请使用Azure门户或Azure资源管理器API。

function listApplications(options?: ListApplicationsOptionalParams): PagedAsyncIterableIterator<BatchApplication, BatchApplication[], PageSettings>

参数

options: ListApplicationsOptionalParams

返回

PagedAsyncIterableIterator<BatchApplication, BatchApplication[], PageSettings>

listJobPreparationAndReleaseTaskStatus(string, ListJobPreparationAndReleaseTaskStatusOptionalParams)

此 API 返回运行作业准备或作业发布任务的所有计算节点上的作业准备和作业发布任务状态。这包括从池中删除的计算节点。如果在没有作业准备或作业发布任务的作业上调用此 API，Batch 服务将返回 HTTP 状态代码 409（冲突），并返回 JobPreparationTaskNotSpecified 的错误代码。

function listJobPreparationAndReleaseTaskStatus(jobId: string, options?: ListJobPreparationAndReleaseTaskStatusOptionalParams): PagedAsyncIterableIterator<BatchJobPreparationAndReleaseTaskStatus, BatchJobPreparationAndReleaseTaskStatus[], PageSettings>

参数

jobId: string

options: ListJobPreparationAndReleaseTaskStatusOptionalParams

返回

PagedAsyncIterableIterator<BatchJobPreparationAndReleaseTaskStatus, BatchJobPreparationAndReleaseTaskStatus[], PageSettings>

listJobs(ListJobsOptionalParams)

列出指定账户中的所有职位。

function listJobs(options?: ListJobsOptionalParams): PagedAsyncIterableIterator<BatchJob, BatchJob[], PageSettings>

参数

options: ListJobsOptionalParams

返回

PagedAsyncIterableIterator<BatchJob, BatchJob[], PageSettings>

listJobSchedules(ListJobSchedulesOptionalParams)

列出指定账户中的所有工作计划。

function listJobSchedules(options?: ListJobSchedulesOptionalParams): PagedAsyncIterableIterator<BatchJobSchedule, BatchJobSchedule[], PageSettings>

参数

options: ListJobSchedulesOptionalParams

返回

PagedAsyncIterableIterator<BatchJobSchedule, BatchJobSchedule[], PageSettings>

listJobsFromSchedule(string, ListJobsFromScheduleOptionalParams)

列出根据指定作业计划创建的职位。

function listJobsFromSchedule(jobScheduleId: string, options?: ListJobsFromScheduleOptionalParams): PagedAsyncIterableIterator<BatchJob, BatchJob[], PageSettings>

参数

jobScheduleId: string

options: ListJobsFromScheduleOptionalParams

返回

PagedAsyncIterableIterator<BatchJob, BatchJob[], PageSettings>

listNodeExtensions(string, string, ListNodeExtensionsOptionalParams)

列出指定池中的计算节点扩展。

function listNodeExtensions(poolId: string, nodeId: string, options?: ListNodeExtensionsOptionalParams): PagedAsyncIterableIterator<BatchNodeVMExtension, BatchNodeVMExtension[], PageSettings>

参数

poolId: string

nodeId: string

options: ListNodeExtensionsOptionalParams

返回

PagedAsyncIterableIterator<BatchNodeVMExtension, BatchNodeVMExtension[], PageSettings>

listNodeFiles(string, string, ListNodeFilesOptionalParams)

列出指定计算节点上的任务目录中的所有文件。

function listNodeFiles(poolId: string, nodeId: string, options?: ListNodeFilesOptionalParams): PagedAsyncIterableIterator<BatchNodeFile, BatchNodeFile[], PageSettings>

参数

poolId: string

nodeId: string

options: ListNodeFilesOptionalParams

返回

PagedAsyncIterableIterator<BatchNodeFile, BatchNodeFile[], PageSettings>

listNodes(string, ListNodesOptionalParams)

列出指定池中的计算节点。

function listNodes(poolId: string, options?: ListNodesOptionalParams): PagedAsyncIterableIterator<BatchNode, BatchNode[], PageSettings>

参数

poolId: string

options: ListNodesOptionalParams

返回

PagedAsyncIterableIterator<BatchNode, BatchNode[], PageSettings>

listPoolNodeCounts(ListPoolNodeCountsOptionalParams)

获取按池分组的每个状态中的计算节点数。请注意，返回的数字可能并不总是最新的。如果需要确切的节点计数，请使用列表查询。

function listPoolNodeCounts(options?: ListPoolNodeCountsOptionalParams): PagedAsyncIterableIterator<BatchPoolNodeCounts, BatchPoolNodeCounts[], PageSettings>

参数

options: ListPoolNodeCountsOptionalParams

返回

PagedAsyncIterableIterator<BatchPoolNodeCounts, BatchPoolNodeCounts[], PageSettings>

listPools(ListPoolsOptionalParams)

列出指定帐户中的所有池。

function listPools(options?: ListPoolsOptionalParams): PagedAsyncIterableIterator<BatchPool, BatchPool[], PageSettings>

参数

options: ListPoolsOptionalParams

返回

PagedAsyncIterableIterator<BatchPool, BatchPool[], PageSettings>

listPoolUsageMetrics(ListPoolUsageMetricsOptionalParams)

如果未指定包含 poolId 的$filter子句，响应将包括帐户中存在的所有池，这些池在返回的聚合间隔的时间范围内存在。如果未指定$filter子句（包括 startTime 或 endTime），则这些筛选器默认为当前可用的最后一个聚合间隔的开始和结束时间;即，仅返回最后一个聚合间隔。

function listPoolUsageMetrics(options?: ListPoolUsageMetricsOptionalParams): PagedAsyncIterableIterator<BatchPoolUsageMetrics, BatchPoolUsageMetrics[], PageSettings>

参数

options: ListPoolUsageMetricsOptionalParams

返回

PagedAsyncIterableIterator<BatchPoolUsageMetrics, BatchPoolUsageMetrics[], PageSettings>

listSubTasks(string, string, ListSubTasksOptionalParams)

如果任务不是多实例任务，则返回空集合。

function listSubTasks(jobId: string, taskId: string, options?: ListSubTasksOptionalParams): PagedAsyncIterableIterator<BatchSubtask, BatchSubtask[], PageSettings>

参数

jobId: string

taskId: string

options: ListSubTasksOptionalParams

返回

PagedAsyncIterableIterator<BatchSubtask, BatchSubtask[], PageSettings>

listSupportedImages(ListSupportedImagesOptionalParams)

列出Azure Batch服务支持的所有虚拟机映像。

function listSupportedImages(options?: ListSupportedImagesOptionalParams): PagedAsyncIterableIterator<BatchSupportedImage, BatchSupportedImage[], PageSettings>

参数

options: ListSupportedImagesOptionalParams

返回

PagedAsyncIterableIterator<BatchSupportedImage, BatchSupportedImage[], PageSettings>

listTaskFiles(string, string, ListTaskFilesOptionalParams)

列出任务目录中的计算节点上的文件。

function listTaskFiles(jobId: string, taskId: string, options?: ListTaskFilesOptionalParams): PagedAsyncIterableIterator<BatchNodeFile, BatchNodeFile[], PageSettings>

参数

jobId: string

taskId: string

options: ListTaskFilesOptionalParams

返回

PagedAsyncIterableIterator<BatchNodeFile, BatchNodeFile[], PageSettings>

listTasks(string, ListTasksOptionalParams)

对于多实例任务，affinityId、executionInfo 和 nodeInfo 等信息指代主任务。使用列表子任务 API 来获取子任务的信息。

function listTasks(jobId: string, options?: ListTasksOptionalParams): PagedAsyncIterableIterator<BatchTask, BatchTask[], PageSettings>

参数

jobId: string

options: ListTasksOptionalParams

返回

PagedAsyncIterableIterator<BatchTask, BatchTask[], PageSettings>

poolExists(string, PoolExistsOptionalParams)

获得池的基本属性。

function poolExists(poolId: string, options?: PoolExistsOptionalParams): Promise<boolean>

参数

poolId: string

options: PoolExistsOptionalParams

返回

Promise<boolean>

reactivateTask(string, string, ReactivateTaskOptionalParams)

重新激活使任务有资格再次重试，最大重试计数。任务的状态更改为活动状态。由于任务不再处于已完成状态，因此重新激活后不再提供任何以前的退出代码或失败信息。每次重新激活任务时，其重试计数将重置为 0。对于未完成或以前成功完成的任务，重新激活将失败（退出代码为 0）。此外，如果作业已完成（或正在终止或删除），它将失败。

function reactivateTask(jobId: string, taskId: string, options?: ReactivateTaskOptionalParams): Promise<void>

参数

jobId: string

taskId: string

options: ReactivateTaskOptionalParams

返回

Promise<void>

rebootNode(string, string, RebootNodeOptionalParams)

仅当计算节点处于空闲或正在运行状态时，才能重启计算节点。

function rebootNode(poolId: string, nodeId: string, options?: RebootNodeOptionalParams): PollerLike<OperationState<void>, void>

参数

poolId: string

nodeId: string

options: RebootNodeOptionalParams

返回

PollerLike<OperationState<void>, void>

reimageNode(string, string, ReimageNodeOptionalParams)

仅当操作系统处于空闲或正在运行状态时，才能在计算节点上重新安装操作系统。该 API 只能在基于云服务配置属性创建的池中调用。

function reimageNode(poolId: string, nodeId: string, options?: ReimageNodeOptionalParams): PollerLike<OperationState<void>, void>

参数

poolId: string

nodeId: string

options: ReimageNodeOptionalParams

返回

PollerLike<OperationState<void>, void>

removeNodes(string, BatchNodeRemoveOptions, RemoveNodesOptionalParams)

此作只能在池的分配状态稳定时运行。此作运行时，分配状态将从稳定更改为调整大小。每个请求最多可以删除 100 个节点。

function removeNodes(poolId: string, removeOptions: BatchNodeRemoveOptions, options?: RemoveNodesOptionalParams): PollerLike<OperationState<void>, void>

参数

poolId: string

removeOptions: BatchNodeRemoveOptions

options: RemoveNodesOptionalParams

返回

PollerLike<OperationState<void>, void>

replaceJob(string, BatchJob, ReplaceJobOptionalParams)

这完全取代了工作中所有可更新的属性。例如，如果作业与其关联约束，且请求中未指定约束，那么批处理服务将移除现有约束。

function replaceJob(jobId: string, job: BatchJob, options?: ReplaceJobOptionalParams): Promise<void>

参数

jobId: string

job: BatchJob

options: ReplaceJobOptionalParams

返回

Promise<void>

replaceJobSchedule(string, BatchJobSchedule, ReplaceJobScheduleOptionalParams)

这完全取代了工作计划中所有可更新的属性。例如，如果该请求未指定调度属性，批处理服务将删除现有的调度。对作业计划的更改只会影响更新后由该计划创建的作业;目前运行的职位不受影响。

function replaceJobSchedule(jobScheduleId: string, jobSchedule: BatchJobSchedule, options?: ReplaceJobScheduleOptionalParams): Promise<void>

参数

jobScheduleId: string

jobSchedule: BatchJobSchedule

options: ReplaceJobScheduleOptionalParams

返回

Promise<void>

replaceNodeUser(string, string, string, BatchNodeUserUpdateOptions, ReplaceNodeUserOptionalParams)

此作替换了账户中所有可更新的属性。例如，如果未指定到期时间元素，当前值会被替换为默认值，而不会保持不修改。只有在计算节点处于空闲或运行状态时，你才能更新计算节点上的用户账户。

function replaceNodeUser(poolId: string, nodeId: string, userName: string, updateOptions: BatchNodeUserUpdateOptions, options?: ReplaceNodeUserOptionalParams): Promise<void>

参数

poolId: string

nodeId: string

userName: string

updateOptions: BatchNodeUserUpdateOptions

options: ReplaceNodeUserOptionalParams

返回

Promise<void>

replacePoolProperties(string, BatchPoolReplaceOptions, ReplacePoolPropertiesOptionalParams)

这完全取代了池中所有可更新的属性。例如，如果池中有关联的 StartTask，且该请求未指定 StartTask，那么批处理服务将删除现有的 StartTask。

function replacePoolProperties(poolId: string, pool: BatchPoolReplaceOptions, options?: ReplacePoolPropertiesOptionalParams): Promise<void>

参数

poolId: string

pool: BatchPoolReplaceOptions

options: ReplacePoolPropertiesOptionalParams

返回

Promise<void>

replaceTask(string, string, BatchTask, ReplaceTaskOptionalParams)

更新指定任务的属性。

function replaceTask(jobId: string, taskId: string, task: BatchTask, options?: ReplaceTaskOptionalParams): Promise<void>

参数

jobId: string

taskId: string

task: BatchTask

options: ReplaceTaskOptionalParams

返回

Promise<void>

resizePool(string, BatchPoolResizeOptions, ResizePoolOptionalParams)

仅当池的分配状态稳定时，才能调整池的大小。如果池已调整大小，则请求失败，状态代码为 409。调整池大小时，池的分配状态会从稳定更改为调整大小。无法调整为自动缩放配置的池的大小。如果尝试执行此作，Batch 服务将返回错误 409。如果向下调整池的大小，Batch 服务会选择要删除的计算节点。若要删除特定的计算节点，请使用池删除计算节点 API。

function resizePool(poolId: string, resizeOptions: BatchPoolResizeOptions, options?: ResizePoolOptionalParams): PollerLike<OperationState<void>, void>

参数

poolId: string

resizeOptions: BatchPoolResizeOptions

options: ResizePoolOptionalParams

返回

PollerLike<OperationState<void>, void>

startNode(string, string, StartNodeOptionalParams)

只有当计算节点已被释放时，才能启动它。

function startNode(poolId: string, nodeId: string, options?: StartNodeOptionalParams): PollerLike<OperationState<void>, void>

参数

poolId: string

nodeId: string

options: StartNodeOptionalParams

返回

PollerLike<OperationState<void>, void>

stopPoolResize(string, StopPoolResizeOptionalParams)

这不会将池恢复到调整大小作前的状态：它只是停止了后续的更改，池保持当前状态。停止作后，池会稳定在停止作时的计算节点数。在停止作过程中，池分配状态先变为停止，再变为稳。调整大小作不一定是显式的调整容量池请求;该 API 还可以在创建池时停止初始大小。

function stopPoolResize(poolId: string, options?: StopPoolResizeOptionalParams): PollerLike<OperationState<void>, void>

参数

poolId: string

options: StopPoolResizeOptionalParams

返回

PollerLike<OperationState<void>, void>

terminateJob(string, TerminateJobOptionalParams)

当收到终止作业请求时，批处理服务会将作业设置为终止状态。批处理服务随后终止与作业相关的正在运行任务，并执行所需的作业释放任务。然后工作进入完成状态。如果工作中有任何任务处于活跃状态，它们将保持在活跃状态。一旦作业终止，就无法添加新的任务，且剩余的活跃任务也不会被安排。

function terminateJob(jobId: string, options?: TerminateJobOptionalParams): PollerLike<OperationState<void>, void>

参数

jobId: string

options: TerminateJobOptionalParams

返回

PollerLike<OperationState<void>, void>

terminateJobSchedule(string, TerminateJobScheduleOptionalParams)

终止作业计划。

function terminateJobSchedule(jobScheduleId: string, options?: TerminateJobScheduleOptionalParams): PollerLike<OperationState<void>, void>

参数

jobScheduleId: string

options: TerminateJobScheduleOptionalParams

返回

PollerLike<OperationState<void>, void>

terminateTask(string, string, TerminateTaskOptionalParams)

任务终止后，它会移动到已完成状态。对于多实例任务，终止任务作将同步应用于主任务;子任务随后在后台异步终止。

function terminateTask(jobId: string, taskId: string, options?: TerminateTaskOptionalParams): Promise<void>

参数

jobId: string

taskId: string

options: TerminateTaskOptionalParams

返回

Promise<void>

updateJob(string, BatchJobUpdateOptions, UpdateJobOptionalParams)

这只替换请求中指定的工作属性。例如，如果作业有约束，且请求未指定约束元素，则作业保留现有约束。

function updateJob(jobId: string, job: BatchJobUpdateOptions, options?: UpdateJobOptionalParams): Promise<void>

参数

jobId: string

job: BatchJobUpdateOptions

options: UpdateJobOptionalParams

返回

Promise<void>

updateJobSchedule(string, BatchJobScheduleUpdateOptions, UpdateJobScheduleOptionalParams)

这只替换了请求中指定的作业计划属性。例如，如果该请求未指定调度属性，批处理服务将保留现有的调度。对作业计划的更改只会影响更新后由该计划创建的作业;目前运行的职位不受影响。

function updateJobSchedule(jobScheduleId: string, jobSchedule: BatchJobScheduleUpdateOptions, options?: UpdateJobScheduleOptionalParams): Promise<void>

参数

jobScheduleId: string

jobSchedule: BatchJobScheduleUpdateOptions

options: UpdateJobScheduleOptionalParams

返回

Promise<void>

updatePool(string, BatchPoolUpdateOptions, UpdatePoolOptionalParams)

这只替换了请求中指定的池属性。例如，如果池中关联了一个 StartTask，而请求没有指定 StartTask 元素，那么池会保留现有的 StartTask。

function updatePool(poolId: string, pool: BatchPoolUpdateOptions, options?: UpdatePoolOptionalParams): Promise<void>

参数

poolId: string

pool: BatchPoolUpdateOptions

options: UpdatePoolOptionalParams

返回

Promise<void>

uploadNodeLogs(string, string, UploadBatchServiceLogsOptions, UploadNodeLogsOptionalParams)

这是为了在你遇到错误并希望升级到Azure支持时，自动从计算节点收集Azure批处理服务日志文件。应与Azure 支持共享Azure Batch服务日志文件，以帮助调试 Batch 服务的问题。

function uploadNodeLogs(poolId: string, nodeId: string, uploadOptions: UploadBatchServiceLogsOptions, options?: UploadNodeLogsOptionalParams): Promise<UploadBatchServiceLogsResult>

参数

poolId: string

nodeId: string

uploadOptions: UploadBatchServiceLogsOptions

options: UploadNodeLogsOptionalParams

返回

Promise<UploadBatchServiceLogsResult>

BatchClient class

构造函数

方法

构造函数详细信息

BatchClient(string, TokenCredential | AzureNamedKeyCredential, BatchClientOptionalParams)

参数

方法详细信息

createJob(BatchJobCreateOptions, CreateJobOptionalParams)

参数

返回

createJobSchedule(BatchJobScheduleCreateOptions, CreateJobScheduleOptionalParams)

参数

返回

createNodeUser(string, string, BatchNodeUserCreateOptions, CreateNodeUserOptionalParams)

参数

返回

createPool(BatchPoolCreateOptions, CreatePoolOptionalParams)

参数

返回

createTask(string, BatchTaskCreateOptions, CreateTaskOptionalParams)

参数

返回

createTaskCollection(string, BatchTaskGroup, CreateTaskCollectionOptionalParams)

参数

返回

deallocateNode(string, string, DeallocateNodeOptionalParams)

参数

返回

deleteJob(string, DeleteJobOptionalParams)

参数

返回

deleteJobSchedule(string, DeleteJobScheduleOptionalParams)

参数

返回

deleteNodeFile(string, string, string, DeleteNodeFileOptionalParams)

参数

返回

deleteNodeUser(string, string, string, DeleteNodeUserOptionalParams)

参数

返回

deletePool(string, DeletePoolOptionalParams)

参数

返回

deleteTask(string, string, DeleteTaskOptionalParams)

参数

返回

deleteTaskFile(string, string, string, DeleteTaskFileOptionalParams)

参数

返回

disableJob(string, BatchJobDisableOptions, DisableJobOptionalParams)

参数

返回

disableJobSchedule(string, DisableJobScheduleOptionalParams)

参数

返回

disableNodeScheduling(string, string, DisableNodeSchedulingOptionalParams)

参数

返回

disablePoolAutoScale(string, DisablePoolAutoScaleOptionalParams)

参数

返回

enableJob(string, EnableJobOptionalParams)

参数

返回

enableJobSchedule(string, EnableJobScheduleOptionalParams)

参数

返回

enableNodeScheduling(string, string, EnableNodeSchedulingOptionalParams)

参数

返回

enablePoolAutoScale(string, BatchPoolEnableAutoScaleOptions, EnablePoolAutoScaleOptionalParams)

参数

返回

evaluatePoolAutoScale(string, BatchPoolEvaluateAutoScaleOptions, EvaluatePoolAutoScaleOptionalParams)

参数

返回

getApplication(string, GetApplicationOptionalParams)

参数

返回

getJob(string, GetJobOptionalParams)