Microsoft.Network expressRouteCircuits/peerings template reference
-
- 3 minutes to read
-
To create a Microsoft.Network/expressRouteCircuits/peerings resource, add the following JSON to the resources section of your template.
{
"name": "string",
"type": "Microsoft.Network/expressRouteCircuits/peerings",
"apiVersion": "2019-09-01",
"properties": {
"peeringType": "string",
"state": "string",
"azureASN": "integer",
"peerASN": "integer",
"primaryPeerAddressPrefix": "string",
"secondaryPeerAddressPrefix": "string",
"primaryAzurePort": "string",
"secondaryAzurePort": "string",
"sharedKey": "string",
"vlanId": "integer",
"microsoftPeeringConfig": {
"advertisedPublicPrefixes": [
"string"
],
"advertisedCommunities": [
"string"
],
"legacyMode": "integer",
"customerASN": "integer",
"routingRegistryName": "string"
},
"stats": {
"primarybytesIn": "integer",
"primarybytesOut": "integer",
"secondarybytesIn": "integer",
"secondarybytesOut": "integer"
},
"routeFilter": {
"id": "string"
},
"ipv6PeeringConfig": {
"primaryPeerAddressPrefix": "string",
"secondaryPeerAddressPrefix": "string",
"microsoftPeeringConfig": {
"advertisedPublicPrefixes": [
"string"
],
"advertisedCommunities": [
"string"
],
"legacyMode": "integer",
"customerASN": "integer",
"routingRegistryName": "string"
},
"routeFilter": {
"id": "string"
},
"state": "string"
},
"expressRouteConnection": {},
"connections": [
{
"id": "string",
"properties": {
"expressRouteCircuitPeering": {
"id": "string"
},
"peerExpressRouteCircuitPeering": {
"id": "string"
},
"addressPrefix": "string",
"authorizationKey": "string",
"circuitConnectionStatus": "string"
},
"name": "string"
}
]
},
"resources": []
}
Property values
The following tables describe the values you need to set in the schema.
Microsoft.Network/expressRouteCircuits/peerings object
| Name |
Type |
Required |
Value |
| peeringType |
enum |
No |
The peering type. - AzurePublicPeering, AzurePrivatePeering, MicrosoftPeering |
| state |
enum |
No |
The peering state. - Disabled or Enabled |
| azureASN |
integer |
No |
The Azure ASN. |
| peerASN |
integer |
No |
The peer ASN. |
| primaryPeerAddressPrefix |
string |
No |
The primary address prefix. |
| secondaryPeerAddressPrefix |
string |
No |
The secondary address prefix. |
| primaryAzurePort |
string |
No |
The primary port. |
| secondaryAzurePort |
string |
No |
The secondary port. |
| sharedKey |
string |
No |
The shared key. |
| vlanId |
integer |
No |
The VLAN ID. |
| microsoftPeeringConfig |
object |
No |
The Microsoft peering configuration. - ExpressRouteCircuitPeeringConfig object |
| stats |
object |
No |
The peering stats of express route circuit. - ExpressRouteCircuitStats object |
| routeFilter |
object |
No |
The reference of the RouteFilter resource. - SubResource object |
| ipv6PeeringConfig |
object |
No |
The IPv6 peering configuration. - Ipv6ExpressRouteCircuitPeeringConfig object |
| expressRouteConnection |
object |
No |
The ExpressRoute connection. - ExpressRouteConnectionId object |
| connections |
array |
No |
The list of circuit connections associated with Azure Private Peering for this circuit. - ExpressRouteCircuitConnection object |
ExpressRouteCircuitPeeringConfig object
| Name |
Type |
Required |
Value |
| advertisedPublicPrefixes |
array |
No |
The reference of AdvertisedPublicPrefixes. - string |
| advertisedCommunities |
array |
No |
The communities of bgp peering. Specified for microsoft peering. - string |
| legacyMode |
integer |
No |
The legacy mode of the peering. |
| customerASN |
integer |
No |
The CustomerASN of the peering. |
| routingRegistryName |
string |
No |
The RoutingRegistryName of the configuration. |
ExpressRouteCircuitStats object
| Name |
Type |
Required |
Value |
| primarybytesIn |
integer |
No |
The Primary BytesIn of the peering. |
| primarybytesOut |
integer |
No |
The primary BytesOut of the peering. |
| secondarybytesIn |
integer |
No |
The secondary BytesIn of the peering. |
| secondarybytesOut |
integer |
No |
The secondary BytesOut of the peering. |
SubResource object
| Name |
Type |
Required |
Value |
| id |
string |
No |
Resource ID. |
Ipv6ExpressRouteCircuitPeeringConfig object
| Name |
Type |
Required |
Value |
| primaryPeerAddressPrefix |
string |
No |
The primary address prefix. |
| secondaryPeerAddressPrefix |
string |
No |
The secondary address prefix. |
| microsoftPeeringConfig |
object |
No |
The Microsoft peering configuration. - ExpressRouteCircuitPeeringConfig object |
| routeFilter |
object |
No |
The reference of the RouteFilter resource. - SubResource object |
| state |
enum |
No |
The state of peering. - Disabled or Enabled |
ExpressRouteCircuitConnection object
| Name |
Type |
Required |
Value |
| id |
string |
No |
Resource ID. |
| properties |
object |
No |
Properties of the express route circuit connection. - ExpressRouteCircuitConnectionPropertiesFormat object |
| name |
string |
No |
The name of the resource that is unique within a resource group. This name can be used to access the resource. |
| Name |
Type |
Required |
Value |
| expressRouteCircuitPeering |
object |
No |
Reference to Express Route Circuit Private Peering Resource of the circuit initiating connection. - SubResource object |
| peerExpressRouteCircuitPeering |
object |
No |
Reference to Express Route Circuit Private Peering Resource of the peered circuit. - SubResource object |
| addressPrefix |
string |
No |
/29 IP address space to carve out Customer addresses for tunnels. |
| authorizationKey |
string |
No |
The authorization key. |
| circuitConnectionStatus |
enum |
No |
Express Route Circuit connection state. - Connected, Connecting, Disconnected |
Quickstart templates
The following quickstart templates deploy this resource type.
