Connect virtual networks with virtual network peering using PowerShell
This article has been updated to use the new Azure PowerShell Az module. You can still use the AzureRM module, which will continue to receive bug fixes until at least December 2020. To learn more about the new Az module and AzureRM compatibility, see Introducing the new Azure PowerShell Az module. For Az module installation instructions, see Install Azure PowerShell.
You can connect virtual networks to each other with virtual network peering. Once virtual networks are peered, resources in both virtual networks are able to communicate with each other, with the same latency and bandwidth as if the resources were in the same virtual network. In this article, you learn how to:
- Create two virtual networks
- Connect two virtual networks with a virtual network peering
- Deploy a virtual machine (VM) into each virtual network
- Communicate between VMs
If you don't have an Azure subscription, create a free account before you begin.
Use Azure Cloud Shell
Azure hosts Azure Cloud Shell, an interactive shell environment that you can use through your browser. You can use either Bash or PowerShell with Cloud Shell to work with Azure services. You can use the Cloud Shell preinstalled commands to run the code in this article without having to install anything on your local environment.
To start Azure Cloud Shell:
|Select Try It in the upper-right corner of a code block. Selecting Try It doesn't automatically copy the code to Cloud Shell.|
|Go to https://shell.azure.com, or select the Launch Cloud Shell button to open Cloud Shell in your browser.|
|Select the Cloud Shell button on the menu bar at the upper right in the Azure portal.|
To run the code in this article in Azure Cloud Shell:
Start Cloud Shell.
Select the Copy button on a code block to copy the code.
Paste the code into the Cloud Shell session by selecting Ctrl+Shift+V on Windows and Linux or by selecting Cmd+Shift+V on macOS.
Select Enter to run the code.
If you choose to install and use PowerShell locally, this article requires the Azure PowerShell module version 1.0.0 or later. Run
Get-Module -ListAvailable Az to find the installed version. If you need to upgrade, see Install Azure PowerShell module. If you are running PowerShell locally, you also need to run
Connect-AzAccount to create a connection with Azure.
Create virtual networks
Before creating a virtual network, you have to create a resource group for the virtual network, and all other resources created in this article. Create a resource group with New-AzResourceGroup. The following example creates a resource group named myResourceGroup in the eastus location.
New-AzResourceGroup -ResourceGroupName myResourceGroup -Location EastUS
Create a virtual network with New-AzVirtualNetwork. The following example creates a virtual network named myVirtualNetwork1 with the address prefix 10.0.0.0/16.
$virtualNetwork1 = New-AzVirtualNetwork ` -ResourceGroupName myResourceGroup ` -Location EastUS ` -Name myVirtualNetwork1 ` -AddressPrefix 10.0.0.0/16
Create a subnet configuration with New-AzVirtualNetworkSubnetConfig. The following example creates a subnet configuration with a 10.0.0.0/24 address prefix:
$subnetConfig = Add-AzVirtualNetworkSubnetConfig ` -Name Subnet1 ` -AddressPrefix 10.0.0.0/24 ` -VirtualNetwork $virtualNetwork1
Write the subnet configuration to the virtual network with Set-AzVirtualNetwork, which creates the subnet:
$virtualNetwork1 | Set-AzVirtualNetwork
Create a virtual network with a 10.1.0.0/16 address prefix and one subnet:
# Create the virtual network. $virtualNetwork2 = New-AzVirtualNetwork ` -ResourceGroupName myResourceGroup ` -Location EastUS ` -Name myVirtualNetwork2 ` -AddressPrefix 10.1.0.0/16 # Create the subnet configuration. $subnetConfig = Add-AzVirtualNetworkSubnetConfig ` -Name Subnet1 ` -AddressPrefix 10.1.0.0/24 ` -VirtualNetwork $virtualNetwork2 # Write the subnet configuration to the virtual network. $virtualNetwork2 | Set-AzVirtualNetwork
Peer virtual networks
Create a peering with Add-AzVirtualNetworkPeering. The following example peers myVirtualNetwork1 to myVirtualNetwork2.
Add-AzVirtualNetworkPeering ` -Name myVirtualNetwork1-myVirtualNetwork2 ` -VirtualNetwork $virtualNetwork1 ` -RemoteVirtualNetworkId $virtualNetwork2.Id
In the output returned after the previous command executes, you see that the PeeringState is Initiated. The peering remains in the Initiated state until you create the peering from myVirtualNetwork2 to myVirtualNetwork1. Create a peering from myVirtualNetwork2 to myVirtualNetwork1.
Add-AzVirtualNetworkPeering ` -Name myVirtualNetwork2-myVirtualNetwork1 ` -VirtualNetwork $virtualNetwork2 ` -RemoteVirtualNetworkId $virtualNetwork1.Id
In the output returned after the previous command executes, you see that the PeeringState is Connected. Azure also changed the peering state of the myVirtualNetwork1-myVirtualNetwork2 peering to Connected. Confirm that the peering state for the myVirtualNetwork1-myVirtualNetwork2 peering changed to Connected with Get-AzVirtualNetworkPeering.
Get-AzVirtualNetworkPeering ` -ResourceGroupName myResourceGroup ` -VirtualNetworkName myVirtualNetwork1 ` | Select PeeringState
Resources in one virtual network cannot communicate with resources in the other virtual network until the PeeringState for the peerings in both virtual networks is Connected.
Create virtual machines
Create a VM in each virtual network so that you can communicate between them in a later step.
Create the first VM
Create a VM with New-AzVM. The following example creates a VM named myVm1 in the myVirtualNetwork1 virtual network. The
-AsJob option creates the VM in the background, so you can continue to the next step. When prompted, enter the user name and password you want to log in to the VM with.
New-AzVm ` -ResourceGroupName "myResourceGroup" ` -Location "East US" ` -VirtualNetworkName "myVirtualNetwork1" ` -SubnetName "Subnet1" ` -ImageName "Win2016Datacenter" ` -Name "myVm1" ` -AsJob
Create the second VM
New-AzVm ` -ResourceGroupName "myResourceGroup" ` -Location "East US" ` -VirtualNetworkName "myVirtualNetwork2" ` -SubnetName "Subnet1" ` -ImageName "Win2016Datacenter" ` -Name "myVm2"
The VM takes a few minutes to create. Do not continue with later steps until Azure creates the VM and returns output to PowerShell.
Communicate between VMs
You can connect to a VM's public IP address from the internet. Use Get-AzPublicIpAddress to return the public IP address of a VM. The following example returns the public IP address of the myVm1 VM:
Get-AzPublicIpAddress ` -Name myVm1 ` -ResourceGroupName myResourceGroup | Select IpAddress
Use the following command to create a remote desktop session with the myVm1 VM from your local computer. Replace
<publicIpAddress> with the IP address returned from the previous command.
A Remote Desktop Protocol (.rdp) file is created, downloaded to your computer, and opened. Enter the user name and password (you may need to select More choices, then Use a different account, to specify the credentials you entered when you created the VM), and then click OK. You may receive a certificate warning during the sign-in process. Click Yes or Continue to proceed with the connection.
On the myVm1 VM, enable the Internet Control Message Protocol (ICMP) through the Windows firewall so you can ping this VM from myVm2 in a later step, using PowerShell:
New-NetFirewallRule –DisplayName "Allow ICMPv4-In" –Protocol ICMPv4
Though ping is used to communicate between VMs in this article, allowing ICMP through the Windows Firewall for production deployments is not recommended.
To connect to the myVm2 VM, enter the following command from a command prompt on the myVm1 VM:
Since you enabled ping on myVm1, you can now ping it by IP address from a command prompt on the myVm2 VM:
You receive four replies. Disconnect your RDP sessions to both myVm1 and myVm2.
Clean up resources
When no longer needed, use Remove-AzResourcegroup to remove the resource group and all of the resources it contains.
Remove-AzResourceGroup -Name myResourceGroup -Force
In this article, you learned how to connect two networks in the same Azure region, with virtual network peering. You can also peer virtual networks in different supported regions and in different Azure subscriptions, as well as create hub and spoke network designs with peering. To learn more about virtual network peering, see Virtual network peering overview and Manage virtual network peerings.
You can connect your own computer to a virtual network through a VPN, and interact with resources in a virtual network, or in peered virtual networks. For reusable scripts to complete many of the tasks covered in the virtual network articles, see script samples.