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

Microsoft.Network virtualNetworks/virtualNetworkPeerings

• 最新
• 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

Bicep 资源定义

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

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

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

资源格式

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

resource symbolicname 'Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2024-05-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    allowForwardedTraffic: bool
    allowGatewayTransit: bool
    allowVirtualNetworkAccess: bool
    doNotVerifyRemoteGateways: bool
    enableOnlyIPv6Peering: bool
    localAddressSpace: {
      addressPrefixes: [
        'string'
      ]
      ipamPoolPrefixAllocations: [
        {
          numberOfIpAddresses: 'string'
          pool: {
            id: 'string'
          }
        }
      ]
    }
    localSubnetNames: [
      'string'
    ]
    localVirtualNetworkAddressSpace: {
      addressPrefixes: [
        'string'
      ]
      ipamPoolPrefixAllocations: [
        {
          numberOfIpAddresses: 'string'
          pool: {
            id: 'string'
          }
        }
      ]
    }
    peerCompleteVnets: bool
    peeringState: 'string'
    peeringSyncLevel: 'string'
    remoteAddressSpace: {
      addressPrefixes: [
        'string'
      ]
      ipamPoolPrefixAllocations: [
        {
          numberOfIpAddresses: 'string'
          pool: {
            id: 'string'
          }
        }
      ]
    }
    remoteBgpCommunities: {
      virtualNetworkCommunity: 'string'
    }
    remoteSubnetNames: [
      'string'
    ]
    remoteVirtualNetwork: {
      id: 'string'
    }
    remoteVirtualNetworkAddressSpace: {
      addressPrefixes: [
        'string'
      ]
      ipamPoolPrefixAllocations: [
        {
          numberOfIpAddresses: 'string'
          pool: {
            id: 'string'
          }
        }
      ]
    }
    useRemoteGateways: bool
  }
}

属性值

AddressSpace

名字	描述	价值
addressPrefixes	CIDR 表示法中为此虚拟网络保留的地址块列表。	string[]
ipamPoolPrefixAllocations	IPAM 池分配 IP 地址前缀的列表。	IpamPoolPrefixAllocation[]

IpamPoolPrefixAllocation

名字	描述	价值
numberOfIpAddresses	要分配的 IP 地址数。	字符串
池		IpamPoolPrefixAllocationPool

IpamPoolPrefixAllocationPool

名字	描述	价值
id	关联的 Azure IpamPool 资源的资源 ID。	字符串

Microsoft.Network/virtualNetworks/virtualNetworkPeerings

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

SubResource

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

VirtualNetworkBgp 社区

名字	描述	价值
virtualNetworkCommunity	与虚拟网络关联的 BGP 社区。	string （必需）

VirtualNetworkPeeringPropertiesFormat

名字	描述	价值
allowForwardedTraffic	是否允许/禁止来自本地虚拟网络中的 VM 的转发流量。	bool
allowGatewayTransit	如果网关链接可用于远程虚拟网络，则链接到此虚拟网络。	bool
allowVirtualNetworkAccess	本地虚拟网络空间中的 VM 能否访问远程虚拟网络空间中的 VM。	bool
doNotVerifyRemoteGateways	如果需要验证远程网关的预配状态。	bool
enableOnlyIPv6Peering	是否仅对等互连 Ipv6 地址空间进行子网对等互连。	bool
localAddressSpace	对等互连的本地虚拟网络的本地地址空间。	AddressSpace
localSubnetNames	与远程虚拟网络对等互连的子网的本地子网名称列表。	string[]
localVirtualNetworkAddressSpace	对等互连的本地虚拟网络的当前本地地址空间。	AddressSpace
peerCompleteVnets	是否对等互连完整的虚拟网络地址空间。	bool
peeringState	虚拟网络对等互连的状态。	“Connected” “Disconnected” “已启动”
peeringSyncLevel	虚拟网络对等互连的对等互连同步状态。	“FullyInSync” 'LocalAndRemoteNotInSync' “LocalNotInSync” “RemoteNotInSync”
remoteAddressSpace	对与远程虚拟网络对等的地址空间的引用。	AddressSpace
remoteBgpCommunities	对远程虚拟网络的 Bgp 社区的引用。	VirtualNetworkBgp 社区
remoteSubnetNames	子网对等互连的远程虚拟网络中的远程子网名称列表。	string[]
remoteVirtualNetwork	对远程虚拟网络的引用。 远程虚拟网络可以位于相同或不同的区域（预览版）。 请参阅此处以注册预览版并了解详细信息（/azure/virtual-network/virtual-network-create-peering）。	SubResource
remoteVirtualNetworkAddressSpace	对远程虚拟网络的当前地址空间的引用。	AddressSpace
useRemoteGateways	如果远程网关可用于此虚拟网络。 如果标志设置为 true，并且允许远程对等互连上的 allowGatewayTransit 也为 true，则虚拟网络将使用远程虚拟网络的网关进行传输。 只有一个对等互连可以将此标志设置为 true。 如果虚拟网络已有网关，则无法设置此标志。	bool

