你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Microsoft.Network expressRouteCircuits/peerings 2017-09-01

Bicep 资源定义

可以使用目标操作部署 expressRouteCircuits/peerings 资源类型:

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.Network/expressRouteCircuits/peerings 资源,请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.Network/expressRouteCircuits/peerings@2017-09-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    azureASN: int
    gatewayManagerEtag: 'string'
    ipv6PeeringConfig: {
      microsoftPeeringConfig: {
        advertisedCommunities: [
          'string'
        ]
        advertisedPublicPrefixes: [
          'string'
        ]
        advertisedPublicPrefixesState: 'string'
        customerASN: int
        legacyMode: int
        routingRegistryName: 'string'
      }
      primaryPeerAddressPrefix: 'string'
      routeFilter: {
        id: 'string'
        location: 'string'
        properties: {
          peerings: [
            {
              id: 'string'
              name: 'string'
              properties: ...
            }
          ]
          rules: [
            {
              id: 'string'
              location: 'string'
              name: 'string'
              properties: {
                access: 'string'
                communities: [
                  'string'
                ]
                routeFilterRuleType: 'string'
              }
              tags: {
                {customized property}: 'string'
              }
            }
          ]
        }
        tags: {
          {customized property}: 'string'
        }
      }
      secondaryPeerAddressPrefix: 'string'
      state: 'string'
    }
    lastModifiedBy: 'string'
    microsoftPeeringConfig: {
      advertisedCommunities: [
        'string'
      ]
      advertisedPublicPrefixes: [
        'string'
      ]
      advertisedPublicPrefixesState: 'string'
      customerASN: int
      legacyMode: int
      routingRegistryName: 'string'
    }
    peerASN: int
    peeringType: 'string'
    primaryAzurePort: 'string'
    primaryPeerAddressPrefix: 'string'
    provisioningState: 'string'
    routeFilter: {
      id: 'string'
      location: 'string'
      properties: {
        peerings: [
          {
            id: 'string'
            name: 'string'
            properties: ...
          }
        ]
        rules: [
          {
            id: 'string'
            location: 'string'
            name: 'string'
            properties: {
              access: 'string'
              communities: [
                'string'
              ]
              routeFilterRuleType: 'string'
            }
            tags: {
              {customized property}: 'string'
            }
          }
        ]
      }
      tags: {
        {customized property}: 'string'
      }
    }
    secondaryAzurePort: 'string'
    secondaryPeerAddressPrefix: 'string'
    sharedKey: 'string'
    state: 'string'
    stats: {
      primarybytesIn: int
      primarybytesOut: int
      secondarybytesIn: int
      secondarybytesOut: int
    }
    vlanId: int
  }
}

属性值

ExpressRouteCircuitPeering

名字 描述 价值
id 资源 ID。 字符串
名字 获取资源组中唯一的资源的名称。 此名称可用于访问资源。 字符串
性能 ExpressRouteCircuitPeeringPropertiesFormat

ExpressRouteCircuitPeeringConfig

名字 描述 价值
广告社区 bgp 对等互连的社区。 为 Microsoft 对等互连指定 string[]
advertisedPublicPrefixes AdvertisedPublicPrefixes 的引用。 string[]
advertisedPublicPrefixesState 对等互连资源的 AdvertisedPublicPrefixState。 可能的值为“NotConfigured”、“Configuring”、“Configured”和“ValidationNeeded”。 “已配置”
“配置”
“NotConfigured”
“ValidationNeeded”
customerASN 对等互连的 CustomerASN。 int
legacyMode 对等互连的旧模式。 int
routingRegistryName 配置的 RoutingRegistryName。 字符串

ExpressRouteCircuitPeeringPropertiesFormat

