Microsoft.Network expressRouteCrossConnections/peerings 2023-11-01

• 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
• 2020-04-01
• 2020-03-01
• 2019-12-01
• 2019-11-01
• 2019-09-01
• 2019-08-01
• 2019-07-01
• 2019-06-01
• 2019-04-01
• 2019-02-01
• 2018-12-01
• 2018-11-01
• 2018-10-01
• 2018-08-01
• 2018-07-01
• 2018-06-01
• 2018-04-01
• 2018-02-01

Bicep resource definition

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

resource symbolicname 'Microsoft.Network/expressRouteCrossConnections/peerings@2023-11-01' = {
  name: 'string'
  properties: {
    gatewayManagerEtag: 'string'
    ipv6PeeringConfig: {
      microsoftPeeringConfig: {
        advertisedCommunities: [
          'string'
        ]
        advertisedPublicPrefixes: [
          'string'
        ]
        customerASN: int
        legacyMode: int
        routingRegistryName: 'string'
      }
      primaryPeerAddressPrefix: 'string'
      routeFilter: {
        id: 'string'
      }
      secondaryPeerAddressPrefix: 'string'
      state: 'string'
    }
    microsoftPeeringConfig: {
      advertisedCommunities: [
        'string'
      ]
      advertisedPublicPrefixes: [
        'string'
      ]
      customerASN: int
      legacyMode: int
      routingRegistryName: 'string'
    }
    peerASN: int
    peeringType: 'string'
    primaryPeerAddressPrefix: 'string'
    secondaryPeerAddressPrefix: 'string'
    sharedKey: 'string'
    state: 'string'
    vlanId: int
  }
}

Property values

ExpressRouteCircuitPeeringConfig

Name	Description	Value
advertisedCommunities	The communities of bgp peering. Specified for microsoft peering.	string[]
advertisedPublicPrefixes	The reference to AdvertisedPublicPrefixes.	string[]
customerASN	The CustomerASN of the peering.	int
legacyMode	The legacy mode of the peering.	int
routingRegistryName	The RoutingRegistryName of the configuration.	string

ExpressRouteCrossConnectionPeeringProperties

Name	Description	Value
gatewayManagerEtag	The GatewayManager Etag.	string
ipv6PeeringConfig	The IPv6 peering configuration.	Ipv6ExpressRouteCircuitPeeringConfig
microsoftPeeringConfig	The Microsoft peering configuration.	ExpressRouteCircuitPeeringConfig
peerASN	The peer ASN.	int Constraints: Min value = 1 Max value = 4294967295
peeringType	The peering type.	'AzurePrivatePeering' 'AzurePublicPeering' 'MicrosoftPeering'
primaryPeerAddressPrefix	The primary address prefix.	string
secondaryPeerAddressPrefix	The secondary address prefix.	string
sharedKey	The shared key.	string
state	The peering state.	'Disabled' 'Enabled'
vlanId	The VLAN ID.	int

Ipv6ExpressRouteCircuitPeeringConfig

Name	Description	Value
microsoftPeeringConfig	The Microsoft peering configuration.	ExpressRouteCircuitPeeringConfig
primaryPeerAddressPrefix	The primary address prefix.	string
routeFilter	The reference to the RouteFilter resource.	SubResource
secondaryPeerAddressPrefix	The secondary address prefix.	string
state	The state of peering.	'Disabled' 'Enabled'

Microsoft.Network/expressRouteCrossConnections/peerings

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: expressRouteCrossConnections
properties	Properties of the express route cross connection peering.	ExpressRouteCrossConnectionPeeringProperties

SubResource

Name	Description	Value
id	Resource ID.	string

ARM template resource definition

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

{
  "type": "Microsoft.Network/expressRouteCrossConnections/peerings",
  "apiVersion": "2023-11-01",
  "name": "string",
  "properties": {
    "gatewayManagerEtag": "string",
    "ipv6PeeringConfig": {
      "microsoftPeeringConfig": {
        "advertisedCommunities": [ "string" ],
        "advertisedPublicPrefixes": [ "string" ],
        "customerASN": "int",
        "legacyMode": "int",
        "routingRegistryName": "string"
      },
      "primaryPeerAddressPrefix": "string",
      "routeFilter": {
        "id": "string"
      },
      "secondaryPeerAddressPrefix": "string",
      "state": "string"
    },
    "microsoftPeeringConfig": {
      "advertisedCommunities": [ "string" ],
      "advertisedPublicPrefixes": [ "string" ],
      "customerASN": "int",
      "legacyMode": "int",
      "routingRegistryName": "string"
    },
    "peerASN": "int",
    "peeringType": "string",
    "primaryPeerAddressPrefix": "string",
    "secondaryPeerAddressPrefix": "string",
    "sharedKey": "string",
    "state": "string",
    "vlanId": "int"
  }
}

Property values

ExpressRouteCircuitPeeringConfig

