Merge pull request #272253 from asudbring/vnet-freshness-1

v-ccolin · web-flow · commit e255b3092330 · 2024-05-02T08:54:28.000+01:00
Freshness update of vnet peering PowerShell article
diff --git a/articles/virtual-network/tutorial-connect-virtual-networks-powershell.md b/articles/virtual-network/tutorial-connect-virtual-networks-powershell.md
@@ -6,19 +6,24 @@ author: asudbring
 ms.service: virtual-network
 ms.topic: how-to
 ms.tgt_pltfrm: virtual-network
-ms.date: 03/13/2018
+ms.date: 04/15/2024
 ms.author: allensu
 ms.custom: devx-track-azurepowershell
 # Customer intent: I want to connect two virtual networks so that virtual machines in one virtual network can communicate with virtual machines in the other virtual network.
 ---
 
 # Connect virtual networks with virtual network peering using 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:
+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](https://azure.microsoft.com/free/?WT.mc_id=A261C142F) before you begin.
@@ -29,29 +34,37 @@ If you choose to install and use PowerShell locally, this article requires the A
 
 ## 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](/powershell/module/az.resources/new-azresourcegroup). The following example creates a resource group named *myResourceGroup* in the *eastus* location.
+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](/powershell/module/az.resources/new-azresourcegroup). The following example creates a resource group named **test-rg** in the **eastus** location.
 
 ```azurepowershell-interactive
-New-AzResourceGroup -ResourceGroupName myResourceGroup -Location EastUS
+$resourceGroup = @{
+    Name = "test-rg"
+    Location = "EastUS"
+}
+New-AzResourceGroup @resourceGroup
 ```
 
-Create a virtual network with [New-AzVirtualNetwork](/powershell/module/az.network/new-azvirtualnetwork). The following example creates a virtual network named *myVirtualNetwork1* with the address prefix *10.0.0.0/16*.
+Create a virtual network with [New-AzVirtualNetwork](/powershell/module/az.network/new-azvirtualnetwork). The following example creates a virtual network named **vnet-1** with the address prefix **10.0.0.0/16**.
 
 ```azurepowershell-interactive
-$virtualNetwork1 = New-AzVirtualNetwork `
-  -ResourceGroupName myResourceGroup `
-  -Location EastUS `
-  -Name myVirtualNetwork1 `
-  -AddressPrefix 10.0.0.0/16
+$vnet1 = @{
+    ResourceGroupName = "test-rg"
+    Location = "EastUS"
+    Name = "vnet-1"
+    AddressPrefix = "10.0.0.0/16"
+}
+$virtualNetwork1 = New-AzVirtualNetwork @vnet1
 ```
 
-Create a subnet configuration with [Add-AzVirtualNetworkSubnetConfig](/powershell/module/az.network/add-azvirtualnetworksubnetconfig). The following example creates a subnet configuration with a 10.0.0.0/24 address prefix:
+Create a subnet configuration with [Add-AzVirtualNetworkSubnetConfig](/powershell/module/az.network/add-azvirtualnetworksubnetconfig). The following example creates a subnet configuration with a **10.0.0.0/24** address prefix:
 
 ```azurepowershell-interactive
-$subnetConfig = Add-AzVirtualNetworkSubnetConfig `
-  -Name Subnet1 `
-  -AddressPrefix 10.0.0.0/24 `
-  -VirtualNetwork $virtualNetwork1
+$subConfig = @{
+    Name = "subnet-1"
+    AddressPrefix = "10.0.0.0/24"
+    VirtualNetwork = $virtualNetwork1
+}
+$subnetConfig = Add-AzVirtualNetworkSubnetConfig @subConfig
 ```
 
 Write the subnet configuration to the virtual network with [Set-AzVirtualNetwork](/powershell/module/az.network/Set-azVirtualNetwork), which creates the subnet:
@@ -60,138 +73,152 @@ Write the subnet configuration to the virtual network with [Set-AzVirtualNetwork
 $virtualNetwork1 | Set-AzVirtualNetwork
 ```
 
