Microsoft.Network virtualHubs/bgpConnections

• Latest
• 2024-03-01
• 2024-01-01
• 2023-11-01
• 2023-09-01
• 2023-06-01
• 2023-05-01
• 2023-04-01
• 2023-02-01
• 2022-11-01
• 2022-09-01
• 2022-07-01
• 2022-05-01
• 2022-01-01
• 2021-08-01
• 2021-05-01
• 2021-03-01
• 2021-02-01
• 2020-11-01
• 2020-08-01
• 2020-07-01
• 2020-06-01
• 2020-05-01

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@2024-03-01' = {
  name: 'string'
  properties: {
    hubVirtualNetworkConnection: {
      id: 'string'
    }
    peerAsn: int
    peerIp: 'string'
  }
}

Property values

BgpConnectionProperties

Name	Description	Value
hubVirtualNetworkConnection	The reference to the HubVirtualNetworkConnection resource.	SubResource
peerAsn	Peer ASN.	int Constraints: Min value = 0 Max value = 4294967295
peerIp	Peer IP.	string

Microsoft.Network/virtualHubs/bgpConnections

Name	Description	Value
name	The resource name	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

SubResource

Name	Description	Value
id	Resource ID.	string

Quickstart samples

The following quickstart samples deploy this resource type.

Bicep File	Description
Create a Route Server in a New Subnet	This template deploys a Route Server into a subnet named RouteServerSubnet.

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

Property values

BgpConnectionProperties

Name	Description	Value
hubVirtualNetworkConnection	The reference to the HubVirtualNetworkConnection resource.	SubResource
peerAsn	Peer ASN.	int Constraints: Min value = 0 Max value = 4294967295
peerIp	Peer IP.	string

Microsoft.Network/virtualHubs/bgpConnections

Name	Description	Value
apiVersion	The api version	'2024-03-01'
name	The resource name	string (required)
properties	The properties of the Bgp connections.	BgpConnectionProperties
type	The resource type	'Microsoft.Network/virtualHubs/bgpConnections'

SubResource

Name	Description	Value
id	Resource ID.	string

Quickstart templates

The following 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@2024-03-01"
  name = "string"
  body = jsonencode({
    properties = {
      hubVirtualNetworkConnection = {
        id = "string"
      }
      peerAsn = int
      peerIp = "string"
    }
  })
}

Property values

BgpConnectionProperties

Name	Description	Value
hubVirtualNetworkConnection	The reference to the HubVirtualNetworkConnection resource.	SubResource
peerAsn	Peer ASN.	int Constraints: Min value = 0 Max value = 4294967295
peerIp	Peer IP.	string

Microsoft.Network/virtualHubs/bgpConnections

Name	Description	Value
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
type	The resource type	"Microsoft.Network/virtualHubs/bgpConnections@2024-03-01"

SubResource

Name	Description	Value
id	Resource ID.	string