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

az ml job

注意

此参考是 Azure CLI（版本 2.15.0 或更高版本）的 ml 扩展的一部分。 该扩展将在首次运行 az ml job 命令时自动安装。 详细了解扩展。

管理 Azure ML 作业。

Azure ML 作业针对指定的计算目标执行任务。 可以将作业配置为在 Azure 上横向扩展模型训练。 Azure ML 支持具有不同功能的不同作业类型。 例如，最基本的作业（即命令作业）在 Docker 容器中执行命令，并可用于单节点和分布式训练。 扫描作业对指定的搜索空间执行超参数扫描，以优化模型的超参数。

作业还支持对 ML 试验和工作流进行系统跟踪。 创建作业后，Azure ML 会维护作业的运行记录，其中包括在作业期间生成的元数据、任何指标、日志和项目、执行的代码以及所使用的 Azure ML 环境。 可以在 Azure ML 工作室中查看作业的所有运行记录。

命令

名称	说明	类型	状态
az ml job archive	存档作业。	扩展	GA
az ml job cancel	取消作业。	扩展	GA
az ml job connect-ssh	设置 ssh 连接，并通过 Tundra 将请求发送到用户容器中运行的 SSH 服务。	扩展	GA
az ml job create	创建 作业。	扩展	GA
az ml job download	下载所有与作业相关的文件。	扩展	GA
az ml job list	列出工作区中的作业。	扩展	GA
az ml job restore	还原存档作业。	扩展	GA
az ml job show	显示作业的详细信息。	扩展	GA
az ml job show-services	显示每个节点的作业的服务。	扩展	GA
az ml job stream	将作业日志流式传输到控制台。	扩展	GA
az ml job update	更新作业。	扩展	GA
az ml job validate	验证作业。 此命令目前仅适用于管道作业。	扩展	GA

az ml job archive

存档作业。

默认情况下，存档作业会在列表查询（az ml job list）中隐藏它。 仍可以在工作流中继续引用和使用存档作业。 只能存档已完成的作业。

az ml job archive --name
                  --resource-group
                  --workspace-name

必需参数

--name -n

作业的名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--workspace-name -w

Azure ML 工作区的名称。 可以使用 配置默认工作区 az configure --defaults workspace=<name>。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az ml job cancel

取消作业。

az ml job cancel --name
                 --resource-group
                 --workspace-name

示例

按名称取消作业

az ml job cancel --name my-job-id --resource-group my-resource-group --workspace-name my-workspace

必需参数

--name -n

作业的名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--workspace-name -w

Azure ML 工作区的名称。 可以使用 配置默认工作区 az configure --defaults workspace=<name>。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az ml job connect-ssh

设置 ssh 连接，并通过 Tundra 将请求发送到用户容器中运行的 SSH 服务。

az ml job connect-ssh --name
                      --resource-group
                      --workspace-name
                      [--node-index]
                      [--private-key-file-path]

示例

设置 ssh 连接，并将请求发送到 SSH 服务。

az ml job connect-ssh --name my-job-id --node-index 0 --private-key-file-path "C:/Temp/.ssh/id_rsa" --resource-group my-resource-group --workspace-name my-workspace

必需参数

--name -n

作业的名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--workspace-name -w

Azure ML 工作区的名称。 可以使用 配置默认工作区 az configure --defaults workspace=<name>。

可选参数

--node-index -i

要通过 ssh 连接的节点的索引。

默认值: 0

--private-key-file-path -f

私钥文件的路径。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az ml job create

创建 作业。

若要创建作业，通常需要配置要运行的任何代码、封装依赖项的环境、要执行作业的计算目标以及任何其他特定于作业的设置。 创建作业时，会针对指定的计算资源提交该作业以供执行。

az ml job create --file
                 --resource-group
                 --workspace-name
                 [--name]
                 [--save-as]
                 [--set]
                 [--skip-validation]
                 [--stream]
                 [--web]

示例

从 YAML 规范文件创建作业

az ml job create --file job.yml --resource-group my-resource-group --workspace-name my-workspace

从 YAML 规范文件创建作业，并在 Azure ML Studio 门户中打开作业的运行详细信息

az ml job create --file job.yml --web --resource-group my-resource-group --workspace-name my-workspace

必需参数

--file -f

包含 Azure ML 作业规范的 YAML 文件的本地路径。 可在以下位置找到作业的 YAML 参考文档： https://aka.ms/ml-cli-v2-job-command-yaml-reference。 https://aka.ms/ml-cli-v2-job-sweep-yaml-referencehttps://aka.ms/ml-cli-v2-job-pipeline-yaml-reference

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--workspace-name -w

Azure ML 工作区的名称。 可以使用 配置默认工作区 az configure --defaults workspace=<name>。

可选参数

--name -n

作业的名称。

--save-as -a

将写入以 YAML 格式创建的作业状态的文件。

--set

通过指定要设置的属性路径和值来更新对象。 示例：--set property1.property2=。

--skip-validation

在创建资源时跳过验证。 请注意，依赖资源不会跳过创建中的验证。

默认值: False

--stream -s

指示是否将作业的日志流式传输到控制台。

默认值: False

--web -e

在 Web 浏览器中的 Azure ML Studio 中显示作业的运行详细信息。

默认值: False

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az ml job download

下载所有与作业相关的文件。

这些文件将下载到以作业名称命名的文件夹中。

az ml job download --name
                   --resource-group
                   --workspace-name
                   [--all]
                   [--download-path]
                   [--output-name]

示例

将作业的日志和输出下载到当前工作目录

az ml job download --name my-job --resource-group my-resource-group --workspace-name my-workspace

必需参数

--name -n

