你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
az ml workspace
注意
此参考是 Azure CLI 的 ml 扩展(版本 2.15.0 或更高版本)的一部分。 该扩展将在首次运行 az ml workspace 命令时自动安装。 详细了解扩展。
管理 Azure ML 工作区。
Azure ML 工作区是 Azure 机器学习的顶级资源。 它提供了一个集中的位置,用于跟踪 ML 工作流中使用的资产和资源,以及从训练作业生成的日志和项目。
如果要从 CLI v1 升级到 v2,需要在工作区管理范围内进行以下两项更改:
- 将
az ml workspace private-endpoint
命令升级到等效的az network private-endpoint
命令。 - 此外,将
az ml workspace share
命令升级到等效的az role assignment create
命令。
命令
名称 | 说明 | 类型 | Status |
---|---|---|---|
az ml workspace create |
创建工作区。 |
外延 | 加语 |
az ml workspace delete |
删除工作区。 |
外延 | 加语 |
az ml workspace diagnose |
诊断工作区设置问题。 |
外延 | 加语 |
az ml workspace list |
列出订阅中的所有工作区。 |
外延 | 加语 |
az ml workspace list-keys |
列出依赖资源的工作区密钥,例如 Azure 存储、Azure 容器注册表和 Azure Application Insights。 |
外延 | 加语 |
az ml workspace outbound-rule |
管理 Azure ML 工作区的托管网络的出站规则。 |
外延 | 加语 |
az ml workspace outbound-rule list |
列出工作区的所有托管网络出站规则。 |
外延 | 加语 |
az ml workspace outbound-rule remove |
从工作区的托管网络中删除出站规则。 |
外延 | 加语 |
az ml workspace outbound-rule set |
在工作区的托管网络中添加或更新出站规则。 |
外延 | 加语 |
az ml workspace outbound-rule show |
显示工作区的托管网络出站规则的详细信息。 |
外延 | 加语 |
az ml workspace provision-network |
预配工作区托管网络。 |
外延 | 加语 |
az ml workspace show |
显示工作区的详细信息。 |
外延 | 加语 |
az ml workspace sync-keys |
同步依赖资源的工作区密钥,例如 Azure 存储、Azure 容器注册表和 Azure Application Insights。 |
外延 | 加语 |
az ml workspace update |
更新工作区。 |
外延 | 加语 |
az ml workspace create
创建工作区。
创建工作区时,Azure ML 将使用的多个 Azure 资源默认也会创建:Azure 存储、Azure 容器注册表、Azure Key Vault 和 Azure Application Insights。 通过在工作区配置 YAML 文件中指定资源 ID,可以改为在创建工作区时为这些实例使用现有的 Azure 资源实例。
az ml workspace create --resource-group
[--allow-roleassignment-on-rg]
[--application-insights]
[--container-registry]
[--default-resource-group]
[--description]
[--display-name]
[--enable-data-isolation]
[--file]
[--hub-id]
[--image-build-compute]
[--key-vault]
[--kind]
[--location]
[--managed-network]
[--name]
[--no-wait]
[--primary-user-assigned-identity]
[--provision-network-now]
[--public-network-access]
[--set]
[--storage-account]
[--system-datastores-auth-mode]
[--tags]
[--update-dependent-resources]
示例
从 YAML 规范文件创建工作区。
az ml workspace create --file workspace.yml --resource-group my-resource-group
必需参数
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
可选参数
用于确定工作区是否可以在资源组级别上分配角色的标志。
与此工作区关联的 application Insights 的 ARM ID。
与此工作区关联的容器注册表的 ARM ID。
仅中心类型。 如果已设置,则此中心的子项目将默认设置其资源组。
Azure ML 工作区的说明。
工作区的显示名称。
用于确定工作区是否启用了数据隔离的标志。 标志只能在创建阶段设置,无法更新。
包含 Azure ML 工作区规范的 YAML 文件的本地路径。 可在以下位置找到工作区的 YAML 参考文档:https://aka.ms/ml-cli-v2-workspace-yaml-reference。
仅项目类型:定义此项目的父中心的 ARM ID。
容器注册表位于 VNet 后面时用于生成环境 Docker 映像的计算目标的名称。
与此工作区关联的密钥保管库的 ARM ID。
将工作区指定为特定类型,覆盖 YAML 中分配的值(如果存在)。 默认为默认值。 有效类型为:default、hub 和 project。
要用于新工作区的位置。
工作区的托管网络隔离模式。
Azure ML 工作区的名称。
不要等待工作区创建完成。
如果指定了多个托管标识,则主要用户分配的托管标识的 ARM 标识符。 也是无群集计算的默认托管标识。
设置为在创建启用了托管网络的工作包时触发托管网络的预配,否则不会执行任何操作。
启用工作区专用链接时允许公共终结点连接。
通过指定要设置的属性路径和值来更新对象。 示例:--set property1.property2=value。
与此工作区关联的存储帐户的 ARM ID。
指定系统数据存储的身份验证模式。 有效模式为:accesskey 和标识。
对象的标记的空间分隔键值对。
指定 --update_dependent_resources,同意更新工作区依赖资源。 更新工作区附加的 Azure 容器注册表或 Application Insights 资源可能会中断以前的作业、已部署的推理终结点或重新运行此工作区中早期作业的能力。
全局参数
增加日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
仅显示错误,禁止显示警告。
输出格式。
JMESPath 查询字符串。 有关详细信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
增加日志记录详细程度。 对完整调试日志使用 --debug。
az ml workspace delete
删除工作区。
默认情况下,不会删除与工作区关联的依赖资源(Azure 存储、Azure 容器注册表、Azure Key Vault、Azure Application Insights)。 若要同时删除这些资源,请包括 --all-resources。 若要永久删除工作区,请包括 --permanently-delete。
az ml workspace delete --name
--resource-group
[--all-resources]
[--no-wait]
[--permanently-delete]
[--yes]
必需参数
Azure ML 工作区的名称。 可以使用 az configure --defaults workspace=<name>
配置默认工作区。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
可选参数
删除与工作区关联的所有依赖资源(Azure 存储帐户、Azure 容器注册表、Azure Application Insights、Azure Key Vault)。
不要等待长时间运行的操作完成。 默认值为 False。
默认情况下,工作区是软删除状态,以允许恢复工作区数据。 设置此标志以替代软删除行为并永久删除工作区。
不要提示确认。
全局参数
增加日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
仅显示错误,禁止显示警告。
输出格式。
JMESPath 查询字符串。 有关详细信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
增加日志记录详细程度。 对完整调试日志使用 --debug。
az ml workspace diagnose
诊断工作区设置问题。
如果工作区未按预期工作,可以运行此诊断来检查工作区是否已损坏。 对于专用终结点工作区,它还有助于检查此工作区的网络设置及其依赖资源是否出现问题。
az ml workspace diagnose --name
--resource-group
[--no-wait]
示例
诊断工作区。
az ml workspace diagnose --name my-workspace-name --no-wait -g my-resource-group
必需参数
Azure ML 工作区的名称。 可以使用 az configure --defaults workspace=<name>
配置默认工作区。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
可选参数
不要等待长时间运行的操作完成。 默认值为 False。
全局参数
增加日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
仅显示错误,禁止显示警告。
输出格式。
JMESPath 查询字符串。 有关详细信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
增加日志记录详细程度。 对完整调试日志使用 --debug。
az ml workspace list
列出订阅中的所有工作区。
工作区列表可以按资源组进行筛选。
az ml workspace list [--filtered-kinds]
[--max-results]
[--resource-group]
示例
列出资源组中的所有工作区
az ml workspace list --resource-group my-resource-group
列出使用 --query 参数对命令结果执行 JMESPath 查询的所有工作区。
az ml workspace list --query "[].{Name:name}" --output table --resource-group my-resource-group
可选参数
仅列出指定类型的工作区,作为逗号分隔的列表。 有效类型为:default、hub 和 project。
要返回的最大结果数。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
全局参数
增加日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
仅显示错误,禁止显示警告。
输出格式。
JMESPath 查询字符串。 有关详细信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
增加日志记录详细程度。 对完整调试日志使用 --debug。
az ml workspace list-keys
列出依赖资源的工作区密钥,例如 Azure 存储、Azure 容器注册表和 Azure Application Insights。
az ml workspace list-keys --name
--resource-group
必需参数
Azure ML 工作区的名称。 可以使用 az configure --defaults workspace=<name>
配置默认工作区。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
全局参数
增加日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
仅显示错误,禁止显示警告。
输出格式。
JMESPath 查询字符串。 有关详细信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
增加日志记录详细程度。 对完整调试日志使用 --debug。
az ml workspace provision-network
预配工作区托管网络。
触发工作区来预配托管网络。 指定已启用 Spark 的标志可准备工作区托管网络以支持 Spark。 如果未指定,则默认值为 false,但稍后可以使用此标志再次运行此命令来启用。 启用后,无法禁用它。
az ml workspace provision-network --name
--resource-group
[--include-spark]
[--no-wait]
示例
预配托管网络。
az ml workspace provision-network --include-spark --name my-workspace-name --no-wait -g my-resource-group
必需参数
Azure ML 工作区的名称。 可以使用 az configure --defaults workspace=<name>
配置默认工作区。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
可选参数
如果应预配托管网络以考虑 Spark 作业,则为布尔值 [true/false]。 如果未设置标志,则默认值为 false。 稍后可以通过使用此标志再次运行此命令来启用它。
不要等待长时间运行的操作完成。 默认值为 False。
全局参数
增加日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
仅显示错误,禁止显示警告。
输出格式。
JMESPath 查询字符串。 有关详细信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
增加日志记录详细程度。 对完整调试日志使用 --debug。
az ml workspace show
显示工作区的详细信息。
az ml workspace show --name
--resource-group
必需参数
Azure ML 工作区的名称。 可以使用 az configure --defaults workspace=<name>
配置默认工作区。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
全局参数
增加日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
仅显示错误,禁止显示警告。
输出格式。
JMESPath 查询字符串。 有关详细信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
增加日志记录详细程度。 对完整调试日志使用 --debug。
az ml workspace sync-keys
同步依赖资源的工作区密钥,例如 Azure 存储、Azure 容器注册表和 Azure Application Insights。
如果工作区中任何资源的密钥已更改,可能需要大约一个小时才能自动更新它们。 此命令触发工作区以立即同步密钥。 在重新生成存储密钥后,可能需要立即访问存储。
az ml workspace sync-keys --name
--resource-group
[--no-wait]
必需参数
Azure ML 工作区的名称。 可以使用 az configure --defaults workspace=<name>
配置默认工作区。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
可选参数
不要等待长时间运行的操作完成。 默认值为 False。
全局参数
增加日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
仅显示错误,禁止显示警告。
输出格式。
JMESPath 查询字符串。 有关详细信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
增加日志记录详细程度。 对完整调试日志使用 --debug。
az ml workspace update
更新工作区。
可以更新“description”、“tags”和“friendly_name”属性。
az ml workspace update --name
--resource-group
[--add]
[--allow-roleassignment-on-rg]
[--application-insights]
[--container-registry]
[--description]
[--display-name]
[--file]
[--force-string]
[--image-build-compute]
[--managed-network]
[--network-acls]
[--no-wait]
[--primary-user-assigned-identity]
[--public-network-access]
[--remove]
[--set]
[--system-datastores-auth-mode]
[--update-dependent-resources]
示例
从 YAML 规范文件更新工作区。
az ml workspace update --resource-group my-resource-group --name my-workspace-name --file workspace.yml
必需参数
Azure ML 工作区的名称。 可以使用 az configure --defaults workspace=<name>
配置默认工作区。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
可选参数
通过指定路径和键值对将对象添加到对象列表。 示例:--add property.listProperty <key=value, string or JSON string>
。
用于确定工作区是否可以在资源组级别上分配角色的标志。
与此工作区关联的 application Insights 的 ARM ID。
与此工作区关联的容器注册表的 ARM ID。
Azure ML 工作区的说明。
工作区的显示名称。
包含 Azure ML 工作区规范的 YAML 文件的本地路径。 可在以下位置找到工作区的 YAML 参考文档:https://aka.ms/ml-cli-v2-workspace-yaml-reference。
使用“set”或“add”时,保留字符串文本,而不是尝试转换为 JSON。
容器注册表位于 VNet 后面时用于生成环境 Docker 映像的计算目标的名称。
工作区的托管网络隔离模式。
CIDR 表示法中允许访问工作区的 IP 地址或 IP 范围的逗号分隔列表。 示例:“XX.XX.XX.XX,XX.XX.XX.XX.XX/32”。 若要将公用网络访问设置为“Enabled”,请将 networkAcls 作为“none”(即,这将重置 network-acls),并将 PNA 标志设置为“Enabled”。 若要禁用,请将 PNA 标志设置为“Disabled”。 若要将公共网络访问设置为“已启用从所选 IP 地址启用”,请将 PNA 标志设置为“Enabled”,并在“network-acls”中传递 CIDR 表示法中以逗号分隔的 IP 列表。
不要等待长时间运行的操作完成。 默认值为 False。
与此工作区关联的主用户分配标识的 ARM ID。
启用工作区专用链接时允许公共终结点连接。
从列表中删除属性或元素。 示例:--remove property.list <indexToRemove>
或 --remove propertyToRemove
。
通过指定要设置的属性路径和值来更新对象。 示例:--set property1.property2=<value>
。
指定系统数据存储的身份验证模式。 有效模式为:accesskey 和标识。
指定 --update_dependent_resources,同意更新工作区依赖资源。 更新工作区附加的 Azure 容器注册表或 Application Insights 资源可能会中断以前的作业、已部署的推理终结点或重新运行此工作区中早期作业的能力。
全局参数
增加日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
仅显示错误,禁止显示警告。
输出格式。
JMESPath 查询字符串。 有关详细信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
增加日志记录详细程度。 对完整调试日志使用 --debug。