Microsoft.Network expressRouteCircuits/peerings/connections template reference

07/14/2020
2 minutes to read

Template format

To create a Microsoft.Network/expressRouteCircuits/peerings/connections resource, add the following JSON to the resources section of your template.

{
  "name": "string",
  "type": "Microsoft.Network/expressRouteCircuits/peerings/connections",
  "apiVersion": "2019-02-01",
  "properties": {
    "expressRouteCircuitPeering": {
      "id": "string"
    },
    "peerExpressRouteCircuitPeering": {
      "id": "string"
    },
    "addressPrefix": "string",
    "authorizationKey": "string",
    "circuitConnectionStatus": "string"
  }
}

Property values

The following tables describe the values you need to set in the schema.

Microsoft.Network/expressRouteCircuits/peerings/connections object

Name	Type	Required	Value
name	string	Yes	The name of the express route circuit connection.
type	enum	Yes	connections -or- Microsoft.Network/expressRouteCircuits/peerings/connections See Set name and type for child resources.
apiVersion	enum	Yes	2019-02-01
properties	object	Yes	Properties of the express route circuit connection. - ExpressRouteCircuitConnectionPropertiesFormat object

ExpressRouteCircuitConnectionPropertiesFormat object

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

SubResource object

Name	Type	Required	Value
id	string	No	Resource ID.