Share via

Microsoft.Network vpnGateways 2023-06-01

  • [アーティクル]

Bicep リソース定義

vpnGateways リソースの種類は、次を対象とする操作でデプロイできます。

各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。

リソース形式

Microsoft.Network/vpnGateways リソースを作成するには、次の Bicep をテンプレートに追加します。

resource symbolicname 'Microsoft.Network/vpnGateways@2023-06-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    bgpSettings: {
      asn: int
      bgpPeeringAddress: 'string'
      bgpPeeringAddresses: [
        {
          customBgpIpAddresses: [
            'string'
          ]
          ipconfigurationId: 'string'
        }
      ]
      peerWeight: int
    }
    connections: [
      {
        id: 'string'
        name: 'string'
        properties: {
          connectionBandwidth: int
          dpdTimeoutSeconds: int
          enableBgp: bool
          enableInternetSecurity: bool
          enableRateLimiting: bool
          ipsecPolicies: [
            {
              dhGroup: 'string'
              ikeEncryption: 'string'
              ikeIntegrity: 'string'
              ipsecEncryption: 'string'
              ipsecIntegrity: 'string'
              pfsGroup: 'string'
              saDataSizeKilobytes: int
              saLifeTimeSeconds: int
            }
          ]
          remoteVpnSite: {
            id: 'string'
          }
          routingConfiguration: {
            associatedRouteTable: {
              id: 'string'
            }
            inboundRouteMap: {
              id: 'string'
            }
            outboundRouteMap: {
              id: 'string'
            }
            propagatedRouteTables: {
              ids: [
                {
                  id: 'string'
                }
              ]
              labels: [
                'string'
              ]
            }
            vnetRoutes: {
              staticRoutes: [
                {
                  addressPrefixes: [
                    'string'
                  ]
                  name: 'string'
                  nextHopIpAddress: 'string'
                }
              ]
              staticRoutesConfig: {
                vnetLocalRouteOverrideCriteria: 'string'
              }
            }
          }
          routingWeight: int
          sharedKey: 'string'
          trafficSelectorPolicies: [
            {
              localAddressRanges: [
                'string'
              ]
              remoteAddressRanges: [
                'string'
              ]
            }
          ]
          useLocalAzureIpAddress: bool
          usePolicyBasedTrafficSelectors: bool
          vpnConnectionProtocolType: 'string'
          vpnLinkConnections: [
            {
              id: 'string'
              name: 'string'
              properties: {
                connectionBandwidth: int
                egressNatRules: [
                  {
                    id: 'string'
                  }
                ]
                enableBgp: bool
                enableRateLimiting: bool
                ingressNatRules: [
                  {
                    id: 'string'
                  }
                ]
                ipsecPolicies: [
                  {
                    dhGroup: 'string'
                    ikeEncryption: 'string'
                    ikeIntegrity: 'string'
                    ipsecEncryption: 'string'
                    ipsecIntegrity: 'string'
                    pfsGroup: 'string'
                    saDataSizeKilobytes: int
                    saLifeTimeSeconds: int
                  }
                ]
                routingWeight: int
                sharedKey: 'string'
                useLocalAzureIpAddress: bool
                usePolicyBasedTrafficSelectors: bool
                vpnConnectionProtocolType: 'string'
                vpnGatewayCustomBgpAddresses: [
                  {
                    customBgpIpAddress: 'string'
                    ipConfigurationId: 'string'
                  }
                ]
                vpnLinkConnectionMode: 'string'
                vpnSiteLink: {
                  id: 'string'
                }
              }
            }
          ]
        }
      }
    ]
    enableBgpRouteTranslationForNat: bool
    isRoutingPreferenceInternet: bool
    natRules: [
      {
        id: 'string'
        name: 'string'
        properties: {
          externalMappings: [
            {
              addressSpace: 'string'
              portRange: 'string'
            }
          ]
          internalMappings: [
            {
              addressSpace: 'string'
              portRange: 'string'
            }
          ]
          ipConfigurationId: 'string'
          mode: 'string'
          type: 'string'
        }
      }
    ]
    virtualHub: {
      id: 'string'
    }
    vpnGatewayScaleUnit: int
  }
}

プロパティ値

vpnGateways

名前 説明 値
name リソース名 string (必須)

文字数制限: 1 から 80

有効な文字:
英数字、アンダースコア、ピリオド、およびハイフン。

英数字で開始します。 英数字またはアンダースコアで終了します。
location リソースの場所。 string
tags リソース タグ。 タグ名と値のディクショナリ。 「テンプレートのタグ」を参照してください
properties VPN ゲートウェイのプロパティ。 VpnGatewayProperties

VpnGatewayProperties

名前 説明 値
bgpSettings ローカル ネットワーク ゲートウェイの BGP スピーカー設定。 BgpSettings
connections ゲートウェイへのすべての VPN 接続の一覧。 VpnConnection[]
enableBgpRouteTranslationForNat この VpnGateway で NAT の BGP ルート変換を有効にします。 [bool]
isRoutingPreferenceInternet VpnGateway のパブリック IP インターフェイスのルーティング設定プロパティを有効にします。 [bool]
natRules ゲートウェイに関連付けられているすべての nat 規則の一覧。 VpnGatewayNatRule[]
virtualHub ゲートウェイが属する VirtualHub。 サブリソース
vpnGatewayScaleUnit この VPN ゲートウェイのスケール ユニット。 INT

