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

Microsoft.Network vpnGateways/vpnConnections 2019-06-01

• 最新
• 2024-05-01
• 2024-03-01
• 2024-01-01
• 2023-11-01
• 2023-09-01
• 2023-06-01
• 2023-05-01
• 2023-04-01
• 2023-02-01
• 2022-11-01
• 2022-09-01
• 2022-07-01
• 2022-05-01
• 2022-01-01
• 2021-08-01
• 2021-05-01
• 2021-03-01
• 2021-02-01
• 2020-11-01
• 2020-08-01
• 2020-07-01
• 2020-06-01
• 2020-05-01
• 2020-04-01
• 2020-03-01
• 2019-12-01
• 2019-11-01
• 2019-09-01
• 2019-08-01
• 2019-07-01
• 2019-06-01
• 2019-04-01
• 2019-02-01
• 2018-12-01
• 2018-11-01
• 2018-10-01
• 2018-08-01
• 2018-07-01
• 2018-06-01
• 2018-04-01

Bicep 资源定义

可以使用目标操作部署 vpnGateways/vpnConnections 资源类型：

• 资源组 - 请参阅 资源组部署命令

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

资源格式

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

resource symbolicname 'Microsoft.Network/vpnGateways/vpnConnections@2019-06-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    connectionBandwidth: int
    enableBgp: bool
    enableInternetSecurity: bool
    enableRateLimiting: bool
    ipsecPolicies: [
      {
        dhGroup: 'string'
        ikeEncryption: 'string'
        ikeIntegrity: 'string'
        ipsecEncryption: 'string'
        ipsecIntegrity: 'string'
        pfsGroup: 'string'
        saDataSizeKilobytes: int
        saLifeTimeSeconds: int
      }
    ]
    remoteVpnSite: {
      id: 'string'
    }
    routingWeight: int
    sharedKey: 'string'
    useLocalAzureIpAddress: bool
    usePolicyBasedTrafficSelectors: bool
    vpnConnectionProtocolType: 'string'
    vpnLinkConnections: [
      {
        id: 'string'
        name: 'string'
        properties: {
          connectionBandwidth: int
          enableBgp: bool
          enableRateLimiting: bool
          ipsecPolicies: [
            {
              dhGroup: 'string'
              ikeEncryption: 'string'
              ikeIntegrity: 'string'
              ipsecEncryption: 'string'
              ipsecIntegrity: 'string'
              pfsGroup: 'string'
              saDataSizeKilobytes: int
              saLifeTimeSeconds: int
            }
          ]
          routingWeight: int
          sharedKey: 'string'
          useLocalAzureIpAddress: bool
          usePolicyBasedTrafficSelectors: bool
          vpnConnectionProtocolType: 'string'
          vpnSiteLink: {
            id: 'string'
          }
        }
      }
    ]
  }
}

属性值

IpsecPolicy

名字	描述	价值
dhGroup	IKE 阶段 1 中用于初始 SA 的 DH 组。	“DHGroup1” “DHGroup14” “DHGroup2” “DHGroup2048” “DHGroup24” “ECP256” “ECP384” “无”（必需）
ikeEncryption	IKE 加密算法（IKE 阶段 2）。	“AES128” “AES192” “AES256” “DES” “DES3” “GCMAES128” “GCMAES256”（必需）
ikeIntegrity	IKE 完整性算法（IKE 阶段 2）。	“GCMAES128” “GCMAES256” “MD5” “SHA1” “SHA256” “SHA384”（必需）
ipsecEncryption	IPSec 加密算法（IKE 阶段 1）。	“AES128” “AES192” “AES256” “DES” “DES3” “GCMAES128” “GCMAES192” “GCMAES256” “无”（必需）
ipsecIntegrity	IPSec 完整性算法（IKE 阶段 1）。	“GCMAES128” “GCMAES192” “GCMAES256” “MD5” “SHA1” “SHA256”（必需）
pfsGroup	IKE 阶段 2 中使用的 Pfs 组用于新的子 SA。	“ECP256” “ECP384” “None” “PFS1” “PFS14” “PFS2” “PFS2048” “PFS24” “PFSMM”（必需）
saDataSizeKilobytes	IPSec 安全关联（也称为快速模式或阶段 2 SA）有效负载大小（以 KB 为单位），用于站点到站点 VPN 隧道。	int （必需）
saLifeTimeSeconds	站点到站点 VPN 隧道的 IPSec 安全关联（也称为快速模式或阶段 2 SA）生存期（以秒为单位）。	int （必需）

Microsoft.Network/vpnGateways/vpnConnections

名字	描述	价值
名字	资源名称	string （必需）
父母	在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。 有关详细信息，请参阅 父资源外部的子资源。	类型资源的符号名称：vpnGateways
性能	VPN 连接的属性。	VpnConnectionProperties

