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

az ml environment

注意

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

管理 Azure ML 环境。

Azure ML 环境定义作业和终结点部署的执行环境，封装用于训练和推理的依赖项。 这些环境定义内置于 Docker 映像中。

命令

名称	说明	类型	状态
az ml environment archive	存档环境。	扩展	GA
az ml environment create	创建环境。	扩展	GA
az ml environment list	列出工作区中的环境。	扩展	GA
az ml environment restore	还原存档的环境。	扩展	GA
az ml environment share	从工作区共享到注册表的特定环境。	扩展	GA
az ml environment show	显示环境的详细信息。	扩展	GA
az ml environment update	更新环境。	扩展	GA

az ml environment archive

存档环境。

默认情况下，将环境存档会使其从列表查询 (az ml environment list) 中隐藏。 你仍然可以继续在工作流中引用和使用已存档的环境。 可以存档环境容器或特定环境版本。 存档一个环境容器将存档在该给定名称下的所有环境版本。 可以使用 .. 还原存档环境 az ml environment restore。 如果整个环境容器已存档，则无法还原环境的各个版本 - 需要还原环境容器。

az ml environment archive --name
                          [--label]
                          [--registry-name]
                          [--resource-group]
                          [--version]
                          [--workspace-name]

示例

存档环境容器（存档该环境的所有版本）

az ml environment archive --name my-env --resource-group my-resource-group --workspace-name my-workspace

存档特定环境版本

az ml environment archive --name my-env --version 1 --resource-group my-resource-group --workspace-name my-workspace

必需参数

--name -n

环境的名称。

可选参数

--label -l

环境的标签。

--registry-name

如果提供，该命令将面向注册表而不是工作区。 因此，不需要资源组和工作区。

--resource-group -g

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

--version -v

环境的版本。

--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 environment create

创建环境。

可以从 Docker 映像、Dockerfile 或 Conda 文件定义环境。 Azure ML 维护一组可用作基本映像的 CPU 和 GPU Docker 映像。 有关这些图像的信息，请参阅 https://github.com/Azure/AzureML-Containers。

创建的环境将在工作区中跟踪指定的名称和版本。

az ml environment create [--build-context]
                         [--conda-file]
                         [--datastore]
                         [--description]
                         [--dockerfile-path]
                         [--file]
                         [--image]
                         [--name]
                         [--no-wait]
                         [--os-type]
                         [--registry-name]
                         [--resource-group]
                         [--set]
                         [--tags]
                         [--version]
                         [--workspace-name]

示例

从 YAML 规范文件创建环境

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

从 docker 映像创建环境

az ml environment create --name my-env --version 1 --file my_env.yml  --image pytorch/pytorch --resource-group my-resource-group --workspace-name my-workspace

从生成上下文创建环境

az ml environment create --name my-env --version 1 --file my_env.yml  --build-context envs/context/ --dockerfile-path Dockerfile --resource-group my-resource-group --workspace-name my-workspace

从 conda 规范创建环境

az ml environment create --name my-env --version 1 --file my_env.yml  --conda-file conda_dep.yml --image mcr.microsoft.com/azureml/openmpi3.1.2-ubuntu18.04 --resource-group my-resource-group --workspace-name my-workspace

从 YAML 规范文件在注册表中创建环境

az ml environment create --file my_env.yml --registry-name my-registry-name --resource-group my-resource-group

可选参数

--build-context -b

要用作 Docker 生成上下文的目录的本地路径。 --build-context/-b 和 --image/-i 是互斥参数。

--conda-file -c

conda 规范文件的本地路径。 如果使用此参数，还必须指定 --image/-i。

--datastore

要将本地项目上传到的数据存储。

--description

环境的说明。

--dockerfile-path -d

--build-context/-b 指定的目录中 Dockerfile 的相对路径。 如果省略，则使用“./Dockerfile”。

默认值: /Dockerfile

--file -f

包含 Azure ML 环境规范的 YAML 文件的本地路径。 可以在以下位置找到适用于环境的 YAML 参考文档。 https://aka.ms/ml-cli-v2-environment-yaml-reference

--image -i

Docker 映像。 --image/-i 和 --build-context/-b 是互斥参数。

--name -n

环境的名称。

--no-wait

不等待长时间运行的操作完成。

默认值: False

--os-type

操作系统的类型。 允许的值：linux、windows。 默认值：linux。

--registry-name

如果提供，该命令将面向注册表而不是工作区。 因此，不需要资源组和工作区。

