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

az ml compute

注意

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

管理 Azure ML 计算资源。

Azure ML 计算目标是指定的计算资源，可在其中运行作业进行训练或部署模型进行推理。

命令

名称	说明	类型	状态
az ml compute attach	将现有计算资源附加到工作区。	扩展	GA
az ml compute connect-ssh	设置与计算实例的 SSH 连接。	扩展	预览
az ml compute create	创建计算目标。	扩展	GA
az ml compute delete	删除计算目标。	扩展	GA
az ml compute detach	从工作区中分离以前附加的计算资源。	扩展	GA
az ml compute list	列出工作区中的计算目标。	扩展	GA
az ml compute list-nodes	列出计算目标的节点详细信息。 此命令唯一支持的计算类型是 AML 计算。	扩展	GA
az ml compute list-sizes	按位置列出可用的 VM 大小。	扩展	GA
az ml compute list-usage	列出 VM 的可用使用情况资源。	扩展	GA
az ml compute restart	重启 ComputeInstance 目标。	扩展	GA
az ml compute show	显示计算目标的详细信息。	扩展	GA
az ml compute start	启动 ComputeInstance 目标。	扩展	GA
az ml compute stop	停止 ComputeInstance 目标。	扩展	GA
az ml compute update	更新计算目标。	扩展	GA

az ml compute attach

将现有计算资源附加到工作区。

Kubernetes 群集和远程 VM 可以作为计算目标进行附加。

az ml compute attach --resource-group
                     --workspace-name
                     [--admin-password]
                     [--admin-username]
                     [--file]
                     [--identity-type]
                     [--name]
                     [--namespace]
                     [--no-wait]
                     [--resource-id]
                     [--ssh-port]
                     [--ssh-private-key-file]
                     [--type]
                     [--user-assigned-identities]

必需参数

--resource-group -g

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

--workspace-name -w

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

可选参数

--admin-password

可用于通过 SSH 连接到节点的管理员用户密码。

--admin-username

可用于通过 SSH 连接到节点的管理员用户帐户的名称。

--file -f

包含 Azure ML 计算规范的 YAML 文件的本地路径。

--identity-type

托管标识的类型。 允许的值：SystemAssigned、UserAssigned。

--name -n

计算目标的名称（如果未在 yaml 文件中指定，则为必需）。

--namespace

KubernetesCompute 的命名空间。

--no-wait

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

默认值: False

--resource-id

资源的完全限定 ID，包括资源名称和资源类型（在 yaml 文件中未指定时是必需的）。

--ssh-port

可用于通过 SSH 连接到节点的端口号。 如果未指定，将使用默认（端口 22）。

--ssh-private-key-file

包含管理员用户帐户的 SSH 私钥的文件。

--type -t

计算目标的类型。 允许的值：virtualmachine、Kubernetes。

--user-assigned-identities -i

用户分配的标识的资源 ID，对于 --identity_type=UserAssigned 是必需的。

全局参数

--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 compute connect-ssh

预览

此命令处于预览阶段，正在开发中。 参考和支持级别： https://aka.ms/CLI_refstatus

设置与计算实例的 SSH 连接。

az ml compute connect-ssh --name
                          --resource-group
                          --workspace-name
                          [--private-key-file-path]

示例

通过 SSH 连接计算实例

az ml compute connect-ssh --name ci1 --resource-group my-resource-group --workspace-name my-workspace --private-key-file-path sshkey.pem

必需参数

--name -n

计算目标的名称。 必需。

--resource-group -g

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

--workspace-name -w

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

可选参数

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

创建计算目标。

可以创建一个 AmlCompute 群集，该群集是 Azure ML 的托管计算基础结构，也可以创建一个计算实例，该实例是基于云的托管工作站。

az ml compute create --resource-group
                     --workspace-name
                     [--admin-password]
                     [--admin-username]
                     [--description]
                     [--enable-node-public-ip]
                     [--file]
                     [--identity-type]
                     [--idle-time-before-scale-down]
                     [--location]
                     [--max-instances]
                     [--min-instances]
                     [--name]
                     [--no-wait]
                     [--set]
                     [--size]
                     [--ssh-key-value]
                     [--ssh-public-access-enabled]
                     [--subnet]
                     [--tags]
                     [--tier]
                     [--type]
                     [--user-assigned-identities]
                     [--user-object-id]
                     [--user-tenant-id]
                     [--vnet-name]

