你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Microsoft.Network vpnSites 2020-08-01
Bicep 资源定义
可以使用目标操作部署 vpnSites 资源类型：
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
若要创建 Microsoft.Network/vpnSites 资源，请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.Network/vpnSites@2020-08-01' = {
location: 'string'
name: 'string'
properties: {
addressSpace: {
addressPrefixes: [
'string'
]
}
bgpProperties: {
asn: int
bgpPeeringAddress: 'string'
bgpPeeringAddresses: [
{
customBgpIpAddresses: [
'string'
]
ipconfigurationId: 'string'
}
]
peerWeight: int
}
deviceProperties: {
deviceModel: 'string'
deviceVendor: 'string'
linkSpeedInMbps: int
}
ipAddress: 'string'
isSecuritySite: bool
o365Policy: {
breakOutCategories: {
allow: bool
default: bool
optimize: bool
}
}
siteKey: 'string'
virtualWan: {
id: 'string'
}
vpnSiteLinks: [
{
id: 'string'
name: 'string'
properties: {
bgpProperties: {
asn: int
bgpPeeringAddress: 'string'
}
fqdn: 'string'
ipAddress: 'string'
linkProperties: {
linkProviderName: 'string'
linkSpeedInMbps: int
}
}
}
]
}
tags: {
{customized property}: 'string'
}
}
属性值
AddressSpace
| 名字 |
描述 |
价值 |
| addressPrefixes |
CIDR 表示法中为此虚拟网络保留的地址块列表。 |
string[] |
BgpSettings
| 名字 |
描述 |
价值 |
| asn |
BGP 扬声器的 ASN。 |
int
约束：
最小值 = 0
最大值 = 4294967295 |
| bgpPeeringAddress |
此 BGP 扬声器的 BGP 对等互连地址和 BGP 标识符。 |
字符串 |
| bgpPeeringAddresses |
具有虚拟网络网关 IP 配置 ID 的 BGP 对等互连地址。 |
IPConfigurationBgpPeeringAddress[] |
| peerWeight |
添加到从此 BGP 扬声器中学习的路由的权重。 |
int |
DeviceProperties
| 名字 |
描述 |
价值 |
| deviceModel |
设备的型号。 |
字符串 |
| deviceVendor |
设备供应商的名称。 |
字符串 |
| linkSpeedInMbps |
链接速度。 |
int |
IPConfigurationBgpPeeringAddress
| 名字 |
描述 |
价值 |
| customBgpIpAddresses |
属于 IP 配置的自定义 BGP 对等互连地址的列表。 |
string[] |
| ipconfigurationId |
属于网关的 IP 配置的 ID。 |
字符串 |
Microsoft.Network/vpnSites
| 名字 |
描述 |
价值 |
| 位置 |
资源位置。 |
字符串 |
| 名字 |
资源名称 |
string （必需） |
| 性能 |
VPN 站点的属性。 |
VpnSiteProperties |
| 标签 |
资源标记 |
标记名称和值的字典。 请参阅模板 中的 标记 |
O365BreakOutCategoryPolicies
| 名字 |
描述 |
价值 |
| 允许 |
用于控制允许类别的标志。 |
bool |
| 违约 |
用于控制默认类别的标志。 |
bool |
| 优化 |
用于控制优化类别的标志。 |
bool |
O365PolicyProperties
SubResource
VpnLinkBgpSettings
| 名字 |
描述 |
价值 |
| asn |
BGP 扬声器的 ASN。 |
int |
| bgpPeeringAddress |
此 BGP 扬声器的 BGP 对等互连地址和 BGP 标识符。 |
字符串 |
VpnLinkProviderProperties
| 名字 |
描述 |
价值 |
| linkProviderName |
链接提供程序的名称。 |
字符串 |
| linkSpeedInMbps |
链接速度。 |
int |
VpnSiteLink
VpnSiteLinkProperties
VpnSiteProperties
快速入门示例
以下快速入门示例部署此资源类型。
| Bicep 文件 |
描述 |
|
创建虚拟 WAN 资源 |
使用此模板可以创建虚拟 WAN 资源，包括虚拟 WAN、虚拟中心、VPN 网关、VPN 站点和 VPN Connecton。 |
ARM 模板资源定义
可以使用目标操作部署 vpnSites 资源类型：
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
若要创建 Microsoft.Network/vpnSites 资源，请将以下 JSON 添加到模板。
{
"type": "Microsoft.Network/vpnSites",
"apiVersion": "2020-08-01",
"name": "string",
"location": "string",
"properties": {
"addressSpace": {
"addressPrefixes": [ "string" ]
},
"bgpProperties": {
"asn": "int",
"bgpPeeringAddress": "string",
"bgpPeeringAddresses": [
{
"customBgpIpAddresses": [ "string" ],
"ipconfigurationId": "string"
}
],
"peerWeight": "int"
},
"deviceProperties": {
"deviceModel": "string",
"deviceVendor": "string",
"linkSpeedInMbps": "int"
},
"ipAddress": "string",
"isSecuritySite": "bool",
"o365Policy": {
"breakOutCategories": {
"allow": "bool",
"default": "bool",
"optimize": "bool"
}
},
"siteKey": "string",
"virtualWan": {
"id": "string"
},
"vpnSiteLinks": [
{
"id": "string",
"name": "string",
"properties": {
"bgpProperties": {
"asn": "int",
"bgpPeeringAddress": "string"
},
"fqdn": "string",
"ipAddress": "string",
"linkProperties": {
"linkProviderName": "string",
"linkSpeedInMbps": "int"
}
}
}
]
},
"tags": {
"{customized property}": "string"
}
}
属性值
AddressSpace
| 名字 |
描述 |
价值 |
| addressPrefixes |
CIDR 表示法中为此虚拟网络保留的地址块列表。 |
string[] |
BgpSettings
| 名字 |
描述 |
价值 |
| asn |
BGP 扬声器的 ASN。 |
int
约束：
最小值 = 0
最大值 = 4294967295 |
| bgpPeeringAddress |
此 BGP 扬声器的 BGP 对等互连地址和 BGP 标识符。 |
字符串 |
| bgpPeeringAddresses |
具有虚拟网络网关 IP 配置 ID 的 BGP 对等互连地址。 |
IPConfigurationBgpPeeringAddress[] |
| peerWeight |
添加到从此 BGP 扬声器中学习的路由的权重。 |
int |
DeviceProperties
| 名字 |
描述 |
价值 |
| deviceModel |
设备的型号。 |
字符串 |
| deviceVendor |
设备供应商的名称。 |
字符串 |
| linkSpeedInMbps |
链接速度。 |
int |
IPConfigurationBgpPeeringAddress
| 名字 |
描述 |
价值 |
| customBgpIpAddresses |
属于 IP 配置的自定义 BGP 对等互连地址的列表。 |
string[] |
| ipconfigurationId |
属于网关的 IP 配置的 ID。 |
字符串 |
Microsoft.Network/vpnSites
| 名字 |
描述 |
价值 |
| apiVersion |
API 版本 |
'2020-08-01' |
| 位置 |
资源位置。 |
字符串 |
| 名字 |
资源名称 |
string （必需） |
| 性能 |
VPN 站点的属性。 |
VpnSiteProperties |
| 标签 |
资源标记 |
标记名称和值的字典。 请参阅模板 中的 标记 |
| 类型 |
资源类型 |
“Microsoft.Network/vpnSites” |
O365BreakOutCategoryPolicies
| 名字 |
描述 |
价值 |
| 允许 |
用于控制允许类别的标志。 |
bool |
| 违约 |
用于控制默认类别的标志。 |
bool |
| 优化 |
用于控制优化类别的标志。 |
bool |
O365PolicyProperties
SubResource
VpnLinkBgpSettings
| 名字 |
描述 |
价值 |
| asn |
BGP 扬声器的 ASN。 |
int |
| bgpPeeringAddress |
此 BGP 扬声器的 BGP 对等互连地址和 BGP 标识符。 |
字符串 |
VpnLinkProviderProperties
| 名字 |
描述 |
价值 |
| linkProviderName |
链接提供程序的名称。 |
字符串 |
| linkSpeedInMbps |
链接速度。 |
int |
VpnSiteLink
VpnSiteLinkProperties
VpnSiteProperties
快速入门模板
以下快速入门模板部署此资源类型。
| 模板 |
描述 |
创建虚拟 WAN 资源
|
使用此模板可以创建虚拟 WAN 资源，包括虚拟 WAN、虚拟中心、VPN 网关、VPN 站点和 VPN Connecton。 |
可以使用目标操作部署 vpnSites 资源类型：
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
若要创建 Microsoft.Network/vpnSites 资源，请将以下 Terraform 添加到模板中。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Network/vpnSites@2020-08-01"
name = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
addressSpace = {
addressPrefixes = [
"string"
]
}
bgpProperties = {
asn = int
bgpPeeringAddress = "string"
bgpPeeringAddresses = [
{
customBgpIpAddresses = [
"string"
]
ipconfigurationId = "string"
}
]
peerWeight = int
}
deviceProperties = {
deviceModel = "string"
deviceVendor = "string"
linkSpeedInMbps = int
}
ipAddress = "string"
isSecuritySite = bool
o365Policy = {
breakOutCategories = {
allow = bool
default = bool
optimize = bool
}
}
siteKey = "string"
virtualWan = {
id = "string"
}
vpnSiteLinks = [
{
id = "string"
name = "string"
properties = {
bgpProperties = {
asn = int
bgpPeeringAddress = "string"
}
fqdn = "string"
ipAddress = "string"
linkProperties = {
linkProviderName = "string"
linkSpeedInMbps = int
}
}
}
]
}
})
}
属性值
AddressSpace
| 名字 |
描述 |
价值 |
| addressPrefixes |
CIDR 表示法中为此虚拟网络保留的地址块列表。 |
string[] |
BgpSettings
| 名字 |
描述 |
价值 |
| asn |
BGP 扬声器的 ASN。 |
int
约束：
最小值 = 0
最大值 = 4294967295 |
| bgpPeeringAddress |
此 BGP 扬声器的 BGP 对等互连地址和 BGP 标识符。 |
字符串 |
| bgpPeeringAddresses |
具有虚拟网络网关 IP 配置 ID 的 BGP 对等互连地址。 |
IPConfigurationBgpPeeringAddress[] |
| peerWeight |
添加到从此 BGP 扬声器中学习的路由的权重。 |
int |
DeviceProperties
| 名字 |
描述 |
价值 |
| deviceModel |
设备的型号。 |
字符串 |
| deviceVendor |
设备供应商的名称。 |
字符串 |
| linkSpeedInMbps |
链接速度。 |
int |
IPConfigurationBgpPeeringAddress
| 名字 |
描述 |
价值 |
| customBgpIpAddresses |
属于 IP 配置的自定义 BGP 对等互连地址的列表。 |
string[] |
| ipconfigurationId |
属于网关的 IP 配置的 ID。 |
字符串 |
Microsoft.Network/vpnSites
| 名字 |
描述 |
价值 |
| 位置 |
资源位置。 |
字符串 |
| 名字 |
资源名称 |
string （必需） |
| 性能 |
VPN 站点的属性。 |
VpnSiteProperties |
| 标签 |
资源标记 |
标记名称和值的字典。 |
| 类型 |
资源类型 |
“Microsoft.Network/vpnSites@2020-08-01” |
O365BreakOutCategoryPolicies
| 名字 |
描述 |
价值 |
| 允许 |
用于控制允许类别的标志。 |
bool |
| 违约 |
用于控制默认类别的标志。 |
bool |
| 优化 |
用于控制优化类别的标志。 |
bool |
O365PolicyProperties
SubResource
VpnLinkBgpSettings
| 名字 |
描述 |
价值 |
| asn |
BGP 扬声器的 ASN。 |
int |
| bgpPeeringAddress |
此 BGP 扬声器的 BGP 对等互连地址和 BGP 标识符。 |
字符串 |
VpnLinkProviderProperties
| 名字 |
描述 |
价值 |
| linkProviderName |
链接提供程序的名称。 |
字符串 |
| linkSpeedInMbps |
链接速度。 |
int |
VpnSiteLink
VpnSiteLinkProperties
VpnSiteProperties