Microsoft.Network virtualNetworkGateways 2021-08-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
• 2018-02-01
• 2018-01-01
• 2017-11-01
• 2017-10-01
• 2017-09-01
• 2017-08-01
• 2017-06-01
• 2017-03-30
• 2017-03-01
• 2016-12-01
• 2016-09-01
• 2016-06-01
• 2016-03-30
• 2015-06-15
• 2015-05-01-preview

Bicep 資源定義

virtualNetworkGateways 資源類型可以使用目標作業來部署：

• 資源群組 - 請參閱 資源群組部署命令

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.Network/virtualNetworkGateways 資源，請將下列 Bicep 新增至範本。

resource symbolicname 'Microsoft.Network/virtualNetworkGateways@2021-08-01' = {
  extendedLocation: {
    name: 'string'
    type: 'string'
  }
  location: 'string'
  name: 'string'
  properties: {
    activeActive: bool
    bgpSettings: {
      asn: int
      bgpPeeringAddress: 'string'
      bgpPeeringAddresses: [
        {
          customBgpIpAddresses: [
            'string'
          ]
          ipconfigurationId: 'string'
        }
      ]
      peerWeight: int
    }
    customRoutes: {
      addressPrefixes: [
        'string'
      ]
    }
    disableIPSecReplayProtection: bool
    enableBgp: bool
    enableBgpRouteTranslationForNat: bool
    enableDnsForwarding: bool
    enablePrivateIpAddress: bool
    gatewayDefaultSite: {
      id: 'string'
    }
    gatewayType: 'string'
    ipConfigurations: [
      {
        id: 'string'
        name: 'string'
        properties: {
          privateIPAllocationMethod: 'string'
          publicIPAddress: {
            id: 'string'
          }
          subnet: {
            id: 'string'
          }
        }
      }
    ]
    natRules: [
      {
        id: 'string'
        name: 'string'
        properties: {
          externalMappings: [
            {
              addressSpace: 'string'
              portRange: 'string'
            }
          ]
          internalMappings: [
            {
              addressSpace: 'string'
              portRange: 'string'
            }
          ]
          ipConfigurationId: 'string'
          mode: 'string'
          type: 'string'
        }
      }
    ]
    sku: {
      name: 'string'
      tier: 'string'
    }
    vNetExtendedLocationResourceId: 'string'
    vpnClientConfiguration: {
      aadAudience: 'string'
      aadIssuer: 'string'
      aadTenant: 'string'
      radiusServerAddress: 'string'
      radiusServers: [
        {
          radiusServerAddress: 'string'
          radiusServerScore: int
          radiusServerSecret: 'string'
        }
      ]
      radiusServerSecret: 'string'
      vpnAuthenticationTypes: [
        'string'
      ]
      vpnClientAddressPool: {
        addressPrefixes: [
          'string'
        ]
      }
      vpnClientIpsecPolicies: [
        {
          dhGroup: 'string'
          ikeEncryption: 'string'
          ikeIntegrity: 'string'
          ipsecEncryption: 'string'
          ipsecIntegrity: 'string'
          pfsGroup: 'string'
          saDataSizeKilobytes: int
          saLifeTimeSeconds: int
        }
      ]
      vpnClientProtocols: [
        'string'
      ]
      vpnClientRevokedCertificates: [
        {
          id: 'string'
          name: 'string'
          properties: {
            thumbprint: 'string'
          }
        }
      ]
      vpnClientRootCertificates: [
        {
          id: 'string'
          name: 'string'
          properties: {
            publicCertData: 'string'
          }
        }
      ]
    }
    vpnGatewayGeneration: 'string'
    vpnType: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

屬性值

AddressSpace

名字	描述	價值
addressPrefixes	以 CIDR 表示法保留給此虛擬網路的位址區塊清單。	string[]

BgpSettings

名字	描述	價值
asn	BGP 喇叭的 ASN。	int 約束： 最小值 = 0 最大值 = 4294967295
bgpPeeringAddress	這個 BGP 說話者的 BGP 對等互連位址和 BGP 識別碼。	字串
bgpPeeringAddresses	具有虛擬網路閘道IP組態標識碼的 BGP 對等互連位址。	IPConfigurationBgpPeeringAddress[]
peerWeight	新增至此 BGP 喇叭所學習路由的權數。	int

ExtendedLocation

名字	描述	價值
名字	擴充位置的名稱。	字串
類型	擴充位置的類型。	'EdgeZone'

IPConfigurationBgpPeeringAddress

名字	描述	價值
customBgpIpAddresses	屬於IP組態的自訂BGP對等互連位址清單。	string[]
ipconfigurationId	屬於閘道的IP組態標識碼。	字串

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/virtualNetworkGateways

名字	描述	價值
extendedLocation	本機虛擬網路閘道類型的擴充位置。	ExtendedLocation
位置	資源位置。	字串
名字	資源名稱	字串 （必要）
性能	虛擬網路閘道的屬性。	VirtualNetworkGatewayPropertiesFormat （必要）
標籤	資源標籤	標記名稱和值的字典。 請參閱範本中的 標籤

RadiusServer

名字	描述	價值
radiusServerAddress	這個半徑伺服器的位址。	字串 （必要）
radiusServerScore	指派給這個半徑伺服器的初始分數。	int
radiusServerSecret	用於這個半徑伺服器的秘密。	字串

ResourceTags

名字	描述	價值

SubResource

名字	描述	價值
id	資源標識碼。	字串

VirtualNetworkGatewayIPConfiguration

名字	描述	價值
id	資源標識碼。	字串
名字	資源群組內唯一的資源名稱。 此名稱可用來存取資源。	字串
性能	虛擬網路閘道IP組態的屬性。	VirtualNetworkGatewayIPConfigurationPropertiesFormat

VirtualNetworkGatewayIPConfigurationPropertiesFormat

名字	描述	價值
privateIPAllocationMethod	私人IP位址配置方法。	'Dynamic' 'Static'
publicIPAddress	公用IP資源的參考。	SubResource
子	子網資源的參考。	SubResource

VirtualNetworkGatewayNatRule

名字	描述	價值
id	資源標識碼。	字串
名字	資源群組內唯一的資源名稱。 此名稱可用來存取資源。	字串
性能	虛擬網路閘道 NAT 規則的屬性。	VirtualNetworkGatewayNatRuleProperties

VirtualNetworkGatewayNatRuleProperties

名字	描述	價值
externalMappings	NAT 的私人IP位址外部對應。	VpnNatRuleMapping[]
internalMappings	NAT 的私人IP位址內部對應。	VpnNatRuleMapping[]
ipConfigurationId	此 NAT 規則適用的IP組態標識碼。	字串
模式	VPN NAT 的來源 NAT 方向。	'EgressSnat' 'IngressSnat'
類型	VPN NAT 的 NAT 規則類型。	'Dynamic' 'Static'

VirtualNetworkGatewayPropertiesFormat

名字	描述	價值
activeActive	ActiveActive 旗標。	bool
bgpSettings	虛擬網路閘道的 BGP 喇叭設定。	BgpSettings
customRoutes	位址空間資源的參考，代表客戶針對虛擬網路網關和 VpnClient 所指定的自定義路由地址空間。	AddressSpace
disableIPSecReplayProtection	disableIPSecReplayProtection 旗標。	bool
enableBgp	是否為此虛擬網路閘道啟用 BGP。	bool
enableBgpRouteTranslationForNat	EnableBgpRouteTranslationForNat 旗標。	bool
enableDnsForwarding	是否啟用 DNS 轉送。	bool
enablePrivateIpAddress	是否需要在此閘道上啟用私人IP以進行連線。	bool
gatewayDefaultSite	LocalNetworkGateway 資源的參考，代表具有預設路由的局域網路網站。 如果移除現有的默認網站設定，請指派 Null 值。	SubResource
gatewayType	此虛擬網路閘道的類型。	'ExpressRoute' 'LocalGateway' 'Vpn'
ipConfigurations	虛擬網路閘道的IP組態。	VirtualNetworkGatewayIPConfiguration[]
natRules	虛擬網路閘道的 NatRules。	VirtualNetworkGatewayNatRule[]
sku	VirtualNetworkGatewaySku 資源的參考，代表為虛擬網路網關選取的 SKU。	VirtualNetworkGatewaySku
vNetExtendedLocationResourceId	客戶 vnet 資源標識碼。本機閘道類型的 VirtualNetworkGateway 會與客戶 vnet 相關聯。	字串
vpnClientConfiguration	代表 P2S VpnClient 組態之 VpnClientConfiguration 資源的參考。	VpnClientConfiguration
vpnGatewayGeneration	此 VirtualNetworkGateway 的世代。 如果 gatewayType 不是 VPN，則必須是 None。	'Generation1' 'Generation2' 'None'
vpnType	此虛擬網路閘道的類型。	'PolicyBased' 'RouteBased'

VirtualNetworkGatewaySku

名字	描述	價值
名字	閘道 SKU 名稱。	'Basic' 'ErGw1AZ' 'ErGw2AZ' 'ErGw3AZ' 'HighPerformance' 'Standard' 'UltraPerformance' 'VpnGw1' 'VpnGw1AZ' 'VpnGw2' 'VpnGw2AZ' 'VpnGw3' 'VpnGw3AZ' 'VpnGw4' 'VpnGw4AZ' 'VpnGw5' 'VpnGw5AZ'
層	閘道 SKU 層。	'Basic' 'ErGw1AZ' 'ErGw2AZ' 'ErGw3AZ' 'HighPerformance' 'Standard' 'UltraPerformance' 'VpnGw1' 'VpnGw1AZ' 'VpnGw2' 'VpnGw2AZ' 'VpnGw3' 'VpnGw3AZ' 'VpnGw4' 'VpnGw4AZ' 'VpnGw5' 'VpnGw5AZ'

VpnClientConfiguration

名字	描述	價值
aadAudience	用於 AAD 驗證之 Vpn 用戶端連線的 VirtualNetworkGateway 資源的 AADAudience 屬性。	字串
aadIssuer	用於 AAD 驗證之 Vpn 用戶端連線的 VirtualNetworkGateway 資源的 AADIssuer 屬性。	字串
aadTenant	用於 AAD 驗證之 Vpn 用戶端連線的 VirtualNetworkGateway 資源的 AADTenant 屬性。	字串
radiusServerAddress	VPN 用戶端連線 VirtualNetworkGateway 資源的 radius 伺服器地址屬性。	字串
radiusServers	多個半徑伺服器組態的radiusServers屬性。	RadiusServer[]
radiusServerSecret	Vpn 用戶端連線的 VirtualNetworkGateway 資源的 radius 秘密屬性。	字串
vpnAuthenticationTypes	虛擬網路閘道的 VPN 驗證類型。	包含任何的字串數組： 'AAD' 'Certificate' 'Radius'
vpnClientAddressPool	地址空間資源的參考，代表 P2S VpnClient 的地址空間。	AddressSpace
vpnClientIpsecPolicies	虛擬網路閘道 P2S 用戶端的 VpnClientIpsecPolicies。	IpsecPolicy[]
vpnClientProtocols	虛擬網路閘道的 VpnClientProtocols。	包含任何的字串數組： 'IkeV2' 'OpenVPN' 'SSTP'
vpnClientRevokedCertificates	虛擬網路閘道的 VpnClientRevokedCertificate。	VpnClientRevokedCertificate[]
vpnClientRootCertificates	虛擬網路閘道的 VpnClientRootCertificate。	VpnClientRootCertificate[]

VpnClientRevokedCertificate

名字	描述	價值
id	資源標識碼。	字串
名字	資源群組內唯一的資源名稱。 此名稱可用來存取資源。	字串
性能	VPN 用戶端撤銷憑證的屬性。	VpnClientRevokedCertificatePropertiesFormat

VpnClientRevokedCertificatePropertiesFormat

名字	描述	價值
指紋	撤銷的 VPN 用戶端憑證指紋。	字串

VpnClientRootCertificate

名字	描述	價值
id	資源標識碼。	字串
名字	資源群組內唯一的資源名稱。 此名稱可用來存取資源。	字串
性能	vpn 用戶端跟證書的屬性。	VpnClientRootCertificatePropertiesFormat （必要）

VpnClientRootCertificatePropertiesFormat

名字	描述	價值
publicCertData	憑證公用數據。	字串 （必要）

VpnNatRuleMapping

名字	描述	價值
addressSpace	Vpn NatRule 對應的地址空間。	字串
portRange	Vpn NatRule 對應的埠範圍。	字串

快速入門範例

下列快速入門範例會部署此資源類型。

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": "2021-08-01",
  "name": "string",
  "extendedLocation": {
    "name": "string",
    "type": "string"
  },
  "location": "string",
  "properties": {
    "activeActive": "bool",
    "bgpSettings": {
      "asn": "int",
      "bgpPeeringAddress": "string",
      "bgpPeeringAddresses": [
        {
          "customBgpIpAddresses": [ "string" ],
          "ipconfigurationId": "string"
        }
      ],
      "peerWeight": "int"
    },
    "customRoutes": {
      "addressPrefixes": [ "string" ]
    },
    "disableIPSecReplayProtection": "bool",
    "enableBgp": "bool",
    "enableBgpRouteTranslationForNat": "bool",
    "enableDnsForwarding": "bool",
    "enablePrivateIpAddress": "bool",
    "gatewayDefaultSite": {
      "id": "string"
    },
    "gatewayType": "string",
    "ipConfigurations": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "privateIPAllocationMethod": "string",
          "publicIPAddress": {
            "id": "string"
          },
          "subnet": {
            "id": "string"
          }
        }
      }
    ],
    "natRules": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "externalMappings": [
            {
              "addressSpace": "string",
              "portRange": "string"
            }
          ],
          "internalMappings": [
            {
              "addressSpace": "string",
              "portRange": "string"
            }
          ],
          "ipConfigurationId": "string",
          "mode": "string",
          "type": "string"
        }
      }
    ],
    "sku": {
      "name": "string",
      "tier": "string"
    },
    "vNetExtendedLocationResourceId": "string",
    "vpnClientConfiguration": {
      "aadAudience": "string",
      "aadIssuer": "string",
      "aadTenant": "string",
      "radiusServerAddress": "string",
      "radiusServers": [
        {
          "radiusServerAddress": "string",
          "radiusServerScore": "int",
          "radiusServerSecret": "string"
        }
      ],
      "radiusServerSecret": "string",
      "vpnAuthenticationTypes": [ "string" ],
      "vpnClientAddressPool": {
        "addressPrefixes": [ "string" ]
      },
      "vpnClientIpsecPolicies": [
        {
          "dhGroup": "string",
          "ikeEncryption": "string",
          "ikeIntegrity": "string",
          "ipsecEncryption": "string",
          "ipsecIntegrity": "string",
          "pfsGroup": "string",
          "saDataSizeKilobytes": "int",
          "saLifeTimeSeconds": "int"
        }
      ],
      "vpnClientProtocols": [ "string" ],
      "vpnClientRevokedCertificates": [
        {
          "id": "string",
          "name": "string",
          "properties": {
            "thumbprint": "string"
          }
        }
      ],
      "vpnClientRootCertificates": [
        {
          "id": "string",
          "name": "string",
          "properties": {
            "publicCertData": "string"
          }
        }
      ]
    },
    "vpnGatewayGeneration": "string",
    "vpnType": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

