Microsoft.Network vpnSites 2022-09-01
Bicep 資源定義
vpnSites 資源類型可以使用目標作業進行部署：
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
若要建立 Microsoft.Network/vpnSites 資源，請將下列 Bicep 新增至範本。
resource symbolicname 'Microsoft.Network/vpnSites@2022-09-01' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
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
}
}
}
]
}
}
屬性值
vpnSites
| 名稱 |
描述 |
值 |
| NAME |
資源名稱 |
需要字串 ()
字元限制：1-80
合法字元：
英數字元、底線、句號和連字號。
以英數字元開頭。 以英數字元或底線結尾。 |
| location |
資源位置。 |
字串 |
| tags |
資源標籤。 |
標記名稱和值的字典。 請參閱 範本中的標籤 |
| properties |
VPN 月臺的屬性。 |
VpnSiteProperties |
VpnSiteProperties
AddressSpace
| 名稱 |
描述 |
值 |
| addressPrefixes |
以 CIDR 表示法保留給此虛擬網路的位址區塊清單。 |
string[] |
BgpSettings
| 名稱 |
描述 |
值 |
| asn |
BGP 喇叭的 ASN。 |
int
約束：
最小值 = 0
最大值 = 4294967295
|
| bgpPeeringAddress |
此 BGP 說話者的 BGP 對等互連位址和 BGP 識別碼。 |
字串 |
| bgpPeeringAddresses |
具有虛擬網路閘道IP組態標識碼的 BGP 對等互連位址。 |
IPConfigurationBgpPeeringAddress[] |
| peerWeight |
新增至從此 BGP 喇叭學習路由的權數。 |
int |
IPConfigurationBgpPeeringAddress
| 名稱 |
描述 |
值 |
| customBgpIpAddresses |
屬於IP組態的自訂BGP對等互連位址清單。 |
string[] |
| ipconfigurationId |
屬於閘道的IP組態標識碼。 |
字串 |
DeviceProperties
| 名稱 |
描述 |
值 |
| deviceModel |
裝置的型號。 |
字串 |
| deviceVendor |
裝置廠商的名稱。 |
字串 |
| linkSpeedInMbps |
連結速度。 |
int |
O365PolicyProperties
O365BreakOutCategoryPolicies
| 名稱 |
描述 |
值 |
| allow |
控制允許類別的旗標。 |
bool |
| 預設 |
用來控制預設類別的旗標。 |
bool |
| optimize |
用來控制優化類別的旗標。 |
bool |
SubResource
VpnSiteLink
VpnSiteLinkProperties
VpnLinkBgpSettings
| 名稱 |
描述 |
值 |
| asn |
BGP 喇叭的 ASN。 |
int |
| bgpPeeringAddress |
此 BGP 說話者的 BGP 對等互連位址和 BGP 識別碼。 |
字串 |
VpnLinkProviderProperties
| 名稱 |
描述 |
值 |
| linkProviderName |
連結提供者的名稱。 |
字串 |
| linkSpeedInMbps |
連結速度。 |
int |
快速入門範本
下列快速入門範本會部署此資源類型。
| 範本 |
描述 |
建立 Virtual WAN 資源
 |