快速入门示例

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

Bicep 文件	描述
Azure Game Developer Virtual Machine	Azure 游戏开发人员虚拟机包括 Unreal 等授权引擎。
使用 vNet 对等互连 创建 vNet 到 vNet 连接	使用此模板，可以使用 vNet 对等互连连接两个 vNet
在中心虚拟网络 部署 Bastion 主机	此模板创建两个具有对等互连的 vNet：中心 vNet 中的 Bastion 主机和辐射 vNet 中的 Linux VM
单个区域中的两个现有 VNet 对等互连	使用此模板，可以使用 VNet 对等互连从同一区域中的相同或不同资源组连接两个 VNET
链接到网关负载均衡器的公共负载均衡器	此模板允许你将链接的公共标准负载均衡器部署到网关负载均衡器。 从 Internet 传入的流量通过后端池中的 linux VM（NVA）路由到网关负载均衡器。
使用 Azure 防火墙作为中心 & 辐射型拓扑中的 DNS 代理	此示例演示如何使用 Azure 防火墙在 Azure 中部署中心辐射型拓扑。 中心虚拟网络充当通过虚拟网络对等互连连接到中心虚拟网络的许多辐射虚拟网络的中心点。

ARM 模板资源定义

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

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

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

资源格式

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

{
  "type": "Microsoft.Network/virtualNetworks/virtualNetworkPeerings",
  "apiVersion": "2024-05-01",
  "name": "string",
  "properties": {
    "allowForwardedTraffic": "bool",
    "allowGatewayTransit": "bool",
    "allowVirtualNetworkAccess": "bool",
    "doNotVerifyRemoteGateways": "bool",
    "enableOnlyIPv6Peering": "bool",
    "localAddressSpace": {
      "addressPrefixes": [ "string" ],
      "ipamPoolPrefixAllocations": [
        {
          "numberOfIpAddresses": "string",
          "pool": {
            "id": "string"
          }
        }
      ]
    },
    "localSubnetNames": [ "string" ],
    "localVirtualNetworkAddressSpace": {
      "addressPrefixes": [ "string" ],
      "ipamPoolPrefixAllocations": [
        {
          "numberOfIpAddresses": "string",
          "pool": {
            "id": "string"
          }
        }
      ]
    },
    "peerCompleteVnets": "bool",
    "peeringState": "string",
    "peeringSyncLevel": "string",
    "remoteAddressSpace": {
      "addressPrefixes": [ "string" ],
      "ipamPoolPrefixAllocations": [
        {
          "numberOfIpAddresses": "string",
          "pool": {
            "id": "string"
          }
        }
      ]
    },
    "remoteBgpCommunities": {
      "virtualNetworkCommunity": "string"
    },
    "remoteSubnetNames": [ "string" ],
    "remoteVirtualNetwork": {
      "id": "string"
    },
    "remoteVirtualNetworkAddressSpace": {
      "addressPrefixes": [ "string" ],
      "ipamPoolPrefixAllocations": [
        {
          "numberOfIpAddresses": "string",
          "pool": {
            "id": "string"
          }
        }
      ]
    },
    "useRemoteGateways": "bool"
  }
}

属性值

AddressSpace

名字	描述	价值
addressPrefixes	CIDR 表示法中为此虚拟网络保留的地址块列表。	string[]
ipamPoolPrefixAllocations	IPAM 池分配 IP 地址前缀的列表。	IpamPoolPrefixAllocation[]

IpamPoolPrefixAllocation

名字	描述	价值
numberOfIpAddresses	要分配的 IP 地址数。	字符串
池		IpamPoolPrefixAllocationPool

IpamPoolPrefixAllocationPool

名字	描述	价值
id	关联的 Azure IpamPool 资源的资源 ID。	字符串

Microsoft.Network/virtualNetworks/virtualNetworkPeerings

名字	描述	价值
apiVersion	API 版本	'2024-05-01'
名字	资源名称	string （必需）
性能	虚拟网络对等互连的属性。	VirtualNetworkPeeringPropertiesFormat
类型	资源类型	“Microsoft.Network/virtualNetworks/virtualNetworkPeerings”

SubResource

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

VirtualNetworkBgp 社区

名字	描述	价值
virtualNetworkCommunity	与虚拟网络关联的 BGP 社区。	string （必需）

VirtualNetworkPeeringPropertiesFormat

