你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Microsoft.网络连接 2015-05-01-preview
Bicep 资源定义
可以使用目标操作部署连接资源类型：
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
若要创建 Microsoft.Network/connections 资源，请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.Network/connections@2015-05-01-preview' = {
etag: 'string'
location: 'string'
name: 'string'
properties: {
connectionStatus: 'string'
connectionType: 'string'
egressBytesTransferred: int
ingressBytesTransferred: int
localNetworkGateway2: {
etag: 'string'
location: 'string'
properties: {
gatewayIpAddress: 'string'
localNetworkAddressSpace: {
addressPrefixes: [
'string'
]
}
provisioningState: 'string'
resourceGuid: 'string'
}
tags: {
{customized property}: 'string'
}
}
peer: {
id: 'string'
}
provisioningState: 'string'
resourceGuid: 'string'
routingWeight: int
sharedKey: 'string'
virtualNetworkGateway1: {
etag: 'string'
location: 'string'
properties: {
enableBgp: bool
gatewayDefaultSite: {
id: 'string'
}
gatewayType: 'string'
ipConfigurations: [
{
etag: 'string'
id: 'string'
name: 'string'
properties: {
privateIPAddress: 'string'
privateIPAllocationMethod: 'string'
provisioningState: 'string'
publicIPAddress: {
id: 'string'
}
subnet: {
id: 'string'
}
}
}
]
provisioningState: 'string'
resourceGuid: 'string'
vpnType: 'string'
}
tags: {
{customized property}: 'string'
}
}
virtualNetworkGateway2: {
etag: 'string'
location: 'string'
properties: {
enableBgp: bool
gatewayDefaultSite: {
id: 'string'
}
gatewayType: 'string'
ipConfigurations: [
{
etag: 'string'
id: 'string'
name: 'string'
properties: {
privateIPAddress: 'string'
privateIPAllocationMethod: 'string'
provisioningState: 'string'
publicIPAddress: {
id: 'string'
}
subnet: {
id: 'string'
}
}
}
]
provisioningState: 'string'
resourceGuid: 'string'
vpnType: 'string'
}
tags: {
{customized property}: 'string'
}
}
}
tags: {
{customized property}: 'string'
}
}
属性值
AddressSpace
| 名字 |
描述 |
价值 |
| addressPrefixes |
获取或设置 CIDR 表示法中为此虚拟网络保留的地址块列表 |
string[] |
LocalNetworkGateway
| 名字 |
描述 |
价值 |
| gatewayIpAddress |
本地网络网关的 IP 地址。 |
字符串 |
| localNetworkAddressSpace |
本地网络站点地址空间 |
AddressSpace |
| provisioningState |
获取或设置 LocalNetworkGateway 资源更新/删除/失败的预配状态 |
字符串 |
| resourceGuid |
获取或设置 LocalNetworkGateway 资源的资源 guid 属性 |
字符串 |
Microsoft.Network/connections
SubResource
VirtualNetworkGateway
| 名字 |
描述 |
价值 |
| connectionStatus |
虚拟网络网关连接状态 |
“Connected”
“正在连接”
“NotConnected”
“未知” |
| connectionType |
网关连接类型 IPsec/Dedicated/VpnClient/Vnet2Vnet |
“ExpressRoute”
“IPsec”
“Vnet2Vnet”
“VPNClient” |
| egressBytesTransferred |
在此连接中传输的出口字节数 |
int |
| ingressBytesTransferred |
在此连接中传输的入口字节数 |
int |
| localNetworkGateway2 |
常规资源信息的通用类 |
LocalNetworkGateway |
| 同辈 |
对等互连资源的引用。 |
SubResource |
| provisioningState |
获取或设置 VirtualNetworkGatewayConnection 资源更新/删除/失败的预配状态 |
字符串 |
| resourceGuid |
获取或设置 VirtualNetworkGatewayConnection 资源的资源 guid 属性 |
字符串 |
| routingWeight |
路由权重。 |
int |
| sharedKey |
IPsec 共享密钥。 |
字符串 |
| virtualNetworkGateway1 |
常规资源信息的通用类 |
VirtualNetworkGateway |
| virtualNetworkGateway2 |
常规资源信息的通用类 |
VirtualNetworkGateway |
VirtualNetworkGatewayIpConfiguration
| 名字 |
描述 |
价值 |
| privateIPAddress |
获取或设置网络接口 IP 配置的 privateIPAddress |
字符串 |
| privateIPAllocationMethod |
获取或设置 PrivateIP 分配方法（静态/动态） |
“Dynamic”
“Static” |
| provisioningState |
获取或设置 PublicIP 资源更新/删除/失败的预配状态 |
字符串 |
| publicIPAddress |
获取或设置 PublicIP 资源的引用 |
SubResource |
| 子 |
获取或设置子网资源的引用 |
SubResource |
| 名字 |
描述 |
价值 |
| enableBgp |
EnableBgp 标志 |
bool |
| gatewayDefaultSite |
获取或设置 LocalNetworkGateway 资源的引用，该资源表示具有默认路由的本地网络站点。 如果删除现有的默认站点设置，请分配 Null 值。 |
SubResource |
| gatewayType |
此虚拟网络网关的类型。 |
“ExpressRoute”
“Vpn” |
| ipConfigurations |
虚拟网络网关的 IpConfigurations。 |
VirtualNetworkGatewayIpConfiguration[] |
| provisioningState |
获取或设置 VirtualNetworkGateway 资源更新/删除/失败的预配状态 |
字符串 |
| resourceGuid |
获取或设置 VirtualNetworkGateway 资源的资源 guid 属性 |
字符串 |
| vpnType |
此虚拟网络网关的类型。 |
“PolicyBased”
“RouteBased” |
快速入门示例
以下快速入门示例部署此资源类型。
| 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": "2015-05-01-preview",
"name": "string",
"etag": "string",
"location": "string",
"properties": {
"connectionStatus": "string",
"connectionType": "string",
"egressBytesTransferred": "int",
"ingressBytesTransferred": "int",
"localNetworkGateway2": {
"etag": "string",
"location": "string",
"properties": {
"gatewayIpAddress": "string",
"localNetworkAddressSpace": {
"addressPrefixes": [ "string" ]
},
"provisioningState": "string",
"resourceGuid": "string"
},
"tags": {
"{customized property}": "string"
}
},
"peer": {
"id": "string"
},
"provisioningState": "string",
"resourceGuid": "string",
"routingWeight": "int",
"sharedKey": "string",
"virtualNetworkGateway1": {
"etag": "string",
"location": "string",
"properties": {
"enableBgp": "bool",
"gatewayDefaultSite": {
"id": "string"
},
"gatewayType": "string",
"ipConfigurations": [
{
"etag": "string",
"id": "string",
"name": "string",
"properties": {
"privateIPAddress": "string",
"privateIPAllocationMethod": "string",
"provisioningState": "string",
"publicIPAddress": {
"id": "string"
},
"subnet": {
"id": "string"
}
}
}
],
"provisioningState": "string",
"resourceGuid": "string",
"vpnType": "string"
},
"tags": {
"{customized property}": "string"
}
},
"virtualNetworkGateway2": {
"etag": "string",
"location": "string",
"properties": {
"enableBgp": "bool",
"gatewayDefaultSite": {
"id": "string"
},
"gatewayType": "string",
"ipConfigurations": [
{
"etag": "string",
"id": "string",
"name": "string",
"properties": {
"privateIPAddress": "string",
"privateIPAllocationMethod": "string",
"provisioningState": "string",
"publicIPAddress": {
"id": "string"
},
"subnet": {
"id": "string"
}
}
}
],
"provisioningState": "string",
"resourceGuid": "string",
"vpnType": "string"
},
"tags": {
"{customized property}": "string"
}
}
},
"tags": {
"{customized property}": "string"
}
}
属性值
AddressSpace
| 名字 |
描述 |
价值 |
| addressPrefixes |
获取或设置 CIDR 表示法中为此虚拟网络保留的地址块列表 |
string[] |
LocalNetworkGateway
| 名字 |
描述 |
价值 |
| gatewayIpAddress |
本地网络网关的 IP 地址。 |
字符串 |
| localNetworkAddressSpace |
本地网络站点地址空间 |
AddressSpace |
| provisioningState |
获取或设置 LocalNetworkGateway 资源更新/删除/失败的预配状态 |
字符串 |
| resourceGuid |
获取或设置 LocalNetworkGateway 资源的资源 guid 属性 |
字符串 |
Microsoft.Network/connections
| 名字 |
描述 |
价值 |
| apiVersion |
API 版本 |
'2015-05-01-preview' |
| etag |
获取在更新资源时更改的唯一只读字符串 |
字符串 |
| 位置 |
资源位置 |
string （必需） |
| 名字 |
资源名称 |
string （必需） |
| 性能 |
VirtualNetworkGatewayConnection 属性 |
VirtualNetworkGatewayConnectionPropertiesFormat |
| 标签 |
资源标记 |
标记名称和值的字典。 请参阅模板 中的 标记 |
| 类型 |
资源类型 |
“Microsoft.Network/connections” |
SubResource
VirtualNetworkGateway
| 名字 |
描述 |
价值 |
| connectionStatus |
虚拟网络网关连接状态 |
“Connected”
“正在连接”
“NotConnected”
“未知” |
| connectionType |
网关连接类型 IPsec/Dedicated/VpnClient/Vnet2Vnet |
“ExpressRoute”
“IPsec”
“Vnet2Vnet”
“VPNClient” |
| egressBytesTransferred |
在此连接中传输的出口字节数 |
int |
| ingressBytesTransferred |
在此连接中传输的入口字节数 |
int |
| localNetworkGateway2 |
常规资源信息的通用类 |
LocalNetworkGateway |
| 同辈 |
对等互连资源的引用。 |
SubResource |
| provisioningState |
获取或设置 VirtualNetworkGatewayConnection 资源更新/删除/失败的预配状态 |
字符串 |
| resourceGuid |
获取或设置 VirtualNetworkGatewayConnection 资源的资源 guid 属性 |
字符串 |
| routingWeight |
路由权重。 |
int |
| sharedKey |
IPsec 共享密钥。 |
字符串 |
| virtualNetworkGateway1 |
常规资源信息的通用类 |
VirtualNetworkGateway |
| virtualNetworkGateway2 |
常规资源信息的通用类 |
VirtualNetworkGateway |
VirtualNetworkGatewayIpConfiguration
| 名字 |
描述 |
价值 |
| privateIPAddress |
获取或设置网络接口 IP 配置的 privateIPAddress |
字符串 |
| privateIPAllocationMethod |
获取或设置 PrivateIP 分配方法（静态/动态） |
“Dynamic”
“Static” |
| provisioningState |
获取或设置 PublicIP 资源更新/删除/失败的预配状态 |
字符串 |
| publicIPAddress |
获取或设置 PublicIP 资源的引用 |
SubResource |
| 子 |
获取或设置子网资源的引用 |
SubResource |
| 名字 |
描述 |
价值 |
| enableBgp |
EnableBgp 标志 |
bool |
| gatewayDefaultSite |
获取或设置 LocalNetworkGateway 资源的引用，该资源表示具有默认路由的本地网络站点。 如果删除现有的默认站点设置，请分配 Null 值。 |
SubResource |
| gatewayType |
此虚拟网络网关的类型。 |
“ExpressRoute”
“Vpn” |
| ipConfigurations |
虚拟网络网关的 IpConfigurations。 |
VirtualNetworkGatewayIpConfiguration[] |
| provisioningState |
获取或设置 VirtualNetworkGateway 资源更新/删除/失败的预配状态 |
字符串 |
| resourceGuid |
获取或设置 VirtualNetworkGateway 资源的资源 guid 属性 |
字符串 |
| vpnType |
此虚拟网络网关的类型。 |
“PolicyBased”
“RouteBased” |
快速入门模板
以下快速入门模板部署此资源类型。
| 模板 |
描述 |
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 终结点设备上的特定设置。 |
可以使用目标操作部署连接资源类型：
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
若要创建 Microsoft.Network/connections 资源，请将以下 Terraform 添加到模板。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Network/connections@2015-05-01-preview"
name = "string"
etag = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
connectionStatus = "string"
connectionType = "string"
egressBytesTransferred = int
ingressBytesTransferred = int
localNetworkGateway2 = {
etag = "string"
location = "string"
properties = {
gatewayIpAddress = "string"
localNetworkAddressSpace = {
addressPrefixes = [
"string"
]
}
provisioningState = "string"
resourceGuid = "string"
}
tags = {
{customized property} = "string"
}
}
peer = {
id = "string"
}
provisioningState = "string"
resourceGuid = "string"
routingWeight = int
sharedKey = "string"
virtualNetworkGateway1 = {
etag = "string"
location = "string"
properties = {
enableBgp = bool
gatewayDefaultSite = {
id = "string"
}
gatewayType = "string"
ipConfigurations = [
{
etag = "string"
id = "string"
name = "string"
properties = {
privateIPAddress = "string"
privateIPAllocationMethod = "string"
provisioningState = "string"
publicIPAddress = {
id = "string"
}
subnet = {
id = "string"
}
}
}
]
provisioningState = "string"
resourceGuid = "string"
vpnType = "string"
}
tags = {
{customized property} = "string"
}
}
virtualNetworkGateway2 = {
etag = "string"
location = "string"
properties = {
enableBgp = bool
gatewayDefaultSite = {
id = "string"
}
gatewayType = "string"
ipConfigurations = [
{
etag = "string"
id = "string"
name = "string"
properties = {
privateIPAddress = "string"
privateIPAllocationMethod = "string"
provisioningState = "string"
publicIPAddress = {
id = "string"
}
subnet = {
id = "string"
}
}
}
]
provisioningState = "string"
resourceGuid = "string"
vpnType = "string"
}
tags = {
{customized property} = "string"
}
}
}
})
}
属性值
AddressSpace
| 名字 |
描述 |
价值 |
| addressPrefixes |
获取或设置 CIDR 表示法中为此虚拟网络保留的地址块列表 |
string[] |
LocalNetworkGateway
| 名字 |
描述 |
价值 |
| gatewayIpAddress |
本地网络网关的 IP 地址。 |
字符串 |
| localNetworkAddressSpace |
本地网络站点地址空间 |
AddressSpace |
| provisioningState |
获取或设置 LocalNetworkGateway 资源更新/删除/失败的预配状态 |
字符串 |
| resourceGuid |
获取或设置 LocalNetworkGateway 资源的资源 guid 属性 |
字符串 |
Microsoft.Network/connections
| 名字 |
描述 |
价值 |
| etag |
获取在更新资源时更改的唯一只读字符串 |
字符串 |
| 位置 |
资源位置 |
string （必需） |
| 名字 |
资源名称 |
string （必需） |
| 性能 |
VirtualNetworkGatewayConnection 属性 |
VirtualNetworkGatewayConnectionPropertiesFormat |
| 标签 |
资源标记 |
标记名称和值的字典。 |
| 类型 |
资源类型 |
“Microsoft.Network/connections@2015-05-01-preview” |
SubResource
VirtualNetworkGateway
| 名字 |
描述 |
价值 |
| connectionStatus |
虚拟网络网关连接状态 |
“Connected”
“正在连接”
“NotConnected”
“未知” |
| connectionType |
网关连接类型 IPsec/Dedicated/VpnClient/Vnet2Vnet |
“ExpressRoute”
“IPsec”
“Vnet2Vnet”
“VPNClient” |
| egressBytesTransferred |
在此连接中传输的出口字节数 |
int |
| ingressBytesTransferred |
在此连接中传输的入口字节数 |
int |
| localNetworkGateway2 |
常规资源信息的通用类 |
LocalNetworkGateway |
| 同辈 |
对等互连资源的引用。 |
SubResource |
| provisioningState |
获取或设置 VirtualNetworkGatewayConnection 资源更新/删除/失败的预配状态 |
字符串 |
| resourceGuid |
获取或设置 VirtualNetworkGatewayConnection 资源的资源 guid 属性 |
字符串 |
| routingWeight |
路由权重。 |
int |
| sharedKey |
IPsec 共享密钥。 |
字符串 |
| virtualNetworkGateway1 |
常规资源信息的通用类 |
VirtualNetworkGateway |
| virtualNetworkGateway2 |
常规资源信息的通用类 |
VirtualNetworkGateway |
VirtualNetworkGatewayIpConfiguration
| 名字 |
描述 |
价值 |
| privateIPAddress |
获取或设置网络接口 IP 配置的 privateIPAddress |
字符串 |
| privateIPAllocationMethod |
获取或设置 PrivateIP 分配方法（静态/动态） |
“Dynamic”
“Static” |
| provisioningState |
获取或设置 PublicIP 资源更新/删除/失败的预配状态 |
字符串 |
| publicIPAddress |
获取或设置 PublicIP 资源的引用 |
SubResource |
| 子 |
获取或设置子网资源的引用 |
SubResource |
| 名字 |
描述 |
价值 |
| enableBgp |
EnableBgp 标志 |
bool |
| gatewayDefaultSite |
获取或设置 LocalNetworkGateway 资源的引用，该资源表示具有默认路由的本地网络站点。 如果删除现有的默认站点设置，请分配 Null 值。 |
SubResource |
| gatewayType |
此虚拟网络网关的类型。 |
“ExpressRoute”
“Vpn” |
| ipConfigurations |
虚拟网络网关的 IpConfigurations。 |
VirtualNetworkGatewayIpConfiguration[] |
| provisioningState |
获取或设置 VirtualNetworkGateway 资源更新/删除/失败的预配状态 |
字符串 |
| resourceGuid |
获取或设置 VirtualNetworkGateway 资源的资源 guid 属性 |
字符串 |
| vpnType |
此虚拟网络网关的类型。 |
“PolicyBased”
“RouteBased” |