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

Microsoft.Network p2svpnGateways 2023-09-01

Bicep 资源定义

可以使用目标操作部署 p2svpnGateways 资源类型:

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

资源格式

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

resource symbolicname 'Microsoft.Network/p2svpnGateways@2023-09-01' = {
  location: 'string'
  name: 'string'
  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'
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

属性值

AddressSpace

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

Microsoft.Network/p2svpnGateways

名字 描述 价值
位置 资源位置。 字符串
名字 资源名称 string (必需)
性能 P2SVpnGateway 的属性。 P2SVpnGatewayProperties
标签 资源标记 标记名称和值的字典。 请参阅模板 中的 标记

P2SConnectionConfiguration

名字 描述 价值
id 资源 ID。 字符串
名字 资源组中唯一的资源的名称。 此名称可用于访问资源。 字符串
性能 P2S 连接配置的属性。 P2SConnectionConfigurationProperties

P2SConnectionConfigurationProperties

名字 描述 价值
enableInternetSecurity 指示是否为 P2S 连接打开启用 Internet 安全标志的标志。 bool
routingConfiguration 路由配置,指示此连接上关联的路由表和传播的路由表。 RoutingConfiguration
vpnClientAddressPool 对表示 P2S VpnClient 地址空间的地址空间资源的引用。 AddressSpace

P2SVpnGatewayProperties

名字 描述 价值
customDnsServers 所有客户指定的 DNS 服务器 IP 地址的列表。 string[]
isRoutingPreferenceInternet 为 P2SVpnGateway 的公共 IP 接口启用路由首选项属性。 bool
p2SConnectionConfigurations 网关的所有 p2s 连接配置的列表。 P2SConnectionConfiguration[]
virtualHub 网关所属的 VirtualHub。 SubResource
vpnGatewayScaleUnit 此 p2s vpn 网关的缩放单元。 int
vpnServerConfiguration p2sVpnGateway 附加到的 VpnServerConfiguration。 SubResource

PropagatedRouteTable

名字 描述 价值
ids 所有 RouteTable 的资源 ID 列表。 SubResource[]
标签 标签列表。 string[]

ResourceTags

名字 描述 价值

RoutingConfiguration

名字 描述 价值
associatedRouteTable 与此 RoutingConfiguration 关联的资源 ID RouteTable。 SubResource
inboundRouteMap 与此 RoutingConfiguration 关联的 RouteMap 的资源 ID,用于入站学习的路由。 SubResource
outboundRouteMap 与此 RoutingConfiguration 关联的RouteMap 的资源 ID,用于出站播发路由。 SubResource
propagatedRouteTables 要向其播发路由的 RouteTable 列表。 PropagatedRouteTable
vnetRoutes 控制从 VirtualHub 到虚拟网络连接的路由的路由列表。 VnetRoute

StaticRoute

名字 描述 价值
addressPrefixes 所有地址前缀的列表。 string[]
名字 在 VnetRoute 中唯一的 StaticRoute 的名称。 字符串
nextHopIpAddress 下一跃点的 IP 地址。 字符串

StaticRoutesConfig

名字 描述 价值
vnetLocalRouteOverrideCriteria 参数,用于确定辐射 vnet 中的 NVA 是否为辐射中具有目标的流量绕过。 “Contains”
“Equal”

SubResource

名字 描述 价值
id 资源 ID。 字符串

VnetRoute

名字 描述 价值
staticRoutes 所有静态路由的列表。 StaticRoute[]
staticRoutesConfig 此 HubVnetConnection 上的静态路由的配置。 StaticRoutesConfig

ARM 模板资源定义

可以使用目标操作部署 p2svpnGateways 资源类型:

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

资源格式

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

{
  "type": "Microsoft.Network/p2svpnGateways",
  "apiVersion": "2023-09-01",
  "name": "string",
  "location": "string",
  "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"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

属性值

AddressSpace

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

Microsoft.Network/p2svpnGateways

名字 描述 价值
apiVersion API 版本 '2023-09-01'
位置 资源位置。 字符串
名字 资源名称 string (必需)
性能 P2SVpnGateway 的属性。 P2SVpnGatewayProperties
标签 资源标记 标记名称和值的字典。 请参阅模板 中的 标记
类型 资源类型 “Microsoft.Network/p2svpnGateways”

P2SConnectionConfiguration

名字 描述 价值
id 资源 ID。 字符串
名字 资源组中唯一的资源的名称。 此名称可用于访问资源。 字符串
性能 P2S 连接配置的属性。 P2SConnectionConfigurationProperties

P2SConnectionConfigurationProperties

名字 描述 价值
enableInternetSecurity 指示是否为 P2S 连接打开启用 Internet 安全标志的标志。 bool
routingConfiguration 路由配置,指示此连接上关联的路由表和传播的路由表。 RoutingConfiguration
vpnClientAddressPool 对表示 P2S VpnClient 地址空间的地址空间资源的引用。 AddressSpace

P2SVpnGatewayProperties

名字 描述 价值
customDnsServers 所有客户指定的 DNS 服务器 IP 地址的列表。 string[]
isRoutingPreferenceInternet 为 P2SVpnGateway 的公共 IP 接口启用路由首选项属性。 bool
p2SConnectionConfigurations 网关的所有 p2s 连接配置的列表。 P2SConnectionConfiguration[]
virtualHub 网关所属的 VirtualHub。 SubResource
vpnGatewayScaleUnit 此 p2s vpn 网关的缩放单元。 int
vpnServerConfiguration p2sVpnGateway 附加到的 VpnServerConfiguration。 SubResource

PropagatedRouteTable

名字 描述 价值
ids 所有 RouteTable 的资源 ID 列表。 SubResource[]
标签 标签列表。 string[]

ResourceTags

名字 描述 价值

RoutingConfiguration

名字 描述 价值
associatedRouteTable 与此 RoutingConfiguration 关联的资源 ID RouteTable。 SubResource
inboundRouteMap 与此 RoutingConfiguration 关联的 RouteMap 的资源 ID,用于入站学习的路由。 SubResource
outboundRouteMap 与此 RoutingConfiguration 关联的RouteMap 的资源 ID,用于出站播发路由。 SubResource
propagatedRouteTables 要向其播发路由的 RouteTable 列表。 PropagatedRouteTable
vnetRoutes 控制从 VirtualHub 到虚拟网络连接的路由的路由列表。 VnetRoute

StaticRoute

名字 描述 价值
addressPrefixes 所有地址前缀的列表。 string[]
名字 在 VnetRoute 中唯一的 StaticRoute 的名称。 字符串
nextHopIpAddress 下一跃点的 IP 地址。 字符串

StaticRoutesConfig

名字 描述 价值
vnetLocalRouteOverrideCriteria 参数,用于确定辐射 vnet 中的 NVA 是否为辐射中具有目标的流量绕过。 “Contains”
“Equal”

SubResource

名字 描述 价值
id 资源 ID。 字符串

VnetRoute

名字 描述 价值
staticRoutes 所有静态路由的列表。 StaticRoute[]
staticRoutesConfig 此 HubVnetConnection 上的静态路由的配置。 StaticRoutesConfig

快速入门模板

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

模板 描述
Azure 虚拟 WAN (vWAN) 多中心部署

部署到 Azure
使用此模板可以创建 Azure 虚拟 WAN(vWAN)多中心部署,包括所有网关和 VNET 连接。
使用自定义路由表 Azure vWAN 多中心部署

部署到 Azure
使用此模板可以创建 Azure 虚拟 WAN(vWAN)多中心部署,包括所有网关和 VNET 连接,并演示路由表用于自定义路由的用法。
使用多地址池和用户组 vWAN P2S 部署

部署到 Azure
此模板部署具有配置多个地址池和用户组的 P2S 的 Azure 虚拟 WAN (vWAN)

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

可以使用目标操作部署 p2svpnGateways 资源类型:

  • 资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/p2svpnGateways@2023-09-01"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  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"
      }
    }
  })
}