BgpSettings

名前 説明 値
Asn BGP スピーカーの ASN。 INT

制約:
最小値 = 0
最大値 = 4294967295
bgpPeeringAddress この BGP スピーカーの BGP ピアリング アドレスと BGP 識別子。 string
bgpPeeringAddresses 仮想ネットワーク ゲートウェイの IP 構成 ID を持つ BGP ピアリング アドレス。 IPConfigurationBgpPeeringAddress[]
peerWeight この BGP スピーカーから学習したルートに追加された重み。 INT

IPConfigurationBgpPeeringAddress

名前 説明 値
customBgpIpAddresses IP 構成に属するカスタム BGP ピアリング アドレスの一覧。 string[]
ipconfigurationId ゲートウェイに属する IP 構成の ID。 string

VpnConnection

名前 説明 値
id リソースの ID string
name リソース グループ内で一意のリソースの名前。 この名前は、リソースへのアクセスに使用できます。 string
properties VPN 接続のプロパティ。 VpnConnectionProperties

VpnConnectionProperties

名前 説明 値
connectionBandwidth MBPS で想定される帯域幅。 INT
dpdTimeoutSeconds VPN 接続の DPD タイムアウト (秒単位)。 INT
enableBgp EnableBgp フラグ。 [bool]
enableInternetSecurity インターネット セキュリティを有効にします。 [bool]
enableRateLimiting EnableBgp フラグ。 [bool]
ipsecPolicies この接続によって考慮される IPSec ポリシー。 IpsecPolicy[]
remoteVpnSite 接続されている VPN サイトの ID。 サブリソース
routingConfiguration この接続に関連付けられているルート テーブルと伝達されたルート テーブルを示すルーティング構成。 RoutingConfiguration
routingWeight VPN 接続のルーティングの重み。 INT
sharedKey Vpn 接続の SharedKey。 string
trafficSelectorPolicies この接続によって考慮されるトラフィック セレクター ポリシー。 TrafficSelectorPolicy[]
useLocalAzureIpAddress ローカル azure ip を使用して接続を開始します。 [bool]
usePolicyBasedTrafficSelectors ポリシーベースのトラフィック セレクターを有効にします。 [bool]
vpnConnectionProtocolType この接続に使用される接続プロトコル。 'IKEv1'
'IKEv2'
vpnLinkConnections ゲートウェイへのすべての VPN サイト リンク接続の一覧。 VpnSiteLinkConnection[]

IpsecPolicy

名前 説明 値
dhGroup 初期 SA に IKE フェーズ 1 で使用される 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 サイト間 VPN トンネルの IPSec セキュリティ アソシエーション (クイック モードまたはフェーズ 2 SA とも呼ばれます) ペイロード サイズ (KB 単位)。 int (必須)
saLifeTimeSeconds サイト間 VPN トンネルの IPSec セキュリティ アソシエーション (クイック モードまたはフェーズ 2 SA とも呼ばれます) の有効期間 (秒単位)。 int (必須)

サブリソース

名前 説明 値
id リソースの ID string

RoutingConfiguration

名前 説明 値
associatedRouteTable この RoutingConfiguration に関連付けられているリソース ID RouteTable。 サブリソース
inboundRouteMap 受信学習ルートのこの RoutingConfiguration に関連付けられている RouteMap のリソース ID。 サブリソース
outboundRouteMap 送信アドバタイズされたルートのこの RoutingConfiguration に関連付けられているRouteMap のリソース ID。 サブリソース
propagatedRouteTables ルートをアドバタイズする RouteTable の一覧。 伝達されたRouteTable
vnetRoutes VirtualHub から仮想ネットワーク接続へのルーティングを制御するルートの一覧。 VnetRoute

伝達されたRouteTable

名前 説明 値
ids すべての RouteTable のリソース ID の一覧。 SubResource[]
labels ラベルの一覧。 string[]

VnetRoute

名前 説明 値
staticRoutes すべての静的ルートの一覧。 StaticRoute[]
staticRoutesConfig この HubVnetConnection 上の静的ルートの構成。 StaticRoutesConfig

StaticRoute

名前 説明 値
addressPrefixes すべてのアドレス プレフィックスの一覧。 string[]
name VnetRoute 内で一意の StaticRoute の名前。 string
nextHopIpAddress 次ホップの IP アドレス。 string

StaticRoutesConfig

名前 説明 値
vnetLocalRouteOverrideCriteria スポーク vnet 内の NVA がスポーク内の宛先を持つトラフィックに対してバイパスされるかどうかを決定するパラメーター。 'Contains'
'Equal'

TrafficSelectorPolicy

名前 説明 値
localAddressRanges CIDR 形式のローカル アドレス空間のコレクション。 string[] (必須)
remoteAddressRanges CIDR 形式のリモート アドレス空間のコレクション。 string[] (必須)

VpnSiteLinkConnection

名前 説明 値
id リソースの ID string
name リソース グループ内で一意のリソースの名前。 この名前は、リソースへのアクセスに使用できます。 string
properties VPN サイト リンク接続のプロパティ。 VpnSiteLinkConnectionProperties

