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

Microsoft.Network virtualNetworks/virtualNetworkPeerings 2023-06-01

Bicep 资源定义

可以使用面向以下操作部署 virtualNetworks/virtualNetworkPeerings 资源类型:

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

资源格式

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

resource symbolicname 'Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2023-06-01' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    allowForwardedTraffic: bool
    allowGatewayTransit: bool
    allowVirtualNetworkAccess: bool
    doNotVerifyRemoteGateways: bool
    peeringState: 'string'
    peeringSyncLevel: 'string'
    remoteAddressSpace: {
      addressPrefixes: [
        'string'
      ]
    }
    remoteBgpCommunities: {
      virtualNetworkCommunity: 'string'
    }
    remoteVirtualNetwork: {
      id: 'string'
    }
    remoteVirtualNetworkAddressSpace: {
      addressPrefixes: [
        'string'
      ]
    }
    useRemoteGateways: bool
  }
}

属性值

virtualNetworks/virtualNetworkPeerings

名称 说明
name 资源名称

了解如何在 Bicep 中设置子资源的名称和类型。
字符串 (必需)

字符限制:1-80

有效字符:
字母数字、下划线字符、句点和连字符。

以字母数字开头。 以字母数字或下划线结尾。
父级 (parent) 在 Bicep 中,可以为子资源指定父资源。 仅当子资源在父资源外部声明时,才需要添加此属性。

有关详细信息,请参阅 父资源之外的子资源
类型为 的资源的符号名称: virtualNetworks
properties 虚拟网络对等互连的属性。 VirtualNetworkPeeringPropertiesFormat

VirtualNetworkPeeringPropertiesFormat