-Create a virtual network with a 10.1.0.0/16 address prefix and one subnet:
+Create a virtual network with a **10.1.0.0/16** address prefix and one subnet:
 
 ```azurepowershell-interactive
 # Create the virtual network.
-$virtualNetwork2 = New-AzVirtualNetwork `
-  -ResourceGroupName myResourceGroup `
-  -Location EastUS `
-  -Name myVirtualNetwork2 `
-  -AddressPrefix 10.1.0.0/16
+$vnet2 = @{
+    ResourceGroupName = "test-rg"
+    Location = "EastUS"
+    Name = "vnet-2"
+    AddressPrefix = "10.1.0.0/16"
+}
+$virtualNetwork2 = New-AzVirtualNetwork @vnet2
 
 # Create the subnet configuration.
-$subnetConfig = Add-AzVirtualNetworkSubnetConfig `
-  -Name Subnet1 `
-  -AddressPrefix 10.1.0.0/24 `
-  -VirtualNetwork $virtualNetwork2
+$subConfig = @{
+    Name = "subnet-1"
+    AddressPrefix = "10.1.0.0/24"
+    VirtualNetwork = $virtualNetwork2
+}
+$subnetConfig = Add-AzVirtualNetworkSubnetConfig @subConfig
 
 # Write the subnet configuration to the virtual network.
 $virtualNetwork2 | Set-AzVirtualNetwork
 ```
 
 ## Peer virtual networks
 
-Create a peering with [Add-AzVirtualNetworkPeering](/powershell/module/az.network/add-azvirtualnetworkpeering). The following example peers *myVirtualNetwork1* to *myVirtualNetwork2*.
+Create a peering with [Add-AzVirtualNetworkPeering](/powershell/module/az.network/add-azvirtualnetworkpeering). The following example peers **vnet-1** to **vnet-2**.
 
 ```azurepowershell-interactive
-Add-AzVirtualNetworkPeering `
-  -Name myVirtualNetwork1-myVirtualNetwork2 `
-  -VirtualNetwork $virtualNetwork1 `
-  -RemoteVirtualNetworkId $virtualNetwork2.Id
+$peerConfig1 = @{
+    Name = "vnet-1-to-vnet-2"
+    VirtualNetwork = $virtualNetwork1
+    RemoteVirtualNetworkId = $virtualNetwork2.Id
+}
+Add-AzVirtualNetworkPeering @peerConfig1
 ```
 
-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*.
+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 **vnet-2** to **vnet-1**. Create a peering from **vnet-2** to **vnet-1**.
 
 ```azurepowershell-interactive
-Add-AzVirtualNetworkPeering `
-  -Name myVirtualNetwork2-myVirtualNetwork1 `
-  -VirtualNetwork $virtualNetwork2 `
-  -RemoteVirtualNetworkId $virtualNetwork1.Id
+$peerConfig2 = @{
+    Name = "vnet-2-to-vnet-1"
+    VirtualNetwork = $virtualNetwork2
+    RemoteVirtualNetworkId = $virtualNetwork1.Id
+}
+Add-AzVirtualNetworkPeering @peerConfig2
 ```
 
-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](/powershell/module/az.network/get-azvirtualnetworkpeering).
+In the output returned after the previous command executes, you see that the **PeeringState** is **Connected**. Azure also changed the peering state of the **vnet-1-to-vnet-2** peering to **Connected**. Confirm that the peering state for the **vnet-1-to-vnet-2** peering changed to **Connected** with [Get-AzVirtualNetworkPeering](/powershell/module/az.network/get-azvirtualnetworkpeering).
 
 ```azurepowershell-interactive
-Get-AzVirtualNetworkPeering `
-  -ResourceGroupName myResourceGroup `
-  -VirtualNetworkName myVirtualNetwork1 `
-  | Select PeeringState
+$peeringState = @{
+    ResourceGroupName = "test-rg"
+    VirtualNetworkName = "vnet-1"
+}
+Get-AzVirtualNetworkPeering @peeringState | 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*.
+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](/powershell/module/az.compute/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.
+Create a VM with [New-AzVM](/powershell/module/az.compute/new-azvm). The following example creates a VM named **vm-1** in the **vnet-1** 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 for the virtual machine.
 
 ```azurepowershell-interactive