作业的名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--workspace-name -w

Azure ML 工作区的名称。 可以使用 配置默认工作区 az configure --defaults workspace=<name>。

可选参数

--all

下载作业的所有输出。

默认值: False

--download-path -p

将作业文件下载到的路径。 如果省略，作业文件将下载到当前目录。

--output-name

要下载的用户定义输出的名称。 这应对应于作业的输出字典中的键。 如果省略，将下载作业的默认项目输出文件。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az ml job list

列出工作区中的作业。

az ml job list --resource-group
               --workspace-name
               [--all-results {false, true}]
               [--archived-only]
               [--include-archived]
               [--max-results]
               [--parent-job-name]

示例

使用 --query 参数对命令结果执行 JMESPath 查询，列出工作区中的所有作业状态。

az ml job list --query "[].{Name:name,Jobstatus:status}"  --output table --resource-group my-resource-group --workspace-name my-workspace

必需参数

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--workspace-name -w

Azure ML 工作区的名称。 可以使用 配置默认工作区 az configure --defaults workspace=<name>。

可选参数

--all-results

返回所有结果。

接受的值: false, true

默认值: False

--archived-only

仅列出存档作业。

默认值: False

--include-archived

列出存档的作业和活动作业。

默认值: False

--max-results -r

要返回的最大结果数。 默认值为 50。

默认值: 50

--parent-job-name -p

父作业的名称。 列出parent_job_name与给定名称匹配的所有作业。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az ml job restore

还原存档作业。

还原存档的作业后，它将不再隐藏在列表查询中（az ml job list）。

az ml job restore --name
                  --resource-group
                  --workspace-name

必需参数

--name -n

作业的名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--workspace-name -w

Azure ML 工作区的名称。 可以使用 配置默认工作区 az configure --defaults workspace=<name>。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az ml job show

显示作业的详细信息。

az ml job show --name
               --resource-group
               --workspace-name
               [--web]

示例

显示使用 --query 参数对命令结果执行 JMESPath 查询的作业状态。

az ml job show --name my-job-id --query "{Name:name,Jobstatus:status}"  --output table --resource-group my-resource-group --workspace-name my-workspace

必需参数

--name -n

作业的名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--workspace-name -w

Azure ML 工作区的名称。 可以使用 配置默认工作区 az configure --defaults workspace=<name>。

可选参数

--web -e

在 Web 浏览器中的 Azure ML Studio 中显示作业的运行详细信息。

默认值: False

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az ml job show-services

显示每个节点的作业的服务。

az ml job show-services --name
                        --resource-group
                        --workspace-name
                        [--node-index]

示例

使用 --query 参数对命令结果执行 JMESPath 查询，显示每个节点作业的服务。

az ml job show-services --name my-job-id --node-index 0 --query "{Name:name,Jobstatus:status}"  --output table --resource-group my-resource-group --workspace-name my-workspace

必需参数

--name -n

作业的名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--workspace-name -w

Azure ML 工作区的名称。 可以使用 配置默认工作区 az configure --defaults workspace=<name>。

可选参数

--node-index -i

必须为其显示服务的节点的索引。

默认值: 0

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az ml job stream

将作业日志流式传输到控制台。

az ml job stream --name
                 --resource-group
                 --workspace-name

必需参数

--name -n

作业的名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--workspace-name -w

Azure ML 工作区的名称。 可以使用 配置默认工作区 az configure --defaults workspace=<name>。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az ml job update

更新作业。

只能更新“tags”和“properties”属性。

az ml job update --name
                 --resource-group
                 --workspace-name
                 [--add]
                 [--force-string]
                 [--remove]
                 [--set]
                 [--web]

必需参数

--name -n

作业的名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--workspace-name -w

Azure ML 工作区的名称。 可以使用 配置默认工作区 az configure --defaults workspace=<name>。

可选参数

--add

通过指定路径和键值对将对象添加到对象列表。 示例：--add property.listProperty <key=value, string or JSON string>。

默认值: []

--force-string

使用“set”或“add”时，保留字符串文本，而不是尝试转换为 JSON。

默认值: False

--remove

从列表中删除属性或元素。 示例： --remove property.list <indexToRemove> OR --remove propertyToRemove.

默认值: []

--set

通过指定要设置的属性路径和值来更新对象。 示例：--set property1.property2=<value>。

默认值: []

--web -e

在 Web 浏览器中的 Azure ML Studio 中显示作业的运行详细信息。

默认值: False

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az ml job validate

验证作业。 此命令目前仅适用于管道作业。

此命令将验证 YAML 规范文件，使其检查它是否对创建作业有效，并返回找到的所有问题。 验证主要包括架构的本地检查，例如缺少字段、未指定版本的环境、引用了不存在的本地路径的代码;它还将检查目标工作区中存在引用的计算目标。 验证结果将输出到控制台，包括错误和警告。 只有错误会导致验证失败。 通过的作业验证将能够提交。 此命令目前仅适用于管道作业。

az ml job validate --file
                   --resource-group
                   --workspace-name
                   [--set]

示例

验证 YAML 规范文件，使其在创建作业时检查。

az ml job validate --file job.yml --resource-group my-resource-group --workspace-name my-workspace

必需参数

--file -f

包含 Azure ML 作业规范的 YAML 文件的本地路径。 可在以下位置找到作业的 YAML 参考文档。 https://aka.ms/ml-cli-v2-job-pipeline-yaml-reference

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--workspace-name -w

Azure ML 工作区的名称。 可以使用 配置默认工作区 az configure --defaults workspace=<name>。

可选参数

--set

通过指定要设置的属性路径和值来更新对象。 示例：--set property1.property2=。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。