共用方式為


Microsoft.網路連線 2020-11-01

Bicep 資源定義

您可以使用目標作業來部署連線資源類型:

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

資源格式

若要建立 Microsoft.Network/connections 資源,請將下列 Bicep 新增至您的範本。

resource symbolicname 'Microsoft.Network/connections@2020-11-01' = {
  location: 'string'
  name: 'string'
  properties: {
    authorizationKey: 'string'
    connectionMode: 'string'
    connectionProtocol: 'string'
    connectionType: 'string'
    dpdTimeoutSeconds: int
    enableBgp: bool
    expressRouteGatewayBypass: bool
    ipsecPolicies: [
      {
        dhGroup: 'string'
        ikeEncryption: 'string'
        ikeIntegrity: 'string'
        ipsecEncryption: 'string'
        ipsecIntegrity: 'string'
        pfsGroup: 'string'
        saDataSizeKilobytes: int
        saLifeTimeSeconds: int
      }
    ]
    localNetworkGateway2: {
      id: 'string'
      location: 'string'
      properties: {
        bgpSettings: {
          asn: int
          bgpPeeringAddress: 'string'
          bgpPeeringAddresses: [
            {
              customBgpIpAddresses: [
                'string'
              ]
              ipconfigurationId: 'string'
            }
          ]
          peerWeight: int
        }
        fqdn: 'string'
        gatewayIpAddress: 'string'
        localNetworkAddressSpace: {
          addressPrefixes: [
            'string'
          ]
        }
      }
      tags: {
        {customized property}: 'string'
      }
    }
    peer: {
      id: 'string'
    }
    routingWeight: int
    sharedKey: 'string'
    trafficSelectorPolicies: [
      {
        localAddressRanges: [
          'string'
        ]
        remoteAddressRanges: [
          'string'
        ]
      }
    ]
    useLocalAzureIpAddress: bool
    usePolicyBasedTrafficSelectors: bool
    virtualNetworkGateway1: {
      extendedLocation: {
        name: 'string'
        type: 'string'
      }
      id: 'string'
      location: 'string'
      properties: {
        activeActive: bool
        bgpSettings: {
          asn: int
          bgpPeeringAddress: 'string'
          bgpPeeringAddresses: [
            {
              customBgpIpAddresses: [
                'string'
              ]
              ipconfigurationId: 'string'
            }
          ]
          peerWeight: int
        }
        customRoutes: {
          addressPrefixes: [
            'string'
          ]
        }
        enableBgp: bool
        enableDnsForwarding: bool
        enablePrivateIpAddress: bool
        gatewayDefaultSite: {
          id: 'string'
        }
        gatewayType: 'string'
        ipConfigurations: [
          {
            id: 'string'
            name: 'string'
            properties: {
              privateIPAllocationMethod: 'string'
              publicIPAddress: {
                id: 'string'
              }
              subnet: {
                id: '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'
      }
    }
    virtualNetworkGateway2: {
      extendedLocation: {
        name: 'string'
        type: 'string'
      }
      id: 'string'
      location: 'string'
      properties: {
        activeActive: bool
        bgpSettings: {
          asn: int
          bgpPeeringAddress: 'string'
          bgpPeeringAddresses: [
            {
              customBgpIpAddresses: [
                'string'
              ]
              ipconfigurationId: 'string'
            }
          ]
          peerWeight: int
        }
        customRoutes: {
          addressPrefixes: [
            'string'
          ]
        }
        enableBgp: bool
        enableDnsForwarding: bool
        enablePrivateIpAddress: bool
        gatewayDefaultSite: {
          id: 'string'
        }
        gatewayType: 'string'
        ipConfigurations: [
          {
            id: 'string'
            name: 'string'
            properties: {
              privateIPAllocationMethod: 'string'
              publicIPAddress: {
                id: 'string'
              }
              subnet: {
                id: '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'
      }
    }
  }
  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 (必要)

LocalNetworkGateway

名字 描述 價值
id 資源標識碼。 字串
位置 資源位置。 字串
性能 局域網路閘道的屬性。 LocalNetworkGatewayPropertiesFormat (必要)
標籤 資源標籤。 ResourceTags

LocalNetworkGatewayPropertiesFormat

名字 描述 價值
bgpSettings 局域網路閘道的 BGP 喇叭設定。 BgpSettings
fqdn 局域網路閘道的 FQDN。 字串
gatewayIpAddress 局域網路閘道的IP位址。 字串
localNetworkAddressSpace 局域網路網站位址空間。 AddressSpace

Microsoft.Network/connections

名字 描述 價值
位置 資源位置。 字串
名字 資源名稱 字串 (必要)
性能 虛擬網路網關聯機的屬性。 VirtualNetworkGatewayConnectionPropertiesFormat (必要)
標籤 資源標籤 標記名稱和值的字典。 請參閱範本中的 標籤

RadiusServer

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

ResourceTags

名字 描述 價值

ResourceTags

名字 描述 價值

ResourceTags

名字 描述 價值

SubResource

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

TrafficSelectorPolicy

名字 描述 價值
localAddressRanges CIDR 格式的本機位址空間集合。 string[] (必要)
remoteAddressRanges CIDR 格式的遠端位址空間集合。 string[] (必要)

VirtualNetworkGateway

名字 描述 價值
extendedLocation 本機虛擬網路閘道類型的擴充位置。 ExtendedLocation
id 資源標識碼。 字串
位置 資源位置。 字串
性能 虛擬網路閘道的屬性。 VirtualNetworkGatewayPropertiesFormat (必要)
標籤 資源標籤。 ResourceTags

VirtualNetworkGatewayConnectionPropertiesFormat

名字 描述 價值
authorizationKey authorizationKey。 字串
connectionMode 此連線連接模式。 'Default'
'InitiatorOnly'
'ResponderOnly'
connectionProtocol 用於此連線的連接通訊協定。 'IKEv1'
'IKEv2'
connectionType 網關聯機類型。 'ExpressRoute'
'IPsec'
'Vnet2Vnet'
'VPNClient' (必要)
dpdTimeoutSeconds 此連線的無效對等偵測逾時,以秒為單位。 int
enableBgp EnableBgp 旗標。 bool
expressRouteGatewayBypass 略過 ExpressRoute 閘道進行數據轉送。 bool
ipsecPolicies 此連線所要考慮的IPSec原則。 IpsecPolicy[]
localNetworkGateway2 局域網路網關資源的參考。 LocalNetworkGateway
同輩 對等互連資源的參考。 SubResource
routingWeight 路由權數。 int
sharedKey IPSec 共用金鑰。 字串
trafficSelectorPolicies 此連線所要考慮的流量選取器原則。 TrafficSelectorPolicy[]
useLocalAzureIpAddress 使用私人本機 Azure IP 進行連線。 bool
usePolicyBasedTrafficSelectors 啟用以原則為基礎的流量選取器。 bool
virtualNetworkGateway1 虛擬網路閘道資源的參考。 VirtualNetworkGateway (必要)
virtualNetworkGateway2 虛擬網路閘道資源的參考。 VirtualNetworkGateway

VirtualNetworkGatewayIPConfiguration

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

VirtualNetworkGatewayIPConfigurationPropertiesFormat

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

VirtualNetworkGatewayPropertiesFormat

名字 描述 價值
activeActive ActiveActive 旗標。 bool
bgpSettings 虛擬網路閘道的 BGP 喇叭設定。 BgpSettings
customRoutes 位址空間資源的參考,代表客戶針對虛擬網路網關和 VpnClient 所指定的自定義路由地址空間。 AddressSpace
enableBgp 是否為此虛擬網路閘道啟用 BGP。 bool
enableDnsForwarding 是否啟用 DNS 轉送。 bool
enablePrivateIpAddress 是否需要在此閘道上啟用私人IP以進行連線。 bool
gatewayDefaultSite LocalNetworkGateway 資源的參考,代表具有預設路由的局域網路網站。 如果移除現有的默認網站設定,請指派 Null 值。 SubResource
gatewayType 此虛擬網路閘道的類型。 'ExpressRoute'
'LocalGateway'
'Vpn'
ipConfigurations 虛擬網路閘道的IP組態。 VirtualNetworkGatewayIPConfiguration[]
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 憑證公用數據。 字串 (必要)

快速入門範例

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

Bicep 檔案 描述
建立 BGP VNET 對 VNET 連線 此範本可讓您使用虛擬網路閘道和 BGP 連線兩個 VNET
使用 BGP 使用主動 VPN 閘道 站對站 VPN VPN 此範本可讓您在具有 VPN 閘道的兩個 VNet 之間部署站對站 VPN,以使用 BGP 設定主動-主動。 每個 Azure VPN 閘道都會解析遠端對等的 FQDN,以判斷遠端 VPN 閘道的公用 IP。 範本會在具有可用性區域的 Azure 區域中如預期般執行。

ARM 樣本資源定義

您可以使用目標作業來部署連線資源類型:

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

資源格式

若要建立 Microsoft.Network/connections 資源,請將下列 JSON 新增至範本。

{
  "type": "Microsoft.Network/connections",
  "apiVersion": "2020-11-01",
  "name": "string",
  "location": "string",
  "properties": {
    "authorizationKey": "string",
    "connectionMode": "string",
    "connectionProtocol": "string",
    "connectionType": "string",
    "dpdTimeoutSeconds": "int",
    "enableBgp": "bool",
    "expressRouteGatewayBypass": "bool",
    "ipsecPolicies": [
      {
        "dhGroup": "string",
        "ikeEncryption": "string",
        "ikeIntegrity": "string",
        "ipsecEncryption": "string",
        "ipsecIntegrity": "string",
        "pfsGroup": "string",
        "saDataSizeKilobytes": "int",
        "saLifeTimeSeconds": "int"
      }
    ],
    "localNetworkGateway2": {
      "id": "string",
      "location": "string",
      "properties": {
        "bgpSettings": {
          "asn": "int",
          "bgpPeeringAddress": "string",
          "bgpPeeringAddresses": [
            {
              "customBgpIpAddresses": [ "string" ],
              "ipconfigurationId": "string"
            }
          ],
          "peerWeight": "int"
        },
        "fqdn": "string",
        "gatewayIpAddress": "string",
        "localNetworkAddressSpace": {
          "addressPrefixes": [ "string" ]
        }
      },
      "tags": {
        "{customized property}": "string"
      }
    },
    "peer": {
      "id": "string"
    },
    "routingWeight": "int",
    "sharedKey": "string",
    "trafficSelectorPolicies": [
      {
        "localAddressRanges": [ "string" ],
        "remoteAddressRanges": [ "string" ]
      }
    ],
    "useLocalAzureIpAddress": "bool",
    "usePolicyBasedTrafficSelectors": "bool",
    "virtualNetworkGateway1": {
      "extendedLocation": {
        "name": "string",
        "type": "string"
      },
      "id": "string",
      "location": "string",
      "properties": {
        "activeActive": "bool",
        "bgpSettings": {
          "asn": "int",
          "bgpPeeringAddress": "string",
          "bgpPeeringAddresses": [
            {
              "customBgpIpAddresses": [ "string" ],
              "ipconfigurationId": "string"
            }
          ],
          "peerWeight": "int"
        },
        "customRoutes": {
          "addressPrefixes": [ "string" ]
        },
        "enableBgp": "bool",
        "enableDnsForwarding": "bool",
        "enablePrivateIpAddress": "bool",
        "gatewayDefaultSite": {
          "id": "string"
        },
        "gatewayType": "string",
        "ipConfigurations": [
          {
            "id": "string",
            "name": "string",
            "properties": {
              "privateIPAllocationMethod": "string",
              "publicIPAddress": {
                "id": "string"
              },
              "subnet": {
                "id": "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"
      }
    },
    "virtualNetworkGateway2": {
      "extendedLocation": {
        "name": "string",
        "type": "string"
      },
      "id": "string",
      "location": "string",
      "properties": {
        "activeActive": "bool",
        "bgpSettings": {
          "asn": "int",
          "bgpPeeringAddress": "string",
          "bgpPeeringAddresses": [
            {
              "customBgpIpAddresses": [ "string" ],
              "ipconfigurationId": "string"
            }
          ],
          "peerWeight": "int"
        },
        "customRoutes": {
          "addressPrefixes": [ "string" ]
        },
        "enableBgp": "bool",
        "enableDnsForwarding": "bool",
        "enablePrivateIpAddress": "bool",
        "gatewayDefaultSite": {
          "id": "string"
        },
        "gatewayType": "string",
        "ipConfigurations": [
          {
            "id": "string",
            "name": "string",
            "properties": {
              "privateIPAllocationMethod": "string",
              "publicIPAddress": {
                "id": "string"
              },
              "subnet": {
                "id": "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"
      }
    }
  },
  "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 (必要)

LocalNetworkGateway

名字 描述 價值
id 資源標識碼。 字串
位置 資源位置。 字串
性能 局域網路閘道的屬性。 LocalNetworkGatewayPropertiesFormat (必要)
標籤 資源標籤。 ResourceTags

LocalNetworkGatewayPropertiesFormat

名字 描述 價值
bgpSettings 局域網路閘道的 BGP 喇叭設定。 BgpSettings
fqdn 局域網路閘道的 FQDN。 字串
gatewayIpAddress 局域網路閘道的IP位址。 字串
localNetworkAddressSpace 局域網路網站位址空間。 AddressSpace

Microsoft.Network/connections

名字 描述 價值
apiVersion API 版本 '2020-11-01'
位置 資源位置。 字串
名字 資源名稱 字串 (必要)
性能 虛擬網路網關聯機的屬性。 VirtualNetworkGatewayConnectionPropertiesFormat (必要)
標籤 資源標籤 標記名稱和值的字典。 請參閱範本中的 標籤
類型 資源類型 'Microsoft.Network/connections'

RadiusServer

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

ResourceTags

名字 描述 價值

ResourceTags

名字 描述 價值

ResourceTags

名字 描述 價值

SubResource

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

TrafficSelectorPolicy

名字 描述 價值
localAddressRanges CIDR 格式的本機位址空間集合。 string[] (必要)
remoteAddressRanges CIDR 格式的遠端位址空間集合。 string[] (必要)

VirtualNetworkGateway

名字 描述 價值
extendedLocation 本機虛擬網路閘道類型的擴充位置。 ExtendedLocation
id 資源標識碼。 字串
位置 資源位置。 字串
性能 虛擬網路閘道的屬性。 VirtualNetworkGatewayPropertiesFormat (必要)
標籤 資源標籤。 ResourceTags

VirtualNetworkGatewayConnectionPropertiesFormat

名字 描述 價值
authorizationKey authorizationKey。 字串
connectionMode 此連線連接模式。 'Default'
'InitiatorOnly'
'ResponderOnly'
connectionProtocol 用於此連線的連接通訊協定。 'IKEv1'
'IKEv2'
connectionType 網關聯機類型。 'ExpressRoute'
'IPsec'
'Vnet2Vnet'
'VPNClient' (必要)
dpdTimeoutSeconds 此連線的無效對等偵測逾時,以秒為單位。 int
enableBgp EnableBgp 旗標。 bool
expressRouteGatewayBypass 略過 ExpressRoute 閘道進行數據轉送。 bool
ipsecPolicies 此連線所要考慮的IPSec原則。 IpsecPolicy[]
localNetworkGateway2 局域網路網關資源的參考。 LocalNetworkGateway
同輩 對等互連資源的參考。 SubResource
routingWeight 路由權數。 int
sharedKey IPSec 共用金鑰。 字串
trafficSelectorPolicies 此連線所要考慮的流量選取器原則。 TrafficSelectorPolicy[]
useLocalAzureIpAddress 使用私人本機 Azure IP 進行連線。 bool
usePolicyBasedTrafficSelectors 啟用以原則為基礎的流量選取器。 bool
virtualNetworkGateway1 虛擬網路閘道資源的參考。 VirtualNetworkGateway (必要)
virtualNetworkGateway2 虛擬網路閘道資源的參考。 VirtualNetworkGateway

VirtualNetworkGatewayIPConfiguration

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

VirtualNetworkGatewayIPConfigurationPropertiesFormat

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

VirtualNetworkGatewayPropertiesFormat

名字 描述 價值
activeActive ActiveActive 旗標。 bool
bgpSettings 虛擬網路閘道的 BGP 喇叭設定。 BgpSettings
customRoutes 位址空間資源的參考,代表客戶針對虛擬網路網關和 VpnClient 所指定的自定義路由地址空間。 AddressSpace
enableBgp 是否為此虛擬網路閘道啟用 BGP。 bool
enableDnsForwarding 是否啟用 DNS 轉送。 bool
enablePrivateIpAddress 是否需要在此閘道上啟用私人IP以進行連線。 bool
gatewayDefaultSite LocalNetworkGateway 資源的參考,代表具有預設路由的局域網路網站。 如果移除現有的默認網站設定,請指派 Null 值。 SubResource
gatewayType 此虛擬網路閘道的類型。 'ExpressRoute'
'LocalGateway'
'Vpn'
ipConfigurations 虛擬網路閘道的IP組態。 VirtualNetworkGatewayIPConfiguration[]
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 憑證公用數據。 字串 (必要)

快速入門範本

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

範本 描述
BOSH CF 跨區域

部署至 Azure
此範本可協助您設定在 Azure 上兩個區域部署 BOSH 和 Cloud Foundry 所需的資源。
將 ExpressRoute 線路連線至 VNET

部署至 Azure
此範本會建立 VNET、ExpresRoute 閘道,以及已設定 AzurePrivatePeering 的已佈建和已啟用 ExpressRoute 線路的連線。
建立 BGP VNET 對 VNET 連線

部署至 Azure
此範本可讓您使用虛擬網路閘道和 BGP 連線兩個 VNET
建立站對站 VPN 連線

部署至 Azure
此範本可讓您使用虛擬網路閘道建立站對站 VPN 連線
使用 VM 建立站對站 VPN 連線

部署至 Azure
此範本可讓您使用虛擬網路閘道建立站對站 VPN 連線
跨兩個區域建立 VNET 對 VNET 連線

部署至 Azure
此範本可讓您使用虛擬網路閘道連接不同區域中的兩個 VNET
建立三個 vNet 來示範可轉移的 BGP 連線

部署至 Azure
此範本會部署三個使用虛擬網路閘道和已啟用 BGP 連線的 vNet
部署 HBase 異地復寫

部署至 Azure
此範本可讓您使用 VPN vnet 對 vnet 連線,在兩個不同的區域中設定 HBase 複寫的 Azure 環境。
將現有的 Azure VNET 擴充至多 VNET 組態

部署至 Azure
此範本可讓您使用 VNET 對 VNET 閘道,將現有的單一 VNET 環境延伸至跨兩個資料中心區域延伸的多 VNET 環境
使用 BGP 使用主動 VPN 閘道 站對站 VPN VPN

部署至 Azure
此範本可讓您在具有 VPN 閘道的兩個 VNet 之間部署站對站 VPN,以使用 BGP 設定主動-主動。 每個 Azure VPN 閘道都會解析遠端對等的 FQDN,以判斷遠端 VPN 閘道的公用 IP。 範本會在具有可用性區域的 Azure 區域中如預期般執行。
VPN 自訂 IPSec 原則

部署至 Azure
此自定義IPSec原則允許更細微的IKE參數設定。 這可讓您部署站對站 VPN 原則,以支援 VPN Endpoit 裝置上的特定設定。

Terraform (AzAPI 提供者) 資源定義

您可以使用目標作業來部署連線資源類型:

  • 資源群組

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

資源格式

若要建立 Microsoft.Network/connections 資源,請將下列 Terraform 新增至您的範本。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/connections@2020-11-01"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      authorizationKey = "string"
      connectionMode = "string"
      connectionProtocol = "string"
      connectionType = "string"
      dpdTimeoutSeconds = int
      enableBgp = bool
      expressRouteGatewayBypass = bool
      ipsecPolicies = [
        {
          dhGroup = "string"
          ikeEncryption = "string"
          ikeIntegrity = "string"
          ipsecEncryption = "string"
          ipsecIntegrity = "string"
          pfsGroup = "string"
          saDataSizeKilobytes = int
          saLifeTimeSeconds = int
        }
      ]
      localNetworkGateway2 = {
        id = "string"
        location = "string"
        properties = {
          bgpSettings = {
            asn = int
            bgpPeeringAddress = "string"
            bgpPeeringAddresses = [
              {
                customBgpIpAddresses = [
                  "string"
                ]
                ipconfigurationId = "string"
              }
            ]
            peerWeight = int
          }
          fqdn = "string"
          gatewayIpAddress = "string"
          localNetworkAddressSpace = {
            addressPrefixes = [
              "string"
            ]
          }
        }
        tags = {
          {customized property} = "string"
        }
      }
      peer = {
        id = "string"
      }
      routingWeight = int
      sharedKey = "string"
      trafficSelectorPolicies = [
        {
          localAddressRanges = [
            "string"
          ]
          remoteAddressRanges = [
            "string"
          ]
        }
      ]
      useLocalAzureIpAddress = bool
      usePolicyBasedTrafficSelectors = bool
      virtualNetworkGateway1 = {
        extendedLocation = {
          name = "string"
          type = "string"
        }
        id = "string"
        location = "string"
        properties = {
          activeActive = bool
          bgpSettings = {
            asn = int
            bgpPeeringAddress = "string"
            bgpPeeringAddresses = [
              {
                customBgpIpAddresses = [
                  "string"
                ]
                ipconfigurationId = "string"
              }
            ]
            peerWeight = int
          }
          customRoutes = {
            addressPrefixes = [
              "string"
            ]
          }
          enableBgp = bool
          enableDnsForwarding = bool
          enablePrivateIpAddress = bool
          gatewayDefaultSite = {
            id = "string"
          }
          gatewayType = "string"
          ipConfigurations = [
            {
              id = "string"
              name = "string"
              properties = {
                privateIPAllocationMethod = "string"
                publicIPAddress = {
                  id = "string"
                }
                subnet = {
                  id = "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"
        }
      }
      virtualNetworkGateway2 = {
        extendedLocation = {
          name = "string"
          type = "string"
        }
        id = "string"
        location = "string"
        properties = {
          activeActive = bool
          bgpSettings = {
            asn = int
            bgpPeeringAddress = "string"
            bgpPeeringAddresses = [
              {
                customBgpIpAddresses = [
                  "string"
                ]
                ipconfigurationId = "string"
              }
            ]
            peerWeight = int
          }
          customRoutes = {
            addressPrefixes = [
              "string"
            ]
          }
          enableBgp = bool
          enableDnsForwarding = bool
          enablePrivateIpAddress = bool
          gatewayDefaultSite = {
            id = "string"
          }
          gatewayType = "string"
          ipConfigurations = [
            {
              id = "string"
              name = "string"
              properties = {
                privateIPAllocationMethod = "string"
                publicIPAddress = {
                  id = "string"
                }
                subnet = {
                  id = "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 (必要)

LocalNetworkGateway

名字 描述 價值
id 資源標識碼。 字串
位置 資源位置。 字串
性能 局域網路閘道的屬性。 LocalNetworkGatewayPropertiesFormat (必要)
標籤 資源標籤。 ResourceTags

LocalNetworkGatewayPropertiesFormat

名字 描述 價值
bgpSettings 局域網路閘道的 BGP 喇叭設定。 BgpSettings
fqdn 局域網路閘道的 FQDN。 字串
gatewayIpAddress 局域網路閘道的IP位址。 字串
localNetworkAddressSpace 局域網路網站位址空間。 AddressSpace

Microsoft.Network/connections

名字 描述 價值
位置 資源位置。 字串
名字 資源名稱 字串 (必要)
性能 虛擬網路網關聯機的屬性。 VirtualNetworkGatewayConnectionPropertiesFormat (必要)
標籤 資源標籤 標記名稱和值的字典。
類型 資源類型 “Microsoft.Network/connections@2020-11-01”

RadiusServer

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

ResourceTags

名字 描述 價值

ResourceTags

名字 描述 價值

ResourceTags

名字 描述 價值

SubResource

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

TrafficSelectorPolicy

名字 描述 價值
localAddressRanges CIDR 格式的本機位址空間集合。 string[] (必要)
remoteAddressRanges CIDR 格式的遠端位址空間集合。 string[] (必要)

VirtualNetworkGateway

名字 描述 價值
extendedLocation 本機虛擬網路閘道類型的擴充位置。 ExtendedLocation
id 資源標識碼。 字串
位置 資源位置。 字串
性能 虛擬網路閘道的屬性。 VirtualNetworkGatewayPropertiesFormat (必要)
標籤 資源標籤。 ResourceTags

VirtualNetworkGatewayConnectionPropertiesFormat

名字 描述 價值
authorizationKey authorizationKey。 字串
connectionMode 此連線連接模式。 'Default'
'InitiatorOnly'
'ResponderOnly'
connectionProtocol 用於此連線的連接通訊協定。 'IKEv1'
'IKEv2'
connectionType 網關聯機類型。 'ExpressRoute'
'IPsec'
'Vnet2Vnet'
'VPNClient' (必要)
dpdTimeoutSeconds 此連線的無效對等偵測逾時,以秒為單位。 int
enableBgp EnableBgp 旗標。 bool
expressRouteGatewayBypass 略過 ExpressRoute 閘道進行數據轉送。 bool
ipsecPolicies 此連線所要考慮的IPSec原則。 IpsecPolicy[]
localNetworkGateway2 局域網路網關資源的參考。 LocalNetworkGateway
同輩 對等互連資源的參考。 SubResource
routingWeight 路由權數。 int
sharedKey IPSec 共用金鑰。 字串
trafficSelectorPolicies 此連線所要考慮的流量選取器原則。 TrafficSelectorPolicy[]
useLocalAzureIpAddress 使用私人本機 Azure IP 進行連線。 bool
usePolicyBasedTrafficSelectors 啟用以原則為基礎的流量選取器。 bool
virtualNetworkGateway1 虛擬網路閘道資源的參考。 VirtualNetworkGateway (必要)
virtualNetworkGateway2 虛擬網路閘道資源的參考。 VirtualNetworkGateway

VirtualNetworkGatewayIPConfiguration

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

VirtualNetworkGatewayIPConfigurationPropertiesFormat

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

VirtualNetworkGatewayPropertiesFormat

名字 描述 價值
activeActive ActiveActive 旗標。 bool
bgpSettings 虛擬網路閘道的 BGP 喇叭設定。 BgpSettings
customRoutes 位址空間資源的參考,代表客戶針對虛擬網路網關和 VpnClient 所指定的自定義路由地址空間。 AddressSpace
enableBgp 是否為此虛擬網路閘道啟用 BGP。 bool
enableDnsForwarding 是否啟用 DNS 轉送。 bool
enablePrivateIpAddress 是否需要在此閘道上啟用私人IP以進行連線。 bool
gatewayDefaultSite LocalNetworkGateway 資源的參考,代表具有預設路由的局域網路網站。 如果移除現有的默認網站設定,請指派 Null 值。 SubResource
gatewayType 此虛擬網路閘道的類型。 'ExpressRoute'
'LocalGateway'
'Vpn'
ipConfigurations 虛擬網路閘道的IP組態。 VirtualNetworkGatewayIPConfiguration[]
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 憑證公用數據。 字串 (必要)