Skip to content

quickstart-create-route-server-template.md

Latest commit

 

History

History
134 lines (82 loc) · 7.93 KB

quickstart-create-route-server-template.md

File metadata and controls

134 lines (82 loc) · 7.93 KB
title Quickstart: Create an Azure Route Server using an ARM template
description Learn how to deploy Azure Route Server using Azure Resource Manager templates to enable dynamic routing and BGP peering with network virtual appliances in your virtual network.
author duongau
ms.author duau
ms.service azure-route-server
ms.topic quickstart
ms.date 09/17/2025
ms.custom subject-armqs, mode-arm, devx-track-arm-template

Quickstart: Create an Azure Route Server using an ARM template

This quickstart shows you how to use an Azure Resource Manager template (ARM template) to deploy Azure Route Server into a new or existing virtual network. Azure Route Server enables dynamic routing between your virtual network and network virtual appliances through BGP peering, automatically managing route exchanges in your network infrastructure.

By completing this quickstart, you'll have a functioning Route Server deployed with the necessary network infrastructure and ready for BGP peering configuration.

[!INCLUDE About Azure Resource Manager]

If your environment meets the prerequisites and you're familiar with using ARM templates, select the Deploy to Azure button to open the template in the Azure portal.

:::image type="content" source="~/reusable-content/ce-skilling/azure/media/template-deployments/deploy-to-azure-button.svg" alt-text="Button to deploy the Azure Resource Manager template to Azure portal." border="false" link="https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2FAzure%2Fazure-quickstart-templates%2Fmaster%2Fquickstarts%2Fmicrosoft.network%2Froute-server%2Fazuredeploy.json":::

Prerequisites

Before you begin, ensure you have the following requirements:

Review the template

The template used in this quickstart is from Azure Quickstart Templates. This ARM template deploys a complete Route Server environment including the virtual network infrastructure and BGP peering configuration.

The template creates the following resources:

  • Azure Route Server in a new or existing virtual network
  • Dedicated subnet named RouteServerSubnet to host the Route Server
  • BGP peering configuration with specified Peer ASN and Peer IP

:::code language="json" source="~/quickstart-templates/quickstarts/microsoft.network/route-server/azuredeploy.json" range="001-184" highlight="104-142":::

Template resources

The following Azure resources are defined in the template:

To find more templates related to Azure networking, see Azure Quickstart Templates.

Deploy the template

You can deploy the template using Azure PowerShell through Azure Cloud Shell or your local PowerShell environment.

  1. Select Open Cloud Shell from the following code block to open Azure Cloud Shell, and then follow the instructions to sign in to Azure:

    $projectName = Read-Host -Prompt "Enter a project name that is used for generating resource names"
$location = Read-Host -Prompt "Enter the location (i.e. centralus)"
$templateUri = "https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/quickstarts/microsoft.network/route-server/azuredeploy.json"

$resourceGroupName = "${projectName}rg"

New-AzResourceGroup -Name $resourceGroupName -Location "$location"
New-AzResourceGroupDeployment -ResourceGroupName $resourceGroupName -TemplateUri $templateUri

Read-Host -Prompt "Press [ENTER] to continue ..."

    Wait until you see the prompt from the console.

  2. Select Copy from the previous code block to copy the PowerShell script.

  3. Right-click the shell console pane and then select Paste.

  4. Enter the values when prompted:

    • Project name: Used for generating resource names (the resource group name will be the project name with rg appended)
    • Location: Azure region where resources will be deployed

    The deployment takes approximately 20 minutes to complete. When finished, the output should be similar to:

    :::image type="content" source="./media/quickstart-create-route-server-template/PowerShell-output.png" alt-text="Screenshot showing Route Server Resource Manager template PowerShell deployment output.":::

Azure PowerShell is used to deploy the template in this example. You can also use the Azure portal, Azure CLI, and REST API for template deployment. To learn about other deployment methods, see Deploy templates.

Validate the deployment

After the template deployment completes, verify that the Route Server was created successfully.

Verify resources in the Azure portal

  1. Sign in to the Azure portal.

  2. Select Resource groups from the left pane.

  3. Select the resource group that you created in the previous section. The default resource group name is the project name with rg appended.

  4. The resource group should contain the virtual network and associated resources:

    :::image type="content" source="./media/quickstart-create-route-server-template/resource-group.png" alt-text="Screenshot showing Route Server deployment resource group with virtual network and related resources.":::

Verify Route Server deployment

  1. From the Azure portal, navigate to your resource group and select the Route Server resource.

  2. On the Route Server overview page, verify the following:

    • Status shows as "Succeeded"
    • BGP ASN displays the configured autonomous system number
    • Routing State shows as "Provisioned"

    :::image type="content" source="./media/quickstart-create-route-server-template/deployment.png" alt-text="Screenshot showing Route Server overview page confirming successful deployment.":::

Clean up resources

When you no longer need the Route Server and associated resources, delete the resource group to remove the Route Server and all related resources.

To delete the resource group, use the Remove-AzResourceGroup cmdlet:

Remove-AzResourceGroup -Name <your resource group name>

Next step

Now that you've deployed a Route Server using an ARM template, learn more about Route Server capabilities:

[!div class="nextstepaction"] Tutorial: Configure BGP peering between Route Server and network virtual appliance