名称 说明
allowForwardedTraffic 远程虚拟网络中是否允许/禁止来自本地虚拟网络中 VM 的转发流量。 bool
allowGatewayTransit 是否可以在远程虚拟网络中使用网关链接来链接到此虚拟网络。 bool
allowVirtualNetworkAccess 本地虚拟网络空间中的 VM 能否访问远程虚拟网络空间中的 VM。 bool
doNotVerifyRemoteGateways 如果需要验证远程网关的预配状态。 bool
peeringState 虚拟网络对等互连的状态。 “Connected”
“Disconnected”
'Initiated'
peeringSyncLevel 虚拟网络对等互连的对等互连同步状态。 “FullyInSync”
'LocalAndRemoteNotInSync'
'LocalNotInSync'
“RemoteNotInSync”
remoteAddressSpace 对与远程虚拟网络对等互连的地址空间的引用。 AddressSpace
remoteBgpCommunities 对远程虚拟网络的 Bgp 社区的引用。 VirtualNetworkBgpCommunities
remoteVirtualNetwork 对远程虚拟网络的引用。 远程虚拟网络可以位于相同或不同的区域中, (预览版) 。 请参阅此处注册预览版,并详细了解 /azure/virtual-network/virtual-network-create-peering) (。 SubResource
remoteVirtualNetworkAddressSpace 对远程虚拟网络的当前地址空间的引用。 AddressSpace
useRemoteGateways 如果远程网关可以在此虚拟网络上使用。 如果该标志设置为 true,并且远程对等互连上的 allowGatewayTransit 也为 true,则虚拟网络将使用远程虚拟网络的网关进行传输。 只有一个对等互连可以将此标志设置为 true。 如果虚拟网络已有网关,则无法设置此标志。 bool

AddressSpace

名称 说明
addressPrefixes 以 CIDR 表示法为此虚拟网络保留的地址块列表。 string[]

VirtualNetworkBgp 社区

名称 说明
virtualNetworkCommunity 与虚拟网络关联的 BGP 社区。 字符串 (必需)

SubResource

名称 说明 Value
id 资源 ID。 字符串

快速入门模板

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

模板 说明
部署中心辐射型拓扑沙盒

部署到 Azure
此模板创建基本的中心辐射型拓扑设置。 它创建一个中心 VNet,其中包含外围网络、管理、共享和网关 ((可选)) ,其中两个分支 VNet (开发和生产) 分别包含一个工作负载子网。 它还在中心的管理子网上部署 Windows Jump-Host,并在中心与两个分支之间建立 VNet 对等互连。
链接到网关负载均衡器的公共负载均衡器

部署到 Azure
此模板允许部署链接到网关负载均衡器的公共标准负载均衡器。 从 Internet 传入的流量将路由到网关负载均衡器,linux VM (后端池中的 NVA) 。
在一个区域中部署具有两个 VNet 的 HBase 复制

部署到 Azure
此模板允许在同一区域中的两个 VNet 中配置具有两个 HBase 群集的N HBase 环境,以配置 HBase 复制。
在中心 & 辐射型拓扑中使用 Azure 防火墙 作为 DNS 代理

部署到 Azure
此示例演示如何使用 Azure 防火墙 在 Azure 中部署中心辐射型拓扑。 中心虚拟网络充当与通过虚拟网络对等互连连接到中心虚拟网络的许多辐射虚拟网络的中心连接点。
使用强制隧道Create Azure 防火墙沙盒

部署到 Azure
此模板 (Linux) 创建一个Azure 防火墙沙盒,其中一个防火墙强制通过对等互连 VNET 中的另一个防火墙通过隧道
在中心虚拟网络部署 Bastion 主机

部署到 Azure
此模板创建两个具有对等互连的 vNet:中心 vNet 中的 Bastion 主机和分支 vNet 中的 Linux VM
对等互连单个区域中的两个现有 VNet

部署到 Azure
此模板允许使用 VNet 对等互连从同一区域中的相同或不同的资源组连接两个 VNET
使用 vNet 对等互连Create vNet 到 vNet 连接

部署到 Azure
此模板允许使用 vNet 对等互连连接两个 vNet

ARM 模板资源定义

virtualNetworks/virtualNetworkPeerings 资源类型可以使用以下目标操作进行部署:

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

资源格式

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

{
  "type": "Microsoft.Network/virtualNetworks/virtualNetworkPeerings",
  "apiVersion": "2023-06-01",
  "name": "string",
  "properties": {
    "allowForwardedTraffic": "bool",
    "allowGatewayTransit": "bool",
    "allowVirtualNetworkAccess": "bool",
    "doNotVerifyRemoteGateways": "bool",
    "peeringState": "string",
    "peeringSyncLevel": "string",
    "remoteAddressSpace": {
      "addressPrefixes": [ "string" ]
    },
    "remoteBgpCommunities": {
      "virtualNetworkCommunity": "string"
    },
    "remoteVirtualNetwork": {
      "id": "string"
    },
    "remoteVirtualNetworkAddressSpace": {
      "addressPrefixes": [ "string" ]
    },
    "useRemoteGateways": "bool"
  }
}

属性值

virtualNetworks/virtualNetworkPeerings

名称 说明 Value
type 资源类型 “Microsoft.Network/virtualNetworks/virtualNetworkPeerings”
apiVersion 资源 API 版本 '2023-06-01'
name 资源名称

了解如何在 JSON ARM 模板中为子资源设置名称和类型。
字符串 (必需)

字符限制:1-80

有效字符:
字母数字、下划线字符、句点和连字符。

以字母数字开头。 以字母数字或下划线结尾。
properties 虚拟网络对等互连的属性。 VirtualNetworkPeeringPropertiesFormat

VirtualNetworkPeeringPropertiesFormat

名称 说明
allowForwardedTraffic 远程虚拟网络中是否允许/禁止来自本地虚拟网络中 VM 的转发流量。 bool
allowGatewayTransit 是否可以在远程虚拟网络中使用网关链接来链接到此虚拟网络。 bool
allowVirtualNetworkAccess 本地虚拟网络空间中的 VM 是否能够访问远程虚拟网络空间中的 VM。 bool
doNotVerifyRemoteGateways 如果需要验证远程网关的预配状态。 bool
peeringState 虚拟网络对等互连的状态。 “已连接”
“Disconnected”
“已启动”
peeringSyncLevel 虚拟网络对等互连的对等互连同步状态。 “FullyInSync”
“LocalAndRemoteNotInSync”
“LocalNotInSync”
“RemoteNotInSync”
remoteAddressSpace 对与远程虚拟网络对等互连的地址空间的引用。 AddressSpace
remoteBgp 社区 对远程虚拟网络的 Bgp 社区的引用。 VirtualNetworkBgp 社区
remoteVirtualNetwork 对远程虚拟网络的引用。 远程虚拟网络可以位于预览) (相同或不同的区域。 若要注册预览版,并详细了解 /azure/virtual-network/virtual-network-create-peering) (。 SubResource
remoteVirtualNetworkAddressSpace 对远程虚拟网络的当前地址空间的引用。 AddressSpace
useRemoteGateways 如果远程网关可以在此虚拟网络上使用。 如果标志设置为 true,并且允许远程对等互连上的 allowGatewayTransit 也为 true,则虚拟网络将使用远程虚拟网络的网关进行传输。 只有一个对等互连可以将此标志设置为 true。 如果虚拟网络已有网关,则无法设置此标志。 bool

AddressSpace

名称 说明
addressPrefixes 以 CIDR 表示法为此虚拟网络保留的地址块列表。 string[]

VirtualNetworkBgp 社区

名称 说明
virtualNetworkCommunity 与虚拟网络关联的 BGP 社区。 字符串 (必需)

SubResource

名称 说明 Value
id 资源 ID。 字符串

快速入门模板

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

模板 说明
部署中心辐射型拓扑沙盒

部署到 Azure
此模板创建基本的中心辐射型拓扑设置。 它创建一个中心 VNet,其中包含外围网络、管理、共享和网关 ((可选)) ,其中两个分支 VNet (开发和生产) 分别包含一个工作负载子网。 它还在中心的管理子网上部署 Windows Jump-Host,并在中心与两个分支之间建立 VNet 对等互连。
链接到网关负载均衡器的公共负载均衡器

部署到 Azure
此模板允许部署链接到网关负载均衡器的公共标准负载均衡器。 从 Internet 传入的流量将路由到网关负载均衡器,linux VM (后端池中的 NVA) 。
在一个区域中部署具有两个 VNet 的 HBase 复制

部署到 Azure
此模板允许在同一区域中的两个 VNet 中配置具有两个 HBase 群集的N HBase 环境,以配置 HBase 复制。
在中心 & 辐射型拓扑中使用 Azure 防火墙 作为 DNS 代理

部署到 Azure
此示例演示如何使用 Azure 防火墙 在 Azure 中部署中心辐射型拓扑。 中心虚拟网络充当与通过虚拟网络对等互连连接到中心虚拟网络的许多辐射虚拟网络的中心连接点。
使用强制隧道Create Azure 防火墙沙盒

部署到 Azure
此模板 (Linux) 创建一个Azure 防火墙沙盒,其中一个防火墙强制通过对等互连 VNET 中的另一个防火墙通过隧道
在中心虚拟网络部署 Bastion 主机

部署到 Azure
此模板创建两个具有对等互连的 vNet:中心 vNet 中的 Bastion 主机和分支 vNet 中的 Linux VM
对等互连单个区域中的两个现有 VNet

部署到 Azure
此模板允许使用 VNet 对等互连从同一区域中的相同或不同的资源组连接两个 VNET
使用 vNet 对等互连Create vNet 到 vNet 连接

部署到 Azure
此模板允许使用 vNet 对等互连连接两个 vNet

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

virtualNetworks/virtualNetworkPeerings 资源类型可以使用以下目标操作进行部署:

  • 资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2023-06-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      allowForwardedTraffic = bool
      allowGatewayTransit = bool
      allowVirtualNetworkAccess = bool
      doNotVerifyRemoteGateways = bool
      peeringState = "string"
      peeringSyncLevel = "string"
      remoteAddressSpace = {
        addressPrefixes = [
          "string"
        ]
      }
      remoteBgpCommunities = {
        virtualNetworkCommunity = "string"
      }
      remoteVirtualNetwork = {
        id = "string"
      }
      remoteVirtualNetworkAddressSpace = {
        addressPrefixes = [
          "string"
        ]
      }
      useRemoteGateways = bool
    }
  })
}