屬性值

AddressSpace

名字	描述	價值
addressPrefixes	以 CIDR 表示法保留給此虛擬網路的位址區塊清單。	string[]

BgpSettings

名字	描述	價值
asn	BGP 喇叭的 ASN。	int 約束： 最小值 = 0 最大值 = 4294967295
bgpPeeringAddress	這個 BGP 說話者的 BGP 對等互連位址和 BGP 識別碼。	字串
bgpPeeringAddresses	具有虛擬網路閘道IP組態標識碼的 BGP 對等互連位址。	IPConfigurationBgpPeeringAddress[]
peerWeight	新增至此 BGP 喇叭所學習路由的權數。	int

ExtendedLocation

名字	描述	價值
名字	擴充位置的名稱。	字串
類型	擴充位置的類型。	'EdgeZone'

IPConfigurationBgpPeeringAddress

名字	描述	價值
customBgpIpAddresses	屬於IP組態的自訂BGP對等互連位址清單。	string[]
ipconfigurationId	屬於閘道的IP組態標識碼。	字串

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/virtualNetworkGateways

名字	描述	價值
apiVersion	API 版本	'2021-08-01'
extendedLocation	本機虛擬網路閘道類型的擴充位置。	ExtendedLocation
位置	資源位置。	字串
名字	資源名稱	字串 （必要）
性能	虛擬網路閘道的屬性。	VirtualNetworkGatewayPropertiesFormat （必要）
標籤	資源標籤	標記名稱和值的字典。 請參閱範本中的 標籤
類型	資源類型	'Microsoft.Network/virtualNetworkGateways'