Name	Description	Value
advertisedCommunities	The communities of bgp peering. Specified for microsoft peering.	string[]
advertisedPublicPrefixes	The reference to AdvertisedPublicPrefixes.	string[]
customerASN	The CustomerASN of the peering.	int
legacyMode	The legacy mode of the peering.	int
routingRegistryName	The RoutingRegistryName of the configuration.	string

ExpressRouteCrossConnectionPeeringProperties

Name	Description	Value
gatewayManagerEtag	The GatewayManager Etag.	string
ipv6PeeringConfig	The IPv6 peering configuration.	Ipv6ExpressRouteCircuitPeeringConfig
microsoftPeeringConfig	The Microsoft peering configuration.	ExpressRouteCircuitPeeringConfig
peerASN	The peer ASN.	int Constraints: Min value = 1 Max value = 4294967295
peeringType	The peering type.	'AzurePrivatePeering' 'AzurePublicPeering' 'MicrosoftPeering'
primaryPeerAddressPrefix	The primary address prefix.	string
secondaryPeerAddressPrefix	The secondary address prefix.	string
sharedKey	The shared key.	string
state	The peering state.	'Disabled' 'Enabled'
vlanId	The VLAN ID.	int

Ipv6ExpressRouteCircuitPeeringConfig

Name	Description	Value
microsoftPeeringConfig	The Microsoft peering configuration.	ExpressRouteCircuitPeeringConfig
primaryPeerAddressPrefix	The primary address prefix.	string
routeFilter	The reference to the RouteFilter resource.	SubResource
secondaryPeerAddressPrefix	The secondary address prefix.	string
state	The state of peering.	'Disabled' 'Enabled'

Microsoft.Network/expressRouteCrossConnections/peerings

Name	Description	Value
apiVersion	The api version	'2023-11-01'
name	The resource name	string (required)
properties	Properties of the express route cross connection peering.	ExpressRouteCrossConnectionPeeringProperties
type	The resource type	'Microsoft.Network/expressRouteCrossConnections/peerings'

SubResource

Name	Description	Value
id	Resource ID.	string

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/expressRouteCrossConnections/peerings@2023-11-01"
  name = "string"
  body = jsonencode({
    properties = {
      gatewayManagerEtag = "string"
      ipv6PeeringConfig = {
        microsoftPeeringConfig = {
          advertisedCommunities = [
            "string"
          ]
          advertisedPublicPrefixes = [
            "string"
          ]
          customerASN = int
          legacyMode = int
          routingRegistryName = "string"
        }
        primaryPeerAddressPrefix = "string"
        routeFilter = {
          id = "string"
        }
        secondaryPeerAddressPrefix = "string"
        state = "string"
      }
      microsoftPeeringConfig = {
        advertisedCommunities = [
          "string"
        ]
        advertisedPublicPrefixes = [
          "string"
        ]
        customerASN = int
        legacyMode = int
        routingRegistryName = "string"
      }
      peerASN = int
      peeringType = "string"
      primaryPeerAddressPrefix = "string"
      secondaryPeerAddressPrefix = "string"
      sharedKey = "string"
      state = "string"
      vlanId = int
    }
  })
}

Property values

ExpressRouteCircuitPeeringConfig

Name	Description	Value
advertisedCommunities	The communities of bgp peering. Specified for microsoft peering.	string[]
advertisedPublicPrefixes	The reference to AdvertisedPublicPrefixes.	string[]
customerASN	The CustomerASN of the peering.	int
legacyMode	The legacy mode of the peering.	int
routingRegistryName	The RoutingRegistryName of the configuration.	string

ExpressRouteCrossConnectionPeeringProperties

Name	Description	Value
gatewayManagerEtag	The GatewayManager Etag.	string
ipv6PeeringConfig	The IPv6 peering configuration.	Ipv6ExpressRouteCircuitPeeringConfig
microsoftPeeringConfig	The Microsoft peering configuration.	ExpressRouteCircuitPeeringConfig
peerASN	The peer ASN.	int Constraints: Min value = 1 Max value = 4294967295
peeringType	The peering type.	'AzurePrivatePeering' 'AzurePublicPeering' 'MicrosoftPeering'
primaryPeerAddressPrefix	The primary address prefix.	string
secondaryPeerAddressPrefix	The secondary address prefix.	string
sharedKey	The shared key.	string
state	The peering state.	'Disabled' 'Enabled'
vlanId	The VLAN ID.	int

Ipv6ExpressRouteCircuitPeeringConfig

Name	Description	Value
microsoftPeeringConfig	The Microsoft peering configuration.	ExpressRouteCircuitPeeringConfig
primaryPeerAddressPrefix	The primary address prefix.	string
routeFilter	The reference to the RouteFilter resource.	SubResource
secondaryPeerAddressPrefix	The secondary address prefix.	string
state	The state of peering.	'Disabled' 'Enabled'

Microsoft.Network/expressRouteCrossConnections/peerings

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: expressRouteCrossConnections
properties	Properties of the express route cross connection peering.	ExpressRouteCrossConnectionPeeringProperties
type	The resource type	"Microsoft.Network/expressRouteCrossConnections/peerings@2023-11-01"

SubResource

Name	Description	Value
id	Resource ID.	string