属性值

virtualNetworks/virtualNetworkPeerings

名称 说明 Value
type 资源类型 “Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2023-06-01”
name 资源名称 字符串 (必需)

字符限制:1-80

有效字符:
字母数字、下划线字符、句点和连字符。

以字母数字开头。 以字母数字或下划线结尾。
parent_id 此资源的父资源的 ID。 类型为:virtualNetworks 的资源的 ID
properties 虚拟网络对等互连的属性。 VirtualNetworkPeeringPropertiesFormat

VirtualNetworkPeeringPropertiesFormat

名称 说明
allowForwardedTraffic 远程虚拟网络中是否允许/禁止来自本地虚拟网络中 VM 的转发流量。 bool
allowGatewayTransit 是否可以在远程虚拟网络中使用网关链接来链接到此虚拟网络。 bool
allowVirtualNetworkAccess 本地虚拟网络空间中的 VM 能否访问远程虚拟网络空间中的 VM。 bool
doNotVerifyRemoteGateways 如果需要验证远程网关的预配状态。 bool
peeringState 虚拟网络对等互连的状态。 “Connected”
“Disconnected”
“已启动”
peeringSyncLevel 虚拟网络对等互连的对等互连同步状态。 “FullyInSync”
“LocalAndRemoteNotInSync”
“LocalNotInSync”
“RemoteNotInSync”
remoteAddressSpace 对与远程虚拟网络对等互连的地址空间的引用。 AddressSpace
remoteBgpCommunities 对远程虚拟网络的 Bgp 社区的引用。 VirtualNetworkBgpCommunities
remoteVirtualNetwork 对远程虚拟网络的引用。 远程虚拟网络可以位于相同或不同的区域中, (预览版) 。 请参阅此处注册预览版,并详细了解 /azure/virtual-network/virtual-network-create-peering) (。 SubResource
remoteVirtualNetworkAddressSpace 对远程虚拟网络的当前地址空间的引用。 AddressSpace
useRemoteGateways 如果远程网关可以在此虚拟网络上使用。 如果该标志设置为 true,并且远程对等互连上的 allowGatewayTransit 也为 true,则虚拟网络将使用远程虚拟网络的网关进行传输。 只有一个对等互连可以将此标志设置为 true。 如果虚拟网络已有网关,则无法设置此标志。 bool

AddressSpace

名称 说明
addressPrefixes 以 CIDR 表示法为此虚拟网络保留的地址块列表。 string[]

VirtualNetworkBgpCommunities

名称 说明
virtualNetworkCommunity 与虚拟网络关联的 BGP 社区。 字符串 (必需)

SubResource

名称 说明 Value
id 资源 ID。 字符串