RadiusServer

名字	描述	價值
radiusServerAddress	這個半徑伺服器的位址。	字串 （必要）
radiusServerScore	指派給這個半徑伺服器的初始分數。	int
radiusServerSecret	用於這個半徑伺服器的秘密。	字串

ResourceTags

名字	描述	價值

SubResource

名字	描述	價值
id	資源標識碼。	字串

VirtualNetworkGatewayIPConfiguration

名字	描述	價值
id	資源標識碼。	字串
名字	資源群組內唯一的資源名稱。 此名稱可用來存取資源。	字串
性能	虛擬網路閘道IP組態的屬性。	VirtualNetworkGatewayIPConfigurationPropertiesFormat

VirtualNetworkGatewayIPConfigurationPropertiesFormat

名字	描述	價值
privateIPAllocationMethod	私人IP位址配置方法。	'Dynamic' 'Static'
publicIPAddress	公用IP資源的參考。	SubResource
子	子網資源的參考。	SubResource

VirtualNetworkGatewayNatRule

名字	描述	價值
id	資源標識碼。	字串
名字	資源群組內唯一的資源名稱。 此名稱可用來存取資源。	字串
性能	虛擬網路閘道 NAT 規則的屬性。	VirtualNetworkGatewayNatRuleProperties

VirtualNetworkGatewayNatRuleProperties

