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

Microsoft.网络连接 2018-07-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
• 2018-02-01
• 2018-01-01
• 2017-11-01
• 2017-10-01
• 2017-09-01
• 2017-08-01
• 2017-06-01
• 2017-03-30
• 2017-03-01
• 2016-12-01
• 2016-09-01
• 2016-06-01
• 2016-03-30
• 2015-06-15
• 2015-05-01-preview

Bicep 资源定义

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

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

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

资源格式

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

resource symbolicname 'Microsoft.Network/connections@2018-07-01' = {
  etag: 'string'
  location: 'string'
  name: 'string'
  properties: {
    authorizationKey: 'string'
    connectionType: 'string'
    enableBgp: bool
    expressRouteGatewayBypass: bool
    ipsecPolicies: [
      {
        dhGroup: 'string'
        ikeEncryption: 'string'
        ikeIntegrity: 'string'
        ipsecEncryption: 'string'
        ipsecIntegrity: 'string'
        pfsGroup: 'string'
        saDataSizeKilobytes: int
        saLifeTimeSeconds: int
      }
    ]
    localNetworkGateway2: {
      etag: 'string'
      id: 'string'
      location: 'string'
      properties: {
        bgpSettings: {
          asn: int
          bgpPeeringAddress: 'string'
          peerWeight: int
        }
        gatewayIpAddress: 'string'
        localNetworkAddressSpace: {
          addressPrefixes: [
            'string'
          ]
        }
        resourceGuid: 'string'
      }
      tags: {
        {customized property}: 'string'
      }
    }
    peer: {
      id: 'string'
    }
    resourceGuid: 'string'
    routingWeight: int
    sharedKey: 'string'
    usePolicyBasedTrafficSelectors: bool
    virtualNetworkGateway1: {
      etag: 'string'
      id: 'string'
      location: 'string'
      properties: {
        activeActive: bool
        bgpSettings: {
          asn: int
          bgpPeeringAddress: 'string'
          peerWeight: int
        }
        enableBgp: bool
        gatewayDefaultSite: {
          id: 'string'
        }
        gatewayType: 'string'
        ipConfigurations: [
          {
            etag: 'string'
            id: 'string'
            name: 'string'
            properties: {
              privateIPAllocationMethod: 'string'
              publicIPAddress: {
                id: 'string'
              }
              subnet: {
                id: 'string'
              }
            }
          }
        ]
        resourceGuid: 'string'
        sku: {
          capacity: int
          name: 'string'
          tier: 'string'
        }
        vpnClientConfiguration: {
          radiusServerAddress: 'string'
          radiusServerSecret: 'string'
          vpnClientAddressPool: {
            addressPrefixes: [
              'string'
            ]
          }
          vpnClientIpsecPolicies: [
            {
              dhGroup: 'string'
              ikeEncryption: 'string'
              ikeIntegrity: 'string'
              ipsecEncryption: 'string'
              ipsecIntegrity: 'string'
              pfsGroup: 'string'
              saDataSizeKilobytes: int
              saLifeTimeSeconds: int
            }
          ]
          vpnClientProtocols: [
            'string'
          ]
          vpnClientRevokedCertificates: [
            {
              etag: 'string'
              id: 'string'
              name: 'string'
              properties: {
                thumbprint: 'string'
              }
            }
          ]
          vpnClientRootCertificates: [
            {
              etag: 'string'
              id: 'string'
              name: 'string'
              properties: {
                publicCertData: 'string'
              }
            }
          ]
        }
        vpnType: 'string'
      }
      tags: {
        {customized property}: 'string'
      }
    }
    virtualNetworkGateway2: {
      etag: 'string'
      id: 'string'
      location: 'string'
      properties: {
        activeActive: bool
        bgpSettings: {
          asn: int
          bgpPeeringAddress: 'string'
          peerWeight: int
        }
        enableBgp: bool
        gatewayDefaultSite: {
          id: 'string'
        }
        gatewayType: 'string'
        ipConfigurations: [
          {
            etag: 'string'
            id: 'string'
            name: 'string'
            properties: {
              privateIPAllocationMethod: 'string'
              publicIPAddress: {
                id: 'string'
              }
              subnet: {
                id: 'string'
              }
            }
          }
        ]
        resourceGuid: 'string'
        sku: {
          capacity: int
          name: 'string'
          tier: 'string'
        }
        vpnClientConfiguration: {
          radiusServerAddress: 'string'
          radiusServerSecret: 'string'
          vpnClientAddressPool: {
            addressPrefixes: [
              'string'
            ]
          }
          vpnClientIpsecPolicies: [
            {
              dhGroup: 'string'
              ikeEncryption: 'string'
              ikeIntegrity: 'string'
              ipsecEncryption: 'string'
              ipsecIntegrity: 'string'
              pfsGroup: 'string'
              saDataSizeKilobytes: int
              saLifeTimeSeconds: int
            }
          ]
          vpnClientProtocols: [
            'string'
          ]
          vpnClientRevokedCertificates: [
            {
              etag: 'string'
              id: 'string'
              name: 'string'
              properties: {
                thumbprint: 'string'
              }
            }
          ]
          vpnClientRootCertificates: [
            {
              etag: 'string'
              id: 'string'
              name: 'string'
              properties: {
                publicCertData: 'string'
              }
            }
          ]
        }
        vpnType: 'string'
      }
      tags: {
        {customized property}: 'string'
      }
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

属性值

AddressSpace

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

BgpSettings

名字	描述	价值
asn	BGP 扬声器的 ASN。	int
bgpPeeringAddress	此 BGP 扬声器的 BGP 对等互连地址和 BGP 标识符。	字符串
peerWeight	添加到从此 BGP 扬声器中学习的路由的权重。	int

IpsecPolicy

名字	描述	价值
dhGroup	IKE 阶段 1 中使用的 DH 组用于初始 SA。	“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 中用于新子 SA 的 Pfs 组。	“ECP256” “ECP384” “None” “PFS1” “PFS14” “PFS2” “PFS2048” “PFS24” “PFSMM”（必需）
saDataSizeKilobytes	IPSec 安全关联（也称为快速模式或阶段 2 SA）有效负载大小（以 KB 为单位），用于站点到站点 VPN 隧道。	int （必需）
saLifeTimeSeconds	站点到站点 VPN 隧道的 IPSec 安全关联（也称为快速模式或阶段 2 SA）生存期（以秒为单位）。	int （必需）

LocalNetworkGateway

名字	描述	价值
etag	一个唯一的只读字符串，每当更新资源时更改。	字符串
id	资源 ID。	字符串
位置	资源位置。	字符串
性能	本地网络网关的属性。	LocalNetworkGatewayPropertiesFormat （必需）
标签	资源标记。	ResourceTags

LocalNetworkGatewayPropertiesFormat

名字	描述	价值
bgpSettings	本地网络网关的 BGP 扬声器设置。	BgpSettings
gatewayIpAddress	本地网络网关的 IP 地址。	字符串
localNetworkAddressSpace	本地网络站点地址空间。	AddressSpace
resourceGuid	LocalNetworkGateway 资源的资源 GUID 属性。	字符串

Microsoft.Network/connections

名字	描述	价值
etag	获取在更新资源时更改的唯一只读字符串。	字符串
位置	资源位置。	字符串
名字	资源名称	string （必需）
性能	虚拟网络网关连接的属性。	VirtualNetworkGatewayConnectionPropertiesFormat （必需）
标签	资源标记	标记名称和值的字典。 请参阅模板 中的 标记

ResourceTags

名字	描述	价值

ResourceTags

名字	描述	价值

ResourceTags

名字	描述	价值

SubResource

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

VirtualNetworkGateway

名字	描述	价值
etag	获取在更新资源时更改的唯一只读字符串。	字符串
id	资源 ID。	字符串
位置	资源位置。	字符串
性能	虚拟网络网关的属性。	VirtualNetworkGatewayPropertiesFormat （必需）
标签	资源标记。	ResourceTags

VirtualNetworkGatewayConnectionPropertiesFormat

名字	描述	价值
authorizationKey	authorizationKey。	字符串
connectionType	网关连接类型。 可能的值为：“IPsec”、“Vnet2Vnet”、“ExpressRoute”和“VPNClient”。	“ExpressRoute” “IPsec” “Vnet2Vnet” “VPNClient”（必需）
enableBgp	EnableBgp 标志	bool
expressRouteGatewayBypass	绕过 ExpressRoute 网关进行数据转发	bool
ipsecPolicies	此连接要考虑的 IPSec 策略。	IpsecPolicy[]
localNetworkGateway2	对本地网络网关资源的引用。	LocalNetworkGateway
同辈	对等互连资源的引用。	SubResource
resourceGuid	VirtualNetworkGatewayConnection 资源的资源 GUID 属性。	字符串
routingWeight	路由权重。	int
sharedKey	IPSec 共享密钥。	字符串
usePolicyBasedTrafficSelectors	启用基于策略的流量选择器。	bool
virtualNetworkGateway1	对虚拟网络网关资源的引用。	VirtualNetworkGateway （必需）
virtualNetworkGateway2	对虚拟网络网关资源的引用。	VirtualNetworkGateway

VirtualNetworkGatewayIPConfiguration

名字	描述	价值
etag	一个唯一的只读字符串，每当更新资源时更改。	字符串
id	资源 ID。	字符串
名字	资源组中唯一的资源的名称。 此名称可用于访问资源。	字符串
性能	虚拟网络网关 IP 配置的属性。	VirtualNetworkGatewayIPConfigurationPropertiesFormat

VirtualNetworkGatewayIPConfigurationPropertiesFormat

名字	描述	价值
privateIPAllocationMethod	专用 IP 分配方法。 可能的值为：“Static”和“Dynamic”。	“Dynamic” “Static”
publicIPAddress	公共 IP 资源的引用。	SubResource
子	子网资源的引用。	SubResource

VirtualNetworkGatewayPropertiesFormat

名字	描述	价值
activeActive	ActiveActive 标志	bool
bgpSettings	虚拟网络网关的 BGP 扬声器设置。	BgpSettings
enableBgp	是否为此虚拟网络网关启用了 BGP。	bool
gatewayDefaultSite	LocalNetworkGateway 资源的引用，该资源表示具有默认路由的本地网络站点。 如果删除现有的默认站点设置，请分配 Null 值。	SubResource
gatewayType	此虚拟网络网关的类型。 可能的值为：“Vpn”和“ExpressRoute”。	“ExpressRoute” “Vpn”
ipConfigurations	虚拟网络网关的 IP 配置。	VirtualNetworkGatewayIPConfiguration[]
resourceGuid	VirtualNetworkGateway 资源的资源 GUID 属性。	字符串
sku	VirtualNetworkGatewaySku 资源的引用，该资源表示为虚拟网络网关选择的 SKU。	VirtualNetworkGatewaySku
vpnClientConfiguration	表示 P2S VpnClient 配置的 VpnClientConfiguration 资源的引用。	VpnClientConfiguration
vpnType	此虚拟网络网关的类型。 可能的值为：“PolicyBased”和“RouteBased”。	“PolicyBased” “RouteBased”

VirtualNetworkGatewaySku

名字	描述	价值
能力	容量。	int
名字	网关 SKU 名称。	“Basic” “ErGw1AZ” “ErGw2AZ” “ErGw3AZ” “HighPerformance” “Standard” “UltraPerformance” “VpnGw1” “VpnGw1AZ” “VpnGw2” “VpnGw2AZ” “VpnGw3” “VpnGw3AZ”
层	网关 SKU 层。	“Basic” “ErGw1AZ” “ErGw2AZ” “ErGw3AZ” “HighPerformance” “Standard” “UltraPerformance” “VpnGw1” “VpnGw1AZ” “VpnGw2” “VpnGw2AZ” “VpnGw3” “VpnGw3AZ”

VpnClientConfiguration

名字	描述	价值
radiusServerAddress	用于 VPN 客户端连接的 VirtualNetworkGateway 资源的 radius 服务器地址属性。	字符串
radiusServerSecret	用于 VPN 客户端连接的 VirtualNetworkGateway 资源的 radius 机密属性。	字符串
vpnClientAddressPool	表示 P2S VpnClient 地址空间的地址空间资源的引用。	AddressSpace
vpnClientIpsecPolicies	用于虚拟网络网关 P2S 客户端的 VpnClientIpsecPolicies。	IpsecPolicy[]
vpnClientProtocols	用于虚拟网络网关的 VpnClientProtocols。	包含任一项的字符串数组： “IkeV2” “OpenVPN” “SSTP”
vpnClientRevokedCertificates	用于虚拟网络网关的 VpnClientRevokedCertificate。	VpnClientRevokedCertificate[]
vpnClientRootCertificates	虚拟网络网关的 VpnClientRootCertificate。	VpnClientRootCertificate[]

VpnClientRevokedCertificate

名字	描述	价值
etag	一个唯一的只读字符串，每当更新资源时更改。	字符串
id	资源 ID。	字符串
名字	资源组中唯一的资源的名称。 此名称可用于访问资源。	字符串
性能	VPN 客户端吊销证书的属性。	VpnClientRevokedCertificatePropertiesFormat

VpnClientRevokedCertificatePropertiesFormat

名字	描述	价值
指纹	吊销的 VPN 客户端证书指纹。	字符串

VpnClientRootCertificate

名字	描述	价值
etag	一个唯一的只读字符串，每当更新资源时更改。	字符串
id	资源 ID。	字符串
名字	资源组中唯一的资源的名称。 此名称可用于访问资源。	字符串
性能	VPN 客户端根证书的属性。	VpnClientRootCertificatePropertiesFormat （必需）

VpnClientRootCertificatePropertiesFormat

名字	描述	价值
publicCertData	证书公共数据。	string （必需）

快速入门示例

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

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

ARM 模板资源定义

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

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

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

资源格式

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

{
  "type": "Microsoft.Network/connections",
  "apiVersion": "2018-07-01",
  "name": "string",
  "etag": "string",
  "location": "string",
  "properties": {
    "authorizationKey": "string",
    "connectionType": "string",
    "enableBgp": "bool",
    "expressRouteGatewayBypass": "bool",
    "ipsecPolicies": [
      {
        "dhGroup": "string",
        "ikeEncryption": "string",
        "ikeIntegrity": "string",
        "ipsecEncryption": "string",
        "ipsecIntegrity": "string",
        "pfsGroup": "string",
        "saDataSizeKilobytes": "int",
        "saLifeTimeSeconds": "int"
      }
    ],
    "localNetworkGateway2": {
      "etag": "string",
      "id": "string",
      "location": "string",
      "properties": {
        "bgpSettings": {
          "asn": "int",
          "bgpPeeringAddress": "string",
          "peerWeight": "int"
        },
        "gatewayIpAddress": "string",
        "localNetworkAddressSpace": {
          "addressPrefixes": [ "string" ]
        },
        "resourceGuid": "string"
      },
      "tags": {
        "{customized property}": "string"
      }
    },
    "peer": {
      "id": "string"
    },
    "resourceGuid": "string",
    "routingWeight": "int",
    "sharedKey": "string",
    "usePolicyBasedTrafficSelectors": "bool",
    "virtualNetworkGateway1": {
      "etag": "string",
      "id": "string",
      "location": "string",
      "properties": {
        "activeActive": "bool",
        "bgpSettings": {
          "asn": "int",
          "bgpPeeringAddress": "string",
          "peerWeight": "int"
        },
        "enableBgp": "bool",
        "gatewayDefaultSite": {
          "id": "string"
        },
        "gatewayType": "string",
        "ipConfigurations": [
          {
            "etag": "string",
            "id": "string",
            "name": "string",
            "properties": {
              "privateIPAllocationMethod": "string",
              "publicIPAddress": {
                "id": "string"
              },
              "subnet": {
                "id": "string"
              }
            }
          }
        ],
        "resourceGuid": "string",
        "sku": {
          "capacity": "int",
          "name": "string",
          "tier": "string"
        },
        "vpnClientConfiguration": {
          "radiusServerAddress": "string",
          "radiusServerSecret": "string",
          "vpnClientAddressPool": {
            "addressPrefixes": [ "string" ]
          },
          "vpnClientIpsecPolicies": [
            {
              "dhGroup": "string",
              "ikeEncryption": "string",
              "ikeIntegrity": "string",
              "ipsecEncryption": "string",
              "ipsecIntegrity": "string",
              "pfsGroup": "string",
              "saDataSizeKilobytes": "int",
              "saLifeTimeSeconds": "int"
            }
          ],
          "vpnClientProtocols": [ "string" ],
          "vpnClientRevokedCertificates": [
            {
              "etag": "string",
              "id": "string",
              "name": "string",
              "properties": {
                "thumbprint": "string"
              }
            }
          ],
          "vpnClientRootCertificates": [
            {
              "etag": "string",
              "id": "string",
              "name": "string",
              "properties": {
                "publicCertData": "string"
              }
            }
          ]
        },
        "vpnType": "string"
      },
      "tags": {
        "{customized property}": "string"
      }
    },
    "virtualNetworkGateway2": {
      "etag": "string",
      "id": "string",
      "location": "string",
      "properties": {
        "activeActive": "bool",
        "bgpSettings": {
          "asn": "int",
          "bgpPeeringAddress": "string",
          "peerWeight": "int"
        },
        "enableBgp": "bool",
        "gatewayDefaultSite": {
          "id": "string"
        },
        "gatewayType": "string",
        "ipConfigurations": [
          {
            "etag": "string",
            "id": "string",
            "name": "string",
            "properties": {
              "privateIPAllocationMethod": "string",
              "publicIPAddress": {
                "id": "string"
              },
              "subnet": {
                "id": "string"
              }
            }
          }
        ],
        "resourceGuid": "string",
        "sku": {
          "capacity": "int",
          "name": "string",
          "tier": "string"
        },
        "vpnClientConfiguration": {
          "radiusServerAddress": "string",
          "radiusServerSecret": "string",
          "vpnClientAddressPool": {
            "addressPrefixes": [ "string" ]
          },
          "vpnClientIpsecPolicies": [
            {
              "dhGroup": "string",
              "ikeEncryption": "string",
              "ikeIntegrity": "string",
              "ipsecEncryption": "string",
              "ipsecIntegrity": "string",
              "pfsGroup": "string",
              "saDataSizeKilobytes": "int",
              "saLifeTimeSeconds": "int"
            }
          ],
          "vpnClientProtocols": [ "string" ],
          "vpnClientRevokedCertificates": [
            {
              "etag": "string",
              "id": "string",
              "name": "string",
              "properties": {
                "thumbprint": "string"
              }
            }
          ],
          "vpnClientRootCertificates": [
            {
              "etag": "string",
              "id": "string",
              "name": "string",
              "properties": {
                "publicCertData": "string"
              }
            }
          ]
        },
        "vpnType": "string"
      },
      "tags": {
        "{customized property}": "string"
      }
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

属性值

AddressSpace

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

BgpSettings

名字	描述	价值
asn	BGP 扬声器的 ASN。	int
bgpPeeringAddress	此 BGP 扬声器的 BGP 对等互连地址和 BGP 标识符。	字符串
peerWeight	添加到从此 BGP 扬声器中学习的路由的权重。	int

IpsecPolicy

名字	描述	价值
dhGroup	IKE 阶段 1 中使用的 DH 组用于初始 SA。	“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 中用于新子 SA 的 Pfs 组。	“ECP256” “ECP384” “None” “PFS1” “PFS14” “PFS2” “PFS2048” “PFS24” “PFSMM”（必需）
saDataSizeKilobytes	IPSec 安全关联（也称为快速模式或阶段 2 SA）有效负载大小（以 KB 为单位），用于站点到站点 VPN 隧道。	int （必需）
saLifeTimeSeconds	站点到站点 VPN 隧道的 IPSec 安全关联（也称为快速模式或阶段 2 SA）生存期（以秒为单位）。	int （必需）

LocalNetworkGateway

名字	描述	价值
etag	一个唯一的只读字符串，每当更新资源时更改。	字符串
id	资源 ID。	字符串
位置	资源位置。	字符串
性能	本地网络网关的属性。	LocalNetworkGatewayPropertiesFormat （必需）
标签	资源标记。	ResourceTags

LocalNetworkGatewayPropertiesFormat

名字	描述	价值
bgpSettings	本地网络网关的 BGP 扬声器设置。	BgpSettings
gatewayIpAddress	本地网络网关的 IP 地址。	字符串
localNetworkAddressSpace	本地网络站点地址空间。	AddressSpace
resourceGuid	LocalNetworkGateway 资源的资源 GUID 属性。	字符串

Microsoft.Network/connections

名字	描述	价值
apiVersion	API 版本	'2018-07-01'
etag	获取在更新资源时更改的唯一只读字符串。	字符串
位置	资源位置。	字符串
名字	资源名称	string （必需）
性能	虚拟网络网关连接的属性。	VirtualNetworkGatewayConnectionPropertiesFormat （必需）
标签	资源标记	标记名称和值的字典。 请参阅模板 中的 标记
类型	资源类型	“Microsoft.Network/connections”

ResourceTags

名字	描述	价值

ResourceTags

名字	描述	价值

ResourceTags

名字	描述	价值

SubResource

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

VirtualNetworkGateway

名字	描述	价值
etag	获取在更新资源时更改的唯一只读字符串。	字符串
id	资源 ID。	字符串
位置	资源位置。	字符串
性能	虚拟网络网关的属性。	VirtualNetworkGatewayPropertiesFormat （必需）
标签	资源标记。	ResourceTags

VirtualNetworkGatewayConnectionPropertiesFormat

名字	描述	价值
authorizationKey	authorizationKey。	字符串
connectionType	网关连接类型。 可能的值为：“IPsec”、“Vnet2Vnet”、“ExpressRoute”和“VPNClient”。	“ExpressRoute” “IPsec” “Vnet2Vnet” “VPNClient”（必需）
enableBgp	EnableBgp 标志	bool
expressRouteGatewayBypass	绕过 ExpressRoute 网关进行数据转发	bool
ipsecPolicies	此连接要考虑的 IPSec 策略。	IpsecPolicy[]
localNetworkGateway2	对本地网络网关资源的引用。	LocalNetworkGateway
同辈	对等互连资源的引用。	SubResource
resourceGuid	VirtualNetworkGatewayConnection 资源的资源 GUID 属性。	字符串
routingWeight	路由权重。	int
sharedKey	IPSec 共享密钥。	字符串
usePolicyBasedTrafficSelectors	启用基于策略的流量选择器。	bool
virtualNetworkGateway1	对虚拟网络网关资源的引用。	VirtualNetworkGateway （必需）
virtualNetworkGateway2	对虚拟网络网关资源的引用。	VirtualNetworkGateway

VirtualNetworkGatewayIPConfiguration

名字	描述	价值
etag	一个唯一的只读字符串，每当更新资源时更改。	字符串
id	资源 ID。	字符串
名字	资源组中唯一的资源的名称。 此名称可用于访问资源。	字符串
性能	虚拟网络网关 IP 配置的属性。	VirtualNetworkGatewayIPConfigurationPropertiesFormat

VirtualNetworkGatewayIPConfigurationPropertiesFormat

名字	描述	价值
privateIPAllocationMethod	专用 IP 分配方法。 可能的值为：“Static”和“Dynamic”。	“Dynamic” “Static”
publicIPAddress	公共 IP 资源的引用。	SubResource
子	子网资源的引用。	SubResource

VirtualNetworkGatewayPropertiesFormat

名字	描述	价值
activeActive	ActiveActive 标志	bool
bgpSettings	虚拟网络网关的 BGP 扬声器设置。	BgpSettings
enableBgp	是否为此虚拟网络网关启用了 BGP。	bool
gatewayDefaultSite	LocalNetworkGateway 资源的引用，该资源表示具有默认路由的本地网络站点。 如果删除现有的默认站点设置，请分配 Null 值。	SubResource
gatewayType	此虚拟网络网关的类型。 可能的值为：“Vpn”和“ExpressRoute”。	“ExpressRoute” “Vpn”
ipConfigurations	虚拟网络网关的 IP 配置。	VirtualNetworkGatewayIPConfiguration[]
resourceGuid	VirtualNetworkGateway 资源的资源 GUID 属性。	字符串
sku	VirtualNetworkGatewaySku 资源的引用，该资源表示为虚拟网络网关选择的 SKU。	VirtualNetworkGatewaySku
vpnClientConfiguration	表示 P2S VpnClient 配置的 VpnClientConfiguration 资源的引用。	VpnClientConfiguration
vpnType	此虚拟网络网关的类型。 可能的值为：“PolicyBased”和“RouteBased”。	“PolicyBased” “RouteBased”

VirtualNetworkGatewaySku

名字	描述	价值
能力	容量。	int
名字	网关 SKU 名称。	“Basic” “ErGw1AZ” “ErGw2AZ” “ErGw3AZ” “HighPerformance” “Standard” “UltraPerformance” “VpnGw1” “VpnGw1AZ” “VpnGw2” “VpnGw2AZ” “VpnGw3” “VpnGw3AZ”
层	网关 SKU 层。	“Basic” “ErGw1AZ” “ErGw2AZ” “ErGw3AZ” “HighPerformance” “Standard” “UltraPerformance” “VpnGw1” “VpnGw1AZ” “VpnGw2” “VpnGw2AZ” “VpnGw3” “VpnGw3AZ”

VpnClientConfiguration

名字	描述	价值
radiusServerAddress	用于 VPN 客户端连接的 VirtualNetworkGateway 资源的 radius 服务器地址属性。	字符串
radiusServerSecret	用于 VPN 客户端连接的 VirtualNetworkGateway 资源的 radius 机密属性。	字符串
vpnClientAddressPool	表示 P2S VpnClient 地址空间的地址空间资源的引用。	AddressSpace
vpnClientIpsecPolicies	用于虚拟网络网关 P2S 客户端的 VpnClientIpsecPolicies。	IpsecPolicy[]
vpnClientProtocols	用于虚拟网络网关的 VpnClientProtocols。	包含任一项的字符串数组： “IkeV2” “OpenVPN” “SSTP”
vpnClientRevokedCertificates	用于虚拟网络网关的 VpnClientRevokedCertificate。	VpnClientRevokedCertificate[]
vpnClientRootCertificates	虚拟网络网关的 VpnClientRootCertificate。	VpnClientRootCertificate[]

VpnClientRevokedCertificate

名字	描述	价值
etag	一个唯一的只读字符串，每当更新资源时更改。	字符串
id	资源 ID。	字符串
名字	资源组中唯一的资源的名称。 此名称可用于访问资源。	字符串
性能	VPN 客户端吊销证书的属性。	VpnClientRevokedCertificatePropertiesFormat

VpnClientRevokedCertificatePropertiesFormat

名字	描述	价值
指纹	吊销的 VPN 客户端证书指纹。	字符串

VpnClientRootCertificate

名字	描述	价值
etag	一个唯一的只读字符串，每当更新资源时更改。	字符串
id	资源 ID。	字符串
名字	资源组中唯一的资源的名称。 此名称可用于访问资源。	字符串
性能	VPN 客户端根证书的属性。	VpnClientRootCertificatePropertiesFormat （必需）

VpnClientRootCertificatePropertiesFormat

名字	描述	价值
publicCertData	证书公共数据。	string （必需）

快速入门模板

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

模板	描述
BOSH CF 跨区域	此模板可帮助你设置在 Azure 上跨两个区域部署 BOSH 和 Cloud Foundry 所需的资源。
将 ExpressRoute 线路连接到 VNET	此模板创建 VNET、ExpresRoute 网关和与配置了 AzurePrivatePeering 的预配和已启用的 ExpressRoute 线路的连接。
创建 BGP VNET 到 VNET 连接	使用此模板，可以使用虚拟网络网关和 BGP 连接两个 VNET
创建站点到站点 VPN 连接	使用此模板，可以使用虚拟网络网关创建站点到站点 VPN 连接
使用 VM 创建站点到站点 VPN 连接	使用此模板，可以使用虚拟网络网关创建站点到站点 VPN 连接
跨两个区域创建 VNET 到 VNET 连接	使用此模板，可以使用虚拟网络网关连接不同区域中的两个 VNET
创建三个 vNet 来演示 传递的 BGP 连接	此模板部署使用虚拟网络网关和已启用 BGP 的连接连接的三个 vNet
部署 HBase 异地复制	通过此模板，可以使用 VPN vnet 到 vnet 连接跨两个不同的区域配置用于 HBase 复制的 Azure 环境。
将现有 Azure VNET 扩展到多 VNET 配置	使用此模板，可以将现有单一 VNET 环境扩展到使用 VNET 到 VNET 网关跨两个数据中心区域扩展的多 VNET 环境
使用具有 BGP 的主动-主动 VPN 网关 站点到站点 VPN	通过此模板，可以使用 BGP 在配置主动-主动的两个 VNet 之间部署站点到站点 VPN VPN。 每个 Azure VPN 网关解析远程对等方的 FQDN，以确定远程 VPN 网关的公共 IP。 模板在具有可用性区域的 Azure 区域中按预期运行。
VPN 自定义 IPSec 策略	此自定义 IPSec 策略允许更精细地配置 IKE 参数。 这样，就可以部署站点到站点 VPN 策略，以支持 VPN 终结点设备上的特定设置。

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

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

• 资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/connections@2018-07-01"
  name = "string"
  etag = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      authorizationKey = "string"
      connectionType = "string"
      enableBgp = bool
      expressRouteGatewayBypass = bool
      ipsecPolicies = [
        {
          dhGroup = "string"
          ikeEncryption = "string"
          ikeIntegrity = "string"
          ipsecEncryption = "string"
          ipsecIntegrity = "string"
          pfsGroup = "string"
          saDataSizeKilobytes = int
          saLifeTimeSeconds = int
        }
      ]
      localNetworkGateway2 = {
        etag = "string"
        id = "string"
        location = "string"
        properties = {
          bgpSettings = {
            asn = int
            bgpPeeringAddress = "string"
            peerWeight = int
          }
          gatewayIpAddress = "string"
          localNetworkAddressSpace = {
            addressPrefixes = [
              "string"
            ]
          }
          resourceGuid = "string"
        }
        tags = {
          {customized property} = "string"
        }
      }
      peer = {
        id = "string"
      }
      resourceGuid = "string"
      routingWeight = int
      sharedKey = "string"
      usePolicyBasedTrafficSelectors = bool
      virtualNetworkGateway1 = {
        etag = "string"
        id = "string"
        location = "string"
        properties = {
          activeActive = bool
          bgpSettings = {
            asn = int
            bgpPeeringAddress = "string"
            peerWeight = int
          }
          enableBgp = bool
          gatewayDefaultSite = {
            id = "string"
          }
          gatewayType = "string"
          ipConfigurations = [
            {
              etag = "string"
              id = "string"
              name = "string"
              properties = {
                privateIPAllocationMethod = "string"
                publicIPAddress = {
                  id = "string"
                }
                subnet = {
                  id = "string"
                }
              }
            }
          ]
          resourceGuid = "string"
          sku = {
            capacity = int
            name = "string"
            tier = "string"
          }
          vpnClientConfiguration = {
            radiusServerAddress = "string"
            radiusServerSecret = "string"
            vpnClientAddressPool = {
              addressPrefixes = [
                "string"
              ]
            }
            vpnClientIpsecPolicies = [
              {
                dhGroup = "string"
                ikeEncryption = "string"
                ikeIntegrity = "string"
                ipsecEncryption = "string"
                ipsecIntegrity = "string"
                pfsGroup = "string"
                saDataSizeKilobytes = int
                saLifeTimeSeconds = int
              }
            ]
            vpnClientProtocols = [
              "string"
            ]
            vpnClientRevokedCertificates = [
              {
                etag = "string"
                id = "string"
                name = "string"
                properties = {
                  thumbprint = "string"
                }
              }
            ]
            vpnClientRootCertificates = [
              {
                etag = "string"
                id = "string"
                name = "string"
                properties = {
                  publicCertData = "string"
                }
              }
            ]
          }
          vpnType = "string"
        }
        tags = {
          {customized property} = "string"
        }
      }
      virtualNetworkGateway2 = {
        etag = "string"
        id = "string"
        location = "string"
        properties = {
          activeActive = bool
          bgpSettings = {
            asn = int
            bgpPeeringAddress = "string"
            peerWeight = int
          }
          enableBgp = bool
          gatewayDefaultSite = {
            id = "string"
          }
          gatewayType = "string"
          ipConfigurations = [
            {
              etag = "string"
              id = "string"
              name = "string"
              properties = {
                privateIPAllocationMethod = "string"
                publicIPAddress = {
                  id = "string"
                }
                subnet = {
                  id = "string"
                }
              }
            }
          ]
          resourceGuid = "string"
          sku = {
            capacity = int
            name = "string"
            tier = "string"
          }
          vpnClientConfiguration = {
            radiusServerAddress = "string"
            radiusServerSecret = "string"
            vpnClientAddressPool = {
              addressPrefixes = [
                "string"
              ]
            }
            vpnClientIpsecPolicies = [
              {
                dhGroup = "string"
                ikeEncryption = "string"
                ikeIntegrity = "string"
                ipsecEncryption = "string"
                ipsecIntegrity = "string"
                pfsGroup = "string"
                saDataSizeKilobytes = int
                saLifeTimeSeconds = int
              }
            ]
            vpnClientProtocols = [
              "string"
            ]
            vpnClientRevokedCertificates = [
              {
                etag = "string"
                id = "string"
                name = "string"
                properties = {
                  thumbprint = "string"
                }
              }
            ]
            vpnClientRootCertificates = [
              {
                etag = "string"
                id = "string"
                name = "string"
                properties = {
                  publicCertData = "string"
                }
              }
            ]
          }
          vpnType = "string"
        }
        tags = {
          {customized property} = "string"
        }
      }
    }
  })
}

属性值

AddressSpace

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

BgpSettings

名字	描述	价值
asn	BGP 扬声器的 ASN。	int
bgpPeeringAddress	此 BGP 扬声器的 BGP 对等互连地址和 BGP 标识符。	字符串
peerWeight	添加到从此 BGP 扬声器中学习的路由的权重。	int

IpsecPolicy

名字	描述	价值
dhGroup	IKE 阶段 1 中使用的 DH 组用于初始 SA。	“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 中用于新子 SA 的 Pfs 组。	“ECP256” “ECP384” “None” “PFS1” “PFS14” “PFS2” “PFS2048” “PFS24” “PFSMM”（必需）
saDataSizeKilobytes	IPSec 安全关联（也称为快速模式或阶段 2 SA）有效负载大小（以 KB 为单位），用于站点到站点 VPN 隧道。	int （必需）
saLifeTimeSeconds	站点到站点 VPN 隧道的 IPSec 安全关联（也称为快速模式或阶段 2 SA）生存期（以秒为单位）。	int （必需）

LocalNetworkGateway

名字	描述	价值
etag	一个唯一的只读字符串，每当更新资源时更改。	字符串
id	资源 ID。	字符串
位置	资源位置。	字符串
性能	本地网络网关的属性。	LocalNetworkGatewayPropertiesFormat （必需）
标签	资源标记。	ResourceTags

LocalNetworkGatewayPropertiesFormat

名字	描述	价值
bgpSettings	本地网络网关的 BGP 扬声器设置。	BgpSettings
gatewayIpAddress	本地网络网关的 IP 地址。	字符串
localNetworkAddressSpace	本地网络站点地址空间。	AddressSpace
resourceGuid	LocalNetworkGateway 资源的资源 GUID 属性。	字符串

Microsoft.Network/connections

名字	描述	价值
etag	获取在更新资源时更改的唯一只读字符串。	字符串
位置	资源位置。	字符串
名字	资源名称	string （必需）
性能	虚拟网络网关连接的属性。	VirtualNetworkGatewayConnectionPropertiesFormat （必需）
标签	资源标记	标记名称和值的字典。
类型	资源类型	“Microsoft.Network/connections@2018-07-01”

ResourceTags

名字	描述	价值

ResourceTags

名字	描述	价值

ResourceTags

名字	描述	价值

SubResource

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

VirtualNetworkGateway

名字	描述	价值
etag	获取在更新资源时更改的唯一只读字符串。	字符串
id	资源 ID。	字符串
位置	资源位置。	字符串
性能	虚拟网络网关的属性。	VirtualNetworkGatewayPropertiesFormat （必需）
标签	资源标记。	ResourceTags

VirtualNetworkGatewayConnectionPropertiesFormat

名字	描述	价值
authorizationKey	authorizationKey。	字符串
connectionType	网关连接类型。 可能的值为：“IPsec”、“Vnet2Vnet”、“ExpressRoute”和“VPNClient”。	“ExpressRoute” “IPsec” “Vnet2Vnet” “VPNClient”（必需）
enableBgp	EnableBgp 标志	bool
expressRouteGatewayBypass	绕过 ExpressRoute 网关进行数据转发	bool
ipsecPolicies	此连接要考虑的 IPSec 策略。	IpsecPolicy[]
localNetworkGateway2	对本地网络网关资源的引用。	LocalNetworkGateway
同辈	对等互连资源的引用。	SubResource
resourceGuid	VirtualNetworkGatewayConnection 资源的资源 GUID 属性。	字符串
routingWeight	路由权重。	int
sharedKey	IPSec 共享密钥。	字符串
usePolicyBasedTrafficSelectors	启用基于策略的流量选择器。	bool
virtualNetworkGateway1	对虚拟网络网关资源的引用。	VirtualNetworkGateway （必需）
virtualNetworkGateway2	对虚拟网络网关资源的引用。	VirtualNetworkGateway

VirtualNetworkGatewayIPConfiguration

名字	描述	价值
etag	一个唯一的只读字符串，每当更新资源时更改。	字符串
id	资源 ID。	字符串
名字	资源组中唯一的资源的名称。 此名称可用于访问资源。	字符串
性能	虚拟网络网关 IP 配置的属性。	VirtualNetworkGatewayIPConfigurationPropertiesFormat

VirtualNetworkGatewayIPConfigurationPropertiesFormat

名字	描述	价值
privateIPAllocationMethod	专用 IP 分配方法。 可能的值为：“Static”和“Dynamic”。	“Dynamic” “Static”
publicIPAddress	公共 IP 资源的引用。	SubResource
子	子网资源的引用。	SubResource

VirtualNetworkGatewayPropertiesFormat

名字	描述	价值
activeActive	ActiveActive 标志	bool
bgpSettings	虚拟网络网关的 BGP 扬声器设置。	BgpSettings
enableBgp	是否为此虚拟网络网关启用了 BGP。	bool
gatewayDefaultSite	LocalNetworkGateway 资源的引用，该资源表示具有默认路由的本地网络站点。 如果删除现有的默认站点设置，请分配 Null 值。	SubResource
gatewayType	此虚拟网络网关的类型。 可能的值为：“Vpn”和“ExpressRoute”。	“ExpressRoute” “Vpn”
ipConfigurations	虚拟网络网关的 IP 配置。	VirtualNetworkGatewayIPConfiguration[]
resourceGuid	VirtualNetworkGateway 资源的资源 GUID 属性。	字符串
sku	VirtualNetworkGatewaySku 资源的引用，该资源表示为虚拟网络网关选择的 SKU。	VirtualNetworkGatewaySku
vpnClientConfiguration	表示 P2S VpnClient 配置的 VpnClientConfiguration 资源的引用。	VpnClientConfiguration
vpnType	此虚拟网络网关的类型。 可能的值为：“PolicyBased”和“RouteBased”。	“PolicyBased” “RouteBased”

VirtualNetworkGatewaySku

名字	描述	价值
能力	容量。	int
名字	网关 SKU 名称。	“Basic” “ErGw1AZ” “ErGw2AZ” “ErGw3AZ” “HighPerformance” “Standard” “UltraPerformance” “VpnGw1” “VpnGw1AZ” “VpnGw2” “VpnGw2AZ” “VpnGw3” “VpnGw3AZ”
层	网关 SKU 层。	“Basic” “ErGw1AZ” “ErGw2AZ” “ErGw3AZ” “HighPerformance” “Standard” “UltraPerformance” “VpnGw1” “VpnGw1AZ” “VpnGw2” “VpnGw2AZ” “VpnGw3” “VpnGw3AZ”

VpnClientConfiguration

名字	描述	价值
radiusServerAddress	用于 VPN 客户端连接的 VirtualNetworkGateway 资源的 radius 服务器地址属性。	字符串
radiusServerSecret	用于 VPN 客户端连接的 VirtualNetworkGateway 资源的 radius 机密属性。	字符串
vpnClientAddressPool	表示 P2S VpnClient 地址空间的地址空间资源的引用。	AddressSpace
vpnClientIpsecPolicies	用于虚拟网络网关 P2S 客户端的 VpnClientIpsecPolicies。	IpsecPolicy[]
vpnClientProtocols	用于虚拟网络网关的 VpnClientProtocols。	包含任一项的字符串数组： “IkeV2” “OpenVPN” “SSTP”
vpnClientRevokedCertificates	用于虚拟网络网关的 VpnClientRevokedCertificate。	VpnClientRevokedCertificate[]
vpnClientRootCertificates	虚拟网络网关的 VpnClientRootCertificate。	VpnClientRootCertificate[]

VpnClientRevokedCertificate

名字	描述	价值
etag	一个唯一的只读字符串，每当更新资源时更改。	字符串
id	资源 ID。	字符串
名字	资源组中唯一的资源的名称。 此名称可用于访问资源。	字符串
性能	VPN 客户端吊销证书的属性。	VpnClientRevokedCertificatePropertiesFormat

VpnClientRevokedCertificatePropertiesFormat

名字	描述	价值
指纹	吊销的 VPN 客户端证书指纹。	字符串

VpnClientRootCertificate

名字	描述	价值
etag	一个唯一的只读字符串，每当更新资源时更改。	字符串
id	资源 ID。	字符串
名字	资源组中唯一的资源的名称。 此名称可用于访问资源。	字符串
性能	VPN 客户端根证书的属性。	VpnClientRootCertificatePropertiesFormat （必需）

VpnClientRootCertificatePropertiesFormat

名字	描述	价值
publicCertData	证书公共数据。	string （必需）