Share via


Microsoft.Network p2svpnGateways 2023-04-01

Bicep 資源定義

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

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

資源格式

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

resource symbolicname 'Microsoft.Network/p2svpnGateways@2023-04-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    customDnsServers: [
      'string'
    ]
    isRoutingPreferenceInternet: bool
    p2SConnectionConfigurations: [
      {
        id: 'string'
        name: 'string'
        properties: {
          enableInternetSecurity: bool
          routingConfiguration: {
            associatedRouteTable: {
              id: 'string'
            }
            inboundRouteMap: {
              id: 'string'
            }
            outboundRouteMap: {
              id: 'string'
            }
            propagatedRouteTables: {
              ids: [
                {
                  id: 'string'
                }
              ]
              labels: [
                'string'
              ]
            }
            vnetRoutes: {
              staticRoutes: [
                {
                  addressPrefixes: [
                    'string'
                  ]
                  name: 'string'
                  nextHopIpAddress: 'string'
                }
              ]
              staticRoutesConfig: {
                vnetLocalRouteOverrideCriteria: 'string'
              }
            }
          }
          vpnClientAddressPool: {
            addressPrefixes: [
              'string'
            ]
          }
        }
      }
    ]
    virtualHub: {
      id: 'string'
    }
    vpnGatewayScaleUnit: int
    vpnServerConfiguration: {
      id: 'string'
    }
  }
}

屬性值

p2svpnGateways

名稱 描述
NAME 資源名稱 字串 (必要)
location 資源位置。 字串
tags 資源標籤。 標記名稱和值的字典。 請參閱 範本中的標記
properties P2SVpnGateway 的屬性。 P2SVpnGatewayProperties

P2SVpnGatewayProperties

名稱 描述
customDnsServers 所有客戶指定的 DNS 伺服器 IP 位址清單。 string[]
isRoutingPreferenceInternet 為 P2SVpnGateway 的公用 IP 介面啟用路由喜好設定屬性。 bool
p2SConnectionConfigurations 閘道的所有 p2s 聯機組態清單。 P2SConnectionConfiguration[]
virtualHub 網關所屬的 VirtualHub。 SubResource
vpnGatewayScaleUnit 此 p2s vpn 閘道的縮放單位。 int
vpnServerConfiguration p2sVpnGateway 所連結的 VpnServerConfiguration。 SubResource

P2SConnectionConfiguration

名稱 描述
id 資源識別碼。 字串
NAME 資源群組內唯一的資源名稱。 此名稱可用來存取資源。 字串
properties P2S 聯機組態的屬性。 P2SConnectionConfigurationProperties

P2SConnectionConfigurationProperties

名稱 描述
enableInternetSecurity 旗標,指出是否針對 P2S Connections 開啟啟用因特網安全性旗標。 bool
routingConfiguration 路由組態,指出此聯機上相關聯的和傳播的路由表。 RoutingConfiguration
vpnClientAddressPool 地址空間資源的參考,代表 P2S VpnClient 的地址空間。 AddressSpace

RoutingConfiguration

名稱 描述
associatedRouteTable 與此 RoutingConfiguration 相關聯的資源標識碼 RouteTable。 SubResource
inboundRouteMap 針對輸入學習的路由,與這個 RoutingConfiguration 相關聯的 RouteMap 資源識別符。 SubResource
outboundRouteMap 與這個 RoutingConfiguration 相關聯的RouteMap 資源標識碼,用於輸出公告的路由。 SubResource
propagatedRouteTables 要公告路由的 RouteTable 列表。 PropagatedRouteTable
vnetRoutes 控制從 VirtualHub 到虛擬網路連線路由的路由清單。 VnetRoute

SubResource

名稱 描述
id 資源識別碼。 字串

PropagatedRouteTable

名稱 描述
ids 所有 RouteTable 的資源標識符清單。 SubResource[]
標籤 標籤清單。 string[]

VnetRoute

名稱 描述
staticRoutes 所有靜態路由的清單。 StaticRoute[]
staticRoutesConfig 此 HubVnetConnection 上的靜態路由設定。 StaticRoutesConfig

StaticRoute

名稱 描述
addressPrefixes 所有地址前綴的清單。 string[]
NAME VnetRoute 內唯一的 StaticRoute 名稱。 字串
nextHopIpAddress 下一個躍點的IP位址。 字串

StaticRoutesConfig

名稱 描述
vnetLocalRouteOverrideCriteria 判斷輪輻 vnet 中 NVA 是否略過輪輻中具有目的地之流量的參數。 'Contains'
'Equal'

AddressSpace

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

快速入門範本

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

範本 描述
Azure Virtual WAN (vWAN) 多中樞部署

部署至 Azure
此範本可讓您建立 Azure Virtual WAN (vWAN) 多中樞部署,包括所有閘道和 VNET 連線。
Azure vWAN 多中樞部署與自定義路由表

