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

az batchai cluster

此命令组已隐式弃用,因为命令组“batchai”已弃用,将在将来的版本中删除。

用于管理群集的命令。

命令

名称 说明 类型 状态
az batchai cluster auto-scale

为群集设置自动缩放参数。

核心 已放弃
az batchai cluster create

创建群集。

核心 已放弃
az batchai cluster delete

删除群集。

核心 已放弃
az batchai cluster file

用于处理节点安装任务生成的文件的命令。

核心 已放弃
az batchai cluster file list

列出群集的节点设置任务生成的文件。

核心 已放弃
az batchai cluster list

列出群集。

核心 已放弃
az batchai cluster node

用于群集节点的命令。

核心 已放弃
az batchai cluster node exec

在具有可选端口转发的群集节点上执行命令行。

核心 已放弃
az batchai cluster node list

列出群集节点的远程登录信息。

核心 已放弃
az batchai cluster resize

重设群集大小。

核心 已放弃
az batchai cluster show

显示有关群集的信息。

核心 已放弃

az batchai cluster auto-scale

已放弃

此命令已隐式弃用,因为命令组“batchai”已弃用,将在将来的版本中删除。

为群集设置自动缩放参数。

az batchai cluster auto-scale --max
                              --min
                              [--ids]
                              [--name]
                              [--resource-group]
                              [--subscription]
                              [--workspace]

示例

根据排队和正在运行的作业数,使群集自动缩放 0 到 10 个节点。

az batchai cluster auto-scale -g MyResourceGroup -w MyWorkspace -n MyCluster --min 0 --max 10

必需参数

--max

最大节点数。

--min

最小节点数。

可选参数

--ids