名字	描述	价值
allowForwardedTraffic	是否允许/禁止来自本地虚拟网络中的 VM 的转发流量。	bool
allowGatewayTransit	如果网关链接可用于远程虚拟网络，则链接到此虚拟网络。	bool
allowVirtualNetworkAccess	本地虚拟网络空间中的 VM 能否访问远程虚拟网络空间中的 VM。	bool
doNotVerifyRemoteGateways	如果需要验证远程网关的预配状态。	bool
enableOnlyIPv6Peering	是否仅对等互连 Ipv6 地址空间进行子网对等互连。	bool
localAddressSpace	对等互连的本地虚拟网络的本地地址空间。	AddressSpace
localSubnetNames	与远程虚拟网络对等互连的子网的本地子网名称列表。	string[]
localVirtualNetworkAddressSpace	对等互连的本地虚拟网络的当前本地地址空间。	AddressSpace
peerCompleteVnets	是否对等互连完整的虚拟网络地址空间。	bool
peeringState	虚拟网络对等互连的状态。	“Connected” “Disconnected” “已启动”
peeringSyncLevel	虚拟网络对等互连的对等互连同步状态。	“FullyInSync” 'LocalAndRemoteNotInSync' “LocalNotInSync” “RemoteNotInSync”
remoteAddressSpace	对与远程虚拟网络对等的地址空间的引用。	AddressSpace
remoteBgpCommunities	对远程虚拟网络的 Bgp 社区的引用。	VirtualNetworkBgp 社区
remoteSubnetNames	子网对等互连的远程虚拟网络中的远程子网名称列表。	string[]
remoteVirtualNetwork	对远程虚拟网络的引用。 远程虚拟网络可以位于相同或不同的区域（预览版）。 请参阅此处以注册预览版并了解详细信息（/azure/virtual-network/virtual-network-create-peering）。	SubResource
remoteVirtualNetworkAddressSpace	对远程虚拟网络的当前地址空间的引用。	AddressSpace
useRemoteGateways	如果远程网关可用于此虚拟网络。 如果标志设置为 true，并且允许远程对等互连上的 allowGatewayTransit 也为 true，则虚拟网络将使用远程虚拟网络的网关进行传输。 只有一个对等互连可以将此标志设置为 true。 如果虚拟网络已有网关，则无法设置此标志。	bool

快速入门模板

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

模板	描述
Azure Game Developer Virtual Machine	Azure 游戏开发人员虚拟机包括 Unreal 等授权引擎。
使用 vNet 对等互连 创建 vNet 到 vNet 连接	使用此模板，可以使用 vNet 对等互连连接两个 vNet
创建具有强制隧道 的 Azure 防火墙沙盒	此模板创建一个 Azure 防火墙沙盒（Linux），其中一个防火墙强制通过对等互连 VNET 中的另一个防火墙进行隧道传输
在中心虚拟网络 部署 Bastion 主机	此模板创建两个具有对等互连的 vNet：中心 vNet 中的 Bastion 主机和辐射 vNet 中的 Linux VM
部署中心辐射型拓扑沙盒	此模板创建基本的中心辐射型拓扑设置。 它创建包含外围网络、管理、共享和网关（可选）子网的中心 VNet，其中两个辐射 VNet（开发和生产）包含每个子网的工作负荷子网。 它还在 HUB 的管理子网上部署 Windows Jump-Host，并在中心与两个辐射之间建立 VNet 对等互连。
在一个区域中部署具有两个 VNet 的 HBase 复制	使用此模板，可以在同一区域中的两个 VNet 中配置具有两个 HBase 群集的一个 HBase 环境，以便配置 HBase 复制。
单个区域中的两个现有 VNet 对等互连	使用此模板，可以使用 VNet 对等互连从同一区域中的相同或不同资源组连接两个 VNET
链接到网关负载均衡器的公共负载均衡器	此模板允许你将链接的公共标准负载均衡器部署到网关负载均衡器。 从 Internet 传入的流量通过后端池中的 linux VM（NVA）路由到网关负载均衡器。
使用 Azure 防火墙作为中心 & 辐射型拓扑中的 DNS 代理	此示例演示如何使用 Azure 防火墙在 Azure 中部署中心辐射型拓扑。 中心虚拟网络充当通过虚拟网络对等互连连接到中心虚拟网络的许多辐射虚拟网络的中心点。

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

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