名字	描述	價值
externalMappings	NAT 的私人IP位址外部對應。	VpnNatRuleMapping[]
internalMappings	NAT 的私人IP位址內部對應。	VpnNatRuleMapping[]
ipConfigurationId	此 NAT 規則適用的IP組態標識碼。	字串
模式	VPN NAT 的來源 NAT 方向。	'EgressSnat' 'IngressSnat'
類型	VPN NAT 的 NAT 規則類型。	'Dynamic' 'Static'

VirtualNetworkGatewayPropertiesFormat

名字	描述	價值
activeActive	ActiveActive 旗標。	bool
bgpSettings	虛擬網路閘道的 BGP 喇叭設定。	BgpSettings
customRoutes	位址空間資源的參考，代表客戶針對虛擬網路網關和 VpnClient 所指定的自定義路由地址空間。	AddressSpace
disableIPSecReplayProtection	disableIPSecReplayProtection 旗標。	bool
enableBgp	是否為此虛擬網路閘道啟用 BGP。	bool
enableBgpRouteTranslationForNat	EnableBgpRouteTranslationForNat 旗標。	bool
enableDnsForwarding	是否啟用 DNS 轉送。	bool
enablePrivateIpAddress	是否需要在此閘道上啟用私人IP以進行連線。	bool
gatewayDefaultSite	LocalNetworkGateway 資源的參考，代表具有預設路由的局域網路網站。 如果移除現有的默認網站設定，請指派 Null 值。	SubResource
gatewayType	此虛擬網路閘道的類型。	'ExpressRoute' 'LocalGateway' 'Vpn'
ipConfigurations	虛擬網路閘道的IP組態。	VirtualNetworkGatewayIPConfiguration[]
natRules	虛擬網路閘道的 NatRules。	VirtualNetworkGatewayNatRule[]
sku	VirtualNetworkGatewaySku 資源的參考，代表為虛擬網路網關選取的 SKU。	VirtualNetworkGatewaySku
vNetExtendedLocationResourceId	客戶 vnet 資源標識碼。本機閘道類型的 VirtualNetworkGateway 會與客戶 vnet 相關聯。	字串
vpnClientConfiguration	代表 P2S VpnClient 組態之 VpnClientConfiguration 資源的參考。	VpnClientConfiguration
vpnGatewayGeneration	此 VirtualNetworkGateway 的世代。 如果 gatewayType 不是 VPN，則必須是 None。	'Generation1' 'Generation2' 'None'
vpnType	此虛擬網路閘道的類型。	'PolicyBased' 'RouteBased'

