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 VPN |
此範本可讓您在具有 VPN 閘道的兩個 VNet 之間部署站對站 VPN，以使用 BGP 設定主動-主動。 每個 Azure VPN 閘道都會解析遠端對等的 FQDN，以判斷遠端 VPN 閘道的公用 IP。 範本會在具有可用性區域的 Azure 區域中如預期般執行。 |
|
使用 Azure 防火牆作為中樞 & 輪輻拓撲中的 DNS Proxy |
此範例示範如何使用 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 |
取得唯一的唯一 |
字串 |
| 位置 |
資源位置 |
字串 |
| 名字 |
資源名稱 |
字串 （必要） |
| 性能 |
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 後端 App Service 環境
|
此範本會建立具有 Azure SQL 後端的 App Service 環境，以及私人端點，以及通常用於私人/隔離環境中的相關聯資源。 |
BOSH CF 跨區域
|
此範本可協助您設定在 Azure 上兩個區域部署 BOSH 和 Cloud Foundry 所需的資源。 |
將 ExpressRoute 線路連線至 VNET
|
此範本會建立 VNET、ExpresRoute 閘道，以及已設定 AzurePrivatePeering 的已佈建和已啟用 ExpressRoute 線路的連線。 |
建立 BGP VNET 對 VNET 連線
|
此範本可讓您使用虛擬網路閘道和 BGP 連線兩個 VNET |
使用 P2S VPN 和 IIS 建立 DevTest 環境
|
此範本會在 Windows 伺服器上建立具有點對站 VPN 和 IIS 的簡單 DevTest 環境，這是開始使用的絕佳方式。 |
建立點對站網關
|
此範本可讓您使用 VirtualNetworkGateways 建立點對站連線 |
使用 Azure AD 建立點對站閘道
|
此範本會部署使用 Azure Active Directory 點對站聯機設定的 VPN 虛擬網路閘道 |
建立站對站 VPN 連線
|
此範本可讓您使用虛擬網路閘道建立站對站 VPN 連線 |
使用 VM 建立站對站 VPN 連線
|
此範本可讓您使用虛擬網路閘道建立站對站 VPN 連線 |
跨兩個區域建立 VNET 對 VNET 連線
|
此範本可讓您使用虛擬網路閘道連接不同區域中的兩個 VNET |
建立已設定點對站連線的 SQL MI
|
部署針對新虛擬網路內點對站連線所設定的 Azure Sql Database 受控實例 （SQL MI） 和虛擬網路網關。 |
建立三個 vNet 來示範可轉移的 BGP 連線
|
此範本會部署三個使用虛擬網路閘道和已啟用 BGP 連線的 vNet |
建立具有兩個子網、局域網路和閘道 的 VNet
|
此範本會建立 VNet、2 個子網和閘道 |
部署中樞和輪輻拓撲沙盒
|
此範本會建立基本的中樞和輪輻拓撲設定。 它會建立具有 DMZ、管理、共用和閘道子網的中樞 VNet（選擇性），其中兩個輪輻 VNet（開發和生產環境）包含每個工作負載子網。 它也會在中樞的管理子網上部署 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 VPN
|
此範本可讓您在具有 VPN 閘道的兩個 VNet 之間部署站對站 VPN，以使用 BGP 設定主動-主動。 每個 Azure VPN 閘道都會解析遠端對等的 FQDN，以判斷遠端 VPN 閘道的公用 IP。 範本會在具有可用性區域的 Azure 區域中如預期般執行。 |
使用 Azure 防火牆作為中樞 & 輪輻拓撲中的 DNS Proxy
|
此範例示範如何使用 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 |
取得唯一的唯一 |
字串 |
| 位置 |
資源位置 |
字串 |
| 名字 |
資源名稱 |
字串 （必要） |
| 性能 |
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 |
取得或設定憑證公用數據 |
字串 |