Merge pull request #281076 from cherylmc/ps-basic

VPN Gateway create Basic SKU gateway

Author: AnnaMHuff

articles/vpn-gateway/TOC.yml

@@ -73,6 +73,8 @@
         href: create-routebased-vpn-gateway-powershell.md
       - name: Azure CLI
         href: create-routebased-vpn-gateway-cli.md
+      - name: Create a Basic SKU gateway
+        href: create-gateway-basic-sku-powershell.md
     - name: Verify a gateway connection
       href: vpn-gateway-verify-connection-resource-manager.md
     - name: Reset a connection or a gateway

articles/vpn-gateway/create-gateway-basic-sku-powershell.md

@@ -0,0 +1,155 @@
+---
+title: 'Create a Basic SKU virtual network gateway: PowerShell'
+titleSuffix: Azure VPN Gateway
+description: Learn how to create a Basic SKU virtual network gateway for a VPN connection to your on-premises network, or to connect virtual networks. Use these instructions to create either a policy-based, or route-based VPN gateway.
+author: cherylmc
+ms.service: vpn-gateway
+ms.topic: how-to
+ms.date: 07/17/2024
+ms.author: cherylmc 
+ms.custom: devx-track-azurepowershell
+---
+
+# Create a Basic SKU VPN gateway using PowerShell
+
+This article helps you create a Basic SKU Azure VPN gateway using PowerShell. The VPN gateway you create can be either RouteBased, or PolicyBased, depending on your connection requirements. A VPN gateway is used when creating a VPN connection to your on-premises network. You can also use a VPN gateway to connect VNets.
+
+:::image type="content" source="./media/create-gateway-basic-sku/gateway-diagram.png" alt-text="Diagram that shows a virtual network and a VPN gateway." lightbox="./media/create-gateway-basic-sku/gateway-diagram-expand.png":::
+
+* The left side of the diagram shows the virtual network and the VPN gateway that you create by using the steps in this article.
+* You can later add different types of connections, as shown on the right side of the diagram. For example, you can create [site-to-site](tutorial-site-to-site-portal.md) and [point-to-site](point-to-site-about.md) connections. To view different design architectures that you can build, see [VPN gateway design](design.md).
+
+The steps in this article create a virtual network, a subnet, a gateway subnet, and a VPN gateway (virtual network gateway) using the Basic SKU. The article steps specify a **RouteBased** VPN type. You can also specify a **PolicyBased** VPN type using the steps in this article. Once the gateway creation completes, you can then create connections. If you want to create a gateway using a SKU other than the Basic SKU, see the [Portal article](tutorial-create-gateway-portal.md).
+
+Basic SKU VPN gateways have limitations. For more information about SKUs and Basic SKU limitations, see [About gateway SKUs](about-gateway-skus.md). A few of the limitations that affect the settings used in this article are:
+
+* A Basic SKU VPN gateway must use the Dynamic allocation method for public IP address, not Static.
+* A Basic SKU VPN gateway uses a Basic SKU public IP address, not Standard.
+* You can't create a Basic SKU VPN gateway using the Azure portal.
+
+## Before you begin
+
+These steps require an Azure subscription. If you don't have an Azure subscription, create a [free account](https://azure.microsoft.com/free/?WT.mc_id=A261C142F) before you begin.
+
+### Working with Azure PowerShell
+
+[!INCLUDE [powershell](../../includes/vpn-gateway-cloud-shell-powershell-about.md)]
+
+## Create a resource group
+
+Create an Azure resource group with [New-AzResourceGroup](/powershell/module/az.resources/new-azresourcegroup). A resource group is a logical container into which Azure resources are deployed and managed. If you're running PowerShell locally, open your PowerShell console with elevated privileges and connect to Azure using the `Connect-AzAccount` command.
+
+```azurepowershell-interactive
+New-AzResourceGroup -Name TestRG1 -Location EastUS
+```
+
+## <a name="vnet"></a>Create a virtual network
+
+Create a virtual network with [New-AzVirtualNetwork](/powershell/module/az.network/new-azvirtualnetwork). The following example creates a virtual network named **VNet1** in the **EastUS** location:
+
+```azurepowershell-interactive
+$virtualnetwork = New-AzVirtualNetwork `
+  -ResourceGroupName TestRG1 `
+  -Location EastUS `
+  -Name VNet1 `
+  -AddressPrefix 10.1.0.0/16
+```
+
+Create a subnet configuration using the [New-AzVirtualNetworkSubnetConfig](/powershell/module/az.network/new-azvirtualnetworksubnetconfig) cmdlet.
+
+```azurepowershell-interactive
+$subnetConfig = Add-AzVirtualNetworkSubnetConfig `
+  -Name Frontend `
+  -AddressPrefix 10.1.0.0/24 `
+  -VirtualNetwork $virtualnetwork
+```
+
+Set the subnet configuration for the virtual network using the [Set-AzVirtualNetwork](/powershell/module/az.network/Set-azVirtualNetwork) cmdlet.
+
+```azurepowershell-interactive
+$virtualnetwork | Set-AzVirtualNetwork
+```
+
+## <a name="gwsubnet"></a>Add a gateway subnet
+
+The gateway subnet contains the reserved IP addresses that the virtual network gateway services use. Use the following examples to add a gateway subnet:
+
+Set a variable for your virtual network.
+
+```azurepowershell-interactive
+$vnet = Get-AzVirtualNetwork -ResourceGroupName TestRG1 -Name VNet1
+```
+
+Create the gateway subnet using the [Add-AzVirtualNetworkSubnetConfig](/powershell/module/az.network/Add-azVirtualNetworkSubnetConfig) cmdlet.
+
+```azurepowershell-interactive
+Add-AzVirtualNetworkSubnetConfig -Name 'GatewaySubnet' -AddressPrefix 10.1.255.0/27 -VirtualNetwork $vnet
+```
+
+Set the subnet configuration for the virtual network using the [Set-AzVirtualNetwork](/powershell/module/az.network/Set-azVirtualNetwork) cmdlet.
+
+```azurepowershell-interactive
+$vnet | Set-AzVirtualNetwork
+```
+
+## <a name="PublicIP"></a>Request a public IP address
+
+Each VPN gateway must have an allocated public IP address. At this time, Basic SKU VPN gateways still use **Dynamic** allocation method public IP address and the **Basic** public IP address SKU. These requirements are different from other VPN Gateway SKUs.
+
+```azurepowershell-interactive
+$gwpip = New-AzPublicIpAddress -Name "VNet1GWIP" -ResourceGroupName "TestRG1" -Location "EastUS" -AllocationMethod Dynamic -Sku Basic
+```
+
+## <a name="GatewayIPConfig"></a>Create the gateway IP address configuration
+
+The gateway configuration defines the subnet and the public IP address to use. Use the following example to create your gateway configuration.
+
+```azurepowershell-interactive
+$vnet = Get-AzVirtualNetwork -Name VNet1 -ResourceGroupName TestRG1
+$subnet = Get-AzVirtualNetworkSubnetConfig -Name 'GatewaySubnet' -VirtualNetwork $vnet
+$gwipconfig = New-AzVirtualNetworkGatewayIpConfig -Name gwipconfig -SubnetId $subnet.Id -PublicIpAddressId $gwpip.Id
+```
+
+## <a name="CreateGateway"></a>Create the VPN gateway
+
+Creating a gateway can often take 45 minutes or more, depending on the selected gateway SKU. Once the gateway is created, you can create a connection between your virtual network and another virtual network. Or, create a connection between your virtual network and an on-premises location.
+
+Create a VPN gateway using the [New-AzVirtualNetworkGateway](/powershell/module/az.network/New-azVirtualNetworkGateway) cmdlet. In this example, we create a route-based Basic SKU VPN gateway. You can create a policy-based gateway instead by specifying `-VpnType "PolicyBased"`.
+
+```azurepowershell-interactive
+New-AzVirtualNetworkGateway -Name VNet1GW -ResourceGroupName TestRG1 `
+-Location "East US" -IpConfigurations $gwipconfig -GatewayType "Vpn" `
+-VpnType "RouteBased" -GatewaySku Basic
+```
+
+## <a name="viewgw"></a>View the VPN gateway
+
+You can view the VPN gateway using the [Get-AzVirtualNetworkGateway](/powershell/module/az.network/Get-azVirtualNetworkGateway) cmdlet.
+
+```azurepowershell-interactive
+Get-AzVirtualNetworkGateway -Name Vnet1GW -ResourceGroup TestRG1
+```
+
+## <a name="viewgwpip"></a>View the public IP addresses
+
+To view the public IP address for your VPN gateway, use the [Get-AzPublicIpAddress](/powershell/module/az.network/Get-azPublicIpAddress) cmdlet. Example:
+
+```azurepowershell-interactive
+Get-AzPublicIpAddress -Name VNet1GWpip1 -ResourceGroupName TestRG1
+```
+
+## Clean up resources
+
+When you no longer need the resources you created, use the [Remove-AzResourceGroup](/powershell/module/az.resources/remove-azresourcegroup) command to delete the resource group. This deletes the resource group and all of the resources it contains.
+
+```azurepowershell-interactive
+Remove-AzResourceGroup -Name TestRG1
+```
+
+## Next steps
+
+Once the gateway finishes creating, you can create a connection between your virtual network and another virtual network. Or, create a connection between your virtual network and an on-premises location. See the following articles:
+
+* [Create a site-to-site connection](vpn-gateway-create-site-to-site-rm-powershell.md)
+* [Create a point-to-site connection](vpn-gateway-howto-point-to-site-rm-ps.md)
+* [Create a connection to another virtual network](vpn-gateway-vnet-vnet-rm-ps.md)