VirtualNetworkGatewaySku

名字	描述	價值
名字	閘道 SKU 名稱。	'Basic' 'ErGw1AZ' 'ErGw2AZ' 'ErGw3AZ' 'HighPerformance' 'Standard' 'UltraPerformance' 'VpnGw1' 'VpnGw1AZ' 'VpnGw2' 'VpnGw2AZ' 'VpnGw3' 'VpnGw3AZ' 'VpnGw4' 'VpnGw4AZ' 'VpnGw5' 'VpnGw5AZ'
層	閘道 SKU 層。	'Basic' 'ErGw1AZ' 'ErGw2AZ' 'ErGw3AZ' 'HighPerformance' 'Standard' 'UltraPerformance' 'VpnGw1' 'VpnGw1AZ' 'VpnGw2' 'VpnGw2AZ' 'VpnGw3' 'VpnGw3AZ' 'VpnGw4' 'VpnGw4AZ' 'VpnGw5' 'VpnGw5AZ'

VpnClientConfiguration

名字	描述	價值
aadAudience	用於 AAD 驗證之 Vpn 用戶端連線的 VirtualNetworkGateway 資源的 AADAudience 屬性。	字串
aadIssuer	用於 AAD 驗證之 Vpn 用戶端連線的 VirtualNetworkGateway 資源的 AADIssuer 屬性。	字串
aadTenant	用於 AAD 驗證之 Vpn 用戶端連線的 VirtualNetworkGateway 資源的 AADTenant 屬性。	字串
radiusServerAddress	VPN 用戶端連線 VirtualNetworkGateway 資源的 radius 伺服器地址屬性。	字串
radiusServers	多個半徑伺服器組態的radiusServers屬性。	RadiusServer[]
radiusServerSecret	Vpn 用戶端連線的 VirtualNetworkGateway 資源的 radius 秘密屬性。	字串
vpnAuthenticationTypes	虛擬網路閘道的 VPN 驗證類型。	包含任何的字串數組： 'AAD' 'Certificate' 'Radius'
vpnClientAddressPool	地址空間資源的參考，代表 P2S VpnClient 的地址空間。	AddressSpace
vpnClientIpsecPolicies	虛擬網路閘道 P2S 用戶端的 VpnClientIpsecPolicies。	IpsecPolicy[]
vpnClientProtocols	虛擬網路閘道的 VpnClientProtocols。	包含任何的字串數組： 'IkeV2' 'OpenVPN' 'SSTP'
vpnClientRevokedCertificates	虛擬網路閘道的 VpnClientRevokedCertificate。	VpnClientRevokedCertificate[]
vpnClientRootCertificates	虛擬網路閘道的 VpnClientRootCertificate。	VpnClientRootCertificate[]

