AmlComputeProvisioningConfiguration Class

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

Name	Description
vm_size Required	str 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 The VM priority, either "dedicated" or "lowpriority" VMs. If not specified, defaults to "dedicated". Default value: dedicated
min_nodes	int The minimum number of nodes to use on the cluster. If not specified, defaults to 0. Default value: 0
max_nodes	int The maximum number of nodes to use on the cluster. Defaults to 4. Default value: None
idle_seconds_before_scaledown	int The node idle time in seconds before scaling down the cluster. If not specified, defaults to 1800. Default value: 1800
admin_username	str The name of the administrator user account which can be used to SSH into nodes. Default value: None
admin_user_password	str The password of the administrator user account. Default value: None
admin_user_ssh_key	str The SSH public key of the administrator user account. Default value: None
vnet_resourcegroup_name	str The name of the resource group where the virtual network is located. Default value: None
vnet_name	str The name of the virtual network. Default value: None
subnet_name	str The name of the subnet inside the VNet. Default value: None
tags	dict[str, str] A dictionary of key value tags to provide to the compute object. Default value: None
description	str A description to provide to the compute object. Default value: None
remote_login_port_public_access	str 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. Default value: NotSpecified
identity_type	string Possible values are: SystemAssigned - System assigned identity UserAssigned - User assigned identity. Requires identity id to be set. Default value: None
identity_id	list[str] List of resource ids for the user assigned identity. eg. ['/subscriptions//resourceGroups//providers/Microsoft.ManagedIdentity /userAssignedIdentities/'] Default value: None
vm_size Required	str 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 Required	str The VM priority, either "dedicated" or "lowpriority" VMs. If not specified, defaults to "dedicated".
min_nodes Required	int The minimum number of nodes to use on the cluster. If not specified, defaults to 0.
max_nodes Required	int The maximum number of nodes to use on the cluster. Defaults to 4.
idle_seconds_before_scaledown Required	int The node idle time in seconds before scaling down the cluster. If not specified, defaults to 1800.
admin_username Required	str The name of the administrator user account which can be used to SSH into nodes.
admin_user_password Required	str The password of the administrator user account.
admin_user_ssh_key Required	str The SSH public key of the administrator user account.
vnet_resourcegroup_name Required	str The name of the resource group where the virtual network is located.
vnet_name Required	str The name of the virtual network.
subnet_name Required	str The name of the subnet inside the VNet.
tags Required	dict[str, str] A dictionary of key value tags to provide to the compute object.
description Required	str A description to provide to the compute object.
remote_login_port_public_access Required	str 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 Required	string Possible values are: SystemAssigned - System assigned identity UserAssigned - User assigned identity. Requires identity id to be set.
identity_id Required	list[str] List of resource ids for the user assigned identity. eg. ['/subscriptions//resourceGroups//providers/Microsoft.ManagedIdentity /userAssignedIdentities/']
compute_location	str Location to provision cluster in. Default value: None
enable_node_public_ip	bool Enable node public IP. Possible values are: True - Enable node public IP. False - Disable node public IP. NotSpecified - Enable node public IP. Default value: True

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

Type	Description
ComputeTargetException