-New-AzVm `
-  -ResourceGroupName "myResourceGroup" `
-  -Location "East US" `
-  -VirtualNetworkName "myVirtualNetwork1" `
-  -SubnetName "Subnet1" `
-  -ImageName "Win2016Datacenter" `
-  -Name "myVm1" `
-  -AsJob
+$vm1 = @{
+    ResourceGroupName = "test-rg"
+    Location = "EastUS"
+    VirtualNetworkName = "vnet-1"
+    SubnetName = "subnet-1"
+    ImageName = "Win2019Datacenter"
+    Name = "vm-1"
+}
+New-AzVm @vm1 -AsJob
 ```
 
 ### Create the second VM
 
 ```azurepowershell-interactive
-New-AzVm `
-  -ResourceGroupName "myResourceGroup" `
-  -Location "East US" `
-  -VirtualNetworkName "myVirtualNetwork2" `
-  -SubnetName "Subnet1" `
-  -ImageName "Win2016Datacenter" `
-  -Name "myVm2"
+$vm2 = @{
+    ResourceGroupName = "test-rg"
+    Location = "EastUS"
+    VirtualNetworkName = "vnet-2"
+    SubnetName = "subnet-1"
+    ImageName = "Win2019Datacenter"
+    Name = "vm-2"
+}
+New-AzVm @vm2
 ```
 
-The VM takes a few minutes to create. Do not continue with later steps until Azure creates the VM and returns output to PowerShell.
+The VM takes a few minutes to create. Don't continue with the later steps until Azure creates **vm-2** and returns output to PowerShell.
 
 [!INCLUDE [ephemeral-ip-note.md](../../includes/ephemeral-ip-note.md)]
 
 ## Communicate between VMs
 
-You can connect to a VM's public IP address from the internet. Use [Get-AzPublicIpAddress](/powershell/module/az.network/get-azpublicipaddress) to return the public IP address of a VM. The following example returns the public IP address of the *myVm1* VM:
+You can connect to a VM's public IP address from the internet. Use [Get-AzPublicIpAddress](/powershell/module/az.network/get-azpublicipaddress) to return the public IP address of a VM. The following example returns the public IP address of the **vm-1** VM:
 
 ```azurepowershell-interactive
-Get-AzPublicIpAddress `
-  -Name myVm1 `
-  -ResourceGroupName myResourceGroup | Select IpAddress
+$ipAddress = @{
+    ResourceGroupName = "test-rg"
+    Name = "vm-1"
+}
+Get-AzPublicIpAddress @ipAddress | 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.
+Use the following command to create a remote desktop session with the **vm-1** VM from your local computer. Replace `<publicIpAddress>` with the IP address returned from the previous command.
 
 ```
 mstsc /v:<publicIpAddress>
 ```
 
-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.
+A Remote Desktop Protocol (.rdp) file is created 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:
+On **vm-1**, enable the Internet Control Message Protocol (ICMP) through the Windows Firewall so you can ping this VM from **vm-2** in a later step, using PowerShell:
 
 ```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.
+**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:
+To connect to **vm-2**, enter the following command from a command prompt on **vm-1**:
 
 ```
 mstsc /v:10.1.0.4
 ```
 
-Since you enabled ping on *myVm1*, you can now ping it by IP address from a command prompt on the *myVm2* VM:
+You enabled ping on **vm-1**. You can now ping **vm-1** by IP address from a command prompt on **vm-2**.
 
 ```
 ping 10.0.0.4
 ```
 
-You receive four replies. Disconnect your RDP sessions to both *myVm1* and *myVm2*.
+You receive four replies. Disconnect your RDP sessions to both **vm-1** and **vm-2**.
 
 ## Clean up resources
 
 When no longer needed, use [Remove-AzResourcegroup](/powershell/module/az.resources/remove-azresourcegroup) to remove the resource group and all of the resources it contains.
 
 ```azurepowershell-interactive
-Remove-AzResourceGroup -Name myResourceGroup -Force
+Remove-AzResourceGroup -Name test-rg -Force
 ```
 
 ## Next steps