VpnClientRevokedCertificate

名字	描述	價值
id	資源標識碼。	字串
名字	資源群組內唯一的資源名稱。 此名稱可用來存取資源。	字串
性能	VPN 用戶端撤銷憑證的屬性。	VpnClientRevokedCertificatePropertiesFormat

VpnClientRevokedCertificatePropertiesFormat

名字	描述	價值
指紋	撤銷的 VPN 用戶端憑證指紋。	字串

VpnClientRootCertificate

名字	描述	價值
id	資源標識碼。	字串
名字	資源群組內唯一的資源名稱。 此名稱可用來存取資源。	字串
性能	vpn 用戶端跟證書的屬性。	VpnClientRootCertificatePropertiesFormat （必要）

VpnClientRootCertificatePropertiesFormat

名字	描述	價值
publicCertData	憑證公用數據。	字串 （必要）

VpnNatRuleMapping

名字	描述	價值
addressSpace	Vpn NatRule 對應的地址空間。	字串
portRange	Vpn NatRule 對應的埠範圍。	字串

快速入門範本

下列快速入門範本會部署此資源類型。

範本	描述
使用 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 中部署中樞輪輻拓撲。 中樞虛擬網路可作為透過虛擬網路對等互連連線到中樞虛擬網路之許多輪輻虛擬網路的中央點。

Terraform （AzAPI 提供者） 資源定義

virtualNetworkGateways 資源類型可以使用目標作業來部署：

• 資源群組

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.Network/virtualNetworkGateways 資源，請將下列 Terraform 新增至範本。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/virtualNetworkGateways@2021-08-01"
  name = "string"
  extendedLocation = {
    name = "string"
    type = "string"
  }
  location = "string"
  body = jsonencode({
    properties = {
      activeActive = bool
      bgpSettings = {
        asn = int
        bgpPeeringAddress = "string"
        bgpPeeringAddresses = [
          {
            customBgpIpAddresses = [
              "string"
            ]
            ipconfigurationId = "string"
          }
        ]
        peerWeight = int
      }
      customRoutes = {
        addressPrefixes = [
          "string"
        ]
      }
      disableIPSecReplayProtection = bool
      enableBgp = bool
      enableBgpRouteTranslationForNat = bool
      enableDnsForwarding = bool
      enablePrivateIpAddress = bool
      gatewayDefaultSite = {
        id = "string"
      }
      gatewayType = "string"
      ipConfigurations = [
        {
          id = "string"
          name = "string"
          properties = {
            privateIPAllocationMethod = "string"
            publicIPAddress = {
              id = "string"
            }
            subnet = {
              id = "string"
            }
          }
        }
      ]
      natRules = [
        {
          id = "string"
          name = "string"
          properties = {
            externalMappings = [
              {
                addressSpace = "string"
                portRange = "string"
              }
            ]
            internalMappings = [
              {
                addressSpace = "string"
                portRange = "string"
              }
            ]
            ipConfigurationId = "string"
            mode = "string"
            type = "string"
          }
        }
      ]
      sku = {
        name = "string"
        tier = "string"
      }
      vNetExtendedLocationResourceId = "string"
      vpnClientConfiguration = {
        aadAudience = "string"
        aadIssuer = "string"
        aadTenant = "string"
        radiusServerAddress = "string"
        radiusServers = [
          {
            radiusServerAddress = "string"
            radiusServerScore = int
            radiusServerSecret = "string"
          }
        ]
        radiusServerSecret = "string"
        vpnAuthenticationTypes = [
          "string"
        ]
        vpnClientAddressPool = {
          addressPrefixes = [
            "string"
          ]
        }
        vpnClientIpsecPolicies = [
          {
            dhGroup = "string"
            ikeEncryption = "string"
            ikeIntegrity = "string"
            ipsecEncryption = "string"
            ipsecIntegrity = "string"
            pfsGroup = "string"
            saDataSizeKilobytes = int
            saLifeTimeSeconds = int
          }
        ]
        vpnClientProtocols = [
          "string"
        ]
        vpnClientRevokedCertificates = [
          {
            id = "string"
            name = "string"
            properties = {
              thumbprint = "string"
            }
          }
        ]
        vpnClientRootCertificates = [
          {
            id = "string"
            name = "string"
            properties = {
              publicCertData = "string"
            }
          }
        ]
      }
      vpnGatewayGeneration = "string"
      vpnType = "string"
    }
  })
  tags = {
    {customized property} = "string"
  }
}

