AmlComputeProvisioningConfiguration Class

  • Reference

Represents configuration parameters for provisioning AmlCompute targets.

Use the provisioning_configuration method of the AmlCompute class to specify configuration parameters.

Create a configuration object for provisioning a AmlCompute target.

Inheritance
ComputeTargetProvisioningConfiguration
AmlComputeProvisioningConfiguration

Constructor

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)

Parameters

vm_size
str
Required

The size of agent VMs. More details can be found here: https://aka.ms/azureml-vm-details. Note that not all sizes are available in all regions, as detailed in the previous link. If not specified, defaults to Standard_NC6.

vm_priority
str
default value: dedicated

The VM priority, either "dedicated" or "lowpriority" VMs. If not specified, defaults to "dedicated".

min_nodes
int
default value: 0

The minimum number of nodes to use on the cluster. If not specified, defaults to 0.

max_nodes
int
default value: None

The maximum number of nodes to use on the cluster. Defaults to 4.

idle_seconds_before_scaledown
int
default value: 1800

The node idle time in seconds before scaling down the cluster. If not specified, defaults to 1800.

admin_username
str
default value: None

The name of the administrator user account which can be used to SSH into nodes.

admin_user_password
str
default value: None

The password of the administrator user account.

admin_user_ssh_key
str
default value: None

The SSH public key of the administrator user account.

vnet_resourcegroup_name
str
default value: None

The name of the resource group where the virtual network is located.

vnet_name
str
default value: None

The name of the virtual network.

subnet_name
str
default value: None

The name of the subnet inside the VNet.

tags
dict[str, str]
default value: None

A dictionary of key value tags to provide to the compute object.

description
str
default value: None

A description to provide to the compute object.

remote_login_port_public_access
str
default value: NotSpecified

The state of the public SSH port. Possible values are:

  • Disabled - Indicates that the public ssh port is closed on all nodes of the cluster.

  • Enabled - Indicates that the public ssh port is open on all nodes of the cluster.

  • NotSpecified - Indicates that the public ssh port is closed on all nodes of the cluster if VNet is defined, else is open all public nodes. It can be this default value only during cluster creation time. After creation, it will be either enabled or disabled.

identity_type
string
default value: None

Possible values are:

  • SystemAssigned - System assigned identity

  • UserAssigned - User assigned identity. Requires identity id to be set.

identity_id
list[str]
default value: None

List of resource ids for the user assigned identity. eg. ['/subscriptions//resourceGroups//providers/Microsoft.ManagedIdentity /userAssignedIdentities/']

vm_size
str
Required

The size of agent VMs. More details can be found here: https://aka.ms/azureml-vm-details. Note that not all sizes are available in all regions, as detailed in the previous link. If not specified, defaults to Standard_NC6.

vm_priority
str
Required

The VM priority, either "dedicated" or "lowpriority" VMs. If not specified, defaults to "dedicated".

min_nodes
int
Required

The minimum number of nodes to use on the cluster. If not specified, defaults to 0.

max_nodes
int
Required

The maximum number of nodes to use on the cluster. Defaults to 4.

idle_seconds_before_scaledown
int
Required

The node idle time in seconds before scaling down the cluster. If not specified, defaults to 1800.

admin_username
str
Required

The name of the administrator user account which can be used to SSH into nodes.

admin_user_password
str
Required

The password of the administrator user account.

admin_user_ssh_key
str
Required

The SSH public key of the administrator user account.

vnet_resourcegroup_name
str
Required

The name of the resource group where the virtual network is located.

vnet_name
str
Required

The name of the virtual network.

subnet_name
str
Required

The name of the subnet inside the VNet.

tags
dict[str, str]
Required

A dictionary of key value tags to provide to the compute object.

description
str
Required

A description to provide to the compute object.

remote_login_port_public_access
str
Required

The state of the public SSH port. Possible values are:

  • Disabled - Indicates that the public ssh port is closed on all nodes of the cluster.

  • Enabled - Indicates that the public ssh port is open on all nodes of the cluster.

  • NotSpecified - Indicates that the public ssh port is closed on all nodes of the cluster if VNet is defined, else is open all public nodes. This is the default value. The state can be in this default value only during cluster creation time. After creation, it will be either enabled or disabled.

identity_type
string
Required

Possible values are:

  • SystemAssigned - System assigned identity

  • UserAssigned - User assigned identity. Requires identity id to be set.

identity_id
list[str]
Required

List of resource ids for the user assigned identity. eg. ['/subscriptions//resourceGroups//providers/Microsoft.ManagedIdentity /userAssignedIdentities/']

compute_location
str
default value: None

Location to provision cluster in.

enable_node_public_ip
bool
default value: True

Enable node public IP. Possible values are:

  • True - Enable node public IP.

  • False - Disable node public IP.

  • NotSpecified - Enable node public IP.

Methods

validate_configuration

Check that the specified configuration values are valid.

Raises a ComputeTargetException if validation fails.

validate_configuration

Check that the specified configuration values are valid.

Raises a ComputeTargetException if validation fails.

validate_configuration()

Exceptions

ComputeTargetException