部署至 Azure
此範本可讓您建立 Azure Virtual WAN (vWAN) 多中樞部署,包括所有網關和 VNET 連線,並示範路由表用於自定義路由的使用方式。

ARM 範本資源定義

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

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

資源格式

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

{
  "type": "Microsoft.Network/p2svpnGateways",
  "apiVersion": "2023-04-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "customDnsServers": [ "string" ],
    "isRoutingPreferenceInternet": "bool",
    "p2SConnectionConfigurations": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "enableInternetSecurity": "bool",
          "routingConfiguration": {
            "associatedRouteTable": {
              "id": "string"
            },
            "inboundRouteMap": {
              "id": "string"
            },
            "outboundRouteMap": {
              "id": "string"
            },
            "propagatedRouteTables": {
              "ids": [
                {
                  "id": "string"
                }
              ],
              "labels": [ "string" ]
            },
            "vnetRoutes": {
              "staticRoutes": [
                {
                  "addressPrefixes": [ "string" ],
                  "name": "string",
                  "nextHopIpAddress": "string"
                }
              ],
              "staticRoutesConfig": {
                "vnetLocalRouteOverrideCriteria": "string"
              }
            }
          },
          "vpnClientAddressPool": {
            "addressPrefixes": [ "string" ]
          }
        }
      }
    ],
    "virtualHub": {
      "id": "string"
    },
    "vpnGatewayScaleUnit": "int",
    "vpnServerConfiguration": {
      "id": "string"
    }
  }
}

屬性值

p2svpnGateways

名稱 描述
類型 資源類型 'Microsoft.Network/p2svpnGateways'
apiVersion 資源 API 版本 '2023-04-01'
NAME 資源名稱 需要字串 ()
location 資源位置。 字串
tags 資源標籤。 標記名稱和值的字典。 請參閱 範本中的標籤
properties P2SVpnGateway 的屬性。 P2SVpnGatewayProperties

P2SVpnGatewayProperties

名稱 描述
customDnsServers 所有客戶指定的 DNS 伺服器 IP 位址清單。 string[]
isRoutingPreferenceInternet 為 P2SVpnGateway 的公用 IP 介面啟用路由喜好設定屬性。 bool
p2SConnectionConfigurations 閘道的所有 p2s 聯機組態清單。 P2SConnectionConfiguration[]
virtualHub 網關所屬的 VirtualHub。 SubResource
vpnGatewayScaleUnit 此 p2s vpn 閘道的縮放單位。 int
vpnServerConfiguration p2sVpnGateway 所連結的 VpnServerConfiguration。 SubResource

P2SConnectionConfiguration

名稱 描述
id 資源識別碼。 字串
NAME 資源群組內唯一的資源名稱。 此名稱可用來存取資源。 字串
properties P2S 聯機組態的屬性。 P2SConnectionConfigurationProperties

P2SConnectionConfigurationProperties

名稱 描述
enableInternetSecurity 旗標,指出是否針對 P2S Connections 開啟啟用因特網安全性旗標。 bool
routingConfiguration 路由組態,指出此聯機上相關聯的和傳播的路由表。 RoutingConfiguration
vpnClientAddressPool 地址空間資源的參考,代表 P2S VpnClient 的地址空間。 AddressSpace

RoutingConfiguration

名稱 描述
associatedRouteTable 與此 RoutingConfiguration 相關聯的資源標識碼 RouteTable。 SubResource
inboundRouteMap 針對輸入學習的路由,與這個 RoutingConfiguration 相關聯的 RouteMap 資源識別符。 SubResource
outboundRouteMap 與這個 RoutingConfiguration 相關聯的RouteMap 資源標識碼,用於輸出公告的路由。 SubResource
propagatedRouteTables 要公告路由的 RouteTable 列表。 PropagatedRouteTable
vnetRoutes 控制從 VirtualHub 到虛擬網路連線路由的路由清單。 VnetRoute

SubResource

名稱 描述
id 資源識別碼。 字串

PropagatedRouteTable

名稱 描述
ids 所有 RouteTable 的資源標識符清單。 SubResource[]
標籤 標籤清單。 string[]

VnetRoute

名稱 描述
staticRoutes 所有靜態路由的清單。 StaticRoute[]
staticRoutesConfig 此 HubVnetConnection 上的靜態路由設定。 StaticRoutesConfig

StaticRoute

名稱 描述
addressPrefixes 所有位址前置詞的清單。 string[]
NAME VnetRoute 內唯一的 StaticRoute 名稱。 字串
nextHopIpAddress 下一個躍點的IP位址。 字串

StaticRoutesConfig

名稱 描述
vnetLocalRouteOverrideCriteria 判斷輪輻 vnet 中 NVA 是否略過具有輪輻目的地之流量的參數。 'Contains'
'Equal'

AddressSpace

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

快速入門範本

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

範本 描述
Azure Virtual WAN (vWAN) 多中樞部署