屬性值

AddressSpace

名字	描述	價值
addressPrefixes	以 CIDR 表示法保留給此虛擬網路的位址區塊清單。	string[]

BgpSettings

名字	描述	價值
asn	BGP 喇叭的 ASN。	int 約束： 最小值 = 0 最大值 = 4294967295
bgpPeeringAddress	這個 BGP 說話者的 BGP 對等互連位址和 BGP 識別碼。	字串
bgpPeeringAddresses	具有虛擬網路閘道IP組態標識碼的 BGP 對等互連位址。	IPConfigurationBgpPeeringAddress[]
peerWeight	新增至此 BGP 喇叭所學習路由的權數。	int

ExtendedLocation

名字	描述	價值
名字	擴充位置的名稱。	字串
類型	擴充位置的類型。	'EdgeZone'

IPConfigurationBgpPeeringAddress

名字	描述	價值
customBgpIpAddresses	屬於IP組態的自訂BGP對等互連位址清單。	string[]
ipconfigurationId	屬於閘道的IP組態標識碼。	字串

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/virtualNetworkGateways

名字	描述	價值
extendedLocation	本機虛擬網路閘道類型的擴充位置。	ExtendedLocation
位置	資源位置。	字串
名字	資源名稱	字串 （必要）
性能	虛擬網路閘道的屬性。	VirtualNetworkGatewayPropertiesFormat （必要）
標籤	資源標籤	標記名稱和值的字典。
類型	資源類型	“Microsoft.Network/virtualNetworkGateways@2021-08-01”

RadiusServer

名字	描述	價值
radiusServerAddress	這個半徑伺服器的位址。	字串 （必要）
radiusServerScore	指派給這個半徑伺服器的初始分數。	int
radiusServerSecret	用於這個半徑伺服器的秘密。	字串

ResourceTags

名字	描述	價值

SubResource

名字	描述	價值
id	資源標識碼。	字串

VirtualNetworkGatewayIPConfiguration

名字	描述	價值
id	資源標識碼。	字串
名字	資源群組內唯一的資源名稱。 此名稱可用來存取資源。	字串
性能	虛擬網路閘道IP組態的屬性。	VirtualNetworkGatewayIPConfigurationPropertiesFormat

VirtualNetworkGatewayIPConfigurationPropertiesFormat

名字	描述	價值
privateIPAllocationMethod	私人IP位址配置方法。	'Dynamic' 'Static'
publicIPAddress	公用IP資源的參考。	SubResource
子	子網資源的參考。	SubResource

VirtualNetworkGatewayNatRule

名字	描述	價值
id	資源標識碼。	字串
名字	資源群組內唯一的資源名稱。 此名稱可用來存取資源。	字串
性能	虛擬網路閘道 NAT 規則的屬性。	VirtualNetworkGatewayNatRuleProperties

VirtualNetworkGatewayNatRuleProperties

名字	描述	價值
externalMappings	NAT 的私人IP位址外部對應。	VpnNatRuleMapping[]
internalMappings	NAT 的私人IP位址內部對應。	VpnNatRuleMapping[]
ipConfigurationId	此 NAT 規則適用的IP組態標識碼。	字串
模式	VPN NAT 的來源 NAT 方向。	'EgressSnat' 'IngressSnat'
類型	VPN NAT 的 NAT 規則類型。	'Dynamic' 'Static'

VirtualNetworkGatewayPropertiesFormat

名字	描述	價值
activeActive	ActiveActive 旗標。	bool
bgpSettings	虛擬網路閘道的 BGP 喇叭設定。	BgpSettings
customRoutes	位址空間資源的參考，代表客戶針對虛擬網路網關和 VpnClient 所指定的自定義路由地址空間。	AddressSpace
disableIPSecReplayProtection	disableIPSecReplayProtection 旗標。	bool
enableBgp	是否為此虛擬網路閘道啟用 BGP。	bool
enableBgpRouteTranslationForNat	EnableBgpRouteTranslationForNat 旗標。	bool
enableDnsForwarding	是否啟用 DNS 轉送。	bool
enablePrivateIpAddress	是否需要在此閘道上啟用私人IP以進行連線。	bool
gatewayDefaultSite	LocalNetworkGateway 資源的參考，代表具有預設路由的局域網路網站。 如果移除現有的默認網站設定，請指派 Null 值。	SubResource
gatewayType	此虛擬網路閘道的類型。	'ExpressRoute' 'LocalGateway' 'Vpn'
ipConfigurations	虛擬網路閘道的IP組態。	VirtualNetworkGatewayIPConfiguration[]
natRules	虛擬網路閘道的 NatRules。	VirtualNetworkGatewayNatRule[]
sku	VirtualNetworkGatewaySku 資源的參考，代表為虛擬網路網關選取的 SKU。	VirtualNetworkGatewaySku
vNetExtendedLocationResourceId	客戶 vnet 資源標識碼。本機閘道類型的 VirtualNetworkGateway 會與客戶 vnet 相關聯。	字串
vpnClientConfiguration	代表 P2S VpnClient 組態之 VpnClientConfiguration 資源的參考。	VpnClientConfiguration
vpnGatewayGeneration	此 VirtualNetworkGateway 的世代。 如果 gatewayType 不是 VPN，則必須是 None。	'Generation1' 'Generation2' 'None'
vpnType	此虛擬網路閘道的類型。	'PolicyBased' 'RouteBased'