名字 描述 价值
azureASN Azure ASN。 int
gatewayManagerEtag GatewayManager Etag。 字符串
ipv6PeeringConfig IPv6 对等互连配置。 Ipv6ExpressRouteCircuitPeeringConfig
lastModifiedBy 获取提供程序还是客户上次修改对等互连。 字符串
microsoftPeeringConfig Microsoft对等互连配置。 ExpressRouteCircuitPeeringConfig
peerASN 对等 ASN。 int
peeringType PeeringType。 可能的值为:“AzurePublicPeering”、“AzurePrivatePeering”和“MicrosoftPeering”。 “AzurePrivatePeering”
“AzurePublicPeering”
“MicrosoftPeering”
primaryAzurePort 主端口。 字符串
primaryPeerAddressPrefix 主地址前缀。 字符串
provisioningState 获取公共 IP 资源的预配状态。 可能的值包括:“正在更新”、“删除”和“Failed”。 字符串
routeFilter RouteFilter 资源的引用。 RouteFilter
secondaryAzurePort 辅助端口。 字符串
secondaryPeerAddressPrefix 辅助地址前缀。 字符串
sharedKey 共享密钥。 字符串
对等互连的状态。 可能的值为:“Disabled”和“Enabled” “Disabled”
“Enabled”
统计 获取对等互连统计信息。 ExpressRouteCircuitStats
vlanId VLAN ID。 int

ExpressRouteCircuitStats

名字 描述 价值
primarybytesIn 获取对等互连的 BytesIn。 int
primarybytesOut 获取对等互连的 BytesOut。 int
secondarybytesIn 获取对等互连的 BytesIn。 int
secondarybytesOut 获取对等互连的 BytesOut。 int

Ipv6ExpressRouteCircuitPeeringConfig

名字 描述 价值
microsoftPeeringConfig Microsoft对等互连配置。 ExpressRouteCircuitPeeringConfig
primaryPeerAddressPrefix 主地址前缀。 字符串
routeFilter RouteFilter 资源的引用。 RouteFilter
secondaryPeerAddressPrefix 辅助地址前缀。 字符串
对等互连的状态。 可能的值为:“Disabled”和“Enabled” “Disabled”
“Enabled”

Microsoft.Network/expressRouteCircuits/peerings

名字 描述 价值
名字 资源名称 string (必需)
父母 在 Bicep 中,可以为子资源指定父资源。 仅当子资源在父资源外部声明时,才需要添加此属性。

有关详细信息,请参阅 父资源外部的子资源
类型资源的符号名称:expressRouteCircuits
性能 ExpressRouteCircuitPeeringPropertiesFormat

ResourceTags

名字 描述 价值

RouteFilter

名字 描述 价值
id 资源 ID。 字符串
位置 资源位置。 字符串
性能 路由筛选器资源 RouteFilterPropertiesFormat
标签 资源标记。 ResourceTags

RouteFilterPropertiesFormat

名字 描述 价值
对等互连 对快速路由线路对等互连的引用集合。 ExpressRouteCircuitPeering[]
规则 路由筛选器中包含的 RouteFilterRules 的集合。 RouteFilterRule[]

RouteFilterRule

名字 描述 价值
id 资源 ID。 字符串
位置 资源位置。 字符串
名字 资源组中唯一的资源的名称。 此名称可用于访问资源。 字符串
性能 路由筛选器规则资源 RouteFilterRulePropertiesFormat
标签 资源标记。 RouteFilterRuleTags

RouteFilterRulePropertiesFormat

名字 描述 价值
访问 规则的访问类型。 有效值为:“Allow”、“Deny” “允许”
“拒绝”(必需)
社区 要筛选的 bgp 社区值的集合。例如 ['12076:5010','12076:5020'] string[] (必需)
routeFilterRuleType 规则的规则类型。 有效值为:“Community” “社区”(必需)

RouteFilterRuleTags

名字 描述 价值

快速入门示例

以下快速入门示例部署此资源类型。

Bicep 文件 描述
使用专用对等互连和 Azure VNet ExpressRoute 线路 此模板配置 ExpressRoute Microsoft对等互连,部署包含 Expressroute 网关的 Azure VNet,并将 VNet 链接到 ExpressRoute 线路

