title	titleSuffix	description	services	ms.service	ms.subservice	ms.topic	ms.custom	author	ms.author	ms.date	ms.reviewer
CLI (v2) attached Virtual Machine YAML schema	Azure Machine Learning	Reference documentation for the CLI (v2) attached Virtual Machine schema.	machine-learning	machine-learning	core	reference	cliv2, event-tier1-build-2022	lostmygithubaccount	copeters	10/21/2021	laobri

CLI (v2) attached Virtual Machine YAML schema

[!INCLUDE cli v2]

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.	`virtualmachine`
`name`	string	Required. Name of the compute.
`description`	string	Description of the compute.
`resource_id`	string	Required. Fully qualified resource ID of the Azure Virtual Machine to attach to the workspace as a compute target.
`ssh_settings`	object	SSH settings for connecting to the virtual machine.
`ssh_settings.admin_username`	string	The name of the administrator user account that can be used to SSH into the virtual machine.
`ssh_settings.admin_password`	string	The password of the administrator user account. One of `admin_password` or `ssh_private_key_file` is required.
`ssh_settings.ssh_private_key_file`	string	The local path to the SSH private key file of the administrator user account. One of `admin_password` or `ssh_private_key_file` is required.
`ssh_settings.ssh_port`	integer	The SSH port on the virtual machine.		`22`

The az ml compute command can be used for managing Virtual Machines (VM) attached to an Azure Machine Learning workspace.

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

:::code language="yaml" source="~/azureml-examples-main/cli/resources/compute/vm-attach.yml":::