Share via

Microsoft.Network expressRouteCircuits/peerings/connections 2022-01-01

  • Article

Bicep resource definition

The expressRouteCircuits/peerings/connections resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Network/expressRouteCircuits/peerings/connections resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Network/expressRouteCircuits/peerings/connections@2022-01-01' = {
  name: 'string'
  properties: {
    addressPrefix: 'string'
    authorizationKey: 'string'
    expressRouteCircuitPeering: {
      id: 'string'
    }
    ipv6CircuitConnectionConfig: {
      addressPrefix: 'string'
    }
    peerExpressRouteCircuitPeering: {
      id: 'string'
    }
  }
}

Property values

ExpressRouteCircuitConnectionPropertiesFormat

Name Description Value
addressPrefix /29 IP address space to carve out Customer addresses for tunnels. string
authorizationKey The authorization key. string
expressRouteCircuitPeering Reference to Express Route Circuit Private Peering Resource of the circuit initiating connection. SubResource
ipv6CircuitConnectionConfig IPv6 Address PrefixProperties of the express route circuit connection. Ipv6CircuitConnectionConfig
peerExpressRouteCircuitPeering Reference to Express Route Circuit Private Peering Resource of the peered circuit. SubResource

Ipv6CircuitConnectionConfig

Name Description Value
addressPrefix /125 IP address space to carve out customer addresses for global reach. string

Microsoft.Network/expressRouteCircuits/peerings/connections

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: expressRouteCircuits/peerings
properties Properties of the express route circuit connection. ExpressRouteCircuitConnectionPropertiesFormat

SubResource

Name Description Value
id Resource ID. string

ARM template resource definition

The expressRouteCircuits/peerings/connections resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

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

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

Property values

ExpressRouteCircuitConnectionPropertiesFormat

Name Description Value
addressPrefix /29 IP address space to carve out Customer addresses for tunnels. string
authorizationKey The authorization key. string
expressRouteCircuitPeering Reference to Express Route Circuit Private Peering Resource of the circuit initiating connection. SubResource
ipv6CircuitConnectionConfig IPv6 Address PrefixProperties of the express route circuit connection. Ipv6CircuitConnectionConfig
peerExpressRouteCircuitPeering Reference to Express Route Circuit Private Peering Resource of the peered circuit. SubResource

Ipv6CircuitConnectionConfig

Name Description Value
addressPrefix /125 IP address space to carve out customer addresses for global reach. string

Microsoft.Network/expressRouteCircuits/peerings/connections

Name Description Value
apiVersion The api version '2022-01-01'
name The resource name string (required)
properties Properties of the express route circuit connection. ExpressRouteCircuitConnectionPropertiesFormat
type The resource type 'Microsoft.Network/expressRouteCircuits/peerings/connections'

SubResource

Name Description Value
id Resource ID. string

Terraform (AzAPI provider) resource definition

The expressRouteCircuits/peerings/connections 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/expressRouteCircuits/peerings/connections resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/expressRouteCircuits/peerings/connections@2022-01-01"
  name = "string"
  body = jsonencode({
    properties = {
      addressPrefix = "string"
      authorizationKey = "string"
      expressRouteCircuitPeering = {
        id = "string"
      }
      ipv6CircuitConnectionConfig = {
        addressPrefix = "string"
      }
      peerExpressRouteCircuitPeering = {
        id = "string"
      }
    }
  })
}

Property values

ExpressRouteCircuitConnectionPropertiesFormat

Name Description Value
addressPrefix /29 IP address space to carve out Customer addresses for tunnels. string
authorizationKey The authorization key. string
expressRouteCircuitPeering Reference to Express Route Circuit Private Peering Resource of the circuit initiating connection. SubResource
ipv6CircuitConnectionConfig IPv6 Address PrefixProperties of the express route circuit connection. Ipv6CircuitConnectionConfig
peerExpressRouteCircuitPeering Reference to Express Route Circuit Private Peering Resource of the peered circuit. SubResource

Ipv6CircuitConnectionConfig

Name Description Value
addressPrefix /125 IP address space to carve out customer addresses for global reach. string

Microsoft.Network/expressRouteCircuits/peerings/connections

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: expressRouteCircuits/peerings
properties Properties of the express route circuit connection. ExpressRouteCircuitConnectionPropertiesFormat
type The resource type "Microsoft.Network/expressRouteCircuits/peerings/connections@2022-01-01"

SubResource

Name Description Value
id Resource ID. string