ARM 模板资源定义

可以使用目标操作部署 expressRouteCircuits/peerings 资源类型:

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.Network/expressRouteCircuits/peerings 资源,请将以下 JSON 添加到模板。

{
  "type": "Microsoft.Network/expressRouteCircuits/peerings",
  "apiVersion": "2017-09-01",
  "name": "string",
  "properties": {
    "azureASN": "int",
    "gatewayManagerEtag": "string",
    "ipv6PeeringConfig": {
      "microsoftPeeringConfig": {
        "advertisedCommunities": [ "string" ],
        "advertisedPublicPrefixes": [ "string" ],
        "advertisedPublicPrefixesState": "string",
        "customerASN": "int",
        "legacyMode": "int",
        "routingRegistryName": "string"
      },
      "primaryPeerAddressPrefix": "string",
      "routeFilter": {
        "id": "string",
        "location": "string",
        "properties": {
          "peerings": [
            {
              "id": "string",
              "name": "string",
              "properties": ...
            }
          ],
          "rules": [
            {
              "id": "string",
              "location": "string",
              "name": "string",
              "properties": {
                "access": "string",
                "communities": [ "string" ],
                "routeFilterRuleType": "string"
              },
              "tags": {
                "{customized property}": "string"
              }
            }
          ]
        },
        "tags": {
          "{customized property}": "string"
        }
      },
      "secondaryPeerAddressPrefix": "string",
      "state": "string"
    },
    "lastModifiedBy": "string",
    "microsoftPeeringConfig": {
      "advertisedCommunities": [ "string" ],
      "advertisedPublicPrefixes": [ "string" ],
      "advertisedPublicPrefixesState": "string",
      "customerASN": "int",
      "legacyMode": "int",
      "routingRegistryName": "string"
    },
    "peerASN": "int",
    "peeringType": "string",
    "primaryAzurePort": "string",
    "primaryPeerAddressPrefix": "string",
    "provisioningState": "string",
    "routeFilter": {
      "id": "string",
      "location": "string",
      "properties": {
        "peerings": [
          {
            "id": "string",
            "name": "string",
            "properties": ...
          }
        ],
        "rules": [
          {
            "id": "string",
            "location": "string",
            "name": "string",
            "properties": {
              "access": "string",
              "communities": [ "string" ],
              "routeFilterRuleType": "string"
            },
            "tags": {
              "{customized property}": "string"
            }
          }
        ]
      },
      "tags": {
        "{customized property}": "string"
      }
    },
    "secondaryAzurePort": "string",
    "secondaryPeerAddressPrefix": "string",
    "sharedKey": "string",
    "state": "string",
    "stats": {
      "primarybytesIn": "int",
      "primarybytesOut": "int",
      "secondarybytesIn": "int",
      "secondarybytesOut": "int"
    },
    "vlanId": "int"
  }
}

属性值

ExpressRouteCircuitPeering

名字 描述 价值
id 资源 ID。 字符串
名字 获取资源组中唯一的资源的名称。 此名称可用于访问资源。 字符串
性能 ExpressRouteCircuitPeeringPropertiesFormat

ExpressRouteCircuitPeeringConfig

名字 描述 价值
广告社区 bgp 对等互连的社区。 为 Microsoft 对等互连指定 string[]
advertisedPublicPrefixes AdvertisedPublicPrefixes 的引用。 string[]
advertisedPublicPrefixesState 对等互连资源的 AdvertisedPublicPrefixState。 可能的值为“NotConfigured”、“Configuring”、“Configured”和“ValidationNeeded”。 “已配置”
“配置”
“NotConfigured”
“ValidationNeeded”
customerASN 对等互连的 CustomerASN。 int
legacyMode 对等互连的旧模式。 int
routingRegistryName 配置的 RoutingRegistryName。 字符串

