locally connect

Preview

During Public Preview you can use the Team plan for free, and get an early-adopter discount at GA. Sign in

locally connect

This page is part of the CLI Reference and is generated from the CLI's own help output, so it matches what locally connect --help prints.

locally connect

Connect to a Virtual Machine or a Virtual Machine Scale Set instance.

Connects to a Virtual Machine, or an instance of a Virtual Machine Scale Set, using its admin
credentials. Linux VMs open an SSH session in your terminal. Windows VMs open an .rdp file on macOS;
elsewhere, the file's path is printed.

The VM needs a public IP, or a Load Balancer inbound NAT rule targeting its network interface.

Pass --bastion alone to list the VMs reachable through it, or with --virtual-machine to connect
through it.

Examples:
locally connect --virtual-machine my-vm
  locally connect --virtual-machine my-vm --subscription 00000000-0000-0000-0000-000000000000
  locally connect --virtual-machine-scale-set my-scale-set --instance-id 0
  locally connect --bastion my-bastion
  locally connect --bastion my-bastion --virtual-machine my-vm

Usage

locally connect [flags]

Flags

--bastion string                     Name of a bastion; lists reachable VMs, or connects through it when combined with --virtual-machine
  -h, --help[=true|false]                  help for connect
      --instance-id string                 Instance ID within the scale set (use with --virtual-machine-scale-set)
      --subscription string                Subscription UUID (defaults to the configured default)
      --virtual-machine string             Name of the virtual machine to connect to
      --virtual-machine-scale-set string   Name of the virtual machine scale set holding the instance to connect to
Preview

During Public Preview you can use the Team plan for free, and get an early-adopter discount at GA. Sign in

A local cloud for you and your AI agents.

Your Azure infrastructure, running on your machine. Deploy in seconds, break things freely, and ship to Azure when you're ready.