Share via


Microsoft.Network localNetworkGateways 2021-02-01

Bicep 資源定義

localNetworkGateways 資源類型可以使用目標作業進行部署:

如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.Network/localNetworkGateways 資源,請將下列 Bicep 新增至您的範本。

resource symbolicname 'Microsoft.Network/localNetworkGateways@2021-02-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    bgpSettings: {
      asn: int
      bgpPeeringAddress: 'string'
      bgpPeeringAddresses: [
        {
          customBgpIpAddresses: [
            'string'
          ]
          ipconfigurationId: 'string'
        }
      ]
      peerWeight: int
    }
    fqdn: 'string'
    gatewayIpAddress: 'string'
    localNetworkAddressSpace: {
      addressPrefixes: [
        'string'
      ]
    }
  }
}

屬性值

localNetworkGateways

名稱 描述
NAME 資源名稱 需要字串 ()

字元限制:1-80

合法字元:
英數字元、底線、句號和連字號。

以英數字元開頭。 以英數字元或底線結尾。
location 資源位置。 字串
tags 資源標籤。 標記名稱和值的字典。 請參閱 範本中的標籤
properties 局域網路閘道的屬性。 LocalNetworkGatewayPropertiesFormat (必要)

LocalNetworkGatewayPropertiesFormat

名稱 描述
bgpSettings 局域網路閘道的 BGP 喇叭設定。 BgpSettings
fqdn 局域網路閘道的 FQDN。 字串
gatewayIpAddress 局域網路閘道的IP位址。 字串
localNetworkAddressSpace 局域網路月臺位址空間。 AddressSpace

BgpSettings

名稱 描述
asn BGP 喇叭的 ASN。 int

約束:
最小值 = 0
最大值 = 4294967295
bgpPeeringAddress 此 BGP 說話者的 BGP 對等互連位址和 BGP 識別碼。 字串
bgpPeeringAddresses 具有虛擬網路閘道IP組態標識碼的 BGP 對等互連位址。 IPConfigurationBgpPeeringAddress[]
peerWeight 新增至從此 BGP 喇叭學習路由的權數。 int

IPConfigurationBgpPeeringAddress

名稱 描述
customBgpIpAddresses 屬於IP組態的自訂BGP對等互連位址清單。 string[]
ipconfigurationId 屬於閘道的IP組態標識碼。 字串

AddressSpace

名稱 描述
addressPrefixes 以 CIDR 表示法保留給此虛擬網路的位址區塊清單。 string[]

快速入門範本

下列快速入門範本會部署此資源類型。

範本 描述
Create 具有兩個子網、局域網路和閘道的 VNet

部署至 Azure
此範本會建立 VNet、2 個子網和閘道
使用 VM Create 站對站 VPN 連線

部署至 Azure
此範本可讓您使用 虛擬網路 閘道建立站對站 VPN 連線
Create 站對站 VPN 連線

部署至 Azure
此範本可讓您使用 虛擬網路 閘道建立站對站 VPN 連線
具有主動-主動 VPN 閘道與 BGP 的站對站 VPN

部署至 Azure
此範本可讓您在具有 VPN 閘道的兩個 VNet 之間部署站對站 VPN,並使用 BGP 設定主動-主動。 每個 Azure VPN 閘道 都會解析遠端對等的 FQDN,以判斷遠端 VPN 閘道 的公用 IP。 範本會在具有可用性區域的 Azure 區域中如預期般執行。

ARM 範本資源定義

localNetworkGateways 資源類型可以使用目標作業進行部署:

如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.Network/localNetworkGateways 資源,請將下列 JSON 新增至範本。

{
  "type": "Microsoft.Network/localNetworkGateways",
  "apiVersion": "2021-02-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "bgpSettings": {
      "asn": "int",
      "bgpPeeringAddress": "string",
      "bgpPeeringAddresses": [
        {
          "customBgpIpAddresses": [ "string" ],
          "ipconfigurationId": "string"
        }
      ],
      "peerWeight": "int"
    },
    "fqdn": "string",
    "gatewayIpAddress": "string",
    "localNetworkAddressSpace": {
      "addressPrefixes": [ "string" ]
    }
  }
}

屬性值

localNetworkGateways

名稱 描述
類型 資源類型 'Microsoft.Network/localNetworkGateways'
apiVersion 資源 API 版本 '2021-02-01'
NAME 資源名稱 需要字串 ()

字元限制:1-80

合法字元:
英數字元、底線、句號和連字號。

以英數字元開頭。 以英數字元或底線結尾。
location 資源位置。 字串
tags 資源標籤。 標記名稱和值的字典。 請參閱 範本中的標籤
properties 局域網路閘道的屬性。 LocalNetworkGatewayPropertiesFormat (必要)