ExpressRouteCircuitPeeringPropertiesFormat

名字 描述 价值
azureASN Azure ASN。 int
gatewayManagerEtag GatewayManager Etag。 字符串
ipv6PeeringConfig IPv6 对等互连配置。 Ipv6ExpressRouteCircuitPeeringConfig
lastModifiedBy 获取提供程序还是客户上次修改对等互连。 字符串
microsoftPeeringConfig Microsoft对等互连配置。 ExpressRouteCircuitPeeringConfig
peerASN 对等 ASN。 int
peeringType PeeringType。 可能的值为:“AzurePublicPeering”、“AzurePrivatePeering”和“MicrosoftPeering”。 “AzurePrivatePeering”
“AzurePublicPeering”
“MicrosoftPeering”
primaryAzurePort 主端口。 字符串
primaryPeerAddressPrefix 主地址前缀。 字符串
provisioningState 获取公共 IP 资源的预配状态。 可能的值包括:“正在更新”、“删除”和“Failed”。 字符串
routeFilter RouteFilter 资源的引用。 RouteFilter
secondaryAzurePort 辅助端口。 字符串
secondaryPeerAddressPrefix 辅助地址前缀。 字符串
sharedKey 共享密钥。 字符串
对等互连的状态。 可能的值为:“Disabled”和“Enabled” “Disabled”
“Enabled”
统计 获取对等互连统计信息。 ExpressRouteCircuitStats
vlanId VLAN ID。 int

ExpressRouteCircuitStats

名字 描述 价值
primarybytesIn 获取对等互连的 BytesIn。 int
primarybytesOut 获取对等互连的 BytesOut。 int
secondarybytesIn 获取对等互连的 BytesIn。 int
secondarybytesOut 获取对等互连的 BytesOut。 int

Ipv6ExpressRouteCircuitPeeringConfig

名字 描述 价值
microsoftPeeringConfig Microsoft对等互连配置。 ExpressRouteCircuitPeeringConfig
primaryPeerAddressPrefix 主地址前缀。 字符串
routeFilter RouteFilter 资源的引用。 RouteFilter
secondaryPeerAddressPrefix 辅助地址前缀。 字符串
对等互连的状态。 可能的值为:“Disabled”和“Enabled” “Disabled”
“Enabled”

Microsoft.Network/expressRouteCircuits/peerings

名字 描述 价值
apiVersion API 版本 '2017-09-01'
名字 资源名称 string (必需)
性能 ExpressRouteCircuitPeeringPropertiesFormat
类型 资源类型 “Microsoft.Network/expressRouteCircuits/peerings”

ResourceTags

名字 描述 价值

RouteFilter

名字 描述 价值
id 资源 ID。 字符串
位置 资源位置。 字符串
性能 路由筛选器资源 RouteFilterPropertiesFormat
标签 资源标记。 ResourceTags

RouteFilterPropertiesFormat

名字 描述 价值
对等互连 对快速路由线路对等互连的引用集合。 ExpressRouteCircuitPeering[]
规则 路由筛选器中包含的 RouteFilterRules 的集合。 RouteFilterRule[]

RouteFilterRule

名字 描述 价值
id 资源 ID。 字符串
位置 资源位置。 字符串
名字 资源组中唯一的资源的名称。 此名称可用于访问资源。 字符串
性能 路由筛选器规则资源 RouteFilterRulePropertiesFormat
标签 资源标记。 RouteFilterRuleTags

RouteFilterRulePropertiesFormat

名字 描述 价值
访问 规则的访问类型。 有效值为:“Allow”、“Deny” “允许”
“拒绝”(必需)
社区 要筛选的 bgp 社区值的集合。例如 ['12076:5010','12076:5020'] string[] (必需)
routeFilterRuleType 规则的规则类型。 有效值为:“Community” “社区”(必需)

RouteFilterRuleTags

名字 描述 价值

快速入门模板

