Edit

CLI (v2) compute instance YAML schema

  • Article

APPLIES TO: Azure CLI ml extension v2 (current)

The source JSON schema can be found at https://azuremlschemas.azureedge.net/latest/computeInstance.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. computeinstance
name string Required. Name of the compute.
description string Description of the compute.
size string The VM size to use for the compute instance. 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 the az ml compute list-sizes command. Standard_DS3_v2
create_on_behalf_of object Settings for creating the compute instance on behalf of another user. Please ensure that the assigned user has correct RBAC permissions.
create_on_behalf_of.user_tenant_id string The AAD Tenant ID of the assigned user.
create_on_behalf_of.user_object_id string The AAD Object ID of the assigned user.
ssh_public_access_enabled boolean Whether to enable public SSH access on the compute instance. false
ssh_settings object SSH settings for connecting to the compute instance.
ssh_settings.ssh_key_value string The SSH public key of the administrator user account.
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 command can be used for managing Azure Machine Learning compute instances.

YAML: minimal

$schema: https://azuremlschemas.azureedge.net/latest/computeInstance.schema.json
name: minimal-example-i
type: computeinstance

YAML: basic

$schema: https://azuremlschemas.azureedge.net/latest/computeInstance.schema.json 
name: basic-example-i
type: computeinstance
size: STANDARD_DS3_v2

Next steps