• 资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2024-05-01"
  name = "string"
  body = jsonencode({
    properties = {
      allowForwardedTraffic = bool
      allowGatewayTransit = bool
      allowVirtualNetworkAccess = bool
      doNotVerifyRemoteGateways = bool
      enableOnlyIPv6Peering = bool
      localAddressSpace = {
        addressPrefixes = [
          "string"
        ]
        ipamPoolPrefixAllocations = [
          {
            numberOfIpAddresses = "string"
            pool = {
              id = "string"
            }
          }
        ]
      }
      localSubnetNames = [
        "string"
      ]
      localVirtualNetworkAddressSpace = {
        addressPrefixes = [
          "string"
        ]
        ipamPoolPrefixAllocations = [
          {
            numberOfIpAddresses = "string"
            pool = {
              id = "string"
            }
          }
        ]
      }
      peerCompleteVnets = bool
      peeringState = "string"
      peeringSyncLevel = "string"
      remoteAddressSpace = {
        addressPrefixes = [
          "string"
        ]
        ipamPoolPrefixAllocations = [
          {
            numberOfIpAddresses = "string"
            pool = {
              id = "string"
            }
          }
        ]
      }
      remoteBgpCommunities = {
        virtualNetworkCommunity = "string"
      }
      remoteSubnetNames = [
        "string"
      ]
      remoteVirtualNetwork = {
        id = "string"
      }
      remoteVirtualNetworkAddressSpace = {
        addressPrefixes = [
          "string"
        ]
        ipamPoolPrefixAllocations = [
          {
            numberOfIpAddresses = "string"
            pool = {
              id = "string"
            }
          }
        ]
      }
      useRemoteGateways = bool
    }
  })
}

属性值

AddressSpace

名字	描述	价值
addressPrefixes	CIDR 表示法中为此虚拟网络保留的地址块列表。	string[]
ipamPoolPrefixAllocations	IPAM 池分配 IP 地址前缀的列表。	IpamPoolPrefixAllocation[]

IpamPoolPrefixAllocation

名字	描述	价值
numberOfIpAddresses	要分配的 IP 地址数。	字符串
池		IpamPoolPrefixAllocationPool

IpamPoolPrefixAllocationPool

名字	描述	价值
id	关联的 Azure IpamPool 资源的资源 ID。	字符串

Microsoft.Network/virtualNetworks/virtualNetworkPeerings

名字	描述	价值
名字	资源名称	string （必需）
parent_id	此资源的父资源的 ID。	类型资源的 ID：virtualNetworks
性能	虚拟网络对等互连的属性。	VirtualNetworkPeeringPropertiesFormat
类型	资源类型	“Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2024-05-01”

SubResource

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

VirtualNetworkBgp 社区

名字	描述	价值
virtualNetworkCommunity	与虚拟网络关联的 BGP 社区。	string （必需）

VirtualNetworkPeeringPropertiesFormat

名字	描述	价值
allowForwardedTraffic	是否允许/禁止来自本地虚拟网络中的 VM 的转发流量。	bool
allowGatewayTransit	如果网关链接可用于远程虚拟网络，则链接到此虚拟网络。	bool
allowVirtualNetworkAccess	本地虚拟网络空间中的 VM 能否访问远程虚拟网络空间中的 VM。	bool
doNotVerifyRemoteGateways	如果需要验证远程网关的预配状态。	bool
enableOnlyIPv6Peering	是否仅对等互连 Ipv6 地址空间进行子网对等互连。	bool
localAddressSpace	对等互连的本地虚拟网络的本地地址空间。	AddressSpace
localSubnetNames	与远程虚拟网络对等互连的子网的本地子网名称列表。	string[]
localVirtualNetworkAddressSpace	对等互连的本地虚拟网络的当前本地地址空间。	AddressSpace
peerCompleteVnets	是否对等互连完整的虚拟网络地址空间。	bool
peeringState	虚拟网络对等互连的状态。	“Connected” “Disconnected” “已启动”
peeringSyncLevel	虚拟网络对等互连的对等互连同步状态。	“FullyInSync” 'LocalAndRemoteNotInSync' “LocalNotInSync” “RemoteNotInSync”
remoteAddressSpace	对与远程虚拟网络对等的地址空间的引用。	AddressSpace
remoteBgpCommunities	对远程虚拟网络的 Bgp 社区的引用。	VirtualNetworkBgp 社区
remoteSubnetNames	子网对等互连的远程虚拟网络中的远程子网名称列表。	string[]
remoteVirtualNetwork	对远程虚拟网络的引用。 远程虚拟网络可以位于相同或不同的区域（预览版）。 请参阅此处以注册预览版并了解详细信息（/azure/virtual-network/virtual-network-create-peering）。	SubResource
remoteVirtualNetworkAddressSpace	对远程虚拟网络的当前地址空间的引用。	AddressSpace
useRemoteGateways	如果远程网关可用于此虚拟网络。 如果标志设置为 true，并且允许远程对等互连上的 allowGatewayTransit 也为 true，则虚拟网络将使用远程虚拟网络的网关进行传输。 只有一个对等互连可以将此标志设置为 true。 如果虚拟网络已有网关，则无法设置此标志。	bool