以下快速入门模板部署此资源类型。

模板 描述
使用专用对等互连和 Azure VNet ExpressRoute 线路

部署到 Azure
此模板配置 ExpressRoute Microsoft对等互连,部署包含 Expressroute 网关的 Azure VNet,并将 VNet 链接到 ExpressRoute 线路

Terraform (AzAPI 提供程序)资源定义

可以使用目标操作部署 expressRouteCircuits/peerings 资源类型:

  • 资源组

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.Network/expressRouteCircuits/peerings 资源,请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/expressRouteCircuits/peerings@2017-09-01"
  name = "string"
  body = jsonencode({
    properties = {
      azureASN = int
      gatewayManagerEtag = "string"
      ipv6PeeringConfig = {
        microsoftPeeringConfig = {
          advertisedCommunities = [
            "string"
          ]
          advertisedPublicPrefixes = [
            "string"
          ]
          advertisedPublicPrefixesState = "string"
          customerASN = int
          legacyMode = int
          routingRegistryName = "string"
        }
        primaryPeerAddressPrefix = "string"
        routeFilter = {
          id = "string"
          location = "string"
          properties = {
            peerings = [
              {
                id = "string"
                name = "string"
                properties = ...
              }
            ]
            rules = [
              {
                id = "string"
                location = "string"
                name = "string"
                properties = {
                  access = "string"
                  communities = [
                    "string"
                  ]
                  routeFilterRuleType = "string"
                }
                tags = {
                  {customized property} = "string"
                }
              }
            ]
          }
          tags = {
            {customized property} = "string"
          }
        }
        secondaryPeerAddressPrefix = "string"
        state = "string"
      }
      lastModifiedBy = "string"
      microsoftPeeringConfig = {
        advertisedCommunities = [
          "string"
        ]
        advertisedPublicPrefixes = [
          "string"
        ]
        advertisedPublicPrefixesState = "string"
        customerASN = int
        legacyMode = int
        routingRegistryName = "string"
      }
      peerASN = int
      peeringType = "string"
      primaryAzurePort = "string"
      primaryPeerAddressPrefix = "string"
      provisioningState = "string"
      routeFilter = {
        id = "string"
        location = "string"
        properties = {
          peerings = [
            {
              id = "string"
              name = "string"
              properties = ...
            }
          ]
          rules = [
            {
              id = "string"
              location = "string"
              name = "string"
              properties = {
                access = "string"
                communities = [
                  "string"
                ]
                routeFilterRuleType = "string"
              }
              tags = {
                {customized property} = "string"
              }
            }
          ]
        }
        tags = {
          {customized property} = "string"
        }
      }
      secondaryAzurePort = "string"
      secondaryPeerAddressPrefix = "string"
      sharedKey = "string"
      state = "string"
      stats = {
        primarybytesIn = int
        primarybytesOut = int
        secondarybytesIn = int
        secondarybytesOut = int
      }
      vlanId = int
    }
  })
}

属性值

ExpressRouteCircuitPeering

名字 描述 价值
id 资源 ID。 字符串
名字 获取资源组中唯一的资源的名称。 此名称可用于访问资源。 字符串
性能 ExpressRouteCircuitPeeringPropertiesFormat

ExpressRouteCircuitPeeringConfig

名字 描述 价值
广告社区 bgp 对等互连的社区。 为 Microsoft 对等互连指定 string[]
advertisedPublicPrefixes AdvertisedPublicPrefixes 的引用。 string[]
advertisedPublicPrefixesState 对等互连资源的 AdvertisedPublicPrefixState。 可能的值为“NotConfigured”、“Configuring”、“Configured”和“ValidationNeeded”。 “已配置”
“配置”
“NotConfigured”
“ValidationNeeded”
customerASN 对等互连的 CustomerASN。 int
legacyMode 对等互连的旧模式。 int
routingRegistryName 配置的 RoutingRegistryName。 字符串