SubResource

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

VpnConnectionProperties

名字	描述	价值
connectionBandwidth	预期带宽（以 MBPS 为单位）。	int
enableBgp	EnableBgp 标志。	bool
enableInternetSecurity	启用 Internet 安全性。	bool
enableRateLimiting	EnableBgp 标志。	bool
ipsecPolicies	此连接要考虑的 IPSec 策略。	IpsecPolicy[]
remoteVpnSite	连接的 VPN 站点的 ID。	SubResource
routingWeight	VPN 连接的路由权重。	int
sharedKey	用于 VPN 连接的 SharedKey。	字符串
useLocalAzureIpAddress	使用本地 Azure IP 启动连接。	bool
usePolicyBasedTrafficSelectors	启用基于策略的流量选择器。	bool
vpnConnectionProtocolType	用于此连接的连接协议。	“IKEv1” “IKEv2”
vpnLinkConnections	指向网关的所有 VPN 站点链接连接的列表。	VpnSiteLinkConnection[]

VpnSiteLinkConnection

名字	描述	价值
id	资源 ID。	字符串
名字	资源组中唯一的资源的名称。 此名称可用于访问资源。	字符串
性能	VPN 站点链接连接的属性。	VpnSiteLinkConnectionProperties

VpnSiteLinkConnectionProperties

名字	描述	价值
connectionBandwidth	预期带宽（以 MBPS 为单位）。	int
enableBgp	EnableBgp 标志。	bool
enableRateLimiting	EnableBgp 标志。	bool
ipsecPolicies	此连接要考虑的 IPSec 策略。	IpsecPolicy[]
routingWeight	VPN 连接的路由权重。	int
sharedKey	用于 VPN 连接的 SharedKey。	字符串
useLocalAzureIpAddress	使用本地 Azure IP 启动连接。	bool
usePolicyBasedTrafficSelectors	启用基于策略的流量选择器。	bool
vpnConnectionProtocolType	用于此连接的连接协议。	“IKEv1” “IKEv2”
vpnSiteLink	连接的 VPN 站点链接的 ID。	SubResource

ARM 模板资源定义

可以使用目标操作部署 vpnGateways/vpnConnections 资源类型：

• 资源组 - 请参阅 资源组部署命令

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

资源格式

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

{
  "type": "Microsoft.Network/vpnGateways/vpnConnections",
  "apiVersion": "2019-06-01",
  "name": "string",
  "properties": {
    "connectionBandwidth": "int",
    "enableBgp": "bool",
    "enableInternetSecurity": "bool",
    "enableRateLimiting": "bool",
    "ipsecPolicies": [
      {
        "dhGroup": "string",
        "ikeEncryption": "string",
        "ikeIntegrity": "string",
        "ipsecEncryption": "string",
        "ipsecIntegrity": "string",
        "pfsGroup": "string",
        "saDataSizeKilobytes": "int",
        "saLifeTimeSeconds": "int"
      }
    ],
    "remoteVpnSite": {
      "id": "string"
    },
    "routingWeight": "int",
    "sharedKey": "string",
    "useLocalAzureIpAddress": "bool",
    "usePolicyBasedTrafficSelectors": "bool",
    "vpnConnectionProtocolType": "string",
    "vpnLinkConnections": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "connectionBandwidth": "int",
          "enableBgp": "bool",
          "enableRateLimiting": "bool",
          "ipsecPolicies": [
            {
              "dhGroup": "string",
              "ikeEncryption": "string",
              "ikeIntegrity": "string",
              "ipsecEncryption": "string",
              "ipsecIntegrity": "string",
              "pfsGroup": "string",
              "saDataSizeKilobytes": "int",
              "saLifeTimeSeconds": "int"
            }
          ],
          "routingWeight": "int",
          "sharedKey": "string",
          "useLocalAzureIpAddress": "bool",
          "usePolicyBasedTrafficSelectors": "bool",
          "vpnConnectionProtocolType": "string",
          "vpnSiteLink": {
            "id": "string"
          }
        }
      }
    ]
  }
}

属性值

IpsecPolicy

