AmlComputeProvisioningConfiguration 类

  • 参考

表示用于预配 AmlCompute 目标的配置参数。

使用 AmlCompute 类的 provisioning_configuration 方法指定 configuration 参数。

创建用于预配 AmlCompute 目标的配置对象。

继承
ComputeTargetProvisioningConfiguration
AmlComputeProvisioningConfiguration

构造函数

AmlComputeProvisioningConfiguration(vm_size='', vm_priority='dedicated', min_nodes=0, max_nodes=None, idle_seconds_before_scaledown=1800, admin_username=None, admin_user_password=None, admin_user_ssh_key=None, vnet_resourcegroup_name=None, vnet_name=None, subnet_name=None, tags=None, description=None, remote_login_port_public_access='NotSpecified', identity_type=None, identity_id=None, compute_location=None, enable_node_public_ip=True)

参数

vm_size
str
必需

代理 VM 的大小。 此处提供了更多详细信息：https://aka.ms/azureml-vm-details。 请注意，并非所有大小都适用于所有区域，如上一个链接中所述。 如果未指定，则默认为 Standard_NC6。

vm_priority
str
默认值: dedicated

VM 优先级，“dedicated”或“lowpriority”VM。 如果未指定，则默认为“dedicated”。

min_nodes
int
默认值: 0

要在群集上使用的最小节点数。 如果未指定该项，则默认值为 0。

max_nodes
int
默认值: None

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

idle_seconds_before_scaledown
int
默认值: 1800

缩减群集之前的节点空闲时间（秒）。 如果未指定，则默认为 1800。

admin_username
str
默认值: None

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

admin_user_password
str
默认值: None

管理员用户帐户的密码。

admin_user_ssh_key
str
默认值: None

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

vnet_resourcegroup_name
str
默认值: None

虚拟网络所在的资源组的名称。

vnet_name
str
默认值: None

虚拟网络的名称。

subnet_name
str
默认值: None

VNet 内子网的名称。

tags
dict[str, str]
默认值: None

要提供给计算对象的键值标记的字典。

description
str
默认值: None

要提供给计算对象的说明。

remote_login_port_public_access
str
默认值: NotSpecified

公共 SSH 端口的状态。 可能的值包括：

  • 已禁用 - 指示群集的所有节点上的公用 ssh 端口已关闭。

  • 已启用 - 指示群集的所有节点上的公用 ssh 端口已打开。

  • NotSpecified - 指示如果定义了 VNet，则群集的所有节点上的公共 ssh 端口已关闭，否则将打开所有公共节点。 它只能在创建群集时作为此默认值。 创建后，它将被启用或禁用。

identity_type
string
默认值: None

可能的值包括：

  • SystemAssigned - 系统分配的标识

  • UserAssigned - 用户分配的标识。 需要设置标识 ID。

identity_id
list[str]
默认值: None

用户分配标识的资源 ID 列表。 例如 ['/subscriptions//resourceGroups//providers/Microsoft.ManagedIdentity /userAssignedIdentities/']

vm_size
str
必需

代理 VM 的大小。 此处提供了更多详细信息：https://aka.ms/azureml-vm-details。 请注意，并非所有大小都适用于所有区域，如上一个链接中所述。 如果未指定，则默认为 Standard_NC6。

vm_priority
str
必需

VM 优先级，“dedicated”或“lowpriority”VM。 如果未指定，则默认为“dedicated”。

min_nodes
int
必需

要在群集上使用的最小节点数。 如果未指定该项，则默认值为 0。

max_nodes
int
必需

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

idle_seconds_before_scaledown
int
必需

缩减群集之前的节点空闲时间（秒）。 如果未指定，则默认为 1800。

admin_username
str
必需

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

admin_user_password
str
必需

管理员用户帐户的密码。

admin_user_ssh_key
str
必需

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

vnet_resourcegroup_name
str
必需

虚拟网络所在的资源组的名称。

vnet_name
str
必需

虚拟网络的名称。

subnet_name
str
必需

VNet 内子网的名称。

tags
dict[str, str]
必需

要提供给计算对象的键值标记的字典。

description
str
必需

要提供给计算对象的说明。

remote_login_port_public_access
str
必需

公共 SSH 端口的状态。 可能的值包括：

  • 已禁用 - 指示群集的所有节点上的公用 ssh 端口已关闭。

  • 已启用 - 指示群集的所有节点上的公用 ssh 端口已打开。

  • NotSpecified - 指示如果定义了 VNet，则群集的所有节点上的公共 ssh 端口已关闭，否则将打开所有公共节点。 这是默认值。 状态只能在群集创建期间处于此默认值。 创建后，它将被启用或禁用。

identity_type
string
必需

可能的值包括：

  • SystemAssigned - 系统分配的标识

  • UserAssigned - 用户分配的标识。 需要设置标识 ID。

identity_id
list[str]
必需

用户分配标识的资源 ID 列表。 例如 ['/subscriptions//resourceGroups//providers/Microsoft.ManagedIdentity /userAssignedIdentities/']

compute_location
str
默认值: None

要在其中预配群集的位置。

enable_node_public_ip
bool
默认值: True

启用节点公共 IP。 可能的值包括：

  • True - 启用节点公共 IP。

  • False - 禁用节点公共 IP。

  • NotSpecified - 启用节点公共 IP。

方法

validate_configuration

检查指定的配置值是否有效。

如果验证失败，则会引发 ComputeTargetException。

validate_configuration

检查指定的配置值是否有效。

如果验证失败，则会引发 ComputeTargetException。

validate_configuration()

例外

ComputeTargetException