Bicep 资源定义
可以使用目标操作部署 vpnSites 资源类型:
有关每个 API 版本中已更改属性的列表,请参阅 更改日志。
用法示例
Bicep 示例
部署 VPN 站点的基本示例。
param resourceName string = 'acctest0001'
param location string = 'westeurope'
resource virtualWan 'Microsoft.Network/virtualWans@2022-07-01' = {
name: resourceName
location: location
properties: {
allowBranchToBranchTraffic: true
disableVpnEncryption: false
office365LocalBreakoutCategory: 'None'
type: 'Standard'
}
}
resource vpnSite 'Microsoft.Network/vpnSites@2022-07-01' = {
name: resourceName
location: location
properties: {
addressSpace: {
addressPrefixes: [
'10.0.1.0/24'
]
}
virtualWan: {
id: virtualWan.id
}
vpnSiteLinks: [
{
name: 'link1'
properties: {
fqdn: ''
ipAddress: '10.0.1.1'
linkProperties: {
linkProviderName: ''
linkSpeedInMbps: 0
}
}
}
{
name: 'link2'
properties: {
fqdn: ''
ipAddress: '10.0.1.2'
linkProperties: {
linkProviderName: ''
linkSpeedInMbps: 0
}
}
}
]
}
}
Azure 验证模块
以下 Azure 验证模块 可用于部署此资源类型。
Azure 快速入门示例
以下 Azure 快速入门模板 包含用于部署此资源类型的 Bicep 示例。
| Bicep 文件 |
描述 |
|
创建虚拟 WAN 资源 |
使用此模板可以创建虚拟 WAN 资源,包括虚拟 WAN、虚拟中心、VPN 网关、VPN 站点和 VPN Connecton。 |
若要创建 Microsoft.Network/vpnSites 资源,请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.Network/vpnSites@2018-12-01' = {
location: 'string'
name: 'string'
properties: {
addressSpace: {
addressPrefixes: [
'string'
]
}
bgpProperties: {
asn: int
bgpPeeringAddress: 'string'
peerWeight: int
}
deviceProperties: {
deviceModel: 'string'
deviceVendor: 'string'
linkSpeedInMbps: int
}
ipAddress: 'string'
isSecuritySite: bool
provisioningState: 'string'
siteKey: 'string'
virtualWan: {
id: 'string'
}
}
tags: {
{customized property}: 'string'
}
}
属性值
Microsoft.Network/vpnSites
| 名字 |
描述 |
价值 |
| 位置 |
资源位置。 |
字符串 |
| 名字 |
资源名称 |
string (必需) |
| 性能 |
VpnSite 的参数 |
VpnSiteProperties |
| 标签 |
资源标记 |
标记名称和值的字典。 请参阅模板 中的 标记 |
地址空间
| 名字 |
描述 |
价值 |
| address前缀 |
CIDR 表示法中为此虚拟网络保留的地址块列表。 |
字符串[] |
Bgp设置
| 名字 |
描述 |
价值 |
| ASN |
BGP 扬声器的 ASN。 |
整数 (int) |
| bgp对等地址 |
此 BGP 扬声器的 BGP 对等互连地址和 BGP 标识符。 |
字符串 |
| peerWeight |
添加到从此 BGP 扬声器中学习的路由的权重。 |
整数 (int) |
设备属性
| 名字 |
描述 |
价值 |
| 设备型号 |
设备的型号。 |
字符串 |
| deviceVendor 设备供应商 |
设备供应商的名称。 |
字符串 |
| 链路速度(以Mbps为单位) |
链接速度。 |
整数 (int) |
子资源
VpnSiteProperties
| 名字 |
描述 |
价值 |
| 地址空间 |
包含 IP 地址范围的数组的 AddressSpace。 |
地址空间 |
| bgp属性 |
bgp 属性集。 |
Bgp设置 |
| deviceProperties |
设备属性 |
设备属性 |
| IP地址 |
vpn 站点的 IP 地址。 |
字符串 |
| isSecuritySite |
IsSecuritySite 标志 |
布尔 |
| provisioningState |
资源的预配状态。 |
“删除” “Failed” “Succeeded” “正在更新” |
| siteKey |
可用于连接的 vpn 站点的密钥。 |
字符串 |
| 虚拟 Wan |
vpnSite 所属的 VirtualWAN |
子资源 |
ARM 模板资源定义
可以使用目标操作部署 vpnSites 资源类型:
用法示例
Azure 快速入门模板
以下 Azure 快速入门模板 部署此资源类型。
| 模板 |
描述 |
创建虚拟 WAN 资源
|
使用此模板可以创建虚拟 WAN 资源,包括虚拟 WAN、虚拟中心、VPN 网关、VPN 站点和 VPN Connecton。 |
若要创建 Microsoft.Network/vpnSites 资源,请将以下 JSON 添加到模板。
{
"type": "Microsoft.Network/vpnSites",
"apiVersion": "2018-12-01",
"name": "string",
"location": "string",
"properties": {
"addressSpace": {
"addressPrefixes": [ "string" ]
},
"bgpProperties": {
"asn": "int",
"bgpPeeringAddress": "string",
"peerWeight": "int"
},
"deviceProperties": {
"deviceModel": "string",
"deviceVendor": "string",
"linkSpeedInMbps": "int"
},
"ipAddress": "string",
"isSecuritySite": "bool",
"provisioningState": "string",
"siteKey": "string",
"virtualWan": {
"id": "string"
}
},
"tags": {
"{customized property}": "string"
}
}
属性值
Microsoft.Network/vpnSites
| 名字 |
描述 |
价值 |
| apiVersion |
API 版本 |
'2018-12-01' |
| 位置 |
资源位置。 |
字符串 |
| 名字 |
资源名称 |
string (必需) |
| 性能 |
VpnSite 的参数 |
VpnSiteProperties |
| 标签 |
资源标记 |
标记名称和值的字典。 请参阅模板 中的 标记 |
| 类型 |
资源类型 |
“Microsoft.Network/vpnSites” |
地址空间
| 名字 |
描述 |
价值 |
| address前缀 |
CIDR 表示法中为此虚拟网络保留的地址块列表。 |
字符串[] |
Bgp设置
| 名字 |
描述 |
价值 |
| ASN |
BGP 扬声器的 ASN。 |
整数 (int) |
| bgp对等地址 |
此 BGP 扬声器的 BGP 对等互连地址和 BGP 标识符。 |
字符串 |
| peerWeight |
添加到从此 BGP 扬声器中学习的路由的权重。 |
整数 (int) |
设备属性
| 名字 |
描述 |
价值 |
| 设备型号 |
设备的型号。 |
字符串 |
| deviceVendor 设备供应商 |
设备供应商的名称。 |
字符串 |
| 链路速度(以Mbps为单位) |
链接速度。 |
整数 (int) |
子资源
VpnSiteProperties
| 名字 |
描述 |
价值 |
| 地址空间 |
包含 IP 地址范围的数组的 AddressSpace。 |
地址空间 |
| bgp属性 |
bgp 属性集。 |
Bgp设置 |
| deviceProperties |
设备属性 |
设备属性 |
| IP地址 |
vpn 站点的 IP 地址。 |
字符串 |
| isSecuritySite |
IsSecuritySite 标志 |
布尔 |
| provisioningState |
资源的预配状态。 |
“删除” “Failed” “Succeeded” “正在更新” |
| siteKey |
可用于连接的 vpn 站点的密钥。 |
字符串 |
| 虚拟 Wan |
vpnSite 所属的 VirtualWAN |
子资源 |
可以使用目标操作部署 vpnSites 资源类型:
-
资源组 关于每个API版本中变更属性的列表,请参见 更改日志。
用法示例
部署 VPN 站点的基本示例。
terraform {
required_providers {
azapi = {
source = "Azure/azapi"
}
}
}
provider "azapi" {
skip_provider_registration = false
}
variable "resource_name" {
type = string
default = "acctest0001"
}
variable "location" {
type = string
default = "westeurope"
}
resource "azapi_resource" "resourceGroup" {
type = "Microsoft.Resources/resourceGroups@2020-06-01"
name = var.resource_name
location = var.location
}
resource "azapi_resource" "virtualWan" {
type = "Microsoft.Network/virtualWans@2022-07-01"
parent_id = azapi_resource.resourceGroup.id
name = var.resource_name
location = var.location
body = {
properties = {
allowBranchToBranchTraffic = true
disableVpnEncryption = false
office365LocalBreakoutCategory = "None"
type = "Standard"
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}
resource "azapi_resource" "vpnSite" {
type = "Microsoft.Network/vpnSites@2022-07-01"
parent_id = azapi_resource.resourceGroup.id
name = var.resource_name
location = var.location
body = {
properties = {
addressSpace = {
addressPrefixes = [
"10.0.1.0/24",
]
}
virtualWan = {
id = azapi_resource.virtualWan.id
}
vpnSiteLinks = [
{
name = "link1"
properties = {
fqdn = ""
ipAddress = "10.0.1.1"
linkProperties = {
linkProviderName = ""
linkSpeedInMbps = 0
}
}
},
{
name = "link2"
properties = {
fqdn = ""
ipAddress = "10.0.1.2"
linkProperties = {
linkProviderName = ""
linkSpeedInMbps = 0
}
}
},
]
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}
若要创建 Microsoft.Network/vpnSites 资源,请将以下 Terraform 添加到模板中。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Network/vpnSites@2018-12-01"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
addressSpace = {
addressPrefixes = [
"string"
]
}
bgpProperties = {
asn = int
bgpPeeringAddress = "string"
peerWeight = int
}
deviceProperties = {
deviceModel = "string"
deviceVendor = "string"
linkSpeedInMbps = int
}
ipAddress = "string"
isSecuritySite = bool
provisioningState = "string"
siteKey = "string"
virtualWan = {
id = "string"
}
}
}
}
属性值
Microsoft.Network/vpnSites
| 名字 |
描述 |
价值 |
| 位置 |
资源位置。 |
字符串 |
| 名字 |
资源名称 |
string (必需) |
| 性能 |
VpnSite 的参数 |
VpnSiteProperties |
| 标签 |
资源标记 |
标记名称和值的字典。 |
| 类型 |
资源类型 |
“Microsoft.Network/vpnSites@2018-12-01” |
地址空间
| 名字 |
描述 |
价值 |
| address前缀 |
CIDR 表示法中为此虚拟网络保留的地址块列表。 |
字符串[] |
Bgp设置
| 名字 |
描述 |
价值 |
| ASN |
BGP 扬声器的 ASN。 |
整数 (int) |
| bgp对等地址 |
此 BGP 扬声器的 BGP 对等互连地址和 BGP 标识符。 |
字符串 |
| peerWeight |
添加到从此 BGP 扬声器中学习的路由的权重。 |
整数 (int) |
设备属性
| 名字 |
描述 |
价值 |
| 设备型号 |
设备的型号。 |
字符串 |
| deviceVendor 设备供应商 |
设备供应商的名称。 |
字符串 |
| 链路速度(以Mbps为单位) |
链接速度。 |
整数 (int) |
子资源
VpnSiteProperties
| 名字 |
描述 |
价值 |
| 地址空间 |
包含 IP 地址范围的数组的 AddressSpace。 |
地址空间 |
| bgp属性 |
bgp 属性集。 |
Bgp设置 |
| deviceProperties |
设备属性 |
设备属性 |
| IP地址 |
vpn 站点的 IP 地址。 |
字符串 |
| isSecuritySite |
IsSecuritySite 标志 |
布尔 |
| provisioningState |
资源的预配状态。 |
“删除” “Failed” “Succeeded” “正在更新” |
| siteKey |
可用于连接的 vpn 站点的密钥。 |
字符串 |
| 虚拟 Wan |
vpnSite 所属的 VirtualWAN |
子资源 |