VpnSiteLinkConnectionProperties

名前 説明 値
connectionBandwidth MBPS で想定される帯域幅。 INT
egressNatRules エグレス NatRules の一覧。 SubResource[]
enableBgp EnableBgp フラグ。 [bool]
enableRateLimiting EnableBgp フラグ。 [bool]
ingressNatRules イングレス NatRules の一覧。 SubResource[]
ipsecPolicies この接続によって考慮される IPSec ポリシー。 IpsecPolicy[]
routingWeight VPN 接続のルーティングの重み。 INT
sharedKey Vpn 接続の SharedKey。 string
useLocalAzureIpAddress ローカル azure ip を使用して接続を開始します。 [bool]
usePolicyBasedTrafficSelectors ポリシーベースのトラフィック セレクターを有効にします。 [bool]
vpnConnectionProtocolType この接続に使用される接続プロトコル。 'IKEv1'
'IKEv2'
vpnGatewayCustomBgpAddresses この接続で使用される vpnGatewayCustomBgpAddresses。 GatewayCustomBgpIpAddressIpConfiguration[]
vpnLinkConnectionMode Vpn リンク接続モード。 'Default'
'InitiatorOnly'
'ResponderOnly'
vpnSiteLink 接続された VPN サイト リンクの ID。 サブリソース

GatewayCustomBgpIpAddressIpConfiguration

名前 説明 値
customBgpIpAddress IpconfigurationId に属するカスタム BgpPeeringAddress。 string (必須)
ipConfigurationId ゲートウェイに属する ipconfiguration の IpconfigurationId。 string (必須)

VpnGatewayNatRule

名前 説明 値
id リソースの ID string
name リソース グループ内で一意のリソースの名前。 この名前は、リソースへのアクセスに使用できます。 string
properties VpnGateway NAT 規則のプロパティ。 VpnGatewayNatRuleProperties

VpnGatewayNatRuleProperties

名前 説明 値
externalMappings NAT のプライベート IP アドレス外部マッピング。 VpnNatRuleMapping[]
internalMappings NAT のプライベート IP アドレス内部マッピング。 VpnNatRuleMapping[]
ipConfigurationId この NAT 規則が適用される IP 構成 ID。 string
mode VPN NAT のソース NAT の方向。 'EgressSnat'
'IngressSnat'
型 VPN NAT の NAT 規則の種類。 'Dynamic'
'Static'

VpnNatRuleMapping

名前 説明 値
addressSpace Vpn NatRule マッピングのアドレス空間。 string
portRange Vpn NatRule マッピングのポート範囲。 string

クイック スタート テンプレート

次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。

Template 説明
Virtual WAN リソースを作成します

Azure にデプロイする		 このテンプレートを使用すると、Virtual WAN、Virtual Hub、VPN Gateway、VPN サイト、VPN Connecton などの仮想 WAN リソースを作成できます。
Azure Virtual WAN ルーティングの意図とポリシー

Azure にデプロイする		 このテンプレートでは、ルーティングインテントとポリシー機能が有効になっている 2 つのハブを使用して Azure Virtual WANをプロビジョニングします。
Azure Virtual WAN (vWAN) マルチハブデプロイ

Azure にデプロイする		 このテンプレートを使用すると、すべてのゲートウェイと VNET 接続を含む Azure Virtual WAN (vWAN) マルチハブ デプロイを作成できます。
カスタム ルーティング テーブルを使用した Azure vWAN マルチハブデプロイ

Azure にデプロイする		 このテンプレートを使用すると、すべてのゲートウェイと VNET 接続を含む Azure Virtual WAN (vWAN) マルチハブ デプロイを作成し、カスタム ルーティングのルート テーブルの使用方法を示すことができます。

ARM テンプレート リソース定義

vpnGateways リソースの種類は、次を対象とする操作でデプロイできます。

各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。

リソース形式

Microsoft.Network/vpnGateways リソースを作成するには、次の JSON をテンプレートに追加します。

