Microsoft.Network vpnGateways 2018-11-01
- 最新
- 2024-03-01
- 2024-01-01
- 2023-11-01
- 2023-09-01
- 2023-06-01
- 2023-05-01
- 2023-04-01
- 2023-02-01
- 2022-11-01
- 2022-09-01
- 2022-07-01
- 2022-05-01
- 2022-01-01
- 2021-08-01
- 2021-05-01
- 2021-03-01
- 2021-02-01
- 2020-11-01
- 2020-08-01
- 2020-07-01
- 2020-06-01
- 2020-05-01
- 2020-04-01
- 2020-03-01
- 2019-12-01
- 2019-11-01
- 2019-09-01
- 2019-08-01
- 2019-07-01
- 2019-06-01
- 2019-04-01
- 2019-02-01
- 2018-12-01
- 2018-11-01
- 2018-10-01
- 2018-08-01
- 2018-07-01
- 2018-06-01
- 2018-04-01
Bicep 資源定義
vpnGateways 資源類型可以使用目標作業來部署：
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.Network/vpnGateways 資源，請將下列 Bicep 新增至範本。
resource symbolicname 'Microsoft.Network/vpnGateways@2018-11-01' = {
location: 'string'
name: 'string'
properties: {
bgpSettings: {
asn: int
bgpPeeringAddress: 'string'
peerWeight: int
}
connections: [
{
id: 'string'
name: 'string'
properties: {
connectionBandwidth: int
enableBgp: bool
enableInternetSecurity: bool
enableRateLimiting: bool
ipsecPolicies: [
{
dhGroup: 'string'
ikeEncryption: 'string'
ikeIntegrity: 'string'
ipsecEncryption: 'string'
ipsecIntegrity: 'string'
pfsGroup: 'string'
saDataSizeKilobytes: int
saLifeTimeSeconds: int
}
]
provisioningState: 'string'
remoteVpnSite: {
id: 'string'
}
routingWeight: int
sharedKey: 'string'
vpnConnectionProtocolType: 'string'
}
}
]
provisioningState: 'string'
virtualHub: {
id: 'string'
}
vpnGatewayScaleUnit: int
}
tags: {
{customized property}: 'string'
}
}
屬性值
BgpSettings
| 名字 | 描述 | 價值 |
|---|---|---|
| asn | BGP 喇叭的 ASN。 | int |
| bgpPeeringAddress | 這個 BGP 說話者的 BGP 對等互連位址和 BGP 識別碼。 | 字串 |
| peerWeight | 新增至此 BGP 喇叭所學習路由的權數。 | int |
IpsecPolicy
| 名字 | 描述 | 價值 |
|---|---|---|
| dhGroup | 在 IKE 階段 1 中用於初始 SA 的 DH 群組。 | 'DHGroup1' 'DHGroup14' 'DHGroup2' 'DHGroup2048' 'DHGroup24' 'ECP256' 'ECP384' 'None' （必要） |
| ikeEncryption | IKE 加密演算法 （IKE 階段 2）。 | 'AES128' 'AES192' 'AES256' 'DES' 'DES3' 'GCMAES128' 'GCMAES256' （必要） |
| ikeIntegrity | IKE 完整性演算法 （IKE 階段 2）。 | 'GCMAES128' 'GCMAES256' 'MD5' 'SHA1' 'SHA256' 'SHA384' （必要） |
| ipsecEncryption | IPSec 加密演算法 （IKE 階段 1）。 | 'AES128' 'AES192' 'AES256' 'DES' 'DES3' 'GCMAES128' 'GCMAES192' 'GCMAES256' 'None' （必要） |
| ipsecIntegrity | IPSec 完整性演算法 （IKE 階段 1）。 | 'GCMAES128' 'GCMAES192' 'GCMAES256' 'MD5' 'SHA1' 'SHA256' （必要） |
| pfsGroup | IKE 階段 2 中用於新子 SA 的 Pfs 群組。 | 'ECP256' 'ECP384' 'None' 'PFS1' 'PFS14' 'PFS2' 'PFS2048' 'PFS24' 'PFSMM' （必要） |
| saDataSizeKilobytes | IPSec 安全性關聯 （也稱為快速模式或階段 2 SA） 承載大小 KB，適用於站對站 VPN 通道。 | int （必要） |
| saLifeTimeSeconds | IPSec 安全性關聯 （也稱為快速模式或階段 2 SA） 存留期，以秒為單位，用於站對站 VPN 通道。 | int （必要） |
Microsoft.Network/vpnGateways
| 名字 | 描述 | 價值 |
|---|---|---|
| 位置 | 資源位置。 | 字串 |
| 名字 | 資源名稱 | 字串 （必要） |
| 性能 | VpnGateway 的參數 | VpnGatewayProperties |
| 標籤 | 資源標籤 | 標記名稱和值的字典。 請參閱範本中的 標籤 |
ResourceTags
| 名字 | 描述 | 價值 |
|---|
SubResource
| 名字 | 描述 | 價值 |
|---|---|---|
| id | 資源標識碼。 | 字串 |
VpnConnection
| 名字 | 描述 | 價值 |
|---|---|---|
| id | 資源標識碼。 | 字串 |
| 名字 | 資源群組內唯一的資源名稱。 此名稱可用來存取資源。 | 字串 |
| 性能 | VpnConnection 的參數 | VpnConnectionProperties |
VpnConnectionProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| connectionBandwidth | MBPS 的預期頻寬。 | int |
| enableBgp | EnableBgp 旗標 | bool |
| enableInternetSecurity | 啟用因特網安全性 | bool |
| enableRateLimiting | EnableBgp 旗標 | bool |
| ipsecPolicies | 此連線所要考慮的IPSec原則。 | IpsecPolicy[] |
| provisioningState | 資源的布建狀態。 | '刪除' 'Failed' 'Succeeded' 'Updateing' |
| remoteVpnSite | 已連線 VPN 網站的識別碼。 | SubResource |
| routingWeight | VPN 連線的路由權數。 | int |
| sharedKey | VPN 連線的 SharedKey。 | 字串 |
| vpnConnectionProtocolType | 用於此連線的連接通訊協定 | 'IKEv1' 'IKEv2' |
VpnGatewayProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| bgpSettings | 局域網路閘道的 BGP 喇叭設定。 | BgpSettings |
| 連接 | 閘道的所有 VPN 連線清單。 | VpnConnection[] |
| provisioningState | 資源的布建狀態。 | '刪除' 'Failed' 'Succeeded' 'Updateing' |
| virtualHub | 網關所屬的 VirtualHub | SubResource |
| vpnGatewayScaleUnit | 此 VPN 閘道的縮放單位。 | int |
快速入門範例
下列快速入門範例會部署此資源類型。
| Bicep 檔案 | 描述 |
|---|---|
| 建立虛擬 WAN 資源 | 此範本可讓您建立虛擬 WAN 資源，包括虛擬 WAN、虛擬中樞、VPN 閘道、VPN 網站和 VPN Connecton。 |
ARM 樣本資源定義
vpnGateways 資源類型可以使用目標作業來部署：
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.Network/vpnGateways 資源，請將下列 JSON 新增至範本。
{
"type": "Microsoft.Network/vpnGateways",
"apiVersion": "2018-11-01",
"name": "string",
"location": "string",
"properties": {
"bgpSettings": {
"asn": "int",
"bgpPeeringAddress": "string",
"peerWeight": "int"
},
"connections": [
{
"id": "string",
"name": "string",
"properties": {
"connectionBandwidth": "int",
"enableBgp": "bool",
"enableInternetSecurity": "bool",
"enableRateLimiting": "bool",
"ipsecPolicies": [
{
"dhGroup": "string",
"ikeEncryption": "string",
"ikeIntegrity": "string",
"ipsecEncryption": "string",
"ipsecIntegrity": "string",
"pfsGroup": "string",
"saDataSizeKilobytes": "int",
"saLifeTimeSeconds": "int"
}
],
"provisioningState": "string",
"remoteVpnSite": {
"id": "string"
},
"routingWeight": "int",
"sharedKey": "string",
"vpnConnectionProtocolType": "string"
}
}
],
"provisioningState": "string",
"virtualHub": {
"id": "string"
},
"vpnGatewayScaleUnit": "int"
},
"tags": {
"{customized property}": "string"
}
}
屬性值
BgpSettings
| 名字 | 描述 | 價值 |
|---|---|---|
| asn | BGP 喇叭的 ASN。 | int |
| bgpPeeringAddress | 這個 BGP 說話者的 BGP 對等互連位址和 BGP 識別碼。 | 字串 |
| peerWeight | 新增至此 BGP 喇叭所學習路由的權數。 | int |
IpsecPolicy
| 名字 | 描述 | 價值 |
|---|---|---|
| dhGroup | 在 IKE 階段 1 中用於初始 SA 的 DH 群組。 | 'DHGroup1' 'DHGroup14' 'DHGroup2' 'DHGroup2048' 'DHGroup24' 'ECP256' 'ECP384' 'None' （必要） |
| ikeEncryption | IKE 加密演算法 （IKE 階段 2）。 | 'AES128' 'AES192' 'AES256' 'DES' 'DES3' 'GCMAES128' 'GCMAES256' （必要） |
| ikeIntegrity | IKE 完整性演算法 （IKE 階段 2）。 | 'GCMAES128' 'GCMAES256' 'MD5' 'SHA1' 'SHA256' 'SHA384' （必要） |
| ipsecEncryption | IPSec 加密演算法 （IKE 階段 1）。 | 'AES128' 'AES192' 'AES256' 'DES' 'DES3' 'GCMAES128' 'GCMAES192' 'GCMAES256' 'None' （必要） |
| ipsecIntegrity | IPSec 完整性演算法 （IKE 階段 1）。 | 'GCMAES128' 'GCMAES192' 'GCMAES256' 'MD5' 'SHA1' 'SHA256' （必要） |
| pfsGroup | IKE 階段 2 中用於新子 SA 的 Pfs 群組。 | 'ECP256' 'ECP384' 'None' 'PFS1' 'PFS14' 'PFS2' 'PFS2048' 'PFS24' 'PFSMM' （必要） |
| saDataSizeKilobytes | IPSec 安全性關聯 （也稱為快速模式或階段 2 SA） 承載大小 KB，適用於站對站 VPN 通道。 | int （必要） |
| saLifeTimeSeconds | IPSec 安全性關聯 （也稱為快速模式或階段 2 SA） 存留期，以秒為單位，用於站對站 VPN 通道。 | int （必要） |
Microsoft.Network/vpnGateways
| 名字 | 描述 | 價值 |
|---|---|---|
| apiVersion | API 版本 | '2018-11-01' |
| 位置 | 資源位置。 | 字串 |
| 名字 | 資源名稱 | 字串 （必要） |
| 性能 | VpnGateway 的參數 | VpnGatewayProperties |
| 標籤 | 資源標籤 | 標記名稱和值的字典。 請參閱範本中的 標籤 |
| 類型 | 資源類型 | 'Microsoft.Network/vpnGateways' |
ResourceTags
| 名字 | 描述 | 價值 |
|---|
SubResource
| 名字 | 描述 | 價值 |
|---|---|---|
| id | 資源標識碼。 | 字串 |
VpnConnection
| 名字 | 描述 | 價值 |
|---|---|---|
| id | 資源標識碼。 | 字串 |
| 名字 | 資源群組內唯一的資源名稱。 此名稱可用來存取資源。 | 字串 |
| 性能 | VpnConnection 的參數 | VpnConnectionProperties |
VpnConnectionProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| connectionBandwidth | MBPS 的預期頻寬。 | int |
| enableBgp | EnableBgp 旗標 | bool |
| enableInternetSecurity | 啟用因特網安全性 | bool |
| enableRateLimiting | EnableBgp 旗標 | bool |
| ipsecPolicies | 此連線所要考慮的IPSec原則。 | IpsecPolicy[] |
| provisioningState | 資源的布建狀態。 | '刪除' 'Failed' 'Succeeded' 'Updateing' |
| remoteVpnSite | 已連線 VPN 網站的識別碼。 | SubResource |
| routingWeight | VPN 連線的路由權數。 | int |
| sharedKey | VPN 連線的 SharedKey。 | 字串 |
| vpnConnectionProtocolType | 用於此連線的連接通訊協定 | 'IKEv1' 'IKEv2' |
VpnGatewayProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| bgpSettings | 局域網路閘道的 BGP 喇叭設定。 | BgpSettings |
| 連接 | 閘道的所有 VPN 連線清單。 | VpnConnection[] |
| provisioningState | 資源的布建狀態。 | '刪除' 'Failed' 'Succeeded' 'Updateing' |
| virtualHub | 網關所屬的 VirtualHub | SubResource |
| vpnGatewayScaleUnit | 此 VPN 閘道的縮放單位。 | int |
快速入門範本
下列快速入門範本會部署此資源類型。
| 範本 | 描述 |
|---|---|
Azure 虛擬 WAN （vWAN） 多中樞部署
|
此範本可讓您建立 Azure 虛擬 WAN （vWAN） 多中樞部署，包括所有閘道和 VNET 連線。 |
| 使用自定義路由表 Azure vWAN 多中樞部署
|
此範本可讓您建立 Azure 虛擬 WAN （vWAN） 多中樞部署，包括所有閘道和 VNET 連線，並示範路由表用於自定義路由的使用方式。 |
|
建立虛擬 WAN 資源
|
此範本可讓您建立虛擬 WAN 資源，包括虛擬 WAN、虛擬中樞、VPN 閘道、VPN 網站和 VPN Connecton。 |
Terraform （AzAPI 提供者） 資源定義
vpnGateways 資源類型可以使用目標作業來部署：
- 資源群組
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.Network/vpnGateways 資源，請將下列 Terraform 新增至範本。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Network/vpnGateways@2018-11-01"
name = "string"
location = "string"
body = jsonencode({
properties = {
bgpSettings = {
asn = int
bgpPeeringAddress = "string"
peerWeight = int
}
connections = [
{
id = "string"
name = "string"
properties = {
connectionBandwidth = int
enableBgp = bool
enableInternetSecurity = bool
enableRateLimiting = bool
ipsecPolicies = [
{
dhGroup = "string"
ikeEncryption = "string"
ikeIntegrity = "string"
ipsecEncryption = "string"
ipsecIntegrity = "string"
pfsGroup = "string"
saDataSizeKilobytes = int
saLifeTimeSeconds = int
}
]
provisioningState = "string"
remoteVpnSite = {
id = "string"
}
routingWeight = int
sharedKey = "string"
vpnConnectionProtocolType = "string"
}
}
]
provisioningState = "string"
virtualHub = {
id = "string"
}
vpnGatewayScaleUnit = int
}
})
tags = {
{customized property} = "string"
}
}
屬性值
BgpSettings
| 名字 | 描述 | 價值 |
|---|---|---|
| asn | BGP 喇叭的 ASN。 | int |
| bgpPeeringAddress | 這個 BGP 說話者的 BGP 對等互連位址和 BGP 識別碼。 | 字串 |
| peerWeight | 新增至此 BGP 喇叭所學習路由的權數。 | int |
IpsecPolicy
| 名字 | 描述 | 價值 |
|---|---|---|
| dhGroup | 在 IKE 階段 1 中用於初始 SA 的 DH 群組。 | 'DHGroup1' 'DHGroup14' 'DHGroup2' 'DHGroup2048' 'DHGroup24' 'ECP256' 'ECP384' 'None' （必要） |
| ikeEncryption | IKE 加密演算法 （IKE 階段 2）。 | 'AES128' 'AES192' 'AES256' 'DES' 'DES3' 'GCMAES128' 'GCMAES256' （必要） |
| ikeIntegrity | IKE 完整性演算法 （IKE 階段 2）。 | 'GCMAES128' 'GCMAES256' 'MD5' 'SHA1' 'SHA256' 'SHA384' （必要） |
| ipsecEncryption | IPSec 加密演算法 （IKE 階段 1）。 | 'AES128' 'AES192' 'AES256' 'DES' 'DES3' 'GCMAES128' 'GCMAES192' 'GCMAES256' 'None' （必要） |
| ipsecIntegrity | IPSec 完整性演算法 （IKE 階段 1）。 | 'GCMAES128' 'GCMAES192' 'GCMAES256' 'MD5' 'SHA1' 'SHA256' （必要） |
| pfsGroup | IKE 階段 2 中用於新子 SA 的 Pfs 群組。 | 'ECP256' 'ECP384' 'None' 'PFS1' 'PFS14' 'PFS2' 'PFS2048' 'PFS24' 'PFSMM' （必要） |
| saDataSizeKilobytes | IPSec 安全性關聯 （也稱為快速模式或階段 2 SA） 承載大小 KB，適用於站對站 VPN 通道。 | int （必要） |
| saLifeTimeSeconds | IPSec 安全性關聯 （也稱為快速模式或階段 2 SA） 存留期，以秒為單位，用於站對站 VPN 通道。 | int （必要） |
Microsoft.Network/vpnGateways
| 名字 | 描述 | 價值 |
|---|---|---|
| 位置 | 資源位置。 | 字串 |
| 名字 | 資源名稱 | 字串 （必要） |
| 性能 | VpnGateway 的參數 | VpnGatewayProperties |
| 標籤 | 資源標籤 | 標記名稱和值的字典。 |
| 類型 | 資源類型 | “Microsoft.Network/vpnGateways@2018-11-01” |
ResourceTags
| 名字 | 描述 | 價值 |
|---|
SubResource
| 名字 | 描述 | 價值 |
|---|---|---|
| id | 資源標識碼。 | 字串 |
VpnConnection
| 名字 | 描述 | 價值 |
|---|---|---|
| id | 資源標識碼。 | 字串 |
| 名字 | 資源群組內唯一的資源名稱。 此名稱可用來存取資源。 | 字串 |
| 性能 | VpnConnection 的參數 | VpnConnectionProperties |
VpnConnectionProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| connectionBandwidth | MBPS 的預期頻寬。 | int |
| enableBgp | EnableBgp 旗標 | bool |
| enableInternetSecurity | 啟用因特網安全性 | bool |
| enableRateLimiting | EnableBgp 旗標 | bool |
| ipsecPolicies | 此連線所要考慮的IPSec原則。 | IpsecPolicy[] |
| provisioningState | 資源的布建狀態。 | '刪除' 'Failed' 'Succeeded' 'Updateing' |
| remoteVpnSite | 已連線 VPN 網站的識別碼。 | SubResource |
| routingWeight | VPN 連線的路由權數。 | int |
| sharedKey | VPN 連線的 SharedKey。 | 字串 |
| vpnConnectionProtocolType | 用於此連線的連接通訊協定 | 'IKEv1' 'IKEv2' |
VpnGatewayProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| bgpSettings | 局域網路閘道的 BGP 喇叭設定。 | BgpSettings |
| 連接 | 閘道的所有 VPN 連線清單。 | VpnConnection[] |
| provisioningState | 資源的布建狀態。 | '刪除' 'Failed' 'Succeeded' 'Updateing' |
| virtualHub | 網關所屬的 VirtualHub | SubResource |
| vpnGatewayScaleUnit | 此 VPN 閘道的縮放單位。 | int |