名字	描述	价值
dhGroup	IKE 阶段 1 中用于初始 SA 的 DH 组。	“DHGroup1” “DHGroup14” “DHGroup2” “DHGroup2048” “DHGroup24” “ECP256” “ECP384” “无”（必需）
ikeEncryption	IKE 加密算法（IKE 阶段 2）。	“AES128” “AES192” “AES256” “DES” “DES3” “GCMAES128” “GCMAES256”（必需）
ikeIntegrity	IKE 完整性算法（IKE 阶段 2）。	“GCMAES128” “GCMAES256” “MD5” “SHA1” “SHA256” “SHA384”（必需）
ipsecEncryption	IPSec 加密算法（IKE 阶段 1）。	“AES128” “AES192” “AES256” “DES” “DES3” “GCMAES128” “GCMAES192” “GCMAES256” “无”（必需）
ipsecIntegrity	IPSec 完整性算法（IKE 阶段 1）。	“GCMAES128” “GCMAES192” “GCMAES256” “MD5” “SHA1” “SHA256”（必需）
pfsGroup	IKE 阶段 2 中使用的 Pfs 组用于新的子 SA。	“ECP256” “ECP384” “None” “PFS1” “PFS14” “PFS2” “PFS2048” “PFS24” “PFSMM”（必需）
saDataSizeKilobytes	IPSec 安全关联（也称为快速模式或阶段 2 SA）有效负载大小（以 KB 为单位），用于站点到站点 VPN 隧道。	int （必需）
saLifeTimeSeconds	站点到站点 VPN 隧道的 IPSec 安全关联（也称为快速模式或阶段 2 SA）生存期（以秒为单位）。	int （必需）

Microsoft.Network/vpnGateways/vpnConnections

名字	描述	价值
apiVersion	API 版本	'2019-06-01'
名字	资源名称	string （必需）
性能	VPN 连接的属性。	VpnConnectionProperties
类型	资源类型	“Microsoft.Network/vpnGateways/vpnConnections”

SubResource

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

VpnConnectionProperties

名字	描述	价值
connectionBandwidth	预期带宽（以 MBPS 为单位）。	int
enableBgp	EnableBgp 标志。	bool
enableInternetSecurity	启用 Internet 安全性。	bool
enableRateLimiting	EnableBgp 标志。	bool
ipsecPolicies	此连接要考虑的 IPSec 策略。	IpsecPolicy[]
remoteVpnSite	连接的 VPN 站点的 ID。	SubResource
routingWeight	VPN 连接的路由权重。	int
sharedKey	用于 VPN 连接的 SharedKey。	字符串
useLocalAzureIpAddress	使用本地 Azure IP 启动连接。	bool
usePolicyBasedTrafficSelectors	启用基于策略的流量选择器。	bool
vpnConnectionProtocolType	用于此连接的连接协议。	“IKEv1” “IKEv2”
vpnLinkConnections	指向网关的所有 VPN 站点链接连接的列表。	VpnSiteLinkConnection[]

VpnSiteLinkConnection

名字	描述	价值
id	资源 ID。	字符串
名字	资源组中唯一的资源的名称。 此名称可用于访问资源。	字符串
性能	VPN 站点链接连接的属性。	VpnSiteLinkConnectionProperties

VpnSiteLinkConnectionProperties

名字	描述	价值
connectionBandwidth	预期带宽（以 MBPS 为单位）。	int
enableBgp	EnableBgp 标志。	bool
enableRateLimiting	EnableBgp 标志。	bool
ipsecPolicies	此连接要考虑的 IPSec 策略。	IpsecPolicy[]
routingWeight	VPN 连接的路由权重。	int
sharedKey	用于 VPN 连接的 SharedKey。	字符串
useLocalAzureIpAddress	使用本地 Azure IP 启动连接。	bool
usePolicyBasedTrafficSelectors	启用基于策略的流量选择器。	bool
vpnConnectionProtocolType	用于此连接的连接协议。	“IKEv1” “IKEv2”
vpnSiteLink	连接的 VPN 站点链接的 ID。	SubResource

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

可以使用目标操作部署 vpnGateways/vpnConnections 资源类型：

• 资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/vpnGateways/vpnConnections@2019-06-01"
  name = "string"
  body = jsonencode({
    properties = {
      connectionBandwidth = int
      enableBgp = bool
      enableInternetSecurity = bool
      enableRateLimiting = bool
      ipsecPolicies = [
        {
          dhGroup = "string"
          ikeEncryption = "string"
          ikeIntegrity = "string"
          ipsecEncryption = "string"
          ipsecIntegrity = "string"
          pfsGroup = "string"
          saDataSizeKilobytes = int
          saLifeTimeSeconds = int
        }
      ]
      remoteVpnSite = {
        id = "string"
      }
      routingWeight = int
      sharedKey = "string"
      useLocalAzureIpAddress = bool
      usePolicyBasedTrafficSelectors = bool
      vpnConnectionProtocolType = "string"
      vpnLinkConnections = [
        {
          id = "string"
          name = "string"
          properties = {
            connectionBandwidth = int
            enableBgp = bool
            enableRateLimiting = bool
            ipsecPolicies = [
              {
                dhGroup = "string"
                ikeEncryption = "string"
                ikeIntegrity = "string"
                ipsecEncryption = "string"
                ipsecIntegrity = "string"
                pfsGroup = "string"
                saDataSizeKilobytes = int
                saLifeTimeSeconds = int
              }
            ]
            routingWeight = int
            sharedKey = "string"
            useLocalAzureIpAddress = bool
            usePolicyBasedTrafficSelectors = bool
            vpnConnectionProtocolType = "string"
            vpnSiteLink = {
              id = "string"
            }
          }
        }
      ]
    }
  })
}

