Microsoft.Network vpnGateways

  • [アーティクル]

Bicep リソース定義

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

  • リソース グループの - リソース グループのデプロイ コマンド 参照

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

リソースの形式

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

resource symbolicname 'Microsoft.Network/vpnGateways@2024-03-01' = {
  location: 'string'
  name: 'string'
  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
                dpdTimeoutSeconds: 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
  }
  tags: {
    {customized property}: 'string'
  }
}

プロパティ値

BgpSettings

名前 形容 価値
asn BGP スピーカーの ASN。 int

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

GatewayCustomBgpIpAddressIpConfiguration

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

IPConfigurationBgpPeeringAddress

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

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 (必須)

Microsoft.Network/vpnGateways

名前 形容 価値
場所 リソースの場所。 糸
名前 リソース名 string (必須)
プロパティ VPN ゲートウェイのプロパティ。 VpnGatewayProperties の
タグ リソース タグ タグ名と値のディクショナリ。 テンプレート の タグを参照してください

PropagatedRouteTable

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

ResourceTags

名前 形容 価値

RoutingConfiguration

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

StaticRoute

名前 形容 価値
addressPrefixes すべてのアドレス プレフィックスの一覧。 string[]
名前 VnetRoute 内で一意である StaticRoute の名前。 糸
nextHopIpAddress 次ホップの IP アドレス。 糸

StaticRoutesConfig

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

SubResource

名前 形容 価値
身分証明書 リソース ID。 糸

TrafficSelectorPolicy

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

VnetRoute

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

VpnConnection

名前 形容 価値
身分証明書 リソース ID。 糸
名前 リソース グループ内で一意であるリソースの名前。 この名前は、リソースへのアクセスに使用できます。 糸
プロパティ VPN 接続のプロパティ。 VpnConnectionProperties の

VpnConnectionProperties

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

VpnGatewayNatRule

名前 形容 価値
身分証明書 リソース ID。 糸
名前 リソース グループ内で一意であるリソースの名前。 この名前は、リソースへのアクセスに使用できます。 糸
プロパティ VpnGateway NAT 規則のプロパティ。 VpnGatewayNatRuleProperties の

VpnGatewayNatRuleProperties

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

VpnGatewayProperties

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

VpnNatRuleMapping

名前 形容 価値
addressSpace Vpn NatRule マッピングのアドレス空間。 糸
portRange Vpn NatRule マッピングのポート範囲。 糸

VpnSiteLinkConnection

名前 形容 価値
身分証明書 リソース ID。 糸
名前 リソース グループ内で一意であるリソースの名前。 この名前は、リソースへのアクセスに使用できます。 糸
プロパティ VPN サイト リンク接続のプロパティ。 VpnSiteLinkConnectionProperties の

VpnSiteLinkConnectionProperties

名前 形容 価値
connectionBandwidth 予想される帯域幅 (MBPS)。 int
dpdTimeoutSeconds VpnLink 接続のデッド ピア検出タイムアウト (秒単位)。 int
egressNatRules エグレス NatRules の一覧。 SubResource[]
enableBgp EnableBgp フラグ。 bool
enableRateLimiting EnableBgp フラグ。 bool
ingressNatRules イングレス NatRules の一覧。 SubResource[]
ipsecPolicies この接続によって考慮される IPSec ポリシー。 IpsecPolicy[]
routingWeight VPN 接続のルーティングの重み。 int
sharedKey VPN 接続の SharedKey。 糸
useLocalAzureIpAddress ローカル Azure IP を使用して接続を開始します。 bool
usePolicyBasedTrafficSelectors ポリシー ベースのトラフィック セレクターを有効にします。 bool
vpnConnectionProtocolType この接続に使用される接続プロトコル。 'IKEv1'
'IKEv2'
vpnGatewayCustomBgpAddresses この接続で使用される vpnGatewayCustomBgpAddresses。 GatewayCustomBgpIpAddressIpConfiguration[]
vpnLinkConnectionMode VPN リンク接続モード。 'Default'
'InitiatorOnly'
'ResponderOnly'
vpnSiteLink 接続されている VPN サイト リンクの ID。 SubResource の

クイック スタートのサンプル

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

