Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The networkVirtualAppliances/networkVirtualApplianceConnections 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/networkVirtualAppliances/networkVirtualApplianceConnections resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Network/networkVirtualAppliances/networkVirtualApplianceConnections@2024-07-01' = {
parent: resourceSymbolicName
name: 'string'
properties: {
asn: int
bgpPeerAddress: [
'string'
]
enableInternetSecurity: bool
name: '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: {
vnetLocalRouteOverrideCriteria: 'string'
}
}
}
tunnelIdentifier: int
}
}
Property Values
Microsoft.Network/networkVirtualAppliances/networkVirtualApplianceConnections
| Name | Description | Value |
|---|---|---|
| name | The resource name | string Constraints: Pattern = ^[A-Za-z0-9_]+ (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: networkVirtualAppliances |
| properties | Properties of the express route connection. | NetworkVirtualApplianceConnectionProperties |
NetworkVirtualApplianceConnectionProperties
| Name | Description | Value |
|---|---|---|
| asn | Network Virtual Appliance ASN. | int Constraints: Min value = 0 Max value = 4294967295 |
| bgpPeerAddress | List of bgpPeerAddresses for the NVA instances | string[] |
| enableInternetSecurity | Enable internet security. | bool |
| name | The name of the resource. | string |
| routingConfiguration | The Routing Configuration indicating the associated and propagated route tables on this connection. | RoutingConfiguration |
| tunnelIdentifier | Unique identifier for the connection. | int Constraints: Min value = 0 Max value = 4294967295 |
PropagatedRouteTable
| Name | Description | Value |
|---|---|---|
| ids | The list of resource ids of all the RouteTables. | SubResource[] |
| labels | The list of labels. | string[] |
RoutingConfiguration
| Name | Description | Value |
|---|---|---|
| associatedRouteTable | The resource id RouteTable associated with this RoutingConfiguration. | SubResource |
| inboundRouteMap | The resource id of the RouteMap associated with this RoutingConfiguration for inbound learned routes. | SubResource |
| outboundRouteMap | The resource id of theRouteMap associated with this RoutingConfiguration for outbound advertised routes. | SubResource |
| propagatedRouteTables | The list of RouteTables to advertise the routes to. | PropagatedRouteTable |
| vnetRoutes | List of routes that control routing from VirtualHub into a virtual network connection. | VnetRoute |
StaticRoute
| Name | Description | Value |
|---|---|---|
| addressPrefixes | List of all address prefixes. | string[] |
| name | The name of the StaticRoute that is unique within a VnetRoute. | string |
| nextHopIpAddress | The ip address of the next hop. | string |
StaticRoutesConfig
| Name | Description | Value |
|---|---|---|
| vnetLocalRouteOverrideCriteria | Parameter determining whether NVA in spoke vnet is bypassed for traffic with destination in spoke. | 'Contains' 'Equal' |
SubResource
| Name | Description | Value |
|---|---|---|
| id | Resource ID. | string |
VnetRoute
| Name | Description | Value |
|---|---|---|
| staticRoutes | List of all Static Routes. | StaticRoute[] |
| staticRoutesConfig | Configuration for static routes on this HubVnetConnection. | StaticRoutesConfig |
ARM template resource definition
The networkVirtualAppliances/networkVirtualApplianceConnections 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/networkVirtualAppliances/networkVirtualApplianceConnections resource, add the following JSON to your template.
{
"type": "Microsoft.Network/networkVirtualAppliances/networkVirtualApplianceConnections",
"apiVersion": "2024-07-01",
"name": "string",
"properties": {
"asn": "int",
"bgpPeerAddress": [ "string" ],
"enableInternetSecurity": "bool",
"name": "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": {
"vnetLocalRouteOverrideCriteria": "string"
}
}
},
"tunnelIdentifier": "int"
}
}
Property Values
Microsoft.Network/networkVirtualAppliances/networkVirtualApplianceConnections
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2024-07-01' |
| name | The resource name | string Constraints: Pattern = ^[A-Za-z0-9_]+ (required) |
| properties | Properties of the express route connection. | NetworkVirtualApplianceConnectionProperties |
| type | The resource type | 'Microsoft.Network/networkVirtualAppliances/networkVirtualApplianceConnections' |
NetworkVirtualApplianceConnectionProperties
| Name | Description | Value |
|---|---|---|
| asn | Network Virtual Appliance ASN. | int Constraints: Min value = 0 Max value = 4294967295 |
| bgpPeerAddress | List of bgpPeerAddresses for the NVA instances | string[] |
| enableInternetSecurity | Enable internet security. | bool |
| name | The name of the resource. | string |
| routingConfiguration | The Routing Configuration indicating the associated and propagated route tables on this connection. | RoutingConfiguration |
| tunnelIdentifier | Unique identifier for the connection. | int Constraints: Min value = 0 Max value = 4294967295 |
PropagatedRouteTable
| Name | Description | Value |
|---|---|---|
| ids | The list of resource ids of all the RouteTables. | SubResource[] |
| labels | The list of labels. | string[] |
RoutingConfiguration
| Name | Description | Value |
|---|---|---|
| associatedRouteTable | The resource id RouteTable associated with this RoutingConfiguration. | SubResource |
| inboundRouteMap | The resource id of the RouteMap associated with this RoutingConfiguration for inbound learned routes. | SubResource |
| outboundRouteMap | The resource id of theRouteMap associated with this RoutingConfiguration for outbound advertised routes. | SubResource |
| propagatedRouteTables | The list of RouteTables to advertise the routes to. | PropagatedRouteTable |
| vnetRoutes | List of routes that control routing from VirtualHub into a virtual network connection. | VnetRoute |
StaticRoute
| Name | Description | Value |
|---|---|---|
| addressPrefixes | List of all address prefixes. | string[] |
| name | The name of the StaticRoute that is unique within a VnetRoute. | string |
| nextHopIpAddress | The ip address of the next hop. | string |
StaticRoutesConfig
| Name | Description | Value |
|---|---|---|
| vnetLocalRouteOverrideCriteria | Parameter determining whether NVA in spoke vnet is bypassed for traffic with destination in spoke. | 'Contains' 'Equal' |
SubResource
| Name | Description | Value |
|---|---|---|
| id | Resource ID. | string |
VnetRoute
| Name | Description | Value |
|---|---|---|
| staticRoutes | List of all Static Routes. | StaticRoute[] |
| staticRoutesConfig | Configuration for static routes on this HubVnetConnection. | StaticRoutesConfig |
Usage Examples
Terraform (AzAPI provider) resource definition
The networkVirtualAppliances/networkVirtualApplianceConnections 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/networkVirtualAppliances/networkVirtualApplianceConnections resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Network/networkVirtualAppliances/networkVirtualApplianceConnections@2024-07-01"
name = "string"
parent_id = "string"
body = {
properties = {
asn = int
bgpPeerAddress = [
"string"
]
enableInternetSecurity = bool
name = "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 = {
vnetLocalRouteOverrideCriteria = "string"
}
}
}
tunnelIdentifier = int
}
}
}
Property Values
Microsoft.Network/networkVirtualAppliances/networkVirtualApplianceConnections
| Name | Description | Value |
|---|---|---|
| name | The resource name | string Constraints: Pattern = ^[A-Za-z0-9_]+ (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: networkVirtualAppliances |
| properties | Properties of the express route connection. | NetworkVirtualApplianceConnectionProperties |
| type | The resource type | "Microsoft.Network/networkVirtualAppliances/networkVirtualApplianceConnections@2024-07-01" |
NetworkVirtualApplianceConnectionProperties
| Name | Description | Value |
|---|---|---|
| asn | Network Virtual Appliance ASN. | int Constraints: Min value = 0 Max value = 4294967295 |
| bgpPeerAddress | List of bgpPeerAddresses for the NVA instances | string[] |
| enableInternetSecurity | Enable internet security. | bool |
| name | The name of the resource. | string |
| routingConfiguration | The Routing Configuration indicating the associated and propagated route tables on this connection. | RoutingConfiguration |
| tunnelIdentifier | Unique identifier for the connection. | int Constraints: Min value = 0 Max value = 4294967295 |
PropagatedRouteTable
| Name | Description | Value |
|---|---|---|
| ids | The list of resource ids of all the RouteTables. | SubResource[] |
| labels | The list of labels. | string[] |
RoutingConfiguration
| Name | Description | Value |
|---|---|---|
| associatedRouteTable | The resource id RouteTable associated with this RoutingConfiguration. | SubResource |
| inboundRouteMap | The resource id of the RouteMap associated with this RoutingConfiguration for inbound learned routes. | SubResource |
| outboundRouteMap | The resource id of theRouteMap associated with this RoutingConfiguration for outbound advertised routes. | SubResource |
| propagatedRouteTables | The list of RouteTables to advertise the routes to. | PropagatedRouteTable |
| vnetRoutes | List of routes that control routing from VirtualHub into a virtual network connection. | VnetRoute |
StaticRoute
| Name | Description | Value |
|---|---|---|
| addressPrefixes | List of all address prefixes. | string[] |
| name | The name of the StaticRoute that is unique within a VnetRoute. | string |
| nextHopIpAddress | The ip address of the next hop. | string |
StaticRoutesConfig
| Name | Description | Value |
|---|---|---|
| vnetLocalRouteOverrideCriteria | Parameter determining whether NVA in spoke vnet is bypassed for traffic with destination in spoke. | 'Contains' 'Equal' |
SubResource
| Name | Description | Value |
|---|---|---|
| id | Resource ID. | string |
VnetRoute
| Name | Description | Value |
|---|---|---|
| staticRoutes | List of all Static Routes. | StaticRoute[] |
| staticRoutesConfig | Configuration for static routes on this HubVnetConnection. | StaticRoutesConfig |