一个或多个资源 ID(空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。

--name -n

群集的名称。

--resource-group -g

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

--subscription

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

--workspace -w

工作区的名称。

全局参数
--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 batchai cluster create

已放弃

此命令已隐式弃用,因为命令组“batchai”已弃用,将在将来的版本中删除。

创建群集。

az batchai cluster create --name
                          --resource-group
                          --workspace
                          [--afs-mount-path]
                          [--afs-name]
                          [--bfs-mount-path]
                          [--bfs-name]
                          [--config-file]
                          [--custom-image]
                          [--generate-ssh-keys]
                          [--image]
                          [--max]
                          [--min]
                          [--nfs]
                          [--nfs-mount-path]
                          [--password]
                          [--setup-task]
                          [--setup-task-output]
                          [--ssh-key]
                          [--storage-account-key]
                          [--storage-account-name]
                          [--subnet]
                          [--target]
                          [--use-auto-storage]
                          [--user-name]
                          [--vm-priority {dedicated, lowpriority}]
                          [--vm-size]

示例

创建具有默认映像和自动存储帐户的单个节点 GPU 群集。

az batchai cluster create -g MyResourceGroup -w MyWorkspace -n MyCluster \
    -s Standard_NC6 -t 1 --use-auto-storage --generate-ssh-keys

使用安装命令创建群集,该命令会在每个节点上安装解压缩,命令输出将存储在自动存储帐户 Azure 文件共享上。

az batchai cluster create -g MyResourceGroup -w MyWorkspace -n MyCluster \
    --use-auto-storage \
    -s Standard_NC6 -t 1 -k id_rsa.pub \
    --setup-task 'apt update; apt install unzip -y' \
    --setup-task-output '$AZ_BATCHAI_MOUNT_ROOT/autoafs'

创建手动提供所有参数的群集。

az batchai cluster create -g MyResourceGroup -w MyWorkspace -n MyCluster \
    -i UbuntuLTS -s Standard_NC6 --vm-priority lowpriority \
    --min 0 --target 1 --max 10 \
    --storage-account-name MyStorageAccount \
    --nfs MyNfsToMount --afs-name MyAzureFileShareToMount \
    --bfs-name MyBlobContainerNameToMount \
    -u AdminUserName -k id_rsa.pub -p ImpossibleToGuessPassword

使用配置文件创建群集。

az batchai cluster create -g MyResourceGroup -w MyWorkspace -n MyCluster -f cluster.json

必需参数

--name -n

群集的名称。

--resource-group -g

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

--workspace -w

工作区的名称。

可选参数

--afs-mount-path

Azure 文件共享的相对装载路径。 文件共享将在 $AZ_BATCHAI_MOUNT_ROOT/<relative_mount_path> 文件夹中提供。

默认值: afs
--afs-name

要在每个群集节点上装载的 Azure 文件共享的名称。 必须与 --storage-account-name 结合使用。 可以使用配置文件装载多个共享(请参阅 --config-file 选项)。

--bfs-mount-path

Azure 存储容器的相对装载路径。 容器将在 $AZ_BATCHAI_MOUNT_ROOT/<relative_mount_path> 文件夹中提供。

默认值: bfs
--bfs-name

要在每个群集节点上装载的Azure 存储容器的名称。 必须与 --storage-account-name 结合使用。 可以使用配置文件装载多个容器(请参阅 --config-file 选项)。

--config-file -f

包含群集创建参数的 json 文件的路径(azure.mgmt.batchai.models.ClusterCreateParameters 的 json 表示形式)。

--custom-image

要用于创建节点的虚拟机映像的 ARM ID。 请注意,需要提供 --image 包含有关用于创建此映像的基础映像的信息。

--generate-ssh-keys

在 ~/.ssh 目录中生成 SSH 公钥和私钥文件(如果缺少)。

--image -i

群集节点的操作系统映像。 该值可能包含别名(UbuntuLTS、UbuntuDSVM),或者以“publisher:offer:sku:version”的形式指定映像详细信息。 如果未通过命令行或配置文件提供映像配置,Batch AI 将选择默认的 OS 映像。

--max

自动缩放群集的最大节点计数。

--min

自动缩放群集的最小节点计数。

--nfs

要装载在每个群集节点上的文件服务器的名称或 ARM ID。 如果文件服务器属于其他工作区,则需要提供完整的 ARM ID。 可以使用配置文件装载多个 NFS(请参阅 --config-file 选项)。

--nfs-mount-path

NFS 的相对装载路径。 NFS 将在 $AZ_BATCHAI_MOUNT_ROOT/<relative_mount_path> 文件夹中提供。

默认值: nfs
--password -p

要在每个计算节点上创建的管理员用户帐户的可选密码。

--setup-task

一个命令行,应在分配或重新启动每个计算节点上执行。 该任务在根帐户下的 bash 子Shell 中执行。

--setup-task-output

用于存储安装任务日志位置的目录路径。 请注意,Batch AI 将在此路径下创建多个帮助程序目录。 创建的目录通过“az cluster show”命令报告为 stdOutErrPathSuffix。

--ssh-key -k

可选 SSH 公钥值或路径。 如果 ommited 且未指定密码,将使用默认 SSH 密钥(~/.ssh/id_rsa.pub)。

--storage-account-key

存储帐户密钥。 如果存储帐户属于其他订阅,则为必需。 可以使用AZURE_BATCHAI_STORAGE_KEY环境变量指定。

--storage-account-name

存储要在每个群集节点上装载的 Azure 文件共享和/或Azure 存储容器的帐户名称。 可以使用AZURE_BATCHAI_STORAGE_ACCOUNT环境变量指定。

--subnet

要在其中放置群集的虚拟网络子网的 ARM ID。

--target -t

群集创建后应立即分配的节点数。 如果群集处于自动缩放模式,BatchAI 可以根据运行和排队作业的数量更改以后的节点数。

--use-auto-storage

如果提供,该命令将在名为“batchaiautostorage”的新资源组或现有资源组中创建存储帐户。 它还将创建名为“batchaishare”的 Azure 文件共享、名为“batchaicontainer”的 Azure Blob 容器。 文件共享和 Blob 容器将装载到$AZ_BATCHAI_MOUNT_ROOT/autoafs 的每个群集节点上,$AZ_BATCHAI_MOUNT_ROOT/autobfs。 如果资源组已存在,并且包含属于群集所在的同一区域的 approapriate 存储帐户,此命令将重复使用现有的存储帐户。

默认值: False
--user-name -u

要在每个计算节点上创建的管理员用户帐户的名称。 如果未提供该值,并且配置文件中未提供任何用户配置,将使用当前用户名。

--vm-priority

VM 优先级。

接受的值: dedicated, lowpriority
--vm-size -s

群集节点的 VM 大小(例如 1 个 GPU 节点Standard_NC6)。

全局参数
--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 batchai cluster delete

已放弃

此命令已隐式弃用,因为命令组“batchai”已弃用,将在将来的版本中删除。

删除群集。

az batchai cluster delete [--ids]
                          [--name]
                          [--no-wait]
                          [--resource-group]
                          [--subscription]
                          [--workspace]
                          [--yes]

示例

删除群集并等待删除完成。

az batchai cluster delete -g MyResourceGroup -w MyWorkspace -n MyCluster

为群集发送删除命令,不要等待删除完成。

az batchai cluster delete -g MyResourceGroup -w MyWorkspace -n MyCluster --no-wait

在不要求确认的情况下删除群集(对于非交互式方案)。

az batchai cluster delete -g MyResourceGroup -w MyWorkspace -n MyCluster -y

可选参数

--ids

一个或多个资源 ID(空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。

--name -n

群集的名称。

--no-wait

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

默认值: False
--resource-group -g

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

--subscription

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

--workspace -w

工作区的名称。

--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 batchai cluster list

已放弃

此命令已隐式弃用,因为命令组“batchai”已弃用,将在将来的版本中删除。

列出群集。

az batchai cluster list --resource-group
                        --workspace

示例

列出工作区中的所有群集。

az batchai cluster list -g MyResourceGroup -w MyWorkspace -o table

必需参数

--resource-group -g

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

--workspace -w

工作区的名称。

全局参数
--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 batchai cluster resize

已放弃

此命令已隐式弃用,因为命令组“batchai”已弃用,将在将来的版本中删除。

重设群集大小。

az batchai cluster resize --target
                          [--ids]
                          [--name]
                          [--resource-group]
                          [--subscription]
                          [--workspace]

示例

将群集的大小调整为零大小,以停止为其付费。

az batchai cluster resize -g MyResourceGroup -w MyWorkspace -n MyCluster -t 0

将群集的大小调整为具有 10 个节点。

az batchai cluster resize -g MyResourceGroup -w MyWorkspace -n MyCluster -t 10

必需参数

--target -t

计算节点的目标数量。

可选参数

--ids

一个或多个资源 ID(空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。

--name -n

群集的名称。

--resource-group -g

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

--subscription

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

--workspace -w

工作区的名称。

全局参数
--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 batchai cluster show

已放弃

此命令已隐式弃用,因为命令组“batchai”已弃用,将在将来的版本中删除。

显示有关群集的信息。

az batchai cluster show [--ids]
                        [--name]
                        [--resource-group]
                        [--subscription]
                        [--workspace]

示例

显示有关群集的完整信息。

az batchai cluster show -g MyResourceGroup -w MyWorkspace -n MyCluster

显示群集摘要。

az batchai cluster show -g MyResourceGroup -w MyWorkspace -n MyCluster -o table

可选参数

--ids

一个或多个资源 ID(空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。

--name -n

群集的名称。

--resource-group -g

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

--subscription

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

--workspace -w

工作区的名称。

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