示例

从 YAML 规范文件创建计算目标

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

使用命令选项创建 AmlCompute 目标

az ml compute create --name nc6-cluster --size Standard_NC6 --min-instances 0 --max-instances 5 --type AmlCompute --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>。

可选参数

--admin-password

如果身份验证类型为“密码”，则管理员用户帐户的密码。

--admin-username

可用于通过 SSH 连接到节点的管理员用户帐户的名称。

--description

计算目标的说明。

--enable-node-public-ip

指示是否启用公共 IP。 默认值：True。

--file -f

包含 Azure ML 计算规范的 YAML 文件的本地路径。 可在以下位置找到用于计算的 YAML 参考文档： https://aka.ms/ml-cli-v2-compute-aml-yaml-reference。 https://aka.ms/ml-cli-v2-compute-instance-yaml-referencehttps://aka.ms/ml-cli-v2-compute-vm-yaml-reference

--identity-type

托管标识的类型。 允许的值：SystemAssigned、UserAssigned。

--idle-time-before-scale-down -d

缩减群集之前的节点空闲时间（秒）。 默认值：120。

--location -l

计算的位置。 如果未指定，则默认为工作区的位置。

--max-instances

要在群集上使用的最大节点数。 默认值：4。

--min-instances

要在群集上使用的最小节点数。 默认值：0。

--name -n

计算目标的名称。 如果未提供 --file/-f，则为必需。

--no-wait

不要等待长时间运行的操作完成。 默认值为 False。

默认值: False

--set

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

--size

要用于计算目标的 VM 大小。 此处提供了更多详细信息：https://aka.ms/azureml-vm-details。

--ssh-key-value

管理员用户帐户的 SSH 公钥。

--ssh-public-access-enabled -p

指示是否启用公共 SSH 端口。

--subnet

子网的名称。 还可以按 ID 而不是名称引用现有 vnet 中的子网。 如果指定了子网 ID，则将忽略 vnet-name。 子网 ID 可以通过指定完全限定的子网 ID 来引用另一个 RG 中的 vnet/子网。 指定 vnet 名称时是必需的。

--tags

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

--tier

VM 优先级层。 允许的值：专用、low_priority。

--type -t

计算目标的类型。 如果未提供 --file/-f，则为必需。 允许的值：AmlCompute、ComputeInstance。

--user-assigned-identities -i

使用“[system]”设置系统分配的标识，否则输入资源 ID 用逗号（即，）分隔来设置用户分配的标识。

--user-object-id

已分配用户的 AAD 对象 ID。

--user-tenant-id

已分配用户的 AAD 租户 ID。

--vnet-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 compute delete

删除计算目标。

az ml compute delete --name
                     --resource-group
                     --workspace-name
                     [--no-wait]
                     [--yes]

必需参数

--name -n

计算目标的名称（如果未在 yaml 文件中指定，则为必需）。

--resource-group -g

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

--workspace-name -w

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

可选参数

--no-wait

不要等待长时间运行的操作完成。 默认值为 False。

默认值: False

--yes -y

不提示确认。

默认值: 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 compute detach

从工作区中分离以前附加的计算资源。

az ml compute detach --name
                     --resource-group
                     --workspace-name
                     [--no-wait]
                     [--yes]

必需参数

--name -n

计算目标的名称（如果未在 yaml 文件中指定，则为必需）。

--resource-group -g

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

--workspace-name -w

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

可选参数

--no-wait

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

默认值: False

--yes -y

不提示确认。

默认值: 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 compute list

列出工作区中的计算目标。

az ml compute list --resource-group
                   --workspace-name
                   [--max-results]
                   [--type]

示例

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

az ml compute list --query "[].{Name:name}"  --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>。

可选参数

--max-results -r

要返回的最大结果数。

--type

计算目标的类型。 允许的值：AmlCompute、ComputeInstance、Kubernetes。

全局参数

--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 compute list-nodes

列出计算目标的节点详细信息。 此命令唯一支持的计算类型是 AML 计算。

az ml compute list-nodes --name
                         --resource-group
                         --workspace-name

示例

列出 AML 计算目标的节点详细信息