此範本可讓您建立虛擬 WAN 資源，包括 Virtual WAN、虛擬中樞、VPN 閘道、VPN 網站和 VPN Connecton。 |
ARM 範本資源定義
vpnSites 資源類型可以使用目標作業來部署：
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄。
若要建立 Microsoft.Network/vpnSites 資源，請將下列 JSON 新增至您的範本。
{
"type": "Microsoft.Network/vpnSites",
"apiVersion": "2022-09-01",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"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"
}
}
}
]
}
}
屬性值
vpnSites
| 名稱 |
描述 |
值 |
| 類型 |
資源類型 |
'Microsoft.Network/vpnSites' |
| apiVersion |
資源 API 版本 |
'2022-09-01' |
| NAME |
資源名稱 |
字串 (必要)
字元限制：1-80
合法字元：
英數字元、底線、句號和連字號。
以英數字元開頭。 以英數字元或底線結尾。 |
| location |
資源位置。 |
字串 |
| tags |
資源標籤。 |
標記名稱和值的字典。 請參閱 範本中的標記 |
| properties |
VPN 月臺的屬性。 |
VpnSiteProperties |
VpnSiteProperties
AddressSpace
| 名稱 |
描述 |
值 |
| addressPrefixes |
在 CIDR 表示法中保留給此虛擬網路的位址區塊清單。 |
string[] |
BgpSettings
| 名稱 |
描述 |
值 |
| asn |
BGP 說話者的 ASN。 |
int
約束：
最小值 = 0
最大值 = 4294967295
|
| bgpPeeringAddress |
這個 BGP 說話者的 BGP 對等互連位址和 BGP 識別碼。 |
字串 |
| bgpPeeringAddresses |
具有虛擬網路閘道IP組態標識碼的 BGP 對等互連位址。 |
IPConfigurationBgpPeeringAddress[] |
| peerWeight |
新增至從這個 BGP 說話者學到之路由的權數。 |
int |
IPConfigurationBgpPeeringAddress
| 名稱 |
描述 |
值 |
| customBgpIpAddresses |
屬於IP組態的自訂BGP對等互連位址清單。 |
string[] |
| ipconfigurationId |
屬於閘道的IP組態標識碼。 |
字串 |
DeviceProperties
| 名稱 |
描述 |
值 |
| deviceModel |
裝置的型號。 |
字串 |
| deviceVendor |
裝置廠商的名稱。 |
字串 |
| linkSpeedInMbps |
連結速度。 |
int |
O365PolicyProperties
O365BreakOutCategoryPolicies
| 名稱 |
描述 |
值 |
| allow |
要控制允許類別的旗標。 |
bool |
| 預設 |
用來控制預設類別的旗標。 |
bool |
| optimize |
用來控制優化類別的旗標。 |
bool |
SubResource
VpnSiteLink
VpnSiteLinkProperties
VpnLinkBgpSettings
| 名稱 |
描述 |
值 |
| asn |
BGP 說話者的 ASN。 |
int |
| bgpPeeringAddress |
這個 BGP 說話者的 BGP 對等互連位址和 BGP 識別碼。 |
字串 |
VpnLinkProviderProperties
| 名稱 |
描述 |
值 |
| linkProviderName |
連結提供者的名稱。 |
字串 |
| linkSpeedInMbps |
連結速度。 |
int |
快速入門範本
下列快速入門範本會部署此資源類型。
| 範本 |
描述 |
建立 Virtual WAN 資源
|
此範本可讓您建立虛擬 WAN 資源，包括 Virtual WAN、虛擬中樞、VPN 閘道、VPN 網站和 VPN Connecton。 |
vpnSites 資源類型可以使用目標作業進行部署：
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
若要建立 Microsoft.Network/vpnSites 資源，請將下列 Terraform 新增至您的範本。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Network/vpnSites@2022-09-01"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
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
}
}
}
]
}
})
}
屬性值
vpnSites
| 名稱 |
描述 |
值 |
| 類型 |
資源類型 |
“Microsoft.Network/vpnSites@2022-09-01” |
| NAME |
資源名稱 |
需要字串 ()
字元限制：1-80
合法字元：
英數字元、底線、句號和連字號。
以英數字元開頭。 以英數字元或底線結尾。 |
| location |
資源位置。 |
字串 |
| parent_id |
若要部署至資源群組，請使用該資源群組的標識碼。 |
需要字串 () |
| tags |
資源標籤。 |
標記名稱和值的字典。 |
| properties |
VPN 月臺的屬性。 |
VpnSiteProperties |
VpnSiteProperties
AddressSpace
| 名稱 |
描述 |
值 |
| addressPrefixes |
以 CIDR 表示法保留給此虛擬網路的位址區塊清單。 |
string[] |
BgpSettings
| 名稱 |
描述 |
值 |
| asn |
BGP 喇叭的 ASN。 |
int
約束：
最小值 = 0
最大值 = 4294967295
|
| bgpPeeringAddress |
此 BGP 說話者的 BGP 對等互連位址和 BGP 識別碼。 |
字串 |
| bgpPeeringAddresses |
具有虛擬網路閘道IP組態標識碼的 BGP 對等互連位址。 |
IPConfigurationBgpPeeringAddress[] |
| peerWeight |
新增至從此 BGP 喇叭學習路由的權數。 |
int |
IPConfigurationBgpPeeringAddress
| 名稱 |
描述 |
值 |
| customBgpIpAddresses |
屬於IP組態的自訂BGP對等互連位址清單。 |
string[] |
| ipconfigurationId |
屬於閘道的IP組態標識碼。 |
字串 |
DeviceProperties
| 名稱 |
描述 |
值 |
| deviceModel |
裝置的型號。 |
字串 |
| deviceVendor |
裝置廠商的名稱。 |
字串 |
| linkSpeedInMbps |
連結速度。 |
int |
O365PolicyProperties
O365BreakOutCategoryPolicies
| 名稱 |
描述 |
值 |
| allow |
控制允許類別的旗標。 |
bool |
| 預設 |
用來控制預設類別的旗標。 |
bool |
| optimize |
用來控制優化類別的旗標。 |
bool |
SubResource
VpnSiteLink
VpnSiteLinkProperties
VpnLinkBgpSettings
| 名稱 |
描述 |
值 |
| asn |
BGP 喇叭的 ASN。 |
int |
| bgpPeeringAddress |
此 BGP 說話者的 BGP 對等互連位址和 BGP 識別碼。 |
字串 |
VpnLinkProviderProperties
| 名稱 |
描述 |
值 |
| linkProviderName |
連結提供者的名稱。 |
字串 |
| linkSpeedInMbps |
連結速度。 |
int |