Bicep ファイル 形容
Virtual WAN リソースを作成 このテンプレートを使用すると、Virtual WAN、Virtual Hub、VPN Gateway、VPN サイト、VPN Connecton などの仮想 WAN リソースを作成できます。

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

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

  • リソース グループの - リソース グループのデプロイ コマンド 参照

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

リソースの形式

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

{
  "type": "Microsoft.Network/vpnGateways",
  "apiVersion": "2024-03-01",
  "name": "string",
  "location": "string",
  "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",
                "dpdTimeoutSeconds": "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"
  },
  "tags": {
    "{customized property}": "string"
  }
}

プロパティ値

BgpSettings

名前 形容 価値
asn BGP スピーカーの ASN。 int

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

GatewayCustomBgpIpAddressIpConfiguration

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

IPConfigurationBgpPeeringAddress

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

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 (必須)

Microsoft.Network/vpnGateways

名前 形容 価値
apiVersion API のバージョン '2024-03-01'
場所 リソースの場所。 糸
名前 リソース名 string (必須)
プロパティ VPN ゲートウェイのプロパティ。 VpnGatewayProperties の
タグ リソース タグ タグ名と値のディクショナリ。 テンプレート の タグを参照してください
種類 リソースの種類 'Microsoft.Network/vpnGateways'

PropagatedRouteTable

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

ResourceTags

名前 形容 価値

RoutingConfiguration

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

StaticRoute

名前 形容 価値
addressPrefixes すべてのアドレス プレフィックスの一覧。 string[]
名前 VnetRoute 内で一意である StaticRoute の名前。 糸
nextHopIpAddress 次ホップの IP アドレス。 糸

StaticRoutesConfig

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

SubResource

名前 形容 価値
身分証明書 リソース ID。 糸

TrafficSelectorPolicy

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

VnetRoute

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

VpnConnection

名前 形容 価値
身分証明書 リソース ID。 糸
名前 リソース グループ内で一意であるリソースの名前。 この名前は、リソースへのアクセスに使用できます。 糸
プロパティ VPN 接続のプロパティ。 VpnConnectionProperties の

VpnConnectionProperties

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

VpnGatewayNatRule

名前 形容 価値
身分証明書 リソース ID。 糸
名前 リソース グループ内で一意であるリソースの名前。 この名前は、リソースへのアクセスに使用できます。 糸
プロパティ VpnGateway NAT 規則のプロパティ。 VpnGatewayNatRuleProperties の

VpnGatewayNatRuleProperties

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

VpnGatewayProperties

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

VpnNatRuleMapping

名前 形容 価値
addressSpace Vpn NatRule マッピングのアドレス空間。 糸
portRange Vpn NatRule マッピングのポート範囲。 糸

VpnSiteLinkConnection

名前 形容 価値
身分証明書 リソース ID。 糸
名前 リソース グループ内で一意であるリソースの名前。 この名前は、リソースへのアクセスに使用できます。 糸
プロパティ VPN サイト リンク接続のプロパティ。 VpnSiteLinkConnectionProperties の

VpnSiteLinkConnectionProperties

名前 形容 価値
connectionBandwidth 予想される帯域幅 (MBPS)。 int
dpdTimeoutSeconds VpnLink 接続のデッド ピア検出タイムアウト (秒単位)。 int
egressNatRules エグレス NatRules の一覧。 SubResource[]
enableBgp EnableBgp フラグ。 bool
enableRateLimiting EnableBgp フラグ。 bool
ingressNatRules イングレス NatRules の一覧。 SubResource[]
ipsecPolicies この接続によって考慮される IPSec ポリシー。 IpsecPolicy[]
routingWeight VPN 接続のルーティングの重み。 int
sharedKey VPN 接続の SharedKey。 糸
useLocalAzureIpAddress ローカル Azure IP を使用して接続を開始します。 bool
usePolicyBasedTrafficSelectors ポリシー ベースのトラフィック セレクターを有効にします。 bool
vpnConnectionProtocolType この接続に使用される接続プロトコル。 'IKEv1'
'IKEv2'
vpnGatewayCustomBgpAddresses この接続で使用される vpnGatewayCustomBgpAddresses。 GatewayCustomBgpIpAddressIpConfiguration[]
vpnLinkConnectionMode VPN リンク接続モード。 'Default'
'InitiatorOnly'
'ResponderOnly'
vpnSiteLink 接続されている VPN サイト リンクの ID。 SubResource の

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

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