{
  "type": "Microsoft.Network/vpnGateways",
  "apiVersion": "2023-06-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "bgpSettings": {
      "asn": "int",
      "bgpPeeringAddress": "string",
      "bgpPeeringAddresses": [
        {
          "customBgpIpAddresses": [ "string" ],
          "ipconfigurationId": "string"
        }
      ],
      "peerWeight": "int"
    },
    "connections": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "connectionBandwidth": "int",
          "dpdTimeoutSeconds": "int",
          "enableBgp": "bool",
          "enableInternetSecurity": "bool",
          "enableRateLimiting": "bool",
          "ipsecPolicies": [
            {
              "dhGroup": "string",
              "ikeEncryption": "string",
              "ikeIntegrity": "string",
              "ipsecEncryption": "string",
              "ipsecIntegrity": "string",
              "pfsGroup": "string",
              "saDataSizeKilobytes": "int",
              "saLifeTimeSeconds": "int"
            }
          ],
          "remoteVpnSite": {
            "id": "string"
          },
          "routingConfiguration": {
            "associatedRouteTable": {
              "id": "string"
            },
            "inboundRouteMap": {
              "id": "string"
            },
            "outboundRouteMap": {
              "id": "string"
            },
            "propagatedRouteTables": {
              "ids": [
                {
                  "id": "string"
                }
              ],
              "labels": [ "string" ]
            },
            "vnetRoutes": {
              "staticRoutes": [
                {
                  "addressPrefixes": [ "string" ],
                  "name": "string",
                  "nextHopIpAddress": "string"
                }
              ],
              "staticRoutesConfig": {
                "vnetLocalRouteOverrideCriteria": "string"
              }
            }
          },
          "routingWeight": "int",
          "sharedKey": "string",
          "trafficSelectorPolicies": [
            {
              "localAddressRanges": [ "string" ],
              "remoteAddressRanges": [ "string" ]
            }
          ],
          "useLocalAzureIpAddress": "bool",
          "usePolicyBasedTrafficSelectors": "bool",
          "vpnConnectionProtocolType": "string",
          "vpnLinkConnections": [
            {
              "id": "string",
              "name": "string",
              "properties": {
                "connectionBandwidth": "int",
                "egressNatRules": [
                  {
                    "id": "string"
                  }
                ],
                "enableBgp": "bool",
                "enableRateLimiting": "bool",
                "ingressNatRules": [
                  {
                    "id": "string"
                  }
                ],
                "ipsecPolicies": [
                  {
                    "dhGroup": "string",
                    "ikeEncryption": "string",
                    "ikeIntegrity": "string",
                    "ipsecEncryption": "string",
                    "ipsecIntegrity": "string",
                    "pfsGroup": "string",
                    "saDataSizeKilobytes": "int",
                    "saLifeTimeSeconds": "int"
                  }
                ],
                "routingWeight": "int",
                "sharedKey": "string",
                "useLocalAzureIpAddress": "bool",
                "usePolicyBasedTrafficSelectors": "bool",
                "vpnConnectionProtocolType": "string",
                "vpnGatewayCustomBgpAddresses": [
                  {
                    "customBgpIpAddress": "string",
                    "ipConfigurationId": "string"
                  }
                ],
                "vpnLinkConnectionMode": "string",
                "vpnSiteLink": {
                  "id": "string"
                }
              }
            }
          ]
        }
      }
    ],
    "enableBgpRouteTranslationForNat": "bool",
    "isRoutingPreferenceInternet": "bool",
    "natRules": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "externalMappings": [
            {
              "addressSpace": "string",
              "portRange": "string"
            }
          ],
          "internalMappings": [
            {
              "addressSpace": "string",
              "portRange": "string"
            }
          ],
          "ipConfigurationId": "string",
          "mode": "string",
          "type": "string"
        }
      }
    ],
    "virtualHub": {
      "id": "string"
    },
    "vpnGatewayScaleUnit": "int"
  }
}

プロパティ値

vpnGateways

名前 説明 値
type リソースの種類 'Microsoft.Network/vpnGateways'
apiVersion リソース API のバージョン '2023-06-01'
name リソース名 string (必須)

文字数制限: 1 から 80

有効な文字:
英数字、アンダースコア、ピリオド、およびハイフン。

英数字で開始します。 英数字またはアンダースコアで終了します。
location リソースの場所。 string
tags リソース タグ。 タグ名と値のディクショナリ。 「テンプレートのタグ」を参照してください
properties VPN ゲートウェイのプロパティ。 VpnGatewayProperties

VpnGatewayProperties

名前 説明 値
bgpSettings ローカル ネットワーク ゲートウェイの BGP スピーカー設定。 BgpSettings
connections ゲートウェイへのすべての VPN 接続の一覧。 VpnConnection[]
enableBgpRouteTranslationForNat この VpnGateway で NAT の BGP ルート変換を有効にします。 [bool]
isRoutingPreferenceInternet VpnGateway のパブリック IP インターフェイスのルーティング設定プロパティを有効にします。 [bool]
natRules ゲートウェイに関連付けられているすべての nat 規則の一覧。 VpnGatewayNatRule[]
virtualHub ゲートウェイが属する VirtualHub。 サブリソース
vpnGatewayScaleUnit この VPN ゲートウェイのスケール ユニット。 INT

BgpSettings

名前 説明 値
Asn BGP スピーカーの ASN。 INT

制約:
最小値 = 0
最大値 = 4294967295
bgpPeeringAddress この BGP スピーカーの BGP ピアリング アドレスと BGP 識別子。 string
bgpPeeringAddresses 仮想ネットワーク ゲートウェイの IP 構成 ID を持つ BGP ピアリング アドレス。 IPConfigurationBgpPeeringAddress[]
peerWeight この BGP スピーカーから学習したルートに追加された重み。 INT

IPConfigurationBgpPeeringAddress

名前 説明 値
customBgpIpAddresses IP 構成に属するカスタム BGP ピアリング アドレスの一覧。 string[]
ipconfigurationId ゲートウェイに属する IP 構成の ID。 string

VpnConnection

名前 説明 値
id リソースの ID string
name リソース グループ内で一意のリソースの名前。 この名前は、リソースへのアクセスに使用できます。 string
properties VPN 接続のプロパティ。 VpnConnectionProperties

VpnConnectionProperties