--resource-group -g

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

--set

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

--tags

对象的标记的空间分隔键值对。

--version -v

环境的版本。

--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 environment list

列出工作区中的环境。

az ml environment list [--archived-only]
                       [--include-archived]
                       [--max-results]
                       [--name]
                       [--registry-name]
                       [--resource-group]
                       [--workspace-name]

示例

列出工作区中的所有环境

az ml environment list --resource-group my-resource-group --workspace-name my-workspace

列出工作区中指定名称的所有环境版本

az ml environment list --name my-env --resource-group my-resource-group --workspace-name my-workspace

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

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

列出注册表中的所有环境

az ml environment list --registry-name my-registry-name --resource-group my-resource-group

列出注册表中指定名称的所有环境版本

az ml environment list --name my-env --registry-name my-registry-name --resource-group my-resource-group

可选参数

--archived-only

仅列出存档的环境。

默认值: False

--include-archived

列出存档环境和活动环境。

默认值: False

--max-results -r

要返回的最大结果数。

--name -n

环境的名称。 如果提供，将返回此名称下的所有环境版本。

--registry-name

如果提供，该命令将面向注册表而不是工作区。 因此，不需要资源组和工作区。

--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 environment restore

还原存档的环境。

还原存档环境后，将不再隐藏列表查询（az ml environment list）。 如果整个环境容器已存档，可以还原已存档的该容器。 这将还原该给定名称下环境的所有版本。 如果整个环境容器已存档，则不能仅还原特定环境版本，而是需要还原整个容器。 如果仅存档了单个环境版本，则可以还原该特定版本。

az ml environment restore --name
                          [--label]
                          [--registry-name]
                          [--resource-group]
                          [--version]
                          [--workspace-name]

示例

还原存档的环境容器（还原该环境的所有版本）

az ml environment restore --name my-env --resource-group my-resource-group --workspace-name my-workspace

还原特定的存档环境版本

az ml environment restore --name my-env --version 1 --resource-group my-resource-group --workspace-name my-workspace

必需参数

--name -n

环境的名称。

可选参数

--label -l

环境的标签。

--registry-name

如果提供，该命令将面向注册表而不是工作区。 因此，不需要资源组和工作区。

--resource-group -g

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

--version -v

环境的版本。

--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 environment share

从工作区共享到注册表的特定环境。

将现有环境从工作区复制到注册表，以便重复使用跨工作区。

az ml environment share --name
                        --registry-name
                        --share-with-name
                        --share-with-version
                        --version
                        [--resource-group]
                        [--workspace-name]

示例

将现有环境从工作区共享到注册表

az ml environment share --name my-environment --version my-version --resource-group my-resource-group --workspace-name my-workspace --share-with-name new-name-in-registry --share-with-version new-version-in-registry --registry-name my-registry

必需参数

--name -n

环境的名称。

--registry-name

目标注册表。

--share-with-name

要创建的环境的名称。

--share-with-version

要创建的环境的版本。

--version -v

环境的版本。

可选参数

--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 environment show

显示环境的详细信息。

az ml environment show --name
                       [--label]
                       [--registry-name]
                       [--resource-group]
                       [--version]
                       [--workspace-name]

示例

显示具有指定名称和版本的环境的详细信息

az ml environment show --name my-env --version 1 --resource-group my-resource-group --workspace-name my-workspace

显示注册表中具有指定名称和版本的环境的详细信息

az ml environment show --name my-env --version 1 --registry-name my-registry-name --resource-group my-resource-group

必需参数

--name -n

环境的名称。

可选参数

--label -l

环境的标签。

--registry-name

如果提供，该命令将面向注册表而不是工作区。 因此，不需要资源组和工作区。

--resource-group -g

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

--version -v

环境的版本。

--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 environment update

更新环境。

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

az ml environment update --name
                         [--add]
                         [--force-string]
                         [--label]
                         [--registry-name]
                         [--remove]
                         [--resource-group]
                         [--set]
                         [--version]
                         [--workspace-name]

必需参数

--name -n

环境的名称。

可选参数

--add

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

默认值: []

--force-string

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

默认值: False

--label -l

环境的标签。

--registry-name

如果提供，该命令将面向注册表而不是工作区。 因此，不需要资源组和工作区。

--remove

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

默认值: []

--resource-group -g

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

--set

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

默认值: []

--version -v

环境的版本。

--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 获取完整的调试日志。