テンプレート 形容
Azure Virtual WAN (vWAN) マルチハブ デプロイ

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

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

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

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

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

  • リソース グループの

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

リソースの形式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/vpnGateways@2024-03-01"
  name = "string"
  location = "string"
  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
                  dpdTimeoutSeconds = 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
    }
  })
  tags = {
    {customized property} = "string"
  }
}

プロパティ値

BgpSettings

名前 形容 価値
asn BGP スピーカーの ASN。 int

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

GatewayCustomBgpIpAddressIpConfiguration

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

IPConfigurationBgpPeeringAddress

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

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 (必須)

Microsoft.Network/vpnGateways

名前 形容 価値
場所 リソースの場所。 糸
名前 リソース名 string (必須)
プロパティ VPN ゲートウェイのプロパティ。 VpnGatewayProperties の
タグ リソース タグ タグ名と値のディクショナリ。
種類 リソースの種類 "Microsoft.Network/vpnGateways@2024-03-01"

PropagatedRouteTable

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

ResourceTags

名前 形容 価値

RoutingConfiguration

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

StaticRoute

名前 形容 価値
addressPrefixes すべてのアドレス プレフィックスの一覧。 string[]
名前 VnetRoute 内で一意である StaticRoute の名前。 糸
nextHopIpAddress 次ホップの IP アドレス。 糸

StaticRoutesConfig

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

SubResource

名前 形容 価値
身分証明書 リソース ID。 糸

TrafficSelectorPolicy

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

VnetRoute

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

VpnConnection

名前 形容 価値
身分証明書 リソース ID。 糸
名前 リソース グループ内で一意であるリソースの名前。 この名前は、リソースへのアクセスに使用できます。 糸
プロパティ VPN 接続のプロパティ。 VpnConnectionProperties の

VpnConnectionProperties

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

VpnGatewayNatRule

名前 形容 価値
身分証明書 リソース ID。 糸
名前 リソース グループ内で一意であるリソースの名前。 この名前は、リソースへのアクセスに使用できます。 糸
プロパティ VpnGateway NAT 規則のプロパティ。 VpnGatewayNatRuleProperties の

VpnGatewayNatRuleProperties

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

VpnGatewayProperties

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

VpnNatRuleMapping

名前 形容 価値
addressSpace Vpn NatRule マッピングのアドレス空間。 糸
portRange Vpn NatRule マッピングのポート範囲。 糸

VpnSiteLinkConnection

名前 形容 価値
身分証明書 リソース ID。 糸
名前 リソース グループ内で一意であるリソースの名前。 この名前は、リソースへのアクセスに使用できます。 糸
プロパティ VPN サイト リンク接続のプロパティ。 VpnSiteLinkConnectionProperties の

VpnSiteLinkConnectionProperties

名前 形容 価値
connectionBandwidth 予想される帯域幅 (MBPS)。 int
dpdTimeoutSeconds VpnLink 接続のデッド ピア検出タイムアウト (秒単位)。 int
egressNatRules エグレス NatRules の一覧。 SubResource[]
enableBgp EnableBgp フラグ。 bool
enableRateLimiting EnableBgp フラグ。 bool
ingressNatRules イングレス NatRules の一覧。 SubResource[]
ipsecPolicies この接続によって考慮される IPSec ポリシー。 IpsecPolicy[]
routingWeight VPN 接続のルーティングの重み。 int
sharedKey VPN 接続の SharedKey。 糸
useLocalAzureIpAddress ローカル Azure IP を使用して接続を開始します。 bool
usePolicyBasedTrafficSelectors ポリシー ベースのトラフィック セレクターを有効にします。 bool
vpnConnectionProtocolType この接続に使用される接続プロトコル。 'IKEv1'
'IKEv2'
vpnGatewayCustomBgpAddresses この接続で使用される vpnGatewayCustomBgpAddresses。 GatewayCustomBgpIpAddressIpConfiguration[]
vpnLinkConnectionMode VPN リンク接続モード。 'Default'
'InitiatorOnly'
'ResponderOnly'
vpnSiteLink 接続されている VPN サイト リンクの ID。 SubResource の