名前 説明 値
connectionBandwidth MBPS で想定される帯域幅。 INT
dpdTimeoutSeconds VPN 接続の DPD タイムアウト (秒単位)。 INT
enableBgp EnableBgp フラグ。 [bool]
enableInternetSecurity インターネット セキュリティを有効にします。 [bool]
enableRateLimiting EnableBgp フラグ。 [bool]
ipsecPolicies この接続によって考慮される IPSec ポリシー。 IpsecPolicy[]
remoteVpnSite 接続されている VPN サイトの ID。 サブリソース
routingConfiguration この接続に関連付けられているルート テーブルと伝達されたルート テーブルを示すルーティング構成。 RoutingConfiguration
routingWeight VPN 接続のルーティングの重み。 INT
sharedKey Vpn 接続の SharedKey。 string
trafficSelectorPolicies この接続によって考慮されるトラフィック セレクター ポリシー。 TrafficSelectorPolicy[]
useLocalAzureIpAddress ローカル azure ip を使用して接続を開始します。 [bool]
usePolicyBasedTrafficSelectors ポリシーベースのトラフィック セレクターを有効にします。 [bool]
vpnConnectionProtocolType この接続に使用される接続プロトコル。 'IKEv1'
'IKEv2'
vpnLinkConnections ゲートウェイへのすべての VPN サイト リンク接続の一覧。 VpnSiteLinkConnection[]

IpsecPolicy

名前 説明 値
dhGroup 初期 SA に IKE フェーズ 1 で使用される 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 サイト間 VPN トンネルの IPSec セキュリティ アソシエーション (クイック モードまたはフェーズ 2 SA とも呼ばれます) ペイロード サイズ (KB)。 int (必須)
saLifeTimeSeconds サイト間 VPN トンネルの IPSec セキュリティ アソシエーション (クイック モードまたはフェーズ 2 SA とも呼ばれます) の有効期間 (秒単位)。 int (必須)

サブリソース

名前 説明 値
id リソースの ID string

RoutingConfiguration

名前 説明 値
associatedRouteTable この RoutingConfiguration に関連付けられているリソース ID RouteTable。 サブリソース
inboundRouteMap 受信学習ルートのこの RoutingConfiguration に関連付けられている RouteMap のリソース ID。 サブリソース
outboundRouteMap 送信アドバタイズされたルートのこの RoutingConfiguration に関連付けられているRouteMap のリソース ID。 サブリソース
propagatedRouteTables ルートをアドバタイズする RouteTable の一覧。 PropagatedRouteTable
vnetRoutes VirtualHub から仮想ネットワーク接続へのルーティングを制御するルートの一覧。 VnetRoute

PropagatedRouteTable

名前 説明 値
ids すべての RouteTable のリソース ID の一覧。 SubResource[]
labels ラベルの一覧。 string[]

VnetRoute

名前 説明 値
staticRoutes すべての静的ルートの一覧。 StaticRoute[]
staticRoutesConfig この HubVnetConnection 上の静的ルートの構成。 StaticRoutesConfig

StaticRoute

名前 説明 値
addressPrefixes すべてのアドレス プレフィックスの一覧。 string[]
name VnetRoute 内で一意の StaticRoute の名前。 string
nextHopIpAddress 次ホップの IP アドレス。 string

StaticRoutesConfig

名前 説明 値
vnetLocalRouteOverrideCriteria スポーク vnet 内の NVA がスポーク内の宛先を持つトラフィックに対してバイパスされるかどうかを決定するパラメーター。 'Contains'
'Equal'

TrafficSelectorPolicy

名前 説明 値
localAddressRanges CIDR 形式のローカル アドレス空間のコレクション。 string[] (必須)
remoteAddressRanges CIDR 形式のリモート アドレス空間のコレクション。 string[] (必須)

VpnSiteLinkConnection

名前 説明 値
id リソースの ID string
name リソース グループ内で一意のリソースの名前。 この名前は、リソースへのアクセスに使用できます。 string
properties VPN サイト リンク接続のプロパティ。 VpnSiteLinkConnectionProperties

VpnSiteLinkConnectionProperties

名前 説明 値
connectionBandwidth MBPS で想定される帯域幅。 INT
egressNatRules エグレス NatRules の一覧。 SubResource[]
enableBgp EnableBgp フラグ。 [bool]
enableRateLimiting EnableBgp フラグ。 [bool]
ingressNatRules イングレス NatRules の一覧。 SubResource[]
ipsecPolicies この接続によって考慮される IPSec ポリシー。 IpsecPolicy[]
routingWeight VPN 接続のルーティングの重み。 INT
sharedKey Vpn 接続の SharedKey。 string
useLocalAzureIpAddress ローカル azure ip を使用して接続を開始します。 [bool]
usePolicyBasedTrafficSelectors ポリシーベースのトラフィック セレクターを有効にします。 [bool]
vpnConnectionProtocolType この接続に使用される接続プロトコル。 'IKEv1'
'IKEv2'
vpnGatewayCustomBgpAddresses この接続で使用される vpnGatewayCustomBgpAddresses。 GatewayCustomBgpIpAddressIpConfiguration[]
vpnLinkConnectionMode Vpn リンク接続モード。 'Default'
'InitiatorOnly'
'ResponderOnly'
vpnSiteLink 接続された VPN サイト リンクの ID。 サブリソース

