Microsoft.Network virtualHubs/bgpConnections

Bicep resource definition

The virtualHubs/bgpConnections resource type can be deployed to:

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@2022-07-01' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    hubVirtualNetworkConnection: {
      id: 'string'
    }
    peerAsn: int
    peerIp: 'string'
  }
}

Property values

virtualHubs/bgpConnections

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.
string (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.
Symbolic name for resource of type: virtualHubs
properties The properties of the Bgp connections. BgpConnectionProperties

BgpConnectionProperties

Name Description Value
hubVirtualNetworkConnection The reference to the HubVirtualNetworkConnection resource. SubResource
peerAsn Peer ASN. int
peerIp Peer IP. string

SubResource

Name Description Value
id Resource ID. string

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Create a Route Server in a New Subnet

Deploy to Azure
This template deploys a Route Server into a subnet named RouteServerSubnet.
Azure Route Server in BGP peering with Quagga

Deploy to Azure
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

ARM template resource definition

The virtualHubs/bgpConnections resource type can be deployed to:

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": "2022-07-01",
  "name": "string",
  "properties": {
    "hubVirtualNetworkConnection": {
      "id": "string"
    },
    "peerAsn": "int",
    "peerIp": "string"
  }
}

Property values

virtualHubs/bgpConnections

Name Description Value
type The resource type 'Microsoft.Network/virtualHubs/bgpConnections'
apiVersion The resource api version '2022-07-01'
name The resource name

See how to set names and types for child resources in JSON ARM templates.
string (required)
properties The properties of the Bgp connections. BgpConnectionProperties

BgpConnectionProperties

Name Description Value
hubVirtualNetworkConnection The reference to the HubVirtualNetworkConnection resource. SubResource
peerAsn Peer ASN. int
peerIp Peer IP. string

SubResource

Name Description Value
id Resource ID. string

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Create a Route Server in a New Subnet

Deploy to Azure
This template deploys a Route Server into a subnet named RouteServerSubnet.
Azure Route Server in BGP peering with Quagga

Deploy to Azure
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

Terraform (AzAPI provider) resource definition

The virtualHubs/bgpConnections resource type can be deployed to:

  • 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@2022-07-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      hubVirtualNetworkConnection = {
        id = "string"
      }
      peerAsn = int
      peerIp = "string"
    }
  })
}

Property values

virtualHubs/bgpConnections

Name Description Value
type The resource type "Microsoft.Network/virtualHubs/bgpConnections@2022-07-01"
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: virtualHubs
properties The properties of the Bgp connections. BgpConnectionProperties

BgpConnectionProperties

Name Description Value
hubVirtualNetworkConnection The reference to the HubVirtualNetworkConnection resource. SubResource
peerAsn Peer ASN. int
peerIp Peer IP. string

SubResource

Name Description Value
id Resource ID. string