Configure a virtual network gateway for ExpressRoute using PowerShell

This article walks you through the steps to add, resize, and remove a virtual network gateway for a pre-existing virtual network (VNet) using PowerShell. The steps for this configuration apply to VNets that were created using the Resource Manager deployment model for an ExpressRoute configuration. For more information about virtual network gateways and gateway configuration settings for ExpressRoute, see About virtual network gateways for ExpressRoute.

Prerequisites

Configuration reference list

The steps for this task use a VNet based on the values in the following configuration reference list. Additional settings and names are also outlined in this list. We don't use this list directly in any of the steps, although we do add variables based on the values in this list. You can copy the list to use as a reference, replacing the values with your own.

Setting	Value
Virtual Network Name	TestVNet
Virtual Network address space	192.168.0.0/16
Resource Group	TestRG
Subnet1 Name	FrontEnd
Subnet1 address space	192.168.1.0/24
Subnet1 Name	FrontEnd
Gateway Subnet name	GatewaySubnet
Gateway Subnet address space	192.168.200.0/26
Region	China East
Gateway Name	GW
Gateway IP Name	GWIP
Gateway IP configuration Name	gwipconf
Type	ExpressRoute
Gateway Public IP Name	gwpip

Add a gateway

1. To connect with Azure, run Connect-AzAccount -Environment AzureChinaCloud.

2. Declare your variables for this tutorial. Be sure to edit the sample to reflect the settings that you want to use.

   $RG = "TestRG"
   $Location = "China East"
   $GWName = "GW"
   $GWIPName = "GWIP"
   $GWIPconfName = "gwipconf"
   $VNetName = "TestVNet"
   

3. Store the virtual network object as a variable.

   $vnet = Get-AzVirtualNetwork -Name $VNetName -ResourceGroupName $RG
   

4. Add a gateway subnet to your Virtual Network. The gateway subnet must be named "GatewaySubnet". The gateway subnet has to be /27 or larger (/26, /25, and so on). If you plan on connecting 16 ExpressRoute circuits to your gateway, you must create a gateway subnet of /26 or larger.

   Add-AzVirtualNetworkSubnetConfig -Name GatewaySubnet -VirtualNetwork $vnet -AddressPrefix 192.168.200.0/26
   

   If you're using a dual stack virtual network and plan to use IPv6-based private peering over ExpressRoute, create a dual stack gateway subnet instead.

   Add-AzVirtualNetworkSubnetConfig -Name GatewaySubnet -VirtualNetwork $vnet -AddressPrefix "10.0.0.0/26","ace:daa:daaa:deaa::/64"
   

5. Set the configuration.

   $vnet = Set-AzVirtualNetwork -VirtualNetwork $vnet
   

6. Store the gateway subnet as a variable.

   $subnet = Get-AzVirtualNetworkSubnetConfig -Name 'GatewaySubnet' -VirtualNetwork $vnet
   

7. Request a public IP address. The IP address is requested before creating the gateway. You can't specify the IP address that you want to use; it's dynamically assigned. You'll use this IP address in the next configuration section. The AllocationMethod must be Dynamic.

   $pip = New-AzPublicIpAddress -Name $GWIPName  -ResourceGroupName $RG -Location $Location -AllocationMethod Static -SKU Standard
   

   Note

   Basic SKU public IP isn't supported with new ExpressRoute virtual network gateway.

8. Create the configuration for your gateway. The gateway configuration defines the subnet and the public IP address to use. In this step, you're specifying the configuration that will be used when you create the gateway. Use the following sample to create your gateway configuration.

   $ipconf = New-AzVirtualNetworkGatewayIpConfig -Name $GWIPconfName -Subnet $subnet -PublicIpAddress $pip
   

9. Create the gateway. In this step, the -GatewayType is especially important. You must use the value ExpressRoute. After running these cmdlets, the gateway can take 45 minutes or more to create.

   New-AzVirtualNetworkGateway -Name $GWName -ResourceGroupName $RG -Location $Location -IpConfigurations $ipconf -GatewayType Expressroute -GatewaySku Standard
   

Verify the gateway was created

Use the following commands to verify that the gateway has been created:

Get-AzVirtualNetworkGateway -ResourceGroupName $RG

Resize a gateway

There are a number of gateway SKUs. You can use the following command to change the Gateway SKU at any time.

$gw = Get-AzVirtualNetworkGateway -Name $GWName -ResourceGroupName $RG
Resize-AzVirtualNetworkGateway -VirtualNetworkGateway $gw -GatewaySku HighPerformance

Clean up resources

Use the following command to remove the gateway:

Remove-AzVirtualNetworkGateway -Name $GWName -ResourceGroupName $RG

Next steps

After you've created the VNet gateway, you can link your VNet to an ExpressRoute circuit.