属性值

AddressSpace

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

Microsoft.Network/p2svpnGateways

名字 描述 价值
位置 资源位置。 字符串
名字 资源名称 string (必需)
性能 P2SVpnGateway 的属性。 P2SVpnGatewayProperties
标签 资源标记 标记名称和值的字典。
类型 资源类型 “Microsoft.Network/p2svpnGateways@2023-09-01”

P2SConnectionConfiguration

名字 描述 价值
id 资源 ID。 字符串
名字 资源组中唯一的资源的名称。 此名称可用于访问资源。 字符串
性能 P2S 连接配置的属性。 P2SConnectionConfigurationProperties

P2SConnectionConfigurationProperties

名字 描述 价值
enableInternetSecurity 指示是否为 P2S 连接打开启用 Internet 安全标志的标志。 bool
routingConfiguration 路由配置,指示此连接上关联的路由表和传播的路由表。 RoutingConfiguration
vpnClientAddressPool 对表示 P2S VpnClient 地址空间的地址空间资源的引用。 AddressSpace

P2SVpnGatewayProperties

名字 描述 价值
customDnsServers 所有客户指定的 DNS 服务器 IP 地址的列表。 string[]
isRoutingPreferenceInternet 为 P2SVpnGateway 的公共 IP 接口启用路由首选项属性。 bool
p2SConnectionConfigurations 网关的所有 p2s 连接配置的列表。 P2SConnectionConfiguration[]
virtualHub 网关所属的 VirtualHub。 SubResource
vpnGatewayScaleUnit 此 p2s vpn 网关的缩放单元。 int
vpnServerConfiguration p2sVpnGateway 附加到的 VpnServerConfiguration。 SubResource

PropagatedRouteTable

名字 描述 价值
ids 所有 RouteTable 的资源 ID 列表。 SubResource[]
标签 标签列表。 string[]

ResourceTags

名字 描述 价值

RoutingConfiguration

名字 描述 价值
associatedRouteTable 与此 RoutingConfiguration 关联的资源 ID RouteTable。 SubResource
inboundRouteMap 与此 RoutingConfiguration 关联的 RouteMap 的资源 ID,用于入站学习的路由。 SubResource
outboundRouteMap 与此 RoutingConfiguration 关联的RouteMap 的资源 ID,用于出站播发路由。 SubResource
propagatedRouteTables 要向其播发路由的 RouteTable 列表。 PropagatedRouteTable
vnetRoutes 控制从 VirtualHub 到虚拟网络连接的路由的路由列表。 VnetRoute

StaticRoute

名字 描述 价值
addressPrefixes 所有地址前缀的列表。 string[]
名字 在 VnetRoute 中唯一的 StaticRoute 的名称。 字符串
nextHopIpAddress 下一跃点的 IP 地址。 字符串

StaticRoutesConfig

名字 描述 价值
vnetLocalRouteOverrideCriteria 参数,用于确定辐射 vnet 中的 NVA 是否为辐射中具有目标的流量绕过。 “Contains”
“Equal”

SubResource

名字 描述 价值
id 资源 ID。 字符串

VnetRoute

名字 描述 价值
staticRoutes 所有静态路由的列表。 StaticRoute[]
staticRoutesConfig 此 HubVnetConnection 上的静态路由的配置。 StaticRoutesConfig