CLI (v2) compute cluster (AmlCompute) YAML schema

  • Article

APPLIES TO: Azure CLI ml extension v2 (current)

The source JSON schema can be found at https://azuremlschemas.azureedge.net/latest/amlCompute.schema.json.

Note

The YAML syntax detailed in this document is based on the JSON schema for the latest version of the ML CLI v2 extension. This syntax is guaranteed only to work with the latest version of the ML CLI v2 extension. You can find the schemas for older extension versions at https://azuremlschemasprod.azureedge.net/.

YAML syntax

Key Type Description Allowed values Default value
$schema string The YAML schema. If you use the Azure Machine Learning VS Code extension to author the YAML file, including $schema at the top of your file enables you to invoke schema and resource completions.
type string Required. The type of compute. amlcompute
name string Required. Name of the compute.
description string Description of the compute.
location string The location for the compute. If omitted, defaults to the workspace location.
size string The VM size to use for the cluster. For more information, see Supported VM series and sizes. Note that not all sizes are available in all regions. For the list of supported sizes in a given region, please use az ml compute list-sizes. Standard_DS3_v2
tier string The VM priority tier to use for the cluster. Low-priority VMs are pre-emptible but come at a reduced cost compared to dedicated VMs. dedicated, low_priority dedicated
min_instances integer The minimum number of nodes to use on the cluster. Setting the minimum number of nodes to 0 allows Azure Machine Learning to autoscale the cluster down to zero nodes when not in use. Any value larger than 0 will keep that number of nodes running, even if the cluster is not in use. 0
max_instances integer The maximum number of nodes to use on the cluster. 1
idle_time_before_scale_down integer Node idle time in seconds before scaling down the cluster. 120
ssh_public_access_enabled boolean Whether to enable public SSH access on the nodes of the cluster. false
ssh_settings object SSH settings for connecting to the cluster.
ssh_settings.admin_username string The name of the administrator user account that can be used to SSH into nodes.
ssh_settings.admin_password string The password of the administrator user account. One of admin_password or ssh_key_value is required.
ssh_settings.ssh_key_value string The SSH public key of the administrator user account. One of admin_password or ssh_key_value is required.
network_settings object Network security settings.
network_settings.vnet_name string Name of the virtual network (VNet) when creating a new one or referencing an existing one.
network_settings.subnet string Either the name of the subnet when creating a new VNet or referencing an existing one, or the fully qualified resource ID of a subnet in an existing VNet. Do not specify network_settings.vnet_name if the subnet ID is specified. The subnet ID can refer to a VNet/subnet in another resource group.
identity object The managed identity configuration to assign to the compute. AmlCompute clusters support only one system-assigned identity or multiple user-assigned identities, not both concurrently.
identity.type string The type of managed identity to assign to the compute. If the type is user_assigned, the identity.user_assigned_identities property must also be specified. system_assigned, user_assigned
identity.user_assigned_identities array List of fully qualified resource IDs of the user-assigned identities.

Remarks

The az ml compute commands can be used for managing Azure Machine Learning compute clusters (AmlCompute).

Examples

Examples are available in the examples GitHub repository. Several are shown below.

YAML: minimal

$schema: https://azuremlschemas.azureedge.net/latest/amlCompute.schema.json 
name: minimal-example
type: amlcompute

YAML: basic

$schema: https://azuremlschemas.azureedge.net/latest/amlCompute.schema.json 
name: basic-example
type: amlcompute
size: STANDARD_DS3_v2
min_instances: 0
max_instances: 2
idle_time_before_scale_down: 120

YAML: custom location

$schema: https://azuremlschemas.azureedge.net/latest/amlCompute.schema.json 
name: location-example
type: amlcompute
size: STANDARD_DS3_v2
min_instances: 0
max_instances: 2
idle_time_before_scale_down: 120
location: chinaeast2

YAML: low priority

$schema: https://azuremlschemas.azureedge.net/latest/amlCompute.schema.json 
name: low-pri-example
type: amlcompute
size: STANDARD_DS3_v2
min_instances: 0
max_instances: 2
idle_time_before_scale_down: 120
tier: low_priority

YAML: SSH username and password

$schema: https://azuremlschemas.azureedge.net/latest/amlCompute.schema.json 
name: ssh-example
type: amlcompute
size: STANDARD_DS3_v2
min_instances: 0
max_instances: 2
idle_time_before_scale_down: 120
ssh_settings:
  admin_username: example-user
  admin_password: example-password

Next steps