LocalNetworkGatewayPropertiesFormat

名稱 描述
bgpSettings 局域網路閘道的 BGP 喇叭設定。 BgpSettings
fqdn 局域網路閘道的 FQDN。 字串
gatewayIpAddress 局域網路閘道的IP位址。 字串
localNetworkAddressSpace 局域網路月臺位址空間。 AddressSpace

BgpSettings

名稱 描述
asn BGP 喇叭的 ASN。 int

約束:
最小值 = 0
最大值 = 4294967295
bgpPeeringAddress 此 BGP 說話者的 BGP 對等互連位址和 BGP 識別碼。 字串
bgpPeeringAddresses 具有虛擬網路閘道IP組態標識碼的 BGP 對等互連位址。 IPConfigurationBgpPeeringAddress[]
peerWeight 新增至從此 BGP 喇叭學習路由的權數。 int

IPConfigurationBgpPeeringAddress

名稱 描述
customBgpIpAddresses 屬於IP組態的自訂BGP對等互連位址清單。 string[]
ipconfigurationId 屬於閘道的IP組態標識碼。 字串

AddressSpace

名稱 描述
addressPrefixes 以 CIDR 表示法保留給此虛擬網路的位址區塊清單。 string[]

快速入門範本

下列快速入門範本會部署此資源類型。

範本 描述
Create 具有兩個子網、局域網路和閘道的 VNet

部署至 Azure
此範本會建立 VNet、2 個子網和閘道
使用 VM Create 站對站 VPN 連線

部署至 Azure
此範本可讓您使用 虛擬網路 閘道建立站對站 VPN 連線
Create 站對站 VPN 連線

部署至 Azure
此範本可讓您使用 虛擬網路 閘道建立站對站 VPN 連線
具有主動-主動 VPN 閘道與 BGP 的站對站 VPN

部署至 Azure
此範本可讓您在具有 VPN 閘道的兩個 VNet 之間部署站對站 VPN,並使用 BGP 設定主動-主動。 每個 Azure VPN 閘道 都會解析遠端對等的 FQDN,以判斷遠端 VPN 閘道 的公用 IP。 範本會在具有可用性區域的 Azure 區域中如預期般執行。

Terraform (AzAPI 提供者) 資源定義

localNetworkGateways 資源類型可以使用目標作業進行部署:

  • 資源群組

如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.Network/localNetworkGateways 資源,請將下列 Terraform 新增至範本。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/localNetworkGateways@2021-02-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      bgpSettings = {
        asn = int
        bgpPeeringAddress = "string"
        bgpPeeringAddresses = [
          {
            customBgpIpAddresses = [
              "string"
            ]
            ipconfigurationId = "string"
          }
        ]
        peerWeight = int
      }
      fqdn = "string"
      gatewayIpAddress = "string"
      localNetworkAddressSpace = {
        addressPrefixes = [
          "string"
        ]
      }
    }
  })
}

屬性值

localNetworkGateways

名稱 描述
類型 資源類型 “Microsoft.Network/localNetworkGateways@2021-02-01”
NAME 資源名稱 需要字串 ()

字元限制:1-80

合法字元:
英數字元、底線、句號和連字號。

以英數字元開頭。 以英數字元或底線結尾。
location 資源位置。 字串
parent_id 若要部署至資源群組,請使用該資源群組的標識碼。 需要字串 ()
tags 資源標籤。 標記名稱和值的字典。
properties 局域網路閘道的屬性。 LocalNetworkGatewayPropertiesFormat (必要)

LocalNetworkGatewayPropertiesFormat

名稱 描述
bgpSettings 局域網路閘道的 BGP 喇叭設定。 BgpSettings
fqdn 局域網路閘道的 FQDN。 字串
gatewayIpAddress 局域網路閘道的IP位址。 字串
localNetworkAddressSpace 局域網路月臺位址空間。 AddressSpace

BgpSettings

名稱 描述
asn BGP 喇叭的 ASN。 int

約束:
最小值 = 0
最大值 = 4294967295
bgpPeeringAddress 此 BGP 說話者的 BGP 對等互連位址和 BGP 識別碼。 字串
bgpPeeringAddresses 具有虛擬網路閘道IP組態標識碼的 BGP 對等互連位址。 IPConfigurationBgpPeeringAddress[]
peerWeight 新增至從此 BGP 喇叭學習路由的權數。 int

IPConfigurationBgpPeeringAddress

名稱 描述
customBgpIpAddresses 屬於IP組態的自訂BGP對等互連位址清單。 string[]
ipconfigurationId 屬於閘道的IP組態標識碼。 字串

AddressSpace

名稱 描述
addressPrefixes 以 CIDR 表示法保留給此虛擬網路的位址區塊清單。 string[]