你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
az batch task
管理 Batch 任务。
命令
名称 | 说明 | 类型 | Status |
---|---|---|---|
az batch task create |
创建 Batch 任务。 |
核心 | 加语 |
az batch task delete |
从指定的作业中删除任务。 |
核心 | 加语 |
az batch task file |
管理 Batch 任务文件。 |
核心 | 加语 |
az batch task file delete |
从运行任务的计算节点中删除指定的任务文件。 |
核心 | 加语 |
az batch task file download |
下载 Batch 任务文件的内容。 |
核心 | 加语 |
az batch task file list |
列出任务目录中的计算节点上的文件。 |
核心 | 加语 |
az batch task file show |
获取指定任务文件的属性。 |
核心 | 加语 |
az batch task list |
列出与指定作业关联的所有任务。 |
核心 | 加语 |
az batch task reactivate |
重新激活任务,使其再次运行,即使其重试计数已用尽。 |
核心 | 加语 |
az batch task reset |
重置 Batch 任务的属性。 |
核心 | 加语 |
az batch task show |
获取有关指定任务的信息。 |
核心 | 加语 |
az batch task stop |
终止指定的任务。 |
核心 | 加语 |
az batch task subtask |
管理 Batch 任务的子任务信息。 |
核心 | 加语 |
az batch task subtask list |
列出与指定多实例任务关联的所有子任务。 |
核心 | 加语 |
az batch task create
创建 Batch 任务。
az batch task create --job-id
[--account-endpoint]
[--account-key]
[--account-name]
[--affinity-id]
[--application-package-references]
[--command-line]
[--environment-settings]
[--json-file]
[--max-task-retry-count]
[--max-wall-clock-time]
[--resource-files]
[--retention-time]
[--task-id]
示例
创建一个休眠 1 分钟的任务。
az batch task create --task-id task1 --job-id job1 --command-line "sleep 60"
必需参数
包含任务的作业的 ID。
可选参数
Batch 服务终结点。 或者,由环境变量设置:AZURE_BATCH_ENDPOINT。
Batch 帐户密钥。 或者,由环境变量设置:AZURE_BATCH_ACCESS_KEY。
Batch 帐户名称。 仅需要环境变量设置:AZURE_BATCH_ACCOUNT。
必填。 可以传递 Node 的 affinityId,以指示此任务需要在该计算节点上运行。 请注意,这只是软相关性。 如果目标计算节点在计划任务时繁忙或不可用,则任务将在其他位置进行计划。
指定要安装的应用程序包的空间分隔 ID 列表。 采用“id[#version]”格式的可选版本以空格分隔的应用程序 ID。
任务的命令行。 命令行未在 shell 下运行,因此不能利用 shell 功能(如环境变量扩展)。 如果要利用这些功能,则应在命令行中调用 shell,例如在 Windows 中使用“cmd /c MyCommand”或在 Linux 中使用“/bin/sh -c MyCommand”。
任务的环境变量设置列表。 以“key=value”格式分隔的空间值。
包含 JSON 中创建的任务的文件(格式设置为与 REST API 请求正文匹配)。 提交多个任务时,接受任务数组或 TaskAddCollectionParamater。 如果指定此参数,则忽略所有其他参数。
可以重试任务的最大次数。 如果 Batch 服务退出代码为非零,则重试任务。 请注意,由于非零退出代码,此值专门控制任务可执行文件的重试次数。 Batch 服务将尝试一次任务,然后可能会重试到此限制。 例如,如果最大重试计数为 3,Batch 将尝试任务最多 4 次(一次初始尝试和 3 次重试)。 如果最大重试计数为 0,则 Batch 服务不会在第一次尝试后重试任务。 如果最大重试计数为 -1,Batch 服务将重试任务,但不建议用于启动任务或任何任务。 默认值为 0(无重试)。
如果未指定此项,则任务可能运行的时间没有时间限制。
Batch 服务在运行命令行之前将下载到计算节点的文件列表。 以 filename=httpurl 格式分隔的空间分隔资源引用,httpurl 是具有公共访问权限的任何 HTTP URL 或具有读取访问权限的 SAS URL。
默认值为 7 天,即任务目录将保留 7 天,除非删除计算节点或删除作业。
任务的 ID。
全局参数
增加日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
仅显示错误,禁止显示警告。
输出格式。
JMESPath 查询字符串。 有关详细信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
增加日志记录详细程度。 对完整调试日志使用 --debug。
az batch task delete
从指定的作业中删除任务。
删除任务后,也会删除运行任务的计算节点上目录中的所有文件(无论保留时间如何)。 对于多实例任务,删除任务作将同步应用于主任务;子任务及其文件随后在后台异步删除。
az batch task delete --job-id
--task-id
[--account-endpoint]
[--account-key]
[--account-name]
[--if-match]
[--if-modified-since]
[--if-none-match]
[--if-unmodified-since]
[--yes]
必需参数
要从中删除任务的作业的 ID。 必填。
要删除的任务的 ID。 必填。
可选参数
Batch 服务终结点。 或者,由环境变量设置:AZURE_BATCH_ENDPOINT。
Batch 帐户密钥。 或者,由环境变量设置:AZURE_BATCH_ACCESS_KEY。
Batch 帐户名称。 或者,按环境变量设置:AZURE_BATCH_ACCOUNT。
与客户端已知的资源版本关联的 ETag 值。 仅当服务的当前 ETag 与客户端指定的值完全匹配时,才会执行该作。
一个时间戳,指示客户端已知资源的上次修改时间。 仅当服务上的资源自指定时间以来已修改时,才会执行该作。
与客户端已知的资源版本关联的 ETag 值。 仅当服务的当前 ETag 与客户端指定的值不匹配时,才会执行该作。
一个时间戳,指示客户端已知资源的上次修改时间。 仅当服务上的资源自指定时间以来已修改时,才会执行该作。
不要提示确认。
全局参数
增加日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
仅显示错误,禁止显示警告。
输出格式。
JMESPath 查询字符串。 有关详细信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
增加日志记录详细程度。 对完整调试日志使用 --debug。
az batch task list
列出与指定作业关联的所有任务。
对于多实例任务,affinityId、executionInfo 和 nodeInfo 等信息是指主要任务。 使用列表子任务 API 检索有关子任务的信息。
az batch task list --job-id
[--account-endpoint]
[--account-key]
[--account-name]
[--expand]
[--filter]
[--select]
必需参数
作业的 ID。 必填。
可选参数
Batch 服务终结点。 或者,由环境变量设置:AZURE_BATCH_ENDPOINT。
Batch 帐户密钥。 或者,由环境变量设置:AZURE_BATCH_ACCESS_KEY。
Batch 帐户名称。 或者,按环境变量设置:AZURE_BATCH_ACCOUNT。
OData $expand 子句。
OData $filter 子句。 有关构造此筛选器的详细信息,请参阅 https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch。
OData $select 子句。
全局参数
增加日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
仅显示错误,禁止显示警告。
输出格式。
JMESPath 查询字符串。 有关详细信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
增加日志记录详细程度。 对完整调试日志使用 --debug。
az batch task reactivate
重新激活任务,使其再次运行,即使其重试计数已用尽。
重新激活使任务有资格再次重试,最大重试计数。 任务的状态更改为活动状态。 由于任务不再处于已完成状态,因此重新激活后不再提供任何以前的退出代码或失败信息。 每次重新激活任务时,其重试计数将重置为 0。 对于未完成或以前成功完成的任务,重新激活将失败(退出代码为 0)。 此外,如果作业已完成(或正在终止或删除),它将失败。
az batch task reactivate --job-id
--task-id
[--account-endpoint]
[--account-key]
[--account-name]
[--if-match]
[--if-modified-since]
[--if-none-match]
[--if-unmodified-since]
必需参数
包含任务的作业的 ID。 必填。
要重新激活的任务的 ID。 必填。
可选参数
Batch 服务终结点。 或者,由环境变量设置:AZURE_BATCH_ENDPOINT。
Batch 帐户密钥。 或者,由环境变量设置:AZURE_BATCH_ACCESS_KEY。
Batch 帐户名称。 或者,按环境变量设置:AZURE_BATCH_ACCOUNT。
与客户端已知的资源版本关联的 ETag 值。 仅当服务的当前 ETag 与客户端指定的值完全匹配时,才会执行该作。
一个时间戳,指示客户端已知资源的上次修改时间。 仅当服务上的资源自指定时间以来已修改时,才会执行该作。
与客户端已知的资源版本关联的 ETag 值。 仅当服务的当前 ETag 与客户端指定的值不匹配时,才会执行该作。
一个时间戳,指示客户端已知资源的上次修改时间。 仅当服务上的资源自指定时间以来已修改时,才会执行该作。
全局参数
增加日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
仅显示错误,禁止显示警告。
输出格式。
JMESPath 查询字符串。 有关详细信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
增加日志记录详细程度。 对完整调试日志使用 --debug。
az batch task reset
重置 Batch 任务的属性。
az batch task reset --job-id
--task-id
[--account-endpoint]
[--account-key]
[--account-name]
[--if-match]
[--if-modified-since]
[--if-none-match]
[--if-unmodified-since]
[--json-file]
[--max-task-retry-count]
[--max-wall-clock-time]
[--retention-time]
示例
将最大重试计数设置为 3,并将其他属性重置为其默认值
az batch task reset --task-id task1 --job-id job1 --max-task-retry-count 3
必需参数
包含任务的作业的 ID。
要更新的任务的 ID。
可选参数
Batch 服务终结点。 或者,由环境变量设置:AZURE_BATCH_ENDPOINT。
Batch 帐户密钥。 或者,由环境变量设置:AZURE_BATCH_ACCESS_KEY。
Batch 帐户名称。 仅需要环境变量设置:AZURE_BATCH_ACCOUNT。
仅当资源的当前 ETag 与指定值完全匹配时,才会执行该作。
仅当资源自指定时间戳以来已修改时,才会执行该作。
仅当资源的当前 ETag 与指定值完全匹配时,才会执行该作。
仅当资源自指定时间戳以来已修改时,才会执行该作。
包含 JSON 格式的池更新属性参数规范的文件(格式与 REST API 请求正文匹配)。 如果指定此参数,则忽略所有“池更新属性参数参数参数”。
可以重试任务的最大次数。 如果 Batch 服务退出代码为非零,则重试任务。 请注意,由于非零退出代码,此值专门控制任务可执行文件的重试次数。 Batch 服务将尝试一次任务,然后可能会重试到此限制。 例如,如果最大重试计数为 3,Batch 将尝试任务最多 4 次(一次初始尝试和 3 次重试)。 如果最大重试计数为 0,则 Batch 服务不会在第一次尝试后重试任务。 如果最大重试计数为 -1,Batch 服务将重试任务,但不建议用于启动任务或任何任务。 默认值为 0(无重试)。
如果未指定此项,则任务可能运行的时间没有时间限制。 预期格式为 ISO-8601 持续时间。
默认值为 7 天,即任务目录将保留 7 天,除非删除计算节点或删除作业。 预期格式为 ISO-8601 持续时间。
全局参数
增加日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
仅显示错误,禁止显示警告。
输出格式。
JMESPath 查询字符串。 有关详细信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
增加日志记录详细程度。 对完整调试日志使用 --debug。
az batch task show
获取有关指定任务的信息。
对于多实例任务,affinityId、executionInfo 和 nodeInfo 等信息是指主要任务。 使用列表子任务 API 检索有关子任务的信息。
az batch task show --job-id
--task-id
[--account-endpoint]
[--account-key]
[--account-name]
[--expand]
[--if-match]
[--if-modified-since]
[--if-none-match]
[--if-unmodified-since]
[--select]
必需参数
包含任务的作业的 ID。 必填。
要获取相关信息的任务的 ID。 必填。
可选参数
Batch 服务终结点。 或者,由环境变量设置:AZURE_BATCH_ENDPOINT。
Batch 帐户密钥。 或者,由环境变量设置:AZURE_BATCH_ACCESS_KEY。
Batch 帐户名称。 或者,按环境变量设置:AZURE_BATCH_ACCOUNT。
OData $expand 子句。
与客户端已知的资源版本关联的 ETag 值。 仅当服务的当前 ETag 与客户端指定的值完全匹配时,才会执行该作。
一个时间戳,指示客户端已知资源的上次修改时间。 仅当服务上的资源自指定时间以来已修改时,才会执行该作。
与客户端已知的资源版本关联的 ETag 值。 仅当服务的当前 ETag 与客户端指定的值不匹配时,才会执行该作。
一个时间戳,指示客户端已知资源的上次修改时间。 仅当服务上的资源自指定时间以来已修改时,才会执行该作。
OData $select 子句。
全局参数
增加日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
仅显示错误,禁止显示警告。
输出格式。
JMESPath 查询字符串。 有关详细信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
增加日志记录详细程度。 对完整调试日志使用 --debug。
az batch task stop
终止指定的任务。
任务终止后,它会移动到已完成状态。 对于多实例任务,终止任务作将同步应用于主任务;子任务随后在后台异步终止。
az batch task stop --job-id
--task-id
[--account-endpoint]
[--account-key]
[--account-name]
[--if-match]
[--if-modified-since]
[--if-none-match]
[--if-unmodified-since]
必需参数
包含任务的作业的 ID。 必填。
要终止的任务的 ID。 必填。
可选参数
Batch 服务终结点。 或者,由环境变量设置:AZURE_BATCH_ENDPOINT。
Batch 帐户密钥。 或者,由环境变量设置:AZURE_BATCH_ACCESS_KEY。
Batch 帐户名称。 或者,按环境变量设置:AZURE_BATCH_ACCOUNT。
与客户端已知的资源版本关联的 ETag 值。 仅当服务的当前 ETag 与客户端指定的值完全匹配时,才会执行该作。
一个时间戳,指示客户端已知资源的上次修改时间。 仅当服务上的资源自指定时间以来已修改时,才会执行该作。
与客户端已知的资源版本关联的 ETag 值。 仅当服务的当前 ETag 与客户端指定的值不匹配时,才会执行该作。
一个时间戳,指示客户端已知资源的上次修改时间。 仅当服务上的资源自指定时间以来已修改时,才会执行该作。
全局参数
增加日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
仅显示错误,禁止显示警告。
输出格式。
JMESPath 查询字符串。 有关详细信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
增加日志记录详细程度。 对完整调试日志使用 --debug。