GatewayCustomBgpIpAddressIpConfiguration

名前 説明 値
customBgpIpAddress IpconfigurationId に属するカスタム BgpPeeringAddress。 string (必須)
ipConfigurationId ゲートウェイに属する ipconfiguration の IpconfigurationId。 string (必須)

VpnGatewayNatRule

名前 説明 値
id リソースの ID string
name リソース グループ内で一意のリソースの名前。 この名前は、リソースへのアクセスに使用できます。 string
properties VpnGateway NAT 規則のプロパティ。 VpnGatewayNatRuleProperties

VpnGatewayNatRuleProperties

名前 説明 値
externalMappings NAT のプライベート IP アドレス外部マッピング。 VpnNatRuleMapping[]
internalMappings NAT のプライベート IP アドレス内部マッピング。 VpnNatRuleMapping[]
ipConfigurationId この NAT 規則が適用される IP 構成 ID。 string
mode VPN NAT のソース NAT 方向。 'EgressSnat'
'IngressSnat'
型 VPN NAT の NAT 規則の種類。 'Dynamic'
'Static'

VpnNatRuleMapping

名前 説明 値
addressSpace Vpn NatRule マッピングのアドレス空間。 string
portRange Vpn NatRule マッピングのポート範囲。 string

クイック スタート テンプレート

次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。

Template 説明
Virtual WAN リソースを作成します

Azure にデプロイする		 このテンプレートを使用すると、Virtual WAN、Virtual Hub、VPN Gateway、VPN サイト、VPN Connecton などの仮想 WAN リソースを作成できます。
Azure Virtual WAN ルーティングの意図とポリシー

Azure にデプロイする		 このテンプレートは、ルーティングインテントとポリシー機能が有効になっている 2 つのハブを持つ Azure Virtual WANをプロビジョニングします。
Azure Virtual WAN (vWAN) マルチハブデプロイ

Azure にデプロイする		 このテンプレートを使用すると、すべてのゲートウェイと VNET 接続を含む Azure Virtual WAN (vWAN) マルチハブ デプロイを作成できます。
カスタム ルーティング テーブルを使用した Azure vWAN マルチハブ デプロイ

Azure にデプロイする		 このテンプレートを使用すると、すべてのゲートウェイと VNET 接続を含む Azure Virtual WAN (vWAN) マルチハブ デプロイを作成し、カスタム ルーティング用のルート テーブルの使用方法を示すことができます。

Terraform (AzAPI プロバイダー) リソース定義

vpnGateways リソースの種類は、次をターゲットとする操作でデプロイできます。

  • リソース グループ

各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。

リソース形式

Microsoft.Network/vpnGateways リソースを作成するには、次の Terraform をテンプレートに追加します。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/vpnGateways@2023-06-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      bgpSettings = {
        asn = int
        bgpPeeringAddress = "string"
        bgpPeeringAddresses = [
          {
            customBgpIpAddresses = [
              "string"
            ]
            ipconfigurationId = "string"
          }
        ]
        peerWeight = int
      }
      connections = [
        {
          id = "string"
          name = "string"
          properties = {
            connectionBandwidth = int
            dpdTimeoutSeconds = int
            enableBgp = bool
            enableInternetSecurity = bool
            enableRateLimiting = bool
            ipsecPolicies = [
              {
                dhGroup = "string"
                ikeEncryption = "string"
                ikeIntegrity = "string"
                ipsecEncryption = "string"
                ipsecIntegrity = "string"
                pfsGroup = "string"
                saDataSizeKilobytes = int
                saLifeTimeSeconds = int
              }
            ]
            remoteVpnSite = {
              id = "string"
            }
            routingConfiguration = {
              associatedRouteTable = {
                id = "string"
              }
              inboundRouteMap = {
                id = "string"
              }
              outboundRouteMap = {
                id = "string"
              }
              propagatedRouteTables = {
                ids = [
                  {
                    id = "string"
                  }
                ]
                labels = [
                  "string"
                ]
              }
              vnetRoutes = {
                staticRoutes = [
                  {
                    addressPrefixes = [
                      "string"
                    ]
                    name = "string"
                    nextHopIpAddress = "string"
                  }
                ]
                staticRoutesConfig = {
                  vnetLocalRouteOverrideCriteria = "string"
                }
              }
            }
            routingWeight = int
            sharedKey = "string"
            trafficSelectorPolicies = [
              {
                localAddressRanges = [
                  "string"
                ]
                remoteAddressRanges = [
                  "string"
                ]
              }
            ]
            useLocalAzureIpAddress = bool
            usePolicyBasedTrafficSelectors = bool
            vpnConnectionProtocolType = "string"
            vpnLinkConnections = [
              {
                id = "string"
                name = "string"
                properties = {
                  connectionBandwidth = int
                  egressNatRules = [
                    {
                      id = "string"
                    }
                  ]
                  enableBgp = bool
                  enableRateLimiting = bool
                  ingressNatRules = [
                    {
                      id = "string"
                    }
                  ]
                  ipsecPolicies = [
                    {
                      dhGroup = "string"
                      ikeEncryption = "string"
                      ikeIntegrity = "string"
                      ipsecEncryption = "string"
                      ipsecIntegrity = "string"
                      pfsGroup = "string"
                      saDataSizeKilobytes = int
                      saLifeTimeSeconds = int
                    }
                  ]
                  routingWeight = int
                  sharedKey = "string"
                  useLocalAzureIpAddress = bool
                  usePolicyBasedTrafficSelectors = bool
                  vpnConnectionProtocolType = "string"
                  vpnGatewayCustomBgpAddresses = [
                    {
                      customBgpIpAddress = "string"
                      ipConfigurationId = "string"
                    }
                  ]
                  vpnLinkConnectionMode = "string"
                  vpnSiteLink = {
                    id = "string"
                  }
                }
              }
            ]
          }
        }
      ]
      enableBgpRouteTranslationForNat = bool
      isRoutingPreferenceInternet = bool
      natRules = [
        {
          id = "string"
          name = "string"
          properties = {
            externalMappings = [
              {
                addressSpace = "string"
                portRange = "string"
              }
            ]
            internalMappings = [
              {
                addressSpace = "string"
                portRange = "string"
              }
            ]
            ipConfigurationId = "string"
            mode = "string"
            type = "string"
          }
        }
      ]
      virtualHub = {
        id = "string"
      }
      vpnGatewayScaleUnit = int
    }
  })
}

