Microsoft.Network virtualHubs/bgpConnections

Bicep resource definition

The virtualHubs/bgpConnections resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Network/virtualHubs/bgpConnections resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Network/virtualHubs/bgpConnections@2025-07-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    hubVirtualNetworkConnection: {
      id: 'string'
    }
    peerAsn: int
    peerIp: 'string'
    routingConfiguration: {
      associatedRouteTable: {
        id: 'string'
      }
      inboundRouteMap: {
        id: 'string'
      }
      outboundRouteMap: {
        id: 'string'
      }
      propagatedRouteTables: {
        ids: [
          {
            id: 'string'
          }
        ]
        labels: [
          'string'
        ]
      }
      vnetRoutes: {
        staticRoutes: [
          {
            addressPrefixes: [
              'string'
            ]
            name: 'string'
            nextHopIpAddress: 'string'
          }
        ]
        staticRoutesConfig: {
          propagateStaticRoutes: bool
          vnetLocalRouteOverrideCriteria: 'string'
        }
      }
    }
  }
}

Property Values

Microsoft.Network/virtualHubs/bgpConnections

BgpConnectionProperties

CommonSubResource

PropagatedRouteTable

RoutingConfiguration

StaticRoute

StaticRoutesConfig

VnetRoute

Usage Examples

Azure Quickstart Samples

The following Azure Quickstart templates contain Bicep samples for deploying this resource type.

ARM template resource definition

The virtualHubs/bgpConnections resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Network/virtualHubs/bgpConnections resource, add the following JSON to your template.

{
  "type": "Microsoft.Network/virtualHubs/bgpConnections",
  "apiVersion": "2025-07-01",
  "name": "string",
  "properties": {
    "hubVirtualNetworkConnection": {
      "id": "string"
    },
    "peerAsn": "int",
    "peerIp": "string",
    "routingConfiguration": {
      "associatedRouteTable": {
        "id": "string"
      },
      "inboundRouteMap": {
        "id": "string"
      },
      "outboundRouteMap": {
        "id": "string"
      },
      "propagatedRouteTables": {
        "ids": [
          {
            "id": "string"
          }
        ],
        "labels": [ "string" ]
      },
      "vnetRoutes": {
        "staticRoutes": [
          {
            "addressPrefixes": [ "string" ],
            "name": "string",
            "nextHopIpAddress": "string"
          }
        ],
        "staticRoutesConfig": {
          "propagateStaticRoutes": "bool",
          "vnetLocalRouteOverrideCriteria": "string"
        }
      }
    }
  }
}

Property Values

Microsoft.Network/virtualHubs/bgpConnections

BgpConnectionProperties

CommonSubResource

PropagatedRouteTable

RoutingConfiguration

StaticRoute

StaticRoutesConfig

VnetRoute

Usage Examples

Azure Quickstart Templates

The following Azure Quickstart templates deploy this resource type.

Template	Description
Azure Route Server in BGP peering with Quagga	This template deploys a Router Server and Ubuntu VM with Quagga. Two external BGP sessions are established between the Router Server and Quagga. Installation and configuration of Quagga is executed by Azure custom script extension for linux
Create a Route Server in a New Subnet	This template deploys a Route Server into a subnet named RouteServerSubnet.

Terraform (AzAPI provider) resource definition

The virtualHubs/bgpConnections resource type can be deployed with operations that target:

• Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Network/virtualHubs/bgpConnections resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/virtualHubs/bgpConnections@2025-07-01"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      hubVirtualNetworkConnection = {
        id = "string"
      }
      peerAsn = int
      peerIp = "string"
      routingConfiguration = {
        associatedRouteTable = {
          id = "string"
        }
        inboundRouteMap = {
          id = "string"
        }
        outboundRouteMap = {
          id = "string"
        }
        propagatedRouteTables = {
          ids = [
            {
              id = "string"
            }
          ]
          labels = [
            "string"
          ]
        }
        vnetRoutes = {
          staticRoutes = [
            {
              addressPrefixes = [
                "string"
              ]
              name = "string"
              nextHopIpAddress = "string"
            }
          ]
          staticRoutesConfig = {
            propagateStaticRoutes = bool
            vnetLocalRouteOverrideCriteria = "string"
          }
        }
      }
    }
  }
}

Property Values

Microsoft.Network/virtualHubs/bgpConnections

BgpConnectionProperties

CommonSubResource

PropagatedRouteTable

RoutingConfiguration

StaticRoute

StaticRoutesConfig

VnetRoute