az ml compute list-nodes --name nc6-cluster --resource-group my-resource-group --workspace-name my-workspace

必需参数

--name -n

计算目标的名称（如果未在 yaml 文件中指定，则为必需）。

--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 compute list-sizes

按位置列出可用的 VM 大小。

az ml compute list-sizes --resource-group
                         --workspace-name
                         [--location]
                         [--type]

必需参数

--resource-group -g

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

--workspace-name -w

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

可选参数

--location -l

Location。 az account list-locations 中的值。 可以使用 az configure --defaults location=<location> 配置默认位置。

--type -t

计算目标的类型。 允许的值：AmlCompute、ComputeInstance。

全局参数

--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 compute list-usage

列出 VM 的可用使用情况资源。

az ml compute list-usage --resource-group
                         --workspace-name
                         [--location]

必需参数

--resource-group -g

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

--workspace-name -w

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

可选参数

--location -l

默认为工作区位置。

全局参数

--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 compute restart

重启 ComputeInstance 目标。

建议使用 --no-wait 选项。

az ml compute restart --name
                      --resource-group
                      --workspace-name
                      [--no-wait]

必需参数

--name -n

计算目标的名称（如果未在 yaml 文件中指定，则为必需）。

--resource-group -g

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

--workspace-name -w

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

可选参数

--no-wait

不要等待长时间运行的操作完成。 默认值为 False。

默认值: 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 compute show

显示计算目标的详细信息。

az ml compute show --name
                   --resource-group
                   --workspace-name

示例

显示计算目标的详细信息

az ml compute show --name nc6-cluster --resource-group my-resource-group --workspace-name my-workspace

必需参数

--name -n

计算目标的名称（如果未在 yaml 文件中指定，则为必需）。

--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 compute start

启动 ComputeInstance 目标。

建议使用 --no-wait 选项。

az ml compute start --name
                    --resource-group
                    --workspace-name
                    [--no-wait]

必需参数

--name -n

计算目标的名称（如果未在 yaml 文件中指定，则为必需）。

--resource-group -g

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

--workspace-name -w

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

可选参数

--no-wait

不要等待长时间运行的操作完成。 默认值为 False。

默认值: 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 compute stop

停止 ComputeInstance 目标。

建议使用 --no-wait 选项。

az ml compute stop --name
                   --resource-group
                   --workspace-name
                   [--no-wait]

必需参数

--name -n

计算目标的名称（如果未在 yaml 文件中指定，则为必需）。

--resource-group -g

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

--workspace-name -w

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

可选参数

--no-wait

不要等待长时间运行的操作完成。 默认值为 False。

默认值: 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 compute update

更新计算目标。

可以更新“tags”、“max_instances”、“min_instances”、“idle_time_before_scale_down”、“identity_type”和“user_assigned_identities”属性。

az ml compute update --name
                     --resource-group
                     --workspace-name
                     [--add]
                     [--force-string]
                     [--identity-type]
                     [--idle-time-before-scale-down]
                     [--max-instances]
                     [--min-instances]
                     [--no-wait]
                     [--remove]
                     [--set]
                     [--tags]
                     [--user-assigned-identities]

示例

更新 AmlCompute 群集的最小节点数

az ml compute update --name nc6-cluster --min-instances 1 --resource-group my-resource-group --workspace-name my-workspace

更新现有标记或为 AmlCompute 群集添加新标记

az ml compute update --name nc6-cluster --tags key1=value1 key2=value2 --resource-group my-resource-group --workspace-name my-workspace

必需参数

--name -n

计算目标的名称（如果未在 yaml 文件中指定，则为必需）。

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

--identity-type

托管标识的类型。 允许的值：SystemAssigned、UserAssigned。

--idle-time-before-scale-down -d

缩减群集之前的节点空闲时间（秒）。 默认值：120。

--max-instances

要使用的节点数上限。 默认值：4。

--min-instances

要使用的最小节点数。 默认值：0。

--no-wait

不要等待长时间运行的操作完成。 默认值为 False。

默认值: False

--remove

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

默认值: []

--set

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

默认值: []

--tags

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

--user-assigned-identities -i

使用“[system]”设置系统分配的标识，否则输入资源 ID 用逗号（即，）分隔来设置用户分配的标识。

全局参数

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