ExpressRouteCircuitPeeringPropertiesFormat

名字 描述 价值
azureASN Azure ASN。 int
gatewayManagerEtag GatewayManager Etag。 字符串
ipv6PeeringConfig IPv6 对等互连配置。 Ipv6ExpressRouteCircuitPeeringConfig
lastModifiedBy 获取提供程序还是客户上次修改对等互连。 字符串
microsoftPeeringConfig Microsoft对等互连配置。 ExpressRouteCircuitPeeringConfig
peerASN 对等 ASN。 int
peeringType PeeringType。 可能的值为:“AzurePublicPeering”、“AzurePrivatePeering”和“MicrosoftPeering”。 “AzurePrivatePeering”
“AzurePublicPeering”
“MicrosoftPeering”
primaryAzurePort 主端口。 字符串
primaryPeerAddressPrefix 主地址前缀。 字符串
provisioningState 获取公共 IP 资源的预配状态。 可能的值包括:“正在更新”、“删除”和“Failed”。 字符串
routeFilter RouteFilter 资源的引用。 RouteFilter
secondaryAzurePort 辅助端口。 字符串
secondaryPeerAddressPrefix 辅助地址前缀。 字符串
sharedKey 共享密钥。 字符串
对等互连的状态。 可能的值为:“Disabled”和“Enabled” “Disabled”
“Enabled”
统计 获取对等互连统计信息。 ExpressRouteCircuitStats
vlanId VLAN ID。 int

ExpressRouteCircuitStats

名字 描述 价值
primarybytesIn 获取对等互连的 BytesIn。 int
primarybytesOut 获取对等互连的 BytesOut。 int
secondarybytesIn 获取对等互连的 BytesIn。 int
secondarybytesOut 获取对等互连的 BytesOut。 int

Ipv6ExpressRouteCircuitPeeringConfig

名字 描述 价值
microsoftPeeringConfig Microsoft对等互连配置。 ExpressRouteCircuitPeeringConfig
primaryPeerAddressPrefix 主地址前缀。 字符串
routeFilter RouteFilter 资源的引用。 RouteFilter
secondaryPeerAddressPrefix 辅助地址前缀。 字符串
对等互连的状态。 可能的值为:“Disabled”和“Enabled” “Disabled”
“Enabled”

Microsoft.Network/expressRouteCircuits/peerings

名字 描述 价值
名字 资源名称 string (必需)
parent_id 此资源的父资源的 ID。 类型资源的 ID:expressRouteCircuits
性能 ExpressRouteCircuitPeeringPropertiesFormat
类型 资源类型 “Microsoft.Network/expressRouteCircuits/peerings@2017-09-01”

ResourceTags

名字 描述 价值

RouteFilter

名字 描述 价值
id 资源 ID。 字符串
位置 资源位置。 字符串
性能 路由筛选器资源 RouteFilterPropertiesFormat
标签 资源标记。 ResourceTags

RouteFilterPropertiesFormat

名字 描述 价值
对等互连 对快速路由线路对等互连的引用集合。 ExpressRouteCircuitPeering[]
规则 路由筛选器中包含的 RouteFilterRules 的集合。 RouteFilterRule[]

RouteFilterRule

名字 描述 价值
id 资源 ID。 字符串
位置 资源位置。 字符串
名字 资源组中唯一的资源的名称。 此名称可用于访问资源。 字符串
性能 路由筛选器规则资源 RouteFilterRulePropertiesFormat
标签 资源标记。 RouteFilterRuleTags

RouteFilterRulePropertiesFormat

名字 描述 价值
访问 规则的访问类型。 有效值为:“Allow”、“Deny” “允许”
“拒绝”(必需)
社区 要筛选的 bgp 社区值的集合。例如 ['12076:5010','12076:5020'] string[] (必需)
routeFilterRuleType 规则的规则类型。 有效值为:“Community” “社区”(必需)

RouteFilterRuleTags

名字 描述 价值