你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Microsoft.Network virtualNetworkGateways 2016-03-30
Bicep 资源定义
可以使用目标操作部署 virtualNetworkGateways 资源类型：
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
若要创建 Microsoft.Network/virtualNetworkGateways 资源，请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.Network/virtualNetworkGateways@2016-03-30' = {
etag: 'string'
location: 'string'
name: 'string'
properties: {
bgpSettings: {
asn: int
bgpPeeringAddress: 'string'
peerWeight: int
}
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'
sku: {
capacity: int
name: 'string'
tier: 'string'
}
vpnClientConfiguration: {
vpnClientAddressPool: {
addressPrefixes: [
'string'
]
}
vpnClientRevokedCertificates: [
{
etag: 'string'
id: 'string'
name: 'string'
properties: {
provisioningState: 'string'
thumbprint: 'string'
}
}
]
vpnClientRootCertificates: [
{
etag: 'string'
id: 'string'
name: 'string'
properties: {
provisioningState: 'string'
publicCertData: 'string'
}
}
]
}
vpnType: 'string'
}
tags: {
{customized property}: 'string'
}
}
属性值
AddressSpace
| 名字 |
描述 |
价值 |
| addressPrefixes |
获取或设置 CIDR 表示法中为此虚拟网络保留的地址块列表 |
string[] |
BgpSettings
| 名字 |
描述 |
价值 |
| asn |
获取或设置此 BGP 扬声器的 ASN |
int |
| bgpPeeringAddress |
获取或设置此 BGP 扬声器的 BGP 对等互连地址和 BGP 标识符 |
字符串 |
| peerWeight |
获取或设置添加到从此 BGP 扬声器中学习的路由的权重 |
int |
Microsoft.Network/virtualNetworkGateways
SubResource
VirtualNetworkGatewayIPConfiguration
| 名字 |
描述 |
价值 |
| privateIPAddress |
获取或设置 IP 配置的 privateIPAddress |
字符串 |
| privateIPAllocationMethod |
获取或设置 PrivateIP 分配方法（静态/动态） |
“Dynamic”
“Static” |
| provisioningState |
获取或设置 PublicIP 资源更新/删除/失败的预配状态 |
字符串 |
| publicIPAddress |
获取或设置 PublicIP 资源的引用 |
SubResource |
| 子 |
获取或设置子网资源的引用 |
SubResource |
| 名字 |
描述 |
价值 |
| bgpSettings |
虚拟网络网关的 BGP 扬声器设置 |
BgpSettings |
| enableBgp |
EnableBgp 标志 |
bool |
| gatewayDefaultSite |
获取或设置 LocalNetworkGateway 资源的引用，该资源表示具有默认路由的本地网络站点。 如果删除现有的默认站点设置，请分配 Null 值。 |
SubResource |
| gatewayType |
此虚拟网络网关的类型。 |
“ExpressRoute”
“Vpn” |
| ipConfigurations |
虚拟网络网关的 IpConfigurations。 |
VirtualNetworkGatewayIPConfiguration[] |
| provisioningState |
获取或设置 VirtualNetworkGateway 资源更新/删除/失败的预配状态 |
字符串 |
| resourceGuid |
获取或设置 VirtualNetworkGateway 资源的资源 GUID 属性 |
字符串 |
| sku |
获取或设置 VirtualNetworkGatewaySku 资源的引用，该资源表示为虚拟网络网关选择的 SKU。 |
VirtualNetworkGatewaySku |
| vpnClientConfiguration |
获取或设置表示 P2S VpnClient 配置的 VpnClientConfiguration 资源的引用。 |
VpnClientConfiguration |
| vpnType |
此虚拟网络网关的类型。 |
“PolicyBased”
“RouteBased” |
VirtualNetworkGatewaySku
| 名字 |
描述 |
价值 |
| 能力 |
容量 |
int |
| 名字 |
网关 SKU 名称 -Basic/HighPerformance/Standard |
“Basic”
“HighPerformance”
“Standard” |
| 层 |
网关 SKU 层 -Basic/HighPerformance/Standard |
“Basic”
“HighPerformance”
“Standard” |
VpnClientConfiguration
VpnClientRevokedCertificate
| 名字 |
描述 |
价值 |
| provisioningState |
获取或设置 VPN 客户端吊销的证书资源更新/删除/失败的预配状态 |
字符串 |
| 指纹 |
获取或设置吊销的 Vpn 客户端证书指纹 |
字符串 |
VpnClientRootCertificate
| 名字 |
描述 |
价值 |
| provisioningState |
获取或设置 VPN 客户端根证书资源更新/删除/失败的预配状态 |
字符串 |
| publicCertData |
获取或设置证书公共数据 |
字符串 |
快速入门示例
以下快速入门示例部署此资源类型。
| Bicep 文件 |
描述 |
|
创建 BGP VNET 到 VNET 连接 |
使用此模板，可以使用虚拟网络网关和 BGP 连接两个 VNET |
|
使用 Azure AD 创建点到站点网关 |
此模板部署配置了 Azure Active Directory 点到站点连接的 VPN 虚拟网络网关 |
| 使用专用对等互连和 Azure VNet ExpressRoute 线路 |
此模板配置 ExpressRoute Microsoft对等互连，部署包含 Expressroute 网关的 Azure VNet，并将 VNet 链接到 ExpressRoute 线路 |
| 使用具有 BGP 的主动-主动 VPN 网关 站点到站点 VPN |
通过此模板，可以使用 BGP 在配置主动-主动的两个 VNet 之间部署站点到站点 VPN VPN。 每个 Azure VPN 网关解析远程对等方的 FQDN，以确定远程 VPN 网关的公共 IP。 模板在具有可用性区域的 Azure 区域中按预期运行。 |
|
使用 Azure 防火墙作为中心 & 辐射型拓扑中的 DNS 代理 |
此示例演示如何使用 Azure 防火墙在 Azure 中部署中心辐射型拓扑。 中心虚拟网络充当通过虚拟网络对等互连连接到中心虚拟网络的许多辐射虚拟网络的中心点。 |
ARM 模板资源定义
可以使用目标操作部署 virtualNetworkGateways 资源类型：
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
若要创建 Microsoft.Network/virtualNetworkGateways 资源，请将以下 JSON 添加到模板。
{
"type": "Microsoft.Network/virtualNetworkGateways",
"apiVersion": "2016-03-30",
"name": "string",
"etag": "string",
"location": "string",
"properties": {
"bgpSettings": {
"asn": "int",
"bgpPeeringAddress": "string",
"peerWeight": "int"
},
"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",
"sku": {
"capacity": "int",
"name": "string",
"tier": "string"
},
"vpnClientConfiguration": {
"vpnClientAddressPool": {
"addressPrefixes": [ "string" ]
},
"vpnClientRevokedCertificates": [
{
"etag": "string",
"id": "string",
"name": "string",
"properties": {
"provisioningState": "string",
"thumbprint": "string"
}
}
],
"vpnClientRootCertificates": [
{
"etag": "string",
"id": "string",
"name": "string",
"properties": {
"provisioningState": "string",
"publicCertData": "string"
}
}
]
},
"vpnType": "string"
},
"tags": {
"{customized property}": "string"
}
}
属性值
AddressSpace
| 名字 |
描述 |
价值 |
| addressPrefixes |
获取或设置 CIDR 表示法中为此虚拟网络保留的地址块列表 |
string[] |
BgpSettings
| 名字 |
描述 |
价值 |
| asn |
获取或设置此 BGP 扬声器的 ASN |
int |
| bgpPeeringAddress |
获取或设置此 BGP 扬声器的 BGP 对等互连地址和 BGP 标识符 |
字符串 |
| peerWeight |
获取或设置添加到从此 BGP 扬声器中学习的路由的权重 |
int |
Microsoft.Network/virtualNetworkGateways
| 名字 |
描述 |
价值 |
| apiVersion |
API 版本 |
'2016-03-30' |
| etag |
获取在更新资源时更改的唯一只读字符串 |
字符串 |
| 位置 |
资源位置 |
字符串 |
| 名字 |
资源名称 |
string （必需） |
| 性能 |
VirtualNetworkGateway 属性 |
VirtualNetworkGatewayPropertiesFormat |
| 标签 |
资源标记 |
标记名称和值的字典。 请参阅模板 中的 标记 |
| 类型 |
资源类型 |
“Microsoft.Network/virtualNetworkGateways” |
SubResource
VirtualNetworkGatewayIPConfiguration
| 名字 |
描述 |
价值 |
| privateIPAddress |
获取或设置 IP 配置的 privateIPAddress |
字符串 |
| privateIPAllocationMethod |
获取或设置 PrivateIP 分配方法（静态/动态） |
“Dynamic”
“Static” |
| provisioningState |
获取或设置 PublicIP 资源更新/删除/失败的预配状态 |
字符串 |
| publicIPAddress |
获取或设置 PublicIP 资源的引用 |
SubResource |
| 子 |
获取或设置子网资源的引用 |
SubResource |
| 名字 |
描述 |
价值 |
| bgpSettings |
虚拟网络网关的 BGP 扬声器设置 |
BgpSettings |
| enableBgp |
EnableBgp 标志 |
bool |
| gatewayDefaultSite |
获取或设置 LocalNetworkGateway 资源的引用，该资源表示具有默认路由的本地网络站点。 如果删除现有的默认站点设置，请分配 Null 值。 |
SubResource |
| gatewayType |
此虚拟网络网关的类型。 |
“ExpressRoute”
“Vpn” |
| ipConfigurations |
虚拟网络网关的 IpConfigurations。 |
VirtualNetworkGatewayIPConfiguration[] |
| provisioningState |
获取或设置 VirtualNetworkGateway 资源更新/删除/失败的预配状态 |
字符串 |
| resourceGuid |
获取或设置 VirtualNetworkGateway 资源的资源 GUID 属性 |
字符串 |
| sku |
获取或设置 VirtualNetworkGatewaySku 资源的引用，该资源表示为虚拟网络网关选择的 SKU。 |
VirtualNetworkGatewaySku |
| vpnClientConfiguration |
获取或设置表示 P2S VpnClient 配置的 VpnClientConfiguration 资源的引用。 |
VpnClientConfiguration |
| vpnType |
此虚拟网络网关的类型。 |
“PolicyBased”
“RouteBased” |
VirtualNetworkGatewaySku
| 名字 |
描述 |
价值 |
| 能力 |
容量 |
int |
| 名字 |
网关 SKU 名称 -Basic/HighPerformance/Standard |
“Basic”
“HighPerformance”
“Standard” |
| 层 |
网关 SKU 层 -Basic/HighPerformance/Standard |
“Basic”
“HighPerformance”
“Standard” |
VpnClientConfiguration
VpnClientRevokedCertificate
| 名字 |
描述 |
价值 |
| provisioningState |
获取或设置 VPN 客户端吊销的证书资源更新/删除/失败的预配状态 |
字符串 |
| 指纹 |
获取或设置吊销的 Vpn 客户端证书指纹 |
字符串 |
VpnClientRootCertificate
| 名字 |
描述 |
价值 |
| provisioningState |
获取或设置 VPN 客户端根证书资源更新/删除/失败的预配状态 |
字符串 |
| publicCertData |
获取或设置证书公共数据 |
字符串 |
快速入门模板
以下快速入门模板部署此资源类型。
| 模板 |
描述 |
使用 Azure SQL 后端 应用服务环境
|
此模板创建具有 Azure SQL 后端的应用服务环境以及专用终结点以及通常用于专用/隔离环境中的关联资源。 |
BOSH CF 跨区域
|
此模板可帮助你设置在 Azure 上跨两个区域部署 BOSH 和 Cloud Foundry 所需的资源。 |
将 ExpressRoute 线路连接到 VNET
|
此模板创建 VNET、ExpresRoute 网关和与配置了 AzurePrivatePeering 的预配和已启用的 ExpressRoute 线路的连接。 |
创建 BGP VNET 到 VNET 连接
|
使用此模板，可以使用虚拟网络网关和 BGP 连接两个 VNET |
使用 P2S VPN 和 IIS 创建开发测试环境
|
此模板在 Windows 服务器上创建具有点到站点 VPN 和 IIS 的简单开发测试环境，这是入门的好方法。 |
创建点到站点网关
|
使用此模板，可以使用 VirtualNetworkGateways 创建点到站点连接 |
使用 Azure AD 创建点到站点网关
|
此模板部署配置了 Azure Active Directory 点到站点连接的 VPN 虚拟网络网关 |
创建站点到站点 VPN 连接
|
使用此模板，可以使用虚拟网络网关创建站点到站点 VPN 连接 |
使用 VM 创建站点到站点 VPN 连接
|
使用此模板，可以使用虚拟网络网关创建站点到站点 VPN 连接 |
跨两个区域创建 VNET 到 VNET 连接
|
使用此模板，可以使用虚拟网络网关连接不同区域中的两个 VNET |
创建配置了点到站点连接的 SQL MI
|
部署为新虚拟网络中的点到站点连接配置的 Azure Sql 数据库托管实例（SQL MI）和虚拟网络网关。 |
创建三个 vNet 来演示 传递的 BGP 连接
|
此模板部署使用虚拟网络网关和已启用 BGP 的连接连接的三个 vNet |
创建包含两个子网、本地网络和网关 的 VNet
|
此模板创建 VNet、2 个子网和网关 |
部署中心辐射型拓扑沙盒
|
此模板创建基本的中心辐射型拓扑设置。 它创建包含外围网络、管理、共享和网关（可选）子网的中心 VNet，其中两个辐射 VNet（开发和生产）包含每个子网的工作负荷子网。 它还在 HUB 的管理子网上部署 Windows Jump-Host，并在中心与两个辐射之间建立 VNet 对等互连。 |
部署 HBase 异地复制
|
通过此模板，可以使用 VPN vnet 到 vnet 连接跨两个不同的区域配置用于 HBase 复制的 Azure 环境。 |
使用专用对等互连和 Azure VNet ExpressRoute 线路
|
此模板配置 ExpressRoute Microsoft对等互连，部署包含 Expressroute 网关的 Azure VNet，并将 VNet 链接到 ExpressRoute 线路 |
将现有 Azure VNET 扩展到多 VNET 配置
|
使用此模板，可以将现有单一 VNET 环境扩展到使用 VNET 到 VNET 网关跨两个数据中心区域扩展的多 VNET 环境 |
使用具有 BGP 的主动-主动 VPN 网关 站点到站点 VPN
|
通过此模板，可以使用 BGP 在配置主动-主动的两个 VNet 之间部署站点到站点 VPN VPN。 每个 Azure VPN 网关解析远程对等方的 FQDN，以确定远程 VPN 网关的公共 IP。 模板在具有可用性区域的 Azure 区域中按预期运行。 |
使用 Azure 防火墙作为中心 & 辐射型拓扑中的 DNS 代理
|
此示例演示如何使用 Azure 防火墙在 Azure 中部署中心辐射型拓扑。 中心虚拟网络充当通过虚拟网络对等互连连接到中心虚拟网络的许多辐射虚拟网络的中心点。 |
可以使用目标操作部署 virtualNetworkGateways 资源类型：
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
若要创建 Microsoft.Network/virtualNetworkGateways 资源，请将以下 Terraform 添加到模板。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Network/virtualNetworkGateways@2016-03-30"
name = "string"
etag = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
bgpSettings = {
asn = int
bgpPeeringAddress = "string"
peerWeight = int
}
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"
sku = {
capacity = int
name = "string"
tier = "string"
}
vpnClientConfiguration = {
vpnClientAddressPool = {
addressPrefixes = [
"string"
]
}
vpnClientRevokedCertificates = [
{
etag = "string"
id = "string"
name = "string"
properties = {
provisioningState = "string"
thumbprint = "string"
}
}
]
vpnClientRootCertificates = [
{
etag = "string"
id = "string"
name = "string"
properties = {
provisioningState = "string"
publicCertData = "string"
}
}
]
}
vpnType = "string"
}
})
}
属性值
AddressSpace
| 名字 |
描述 |
价值 |
| addressPrefixes |
获取或设置 CIDR 表示法中为此虚拟网络保留的地址块列表 |
string[] |
BgpSettings
| 名字 |
描述 |
价值 |
| asn |
获取或设置此 BGP 扬声器的 ASN |
int |
| bgpPeeringAddress |
获取或设置此 BGP 扬声器的 BGP 对等互连地址和 BGP 标识符 |
字符串 |
| peerWeight |
获取或设置添加到从此 BGP 扬声器中学习的路由的权重 |
int |
Microsoft.Network/virtualNetworkGateways
| 名字 |
描述 |
价值 |
| etag |
获取在更新资源时更改的唯一只读字符串 |
字符串 |
| 位置 |
资源位置 |
字符串 |
| 名字 |
资源名称 |
string （必需） |
| 性能 |
VirtualNetworkGateway 属性 |
VirtualNetworkGatewayPropertiesFormat |
| 标签 |
资源标记 |
标记名称和值的字典。 |
| 类型 |
资源类型 |
“Microsoft.Network/virtualNetworkGateways@2016-03-30” |
SubResource
VirtualNetworkGatewayIPConfiguration
| 名字 |
描述 |
价值 |
| privateIPAddress |
获取或设置 IP 配置的 privateIPAddress |
字符串 |
| privateIPAllocationMethod |
获取或设置 PrivateIP 分配方法（静态/动态） |
“Dynamic”
“Static” |
| provisioningState |
获取或设置 PublicIP 资源更新/删除/失败的预配状态 |
字符串 |
| publicIPAddress |
获取或设置 PublicIP 资源的引用 |
SubResource |
| 子 |
获取或设置子网资源的引用 |
SubResource |
| 名字 |
描述 |
价值 |
| bgpSettings |
虚拟网络网关的 BGP 扬声器设置 |
BgpSettings |
| enableBgp |
EnableBgp 标志 |
bool |
| gatewayDefaultSite |
获取或设置 LocalNetworkGateway 资源的引用，该资源表示具有默认路由的本地网络站点。 如果删除现有的默认站点设置，请分配 Null 值。 |
SubResource |
| gatewayType |
此虚拟网络网关的类型。 |
“ExpressRoute”
“Vpn” |
| ipConfigurations |
虚拟网络网关的 IpConfigurations。 |
VirtualNetworkGatewayIPConfiguration[] |
| provisioningState |
获取或设置 VirtualNetworkGateway 资源更新/删除/失败的预配状态 |
字符串 |
| resourceGuid |
获取或设置 VirtualNetworkGateway 资源的资源 GUID 属性 |
字符串 |
| sku |
获取或设置 VirtualNetworkGatewaySku 资源的引用，该资源表示为虚拟网络网关选择的 SKU。 |
VirtualNetworkGatewaySku |
| vpnClientConfiguration |
获取或设置表示 P2S VpnClient 配置的 VpnClientConfiguration 资源的引用。 |
VpnClientConfiguration |
| vpnType |
此虚拟网络网关的类型。 |
“PolicyBased”
“RouteBased” |
VirtualNetworkGatewaySku
| 名字 |
描述 |
价值 |
| 能力 |
容量 |
int |
| 名字 |
网关 SKU 名称 -Basic/HighPerformance/Standard |
“Basic”
“HighPerformance”
“Standard” |
| 层 |
网关 SKU 层 -Basic/HighPerformance/Standard |
“Basic”
“HighPerformance”
“Standard” |
VpnClientConfiguration
VpnClientRevokedCertificate
| 名字 |
描述 |
价值 |
| provisioningState |
获取或设置 VPN 客户端吊销的证书资源更新/删除/失败的预配状态 |
字符串 |
| 指纹 |
获取或设置吊销的 Vpn 客户端证书指纹 |
字符串 |
VpnClientRootCertificate
| 名字 |
描述 |
价值 |
| provisioningState |
获取或设置 VPN 客户端根证书资源更新/删除/失败的预配状态 |
字符串 |
| publicCertData |
获取或设置证书公共数据 |
字符串 |