プロパティ値

vpnGateways

名前 説明 値
type リソースの種類 "Microsoft.Network/vpnGateways@2023-06-01"
name リソース名 string (必須)

文字制限: 1 から 80

有効な文字:
英数字、アンダースコア、ピリオド、およびハイフン。

英数字で開始します。 英数字またはアンダースコアで終了します。
location リソースの場所。 string
parent_id リソース グループにデプロイするには、そのリソース グループの ID を使用します。 string (必須)
tags リソース タグ。 タグの名前と値のディクショナリ。
properties VPN ゲートウェイのプロパティ。 VpnGatewayProperties

VpnGatewayProperties

名前 説明 値
bgpSettings ローカル ネットワーク ゲートウェイの BGP スピーカー設定。 BgpSettings
connections ゲートウェイへのすべての VPN 接続の一覧。 VpnConnection[]
enableBgpRouteTranslationForNat この VpnGateway で NAT の BGP ルート変換を有効にします。 [bool]
isRoutingPreferenceInternet VpnGateway のパブリック IP インターフェイスのルーティング設定プロパティを有効にします。 [bool]
natRules ゲートウェイに関連付けられているすべての nat 規則の一覧。 VpnGatewayNatRule[]
virtualHub ゲートウェイが属する VirtualHub。 サブリソース
vpnGatewayScaleUnit この VPN ゲートウェイのスケール ユニット。 INT

BgpSettings

名前 説明 値
Asn BGP スピーカーの ASN。 INT

制約:
最小値 = 0
最大値 = 4294967295
bgpPeeringAddress この BGP スピーカーの BGP ピアリング アドレスと BGP 識別子。 string
bgpPeeringAddresses 仮想ネットワーク ゲートウェイの IP 構成 ID を持つ BGP ピアリング アドレス。 IPConfigurationBgpPeeringAddress[]
peerWeight この BGP スピーカーから学習したルートに追加された重み。 INT

IPConfigurationBgpPeeringAddress

名前 説明 値
customBgpIpAddresses IP 構成に属するカスタム BGP ピアリング アドレスの一覧。 string[]
ipconfigurationId ゲートウェイに属する IP 構成の ID。 string

VpnConnection

名前 説明 値
id リソースの ID string
name リソース グループ内で一意のリソースの名前。 この名前は、リソースへのアクセスに使用できます。 string
properties VPN 接続のプロパティ。 VpnConnectionProperties

VpnConnectionProperties

名前 説明 値
connectionBandwidth MBPS で想定される帯域幅。 INT
dpdTimeoutSeconds VPN 接続の DPD タイムアウト (秒単位)。 INT
enableBgp EnableBgp フラグ。 [bool]
enableInternetSecurity インターネット セキュリティを有効にします。 [bool]
enableRateLimiting EnableBgp フラグ。 [bool]
ipsecPolicies この接続によって考慮される IPSec ポリシー。 IpsecPolicy[]
remoteVpnSite 接続されている VPN サイトの ID。 サブリソース
routingConfiguration この接続に関連付けられているルート テーブルと伝達されたルート テーブルを示すルーティング構成。 RoutingConfiguration
routingWeight VPN 接続のルーティングの重み。 INT
sharedKey Vpn 接続の SharedKey。 string
trafficSelectorPolicies この接続によって考慮されるトラフィック セレクター ポリシー。 TrafficSelectorPolicy[]
useLocalAzureIpAddress ローカル azure ip を使用して接続を開始します。 [bool]
usePolicyBasedTrafficSelectors ポリシーベースのトラフィック セレクターを有効にします。 [bool]
vpnConnectionProtocolType この接続に使用される接続プロトコル。 "IKEv1"
"IKEv2"
vpnLinkConnections ゲートウェイへのすべての VPN サイト リンク接続の一覧。 VpnSiteLinkConnection[]

IpsecPolicy