属性值

IpsecPolicy

名字	描述	价值
dhGroup	IKE 阶段 1 中用于初始 SA 的 DH 组。	“DHGroup1” “DHGroup14” “DHGroup2” “DHGroup2048” “DHGroup24” “ECP256” “ECP384” “无”（必需）
ikeEncryption	IKE 加密算法（IKE 阶段 2）。	“AES128” “AES192” “AES256” “DES” “DES3” “GCMAES128” “GCMAES256”（必需）
ikeIntegrity	IKE 完整性算法（IKE 阶段 2）。	“GCMAES128” “GCMAES256” “MD5” “SHA1” “SHA256” “SHA384”（必需）
ipsecEncryption	IPSec 加密算法（IKE 阶段 1）。	“AES128” “AES192” “AES256” “DES” “DES3” “GCMAES128” “GCMAES192” “GCMAES256” “无”（必需）
ipsecIntegrity	IPSec 完整性算法（IKE 阶段 1）。	“GCMAES128” “GCMAES192” “GCMAES256” “MD5” “SHA1” “SHA256”（必需）
pfsGroup	IKE 阶段 2 中使用的 Pfs 组用于新的子 SA。	“ECP256” “ECP384” “None” “PFS1” “PFS14” “PFS2” “PFS2048” “PFS24” “PFSMM”（必需）
saDataSizeKilobytes	IPSec 安全关联（也称为快速模式或阶段 2 SA）有效负载大小（以 KB 为单位），用于站点到站点 VPN 隧道。	int （必需）
saLifeTimeSeconds	站点到站点 VPN 隧道的 IPSec 安全关联（也称为快速模式或阶段 2 SA）生存期（以秒为单位）。	int （必需）

Microsoft.Network/vpnGateways/vpnConnections

名字	描述	价值
名字	资源名称	string （必需）
parent_id	此资源的父资源的 ID。	类型资源的 ID：vpnGateways
性能	VPN 连接的属性。	VpnConnectionProperties
类型	资源类型	“Microsoft.Network/vpnGateways/vpnConnections@2019-06-01”

SubResource

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

VpnConnectionProperties

名字	描述	价值
connectionBandwidth	预期带宽（以 MBPS 为单位）。	int
enableBgp	EnableBgp 标志。	bool
enableInternetSecurity	启用 Internet 安全性。	bool
enableRateLimiting	EnableBgp 标志。	bool
ipsecPolicies	此连接要考虑的 IPSec 策略。	IpsecPolicy[]
remoteVpnSite	连接的 VPN 站点的 ID。	SubResource
routingWeight	VPN 连接的路由权重。	int
sharedKey	用于 VPN 连接的 SharedKey。	字符串
useLocalAzureIpAddress	使用本地 Azure IP 启动连接。	bool
usePolicyBasedTrafficSelectors	启用基于策略的流量选择器。	bool
vpnConnectionProtocolType	用于此连接的连接协议。	“IKEv1” “IKEv2”
vpnLinkConnections	指向网关的所有 VPN 站点链接连接的列表。	VpnSiteLinkConnection[]

VpnSiteLinkConnection

名字	描述	价值
id	资源 ID。	字符串
名字	资源组中唯一的资源的名称。 此名称可用于访问资源。	字符串
性能	VPN 站点链接连接的属性。	VpnSiteLinkConnectionProperties

VpnSiteLinkConnectionProperties

名字	描述	价值
connectionBandwidth	预期带宽（以 MBPS 为单位）。	int
enableBgp	EnableBgp 标志。	bool
enableRateLimiting	EnableBgp 标志。	bool
ipsecPolicies	此连接要考虑的 IPSec 策略。	IpsecPolicy[]
routingWeight	VPN 连接的路由权重。	int
sharedKey	用于 VPN 连接的 SharedKey。	字符串
useLocalAzureIpAddress	使用本地 Azure IP 启动连接。	bool
usePolicyBasedTrafficSelectors	启用基于策略的流量选择器。	bool
vpnConnectionProtocolType	用于此连接的连接协议。	“IKEv1” “IKEv2”
vpnSiteLink	连接的 VPN 站点链接的 ID。	SubResource