部署至 Azure
此範本可讓您建立 Azure Virtual WAN (vWAN) 多中樞部署,包括所有閘道和 VNET 連線。
Azure vWAN 多中樞部署與自定義路由表

部署至 Azure
此範本可讓您建立 Azure Virtual WAN (vWAN) 多中樞部署,包括所有網關和 VNET 連線,並示範路由表用於自定義路由的使用方式。

Terraform (AzAPI 提供者) 資源定義

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

  • 資源群組

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

資源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/p2svpnGateways@2023-04-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      customDnsServers = [
        "string"
      ]
      isRoutingPreferenceInternet = bool
      p2SConnectionConfigurations = [
        {
          id = "string"
          name = "string"
          properties = {
            enableInternetSecurity = bool
            routingConfiguration = {
              associatedRouteTable = {
                id = "string"
              }
              inboundRouteMap = {
                id = "string"
              }
              outboundRouteMap = {
                id = "string"
              }
              propagatedRouteTables = {
                ids = [
                  {
                    id = "string"
                  }
                ]
                labels = [
                  "string"
                ]
              }
              vnetRoutes = {
                staticRoutes = [
                  {
                    addressPrefixes = [
                      "string"
                    ]
                    name = "string"
                    nextHopIpAddress = "string"
                  }
                ]
                staticRoutesConfig = {
                  vnetLocalRouteOverrideCriteria = "string"
                }
              }
            }
            vpnClientAddressPool = {
              addressPrefixes = [
                "string"
              ]
            }
          }
        }
      ]
      virtualHub = {
        id = "string"
      }
      vpnGatewayScaleUnit = int
      vpnServerConfiguration = {
        id = "string"
      }
    }
  })
}

屬性值

p2svpnGateways

名稱 描述
類型 資源類型 “Microsoft.Network/p2svpnGateways@2023-04-01”
NAME 資源名稱 字串 (必要)
location 資源位置。 字串
parent_id 若要部署至資源群組,請使用該資源群組的標識碼。 字串 (必要)
tags 資源標籤。 標記名稱和值的字典。
properties P2SVpnGateway 的屬性。 P2SVpnGatewayProperties

P2SVpnGatewayProperties

名稱 描述
customDnsServers 所有客戶指定的 DNS 伺服器 IP 位址清單。 string[]
isRoutingPreferenceInternet 為 P2SVpnGateway 的公用 IP 介面啟用路由喜好設定屬性。 bool
p2SConnectionConfigurations 閘道的所有 p2s 聯機組態清單。 P2SConnectionConfiguration[]
virtualHub 網關所屬的 VirtualHub。 SubResource
vpnGatewayScaleUnit 此 p2s vpn 閘道的縮放單位。 int
vpnServerConfiguration p2sVpnGateway 所連結的 VpnServerConfiguration。 SubResource

P2SConnectionConfiguration

名稱 描述
id 資源識別碼。 字串
NAME 資源群組內唯一的資源名稱。 此名稱可用來存取資源。 字串
properties P2S 聯機組態的屬性。 P2SConnectionConfigurationProperties

P2SConnectionConfigurationProperties

名稱 描述
enableInternetSecurity 旗標,指出是否開啟 P2S Connections 啟用因特網安全性旗標。 bool
routingConfiguration 路由組態,指出此聯機上相關聯的和傳播的路由表。 RoutingConfiguration
vpnClientAddressPool 地址空間資源的參考,代表 P2S VpnClient 的地址空間。 AddressSpace

RoutingConfiguration

名稱 描述
associatedRouteTable 與此 RoutingConfiguration 相關聯的資源標識碼 RouteTable。 SubResource
inboundRouteMap 針對輸入學習的路由,與這個 RoutingConfiguration 相關聯的 RouteMap 資源識別符。 SubResource
outboundRouteMap 與這個 RoutingConfiguration 相關聯的RouteMap 資源標識碼,用於輸出公告的路由。 SubResource
propagatedRouteTables 要公告路由的 RouteTable 列表。 PropagatedRouteTable
vnetRoutes 控制從 VirtualHub 到虛擬網路連線路由的路由清單。 VnetRoute

SubResource

名稱 描述
id 資源識別碼。 字串

PropagatedRouteTable

名稱 描述
ids 所有 RouteTable 的資源標識符清單。 SubResource[]
標籤 標籤清單。 string[]

VnetRoute

名稱 描述
staticRoutes 所有靜態路由的清單。 StaticRoute[]
staticRoutesConfig 此 HubVnetConnection 上的靜態路由設定。 StaticRoutesConfig

StaticRoute

名稱 描述
addressPrefixes 所有地址前綴的清單。 string[]
NAME VnetRoute 內唯一的 StaticRoute 名稱。 字串
nextHopIpAddress 下一個躍點的IP位址。 字串

StaticRoutesConfig

名稱 描述
vnetLocalRouteOverrideCriteria 判斷輪輻 vnet 中 NVA 是否略過輪輻中具有目的地之流量的參數。 “Contains”
“Equal”

AddressSpace

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