다음을 통해 공유

Microsoft.Network expressRouteGateways/expressRouteConnections 2020-05-01

  • 아티클

Bicep resource definition

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

resource symbolicname 'Microsoft.Network/expressRouteGateways/expressRouteConnections@2020-05-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    authorizationKey: 'string'
    enableInternetSecurity: bool
    expressRouteCircuitPeering: {
      id: 'string'
    }
    routingConfiguration: {
      associatedRouteTable: {
        id: 'string'
      }
      propagatedRouteTables: {
        ids: [
          {
            id: 'string'
          }
        ]
        labels: [
          'string'
        ]
      }
      vnetRoutes: {
        staticRoutes: [
          {
            addressPrefixes: [
              'string'
            ]
            name: 'string'
            nextHopIpAddress: 'string'
          }
        ]
      }
    }
    routingWeight: int
  }
}

Property values

ExpressRouteCircuitPeeringId

Name Description Value
id The ID of the ExpressRoute circuit peering. string

ExpressRouteConnectionProperties

Name Description Value
authorizationKey Authorization key to establish the connection. string
enableInternetSecurity Enable internet security. bool
expressRouteCircuitPeering The ExpressRoute circuit peering. ExpressRouteCircuitPeeringId (required)
routingConfiguration The Routing Configuration indicating the associated and propagated route tables on this connection. RoutingConfiguration
routingWeight The routing weight associated to the connection. int

Microsoft.Network/expressRouteGateways/expressRouteConnections

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: expressRouteGateways
properties Properties of the express route connection. ExpressRouteConnectionProperties

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
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

SubResource

Name Description Value
id Resource ID. string

VnetRoute

Name Description Value
staticRoutes List of all Static Routes. StaticRoute[]

ARM template resource definition

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

{
  "type": "Microsoft.Network/expressRouteGateways/expressRouteConnections",
  "apiVersion": "2020-05-01",
  "name": "string",
  "properties": {
    "authorizationKey": "string",
    "enableInternetSecurity": "bool",
    "expressRouteCircuitPeering": {
      "id": "string"
    },
    "routingConfiguration": {
      "associatedRouteTable": {
        "id": "string"
      },
      "propagatedRouteTables": {
        "ids": [
          {
            "id": "string"
          }
        ],
        "labels": [ "string" ]
      },
      "vnetRoutes": {
        "staticRoutes": [
          {
            "addressPrefixes": [ "string" ],
            "name": "string",
            "nextHopIpAddress": "string"
          }
        ]
      }
    },
    "routingWeight": "int"
  }
}

Property values

ExpressRouteCircuitPeeringId

Name Description Value
id The ID of the ExpressRoute circuit peering. string

ExpressRouteConnectionProperties

Name Description Value
authorizationKey Authorization key to establish the connection. string
enableInternetSecurity Enable internet security. bool
expressRouteCircuitPeering The ExpressRoute circuit peering. ExpressRouteCircuitPeeringId (required)
routingConfiguration The Routing Configuration indicating the associated and propagated route tables on this connection. RoutingConfiguration
routingWeight The routing weight associated to the connection. int

Microsoft.Network/expressRouteGateways/expressRouteConnections

Name Description Value
apiVersion The api version '2020-05-01'
name The resource name string (required)
properties Properties of the express route connection. ExpressRouteConnectionProperties
type The resource type 'Microsoft.Network/expressRouteGateways/expressRouteConnections'

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
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

SubResource

Name Description Value
id Resource ID. string

VnetRoute

Name Description Value
staticRoutes List of all Static Routes. StaticRoute[]

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/expressRouteGateways/expressRouteConnections@2020-05-01"
  name = "string"
  body = jsonencode({
    properties = {
      authorizationKey = "string"
      enableInternetSecurity = bool
      expressRouteCircuitPeering = {
        id = "string"
      }
      routingConfiguration = {
        associatedRouteTable = {
          id = "string"
        }
        propagatedRouteTables = {
          ids = [
            {
              id = "string"
            }
          ]
          labels = [
            "string"
          ]
        }
        vnetRoutes = {
          staticRoutes = [
            {
              addressPrefixes = [
                "string"
              ]
              name = "string"
              nextHopIpAddress = "string"
            }
          ]
        }
      }
      routingWeight = int
    }
  })
}

Property values

ExpressRouteCircuitPeeringId

Name Description Value
id The ID of the ExpressRoute circuit peering. string

ExpressRouteConnectionProperties

Name Description Value
authorizationKey Authorization key to establish the connection. string
enableInternetSecurity Enable internet security. bool
expressRouteCircuitPeering The ExpressRoute circuit peering. ExpressRouteCircuitPeeringId (required)
routingConfiguration The Routing Configuration indicating the associated and propagated route tables on this connection. RoutingConfiguration
routingWeight The routing weight associated to the connection. int

Microsoft.Network/expressRouteGateways/expressRouteConnections

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: expressRouteGateways
properties Properties of the express route connection. ExpressRouteConnectionProperties
type The resource type "Microsoft.Network/expressRouteGateways/expressRouteConnections@2020-05-01"

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
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

SubResource

Name Description Value
id Resource ID. string

VnetRoute

Name Description Value
staticRoutes List of all Static Routes. StaticRoute[]