VirtualNetworkGatewaySku

名字	描述	價值
名字	閘道 SKU 名稱。	'Basic' 'ErGw1AZ' 'ErGw2AZ' 'ErGw3AZ' 'HighPerformance' 'Standard' 'UltraPerformance' 'VpnGw1' 'VpnGw1AZ' 'VpnGw2' 'VpnGw2AZ' 'VpnGw3' 'VpnGw3AZ' 'VpnGw4' 'VpnGw4AZ' 'VpnGw5' 'VpnGw5AZ'
層	閘道 SKU 層。	'Basic' 'ErGw1AZ' 'ErGw2AZ' 'ErGw3AZ' 'HighPerformance' 'Standard' 'UltraPerformance' 'VpnGw1' 'VpnGw1AZ' 'VpnGw2' 'VpnGw2AZ' 'VpnGw3' 'VpnGw3AZ' 'VpnGw4' 'VpnGw4AZ' 'VpnGw5' 'VpnGw5AZ'

VpnClientConfiguration

名字	描述	價值
aadAudience	用於 AAD 驗證之 Vpn 用戶端連線的 VirtualNetworkGateway 資源的 AADAudience 屬性。	字串
aadIssuer	用於 AAD 驗證之 Vpn 用戶端連線的 VirtualNetworkGateway 資源的 AADIssuer 屬性。	字串
aadTenant	用於 AAD 驗證之 Vpn 用戶端連線的 VirtualNetworkGateway 資源的 AADTenant 屬性。	字串
radiusServerAddress	VPN 用戶端連線 VirtualNetworkGateway 資源的 radius 伺服器地址屬性。	字串
radiusServers	多個半徑伺服器組態的radiusServers屬性。	RadiusServer[]
radiusServerSecret	Vpn 用戶端連線的 VirtualNetworkGateway 資源的 radius 秘密屬性。	字串
vpnAuthenticationTypes	虛擬網路閘道的 VPN 驗證類型。	包含任何的字串數組： 'AAD' 'Certificate' 'Radius'
vpnClientAddressPool	地址空間資源的參考，代表 P2S VpnClient 的地址空間。	AddressSpace
vpnClientIpsecPolicies	虛擬網路閘道 P2S 用戶端的 VpnClientIpsecPolicies。	IpsecPolicy[]
vpnClientProtocols	虛擬網路閘道的 VpnClientProtocols。	包含任何的字串數組： 'IkeV2' 'OpenVPN' 'SSTP'
vpnClientRevokedCertificates	虛擬網路閘道的 VpnClientRevokedCertificate。	VpnClientRevokedCertificate[]
vpnClientRootCertificates	虛擬網路閘道的 VpnClientRootCertificate。	VpnClientRootCertificate[]

VpnClientRevokedCertificate

名字	描述	價值
id	資源標識碼。	字串
名字	資源群組內唯一的資源名稱。 此名稱可用來存取資源。	字串
性能	VPN 用戶端撤銷憑證的屬性。	VpnClientRevokedCertificatePropertiesFormat

VpnClientRevokedCertificatePropertiesFormat

名字	描述	價值
指紋	撤銷的 VPN 用戶端憑證指紋。	字串

VpnClientRootCertificate

名字	描述	價值
id	資源標識碼。	字串
名字	資源群組內唯一的資源名稱。 此名稱可用來存取資源。	字串
性能	vpn 用戶端跟證書的屬性。	VpnClientRootCertificatePropertiesFormat （必要）

VpnClientRootCertificatePropertiesFormat

名字	描述	價值
publicCertData	憑證公用數據。	字串 （必要）

VpnNatRuleMapping

名字	描述	價值
addressSpace	Vpn NatRule 對應的地址空間。	字串
portRange	Vpn NatRule 對應的埠範圍。	字串