通过

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

Microsoft.Network localNetworkGateways 2023-11-01

  • 项目

Bicep 资源定义

可以使用目标操作部署 localNetworkGateways 资源类型：

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

资源格式

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

resource symbolicname 'Microsoft.Network/localNetworkGateways@2023-11-01' = {
  location: 'string'
  name: 'string'
  properties: {
    bgpSettings: {
      asn: int
      bgpPeeringAddress: 'string'
      bgpPeeringAddresses: [
        {
          customBgpIpAddresses: [
            'string'
          ]
          ipconfigurationId: 'string'
        }
      ]
      peerWeight: int
    }
    fqdn: 'string'
    gatewayIpAddress: 'string'
    localNetworkAddressSpace: {
      addressPrefixes: [
        'string'
      ]
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

属性值

AddressSpace

名字 描述 价值
addressPrefixes CIDR 表示法中为此虚拟网络保留的地址块列表。 string[]

BgpSettings

名字 描述 价值
asn BGP 扬声器的 ASN。 int

约束：
最小值 = 0
最大值 = 4294967295
bgpPeeringAddress 此 BGP 扬声器的 BGP 对等互连地址和 BGP 标识符。 字符串
bgpPeeringAddresses 具有虚拟网络网关 IP 配置 ID 的 BGP 对等互连地址。 IPConfigurationBgpPeeringAddress[]
peerWeight 添加到从此 BGP 扬声器中学习的路由的权重。 int

IPConfigurationBgpPeeringAddress

名字 描述 价值
customBgpIpAddresses 属于 IP 配置的自定义 BGP 对等互连地址的列表。 string[]
ipconfigurationId 属于网关的 IP 配置的 ID。 字符串

LocalNetworkGatewayPropertiesFormat

名字 描述 价值
bgpSettings 本地网络网关的 BGP 扬声器设置。 BgpSettings
fqdn 本地网关的 FQDN。 字符串
gatewayIpAddress 本地网络网关的 IP 地址。 字符串
localNetworkAddressSpace 本地网络站点地址空间。 AddressSpace

Microsoft.Network/localNetworkGateways

名字 描述 价值
位置 资源位置。 字符串
名字 资源名称 字符串

约束：
最小长度 = 1 （必需）
性能 本地网络网关的属性。 LocalNetworkGatewayPropertiesFormat （必需）
标签 资源标记 标记名称和值的字典。 请参阅模板 中的 标记

ResourceTags

名字 描述 价值

快速入门示例

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

Bicep 文件 描述
使用具有 BGP 的主动-主动 VPN 网关 站点到站点 VPN 通过此模板，可以使用 BGP 在配置主动-主动的两个 VNet 之间部署站点到站点 VPN VPN。 每个 Azure VPN 网关解析远程对等方的 FQDN，以确定远程 VPN 网关的公共 IP。 模板在具有可用性区域的 Azure 区域中按预期运行。

ARM 模板资源定义

可以使用目标操作部署 localNetworkGateways 资源类型：

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

资源格式

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

{
  "type": "Microsoft.Network/localNetworkGateways",
  "apiVersion": "2023-11-01",
  "name": "string",
  "location": "string",
  "properties": {
    "bgpSettings": {
      "asn": "int",
      "bgpPeeringAddress": "string",
      "bgpPeeringAddresses": [
        {
          "customBgpIpAddresses": [ "string" ],
          "ipconfigurationId": "string"
        }
      ],
      "peerWeight": "int"
    },
    "fqdn": "string",
    "gatewayIpAddress": "string",
    "localNetworkAddressSpace": {
      "addressPrefixes": [ "string" ]
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

属性值

AddressSpace

名字 描述 价值
addressPrefixes CIDR 表示法中为此虚拟网络保留的地址块列表。 string[]

BgpSettings

名字 描述 价值
asn BGP 扬声器的 ASN。 int

约束：
最小值 = 0
最大值 = 4294967295
bgpPeeringAddress 此 BGP 扬声器的 BGP 对等互连地址和 BGP 标识符。 字符串
bgpPeeringAddresses 具有虚拟网络网关 IP 配置 ID 的 BGP 对等互连地址。 IPConfigurationBgpPeeringAddress[]
peerWeight 添加到从此 BGP 扬声器中学习的路由的权重。 int

IPConfigurationBgpPeeringAddress

名字 描述 价值
customBgpIpAddresses 属于 IP 配置的自定义 BGP 对等互连地址的列表。 string[]
ipconfigurationId 属于网关的 IP 配置的 ID。 字符串

LocalNetworkGatewayPropertiesFormat

名字 描述 价值
bgpSettings 本地网络网关的 BGP 扬声器设置。 BgpSettings
fqdn 本地网关的 FQDN。 字符串
gatewayIpAddress 本地网络网关的 IP 地址。 字符串
localNetworkAddressSpace 本地网络站点地址空间。 AddressSpace

Microsoft.Network/localNetworkGateways

名字 描述 价值
apiVersion API 版本 '2023-11-01'
位置 资源位置。 字符串
名字 资源名称 字符串

约束：
最小长度 = 1 （必需）
性能 本地网络网关的属性。 LocalNetworkGatewayPropertiesFormat （必需）
标签 资源标记 标记名称和值的字典。 请参阅模板 中的 标记
类型 资源类型 “Microsoft.Network/localNetworkGateways”

ResourceTags

名字 描述 价值

快速入门模板

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

模板 描述
创建站点到站点 VPN 连接

部署到 Azure 		使用此模板，可以使用虚拟网络网关创建站点到站点 VPN 连接
使用 VM 创建站点到站点 VPN 连接

部署到 Azure 		使用此模板，可以使用虚拟网络网关创建站点到站点 VPN 连接
创建包含两个子网、本地网络和网关 的 VNet

部署到 Azure 		此模板创建 VNet、2 个子网和网关
使用具有 BGP 的主动-主动 VPN 网关 站点到站点 VPN

部署到 Azure 		通过此模板，可以使用 BGP 在配置主动-主动的两个 VNet 之间部署站点到站点 VPN VPN。 每个 Azure VPN 网关解析远程对等方的 FQDN，以确定远程 VPN 网关的公共 IP。 模板在具有可用性区域的 Azure 区域中按预期运行。

Terraform （AzAPI 提供程序）资源定义

可以使用目标操作部署 localNetworkGateways 资源类型：

  • 资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/localNetworkGateways@2023-11-01"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      bgpSettings = {
        asn = int
        bgpPeeringAddress = "string"
        bgpPeeringAddresses = [
          {
            customBgpIpAddresses = [
              "string"
            ]
            ipconfigurationId = "string"
          }
        ]
        peerWeight = int
      }
      fqdn = "string"
      gatewayIpAddress = "string"
      localNetworkAddressSpace = {
        addressPrefixes = [
          "string"
        ]
      }
    }
  })
}

属性值

AddressSpace

名字 描述 价值
addressPrefixes CIDR 表示法中为此虚拟网络保留的地址块列表。 string[]

BgpSettings

名字 描述 价值
asn BGP 扬声器的 ASN。 int

约束：
最小值 = 0
最大值 = 4294967295
bgpPeeringAddress 此 BGP 扬声器的 BGP 对等互连地址和 BGP 标识符。 字符串
bgpPeeringAddresses 具有虚拟网络网关 IP 配置 ID 的 BGP 对等互连地址。 IPConfigurationBgpPeeringAddress[]
peerWeight 添加到从此 BGP 扬声器中学习的路由的权重。 int

IPConfigurationBgpPeeringAddress

名字 描述 价值
customBgpIpAddresses 属于 IP 配置的自定义 BGP 对等互连地址的列表。 string[]
ipconfigurationId 属于网关的 IP 配置的 ID。 字符串

LocalNetworkGatewayPropertiesFormat

名字 描述 价值
bgpSettings 本地网络网关的 BGP 扬声器设置。 BgpSettings
fqdn 本地网关的 FQDN。 字符串
gatewayIpAddress 本地网络网关的 IP 地址。 字符串
localNetworkAddressSpace 本地网络站点地址空间。 AddressSpace

Microsoft.Network/localNetworkGateways

名字 描述 价值
位置 资源位置。 字符串
名字 资源名称 字符串

约束：
最小长度 = 1 （必需）
性能 本地网络网关的属性。 LocalNetworkGatewayPropertiesFormat （必需）
标签 资源标记 标记名称和值的字典。
类型 资源类型 “Microsoft.Network/localNetworkGateways@2023-11-01”

ResourceTags

名字 描述 价值