名前 説明 値
dhGroup 初期 SA に IKE フェーズ 1 で使用される 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 サイト間 VPN トンネルの IPSec セキュリティ アソシエーション (クイック モードまたはフェーズ 2 SA とも呼ばれます) ペイロード サイズ (KB 単位)。 int (必須)
saLifeTimeSeconds サイト間 VPN トンネルの IPSec セキュリティ アソシエーション (クイック モードまたはフェーズ 2 SA とも呼ばれます) の有効期間 (秒単位)。 int (必須)

サブリソース

名前 説明 値
id リソースの ID string

RoutingConfiguration

名前 説明 値
associatedRouteTable この RoutingConfiguration に関連付けられているリソース ID RouteTable。 サブリソース
inboundRouteMap 受信学習ルートのこの RoutingConfiguration に関連付けられている RouteMap のリソース ID。 サブリソース
outboundRouteMap 送信アドバタイズされたルートのこの RoutingConfiguration に関連付けられているRouteMap のリソース ID。 サブリソース
propagatedRouteTables ルートをアドバタイズする RouteTable の一覧。 伝達されたRouteTable
vnetRoutes VirtualHub から仮想ネットワーク接続へのルーティングを制御するルートの一覧。 VnetRoute

伝達されたRouteTable

名前 説明 値
ids すべての RouteTable のリソース ID の一覧。 SubResource[]
labels ラベルの一覧。 string[]

VnetRoute

名前 説明 値
staticRoutes すべての静的ルートの一覧。 StaticRoute[]
staticRoutesConfig この HubVnetConnection 上の静的ルートの構成。 StaticRoutesConfig

StaticRoute

名前 説明 値
addressPrefixes すべてのアドレス プレフィックスの一覧。 string[]
name VnetRoute 内で一意の StaticRoute の名前。 string
nextHopIpAddress 次ホップの IP アドレス。 string

StaticRoutesConfig

名前 説明 値
vnetLocalRouteOverrideCriteria スポーク vnet 内の NVA がスポーク内の宛先を持つトラフィックに対してバイパスされるかどうかを決定するパラメーター。 "Contains"
"等しい"

TrafficSelectorPolicy

名前 説明 値
localAddressRanges CIDR 形式のローカル アドレス空間のコレクション。 string[] (必須)
remoteAddressRanges CIDR 形式のリモート アドレス空間のコレクション。 string[] (必須)

VpnSiteLinkConnection

名前 説明 値
id リソースの ID string
name リソース グループ内で一意のリソースの名前。 この名前は、リソースへのアクセスに使用できます。 string
properties VPN サイト リンク接続のプロパティ。 VpnSiteLinkConnectionProperties

VpnSiteLinkConnectionProperties

名前 説明 値
connectionBandwidth MBPS で想定される帯域幅。 INT
egressNatRules エグレス NatRules の一覧。 SubResource[]
enableBgp EnableBgp フラグ。 [bool]
enableRateLimiting EnableBgp フラグ。 [bool]
ingressNatRules イングレス NatRules の一覧。 SubResource[]
ipsecPolicies この接続によって考慮される IPSec ポリシー。 IpsecPolicy[]
routingWeight VPN 接続のルーティングの重み。 INT
sharedKey VPN 接続の SharedKey。 string
useLocalAzureIpAddress ローカル Azure IP を使用して接続を開始します。 [bool]
usePolicyBasedTrafficSelectors ポリシーベースのトラフィック セレクターを有効にします。 [bool]
vpnConnectionProtocolType この接続に使用される接続プロトコル。 "IKEv1"
"IKEv2"
vpnGatewayCustomBgpAddresses この接続で使用される vpnGatewayCustomBgpAddresses。 GatewayCustomBgpIpAddressIpConfiguration[]
vpnLinkConnectionMode VPN リンク接続モード。 "Default"
"InitiatorOnly"
"ResponderOnly"
vpnSiteLink 接続されている VPN サイト リンクの ID。 サブリソース

GatewayCustomBgpIpAddressIpConfiguration

名前 説明 値
customBgpIpAddress IpconfigurationId に属するカスタム BgpPeeringAddress。 string (必須)
ipConfigurationId ゲートウェイに属する ipconfiguration の IpconfigurationId。 string (必須)

VpnGatewayNatRule

名前 説明 値
id リソースの ID string
name リソース グループ内で一意のリソースの名前。 この名前は、リソースへのアクセスに使用できます。 string
properties VpnGateway NAT 規則のプロパティ。 VpnGatewayNatRuleProperties

VpnGatewayNatRuleProperties

名前 説明 値
externalMappings NAT のプライベート IP アドレス外部マッピング。 VpnNatRuleMapping[]
internalMappings NAT のプライベート IP アドレス内部マッピング。 VpnNatRuleMapping[]
ipConfigurationId この NAT 規則が適用される IP 構成 ID。 string
mode VPN NAT のソース NAT の方向。 "EgressSnat"
"IngressSnat"
型 VPN NAT の NAT 規則の種類。 "Dynamic"
"Static"

VpnNatRuleMapping

名前 説明 値
addressSpace Vpn NatRule マッピングのアドレス空間。 string
portRange Vpn NatRule マッピングのポート範囲。 string