Microsoft.Network virtualNetworkGateways

Bicep リソース定義

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

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

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

リソースの形式

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

resource symbolicname 'Microsoft.Network/virtualNetworkGateways@2025-05-01' = {
  extendedLocation: {
    name: 'string'
    type: 'string'
  }
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    activeActive: bool
    adminState: 'string'
    allowRemoteVnetTraffic: bool
    allowVirtualWanTraffic: bool
    autoScaleConfiguration: {
      bounds: {
        max: int
        min: int
      }
    }
    bgpSettings: {
      asn: int
      bgpPeeringAddress: 'string'
      bgpPeeringAddresses: [
        {
          customBgpIpAddresses: [
            'string'
          ]
          ipconfigurationId: 'string'
        }
      ]
      peerWeight: int
    }
    customRoutes: {
      addressPrefixes: [
        'string'
      ]
      ipamPoolPrefixAllocations: [
        {
          numberOfIpAddresses: 'string'
          pool: {
            id: 'string'
          }
        }
      ]
    }
    disableIPSecReplayProtection: bool
    enableBgp: bool
    enableBgpRouteTranslationForNat: bool
    enableDnsForwarding: bool
    enableHighBandwidthVpnGateway: bool
    enablePrivateIpAddress: bool
    gatewayDefaultSite: {
      id: 'string'
    }
    gatewayType: 'string'
    ipConfigurations: [
      {
        id: 'string'
        name: 'string'
        properties: {
          privateIPAllocationMethod: 'string'
          publicIPAddress: {
            id: 'string'
          }
          subnet: {
            id: 'string'
          }
        }
      }
    ]
    natRules: [
      {
        id: 'string'
        name: 'string'
        properties: {
          externalMappings: [
            {
              addressSpace: 'string'
              portRange: 'string'
            }
          ]
          internalMappings: [
            {
              addressSpace: 'string'
              portRange: 'string'
            }
          ]
          ipConfigurationId: 'string'
          mode: 'string'
          type: 'string'
        }
      }
    ]
    resiliencyModel: 'string'
    sku: {
      name: 'string'
      tier: 'string'
    }
    virtualNetworkGatewayMigrationStatus: {
      errorMessage: 'string'
      phase: 'string'
      state: 'string'
    }
    virtualNetworkGatewayPolicyGroups: [
      {
        id: 'string'
        name: 'string'
        properties: {
          isDefault: bool
          policyMembers: [
            {
              attributeType: 'string'
              attributeValue: 'string'
              name: 'string'
            }
          ]
          priority: int
        }
      }
    ]
    vNetExtendedLocationResourceId: 'string'
    vpnClientConfiguration: {
      aadAudience: 'string'
      aadIssuer: 'string'
      aadTenant: 'string'
      radiusServerAddress: 'string'
      radiusServers: [
        {
          radiusServerAddress: 'string'
          radiusServerScore: int
          radiusServerSecret: 'string'
        }
      ]
      radiusServerSecret: 'string'
      vngClientConnectionConfigurations: [
        {
          id: 'string'
          name: 'string'
          properties: {
            virtualNetworkGatewayPolicyGroups: [
              {
                id: 'string'
              }
            ]
            vpnClientAddressPool: {
              addressPrefixes: [
                'string'
              ]
              ipamPoolPrefixAllocations: [
                {
                  numberOfIpAddresses: 'string'
                  pool: {
                    id: 'string'
                  }
                }
              ]
            }
          }
        }
      ]
      vpnAuthenticationTypes: [
        'string'
      ]
      vpnClientAddressPool: {
        addressPrefixes: [
          'string'
        ]
        ipamPoolPrefixAllocations: [
          {
            numberOfIpAddresses: 'string'
            pool: {
              id: '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'
  }
}

プロパティ値

Microsoft.Network/virtualNetworkGateways

名前 形容 価値
拡張ロケーション ローカル仮想ネットワーク ゲートウェイの種類の拡張された場所。 共通拡張位置
ID 構成されている場合は、仮想ネットワーク ゲートウェイの ID。 CommonManagedServiceIdentity
位置 リソースの場所。 文字列
名前 リソース名 string (必須)
プロパティ 仮想ネットワーク ゲートウェイのプロパティ。 VirtualNetworkGatewayPropertiesFormat (必須)
タグ リソース タグ タグ名と値のディクショナリ。 テンプレート の タグを参照してください

Bgp設定

名前 形容 価値
ASN（エーエスエヌ） BGP スピーカーの ASN。 int

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

コモンアドレススペース

名前 形容 価値
addressプレフィックス CIDR 表記でこの仮想ネットワーク用に予約されているアドレス ブロックの一覧。 文字列[]
ipamPoolPrefixAllocations(英語) IP アドレス プレフィックスを割り当てる IPAM プールの一覧。 CommonIpamPoolPrefixAllocation[]

共通拡張位置

名前 形容 価値
名前 拡張された場所の名前。 文字列
型 拡張された場所の型。 「エッジゾーン」

CommonIpamPoolPrefixAllocation

名前 形容 価値
numberOfIpAddresses 割り当てる IP アドレスの数。 文字列
プール CommonIpamPoolPrefixAllocationPool

CommonIpamPoolPrefixAllocationPool

名前 形容 価値
身分証明書 関連付けられている Azure IpamPool リソースのリソース ID。 文字列

CommonManagedServiceIdentity

名前 形容 価値
型 リソースに使用される ID の種類。 型 'SystemAssigned, UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 種類 'None' は、仮想マシンからすべての ID を削除します。 「なし」
'システム割り当て'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities (ユーザー割り当て済みアイデンティティ) リソースに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ のキー参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。 CommonManagedServiceIdentityUserAssignedIdentities

CommonManagedServiceIdentityUserAssignedIdentities

名前 形容 価値

CommonResourceTags

名前 形容 価値

コモンサブリソース

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

IPConfigurationBgpPeeringAddress (英語)

名前 形容 価値
customBgpIpアドレス IP 構成に属するカスタム BGP ピアリング アドレスの一覧。 文字列[]
ipconfigurationId (英語) ゲートウェイに属する IP 構成の ID。 文字列

IpsecPolicy (英語)

名前 形容 価値
dhGroupの 初期 SA に IKE フェーズ 1 で使用される DH グループ。 「DHGroup1」
「DHGroup14」
「DHGroup2」
「DHGroup2048」
「DHGroup24」
「ECP256」
「ECP384」
'None' (必須)
ike暗号化 IKE 暗号化アルゴリズム (IKE フェーズ 2)。 「AES128」
「AES192」
「AES256」
「DES」
「DES3」
「GCMAES128」
'GCMAES256' (必須)
ikeIntegrityの IKE 整合性アルゴリズム (IKE フェーズ 2)。 「GCMAES128」
「GCMAES256」
「MD5」
「SHA1」
「SHA256」
'SHA384' (必須)
ipsec暗号化 IPSec 暗号化アルゴリズム (IKE フェーズ 1)。 「AES128」
「AES192」
「AES256」
「DES」
「DES3」
「GCMAES128」
「GCMAES192」
「GCMAES256」
'None' (必須)
ipsec整合性 IPSec 整合性アルゴリズム (IKE フェーズ 1)。 「GCMAES128」
「GCMAES192」
「GCMAES256」
「MD5」
「SHA1」
'SHA256' (必須)
pfsグループ IKE フェーズ 2 で新しい子 SA に使用される Pfs グループ。 「ECP256」
「ECP384」
「なし」
「PFS1」
「PFS14」
「PFS2」
「PFS2048」
「PFS24」
'PFSMM' (必須)
saDataSizeキロバイト サイト間 VPN トンネルの IPSec セキュリティ アソシエーション (クイック モードまたはフェーズ 2 SA とも呼ばれます) ペイロード サイズ (KB)。 int (必須)
saLifeTimeSeconds (英語) サイト間 VPN トンネルの IPSec セキュリティ アソシエーション (クイック モードまたはフェーズ 2 SA とも呼ばれます) の有効期間 (秒単位)。 int (必須)

ManagedServiceIdentityUserAssignedIdentities

名前 形容 価値

Radiusサーバー

名前 形容 価値
radiusサーバーアドレス この Radius サーバーのアドレス。 string (必須)
radiusサーバースコア この Radius サーバーに割り当てられた初期スコア。 整数 (int)
radiusサーバーシークレット この Radius サーバーに使用されるシークレット。 VirtualNetworkGateway Create/Update/Get/List/UpdateTags API 応答で radiusServerSecret を返さなくなります。 VirtualNetworkGateway ListRadiusSecrets API を使用して、RADIUS サーバー シークレットをフェッチしてください。 string

制約：
機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。

VirtualNetworkGatewayAutoScaleBounds

名前 形容 価値
マックス 自動スケール構成の最大スケール ユニット数 整数 (int)
分 自動スケール構成の最小スケール ユニット数 整数 (int)

VirtualNetworkGatewayAutoScaleConfiguration (英語)

名前 形容 価値
切り 自動スケール構成の境界 VirtualNetworkGatewayAutoScaleBounds

VirtualNetworkGatewayIPConfiguration (英語)

名前 形容 価値
身分証明書 リソース ID。 文字列
名前 リソース グループ内で一意であるリソースの名前。 この名前は、リソースへのアクセスに使用できます。 文字列
プロパティ 仮想ネットワーク ゲートウェイの IP 構成のプロパティ。 VirtualNetworkGatewayIPConfigurationPropertiesFormat

VirtualNetworkGatewayIPConfigurationPropertiesFormat

名前 形容 価値
privateIPAllocationメソッド プライベート IP アドレスの割り当て方法。 「ダイナミック」
「静的」
publicIPアドレス パブリック IP リソースへの参照。 コモンサブリソース
サブネット サブネット リソースへの参照。 コモンサブリソース

VirtualNetworkGatewayMigrationStatus

名前 形容 価値
エラーメッセージ 移行中にエラーが発生した場合。 文字列
フェーズ ゲートウェイの現在の移行フェーズを表します。 「中止」
'AbortSucceeded'
「コミット」
'コミット成功'
「実行」
'ExecuteSucceeded'
「なし」
'準備'
「PrepareSucceeded」
状態 ゲートウェイの移行の現在の状態を表します。 「失敗しました」
「インプログレス」
「なし」
「成功しました」

VirtualNetworkGatewayNatRule

名前 形容 価値
身分証明書 リソース ID。 文字列
名前 リソースの名前。 文字列
プロパティ 仮想ネットワーク ゲートウェイ NAT 規則のプロパティ。 VirtualNetworkGatewayNatRuleProperties の

VirtualNetworkGatewayNatRuleプロパティ

名前 形容 価値
externalMappings (英語) NAT のプライベート IP アドレス外部マッピング。 VpnNatRuleマッピング[]
internalMappings (英語) NAT のプライベート IP アドレスの内部マッピング。 VpnNatRuleマッピング[]
ipConfigurationId(イプコンフィグレーションイ この NAT 規則が適用される IP 構成 ID。 文字列
モード VPN NAT のソース NAT の方向。 「エグレスナット」
「イングレススナット」
型 VPN NAT の NAT 規則の種類。 「ダイナミック」
「静的」

VirtualNetworkGatewayPolicyGroup

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

VirtualNetworkGatewayPolicyGroupMember (英語)

名前 形容 価値
属性タイプ Vpn Policy メンバー属性の種類。 「AADGroupId」
'CertificateGroupId'
'RadiusAzureGroupId'
attributeValue(属性値) この VirtualNetworkGatewayPolicyGroupMember に使用される属性の値。 文字列
名前 VirtualNetworkGatewayPolicyGroupMember の名前。 文字列

VirtualNetworkGatewayPolicyGroupプロパティ

名前 形容 価値
isDefault (デフォルト) これが既定の VirtualNetworkGatewayPolicyGroup であるかどうかを示します。 bool (必須)
ポリシーメンバー VirtualNetworkGatewayPolicyGroup の複数の PolicyMembers。 VirtualNetworkGatewayPolicyGroupMember[] (必須)
優先権 VirtualNetworkGatewayPolicyGroup の優先度。 int (必須)

VirtualNetworkGatewayPropertiesFormat

名前 形容 価値
アクティブアクティブ ActiveActive フラグ。 ブール (bool)
adminStateの vnet に複数の Express Route ゲートウェイがある場合に Express Route ゲートウェイがトラフィックを処理するかどうかを示すプロパティ 「無効」
「有効」
allowRemoteVnetTraffic (英語) 他の Azure 仮想ネットワークからのトラフィックを受け入れるように、このゲートウェイを構成します。 この構成では、Azure Virtual WAN への接続はサポートされていません。 ブール (bool)
VirtualWanTraffic を許可する リモート Virtual WAN ネットワークからのトラフィックを受け入れるように、このゲートウェイを構成します。 ブール (bool)
自動スケール構成 仮想ネットワーク ゲートウェイの自動スケーリング構成 VirtualNetworkGatewayAutoScaleConfiguration (英語)
bgp設定 仮想ネットワーク ゲートウェイの BGP スピーカー設定。 Bgp設定
カスタムルート 仮想ネットワーク ゲートウェイと VpnClient に対して顧客によって指定されたカスタム ルートアドレス空間を表すアドレス空間リソースへの参照。 コモンアドレススペース
disableIPSecReplayProtection (IPSecリプレイ保護) disableIPSecReplayProtection フラグ。 ブール (bool)
enableBgpの この仮想ネットワーク ゲートウェイに対して BGP が有効かどうか。 ブール (bool)
enableBgpRouteTranslationForNat EnableBgpRouteTranslationForNat フラグ。 ブール (bool)
enableDnsForwarding(英語) DNS 転送が有効かどうか。 ブール (bool)
enableHighBandwidthVpnGateway VPN ゲートウェイの高度な接続機能を有効にするには ブール (bool)
enablePrivateIpAddress 接続のためにこのゲートウェイでプライベート IP を有効にする必要があるかどうか。 ブール (bool)
ゲートウェイ・デフォルト・サイト 既定のルートを持つローカル ネットワーク サイトを表す LocalNetworkGateway リソースへの参照。 既存の既定のサイト設定を削除する場合は Null 値を割り当てます。 コモンサブリソース
ゲートウェイタイプ この仮想ネットワーク ゲートウェイの種類。 「エクスプレスルート」
「ローカルゲートウェイ」
「VPN」
ipConfigurationsの 仮想ネットワーク ゲートウェイの IP 構成。 VirtualNetworkGatewayIPConfiguration[]
natRulesの 仮想ネットワーク ゲートウェイの NatRules。 VirtualNetworkGatewayNatRule[]
レジリエンシーモデル Express Route ゲートウェイに MultiHomed または SingleHomed の回復性モデルがあるかどうかを示すプロパティ 「マルチホーム」
「シングルホーム」
エスケーユー 仮想ネットワーク ゲートウェイ用に選択された SKU を表す VirtualNetworkGatewaySku リソースへの参照。 VirtualNetworkGatewaySku
virtualNetworkGatewayMigrationStatus (英語) 移行の状態を表す VirtualNetworkGatewayMigrationStatus への参照。 VirtualNetworkGatewayMigrationStatus
virtualNetworkGatewayPolicyGroups ゲートウェイで使用可能な VirtualNetworkGatewayPolicyGroup を表す VirtualNetworkGatewayPolicyGroup リソースへの参照。 VirtualNetworkGatewayPolicyGroup[]
vNetExtendedLocationResourceId 顧客 vnet リソース ID。ローカル ゲートウェイの種類の VirtualNetworkGateway は、顧客の vnet に関連付けられています。 文字列
vpnClientConfiguration (vpnクライアント構成) P2S VpnClient 構成を表す VpnClientConfiguration リソースへの参照。 VpnClientConfiguration の
vpnGatewayGeneration この VirtualNetworkGateway の世代。 gatewayType が VPN でない場合は None にする必要があります。 「ジェネレーション1」
「ジェネレーション2」
「なし」
vpnタイプ この仮想ネットワーク ゲートウェイの種類。 「ポリシーベース」
「ルートベース」

VirtualNetworkGatewaySku

名前 形容 価値
名前 ゲートウェイ SKU 名。 「ベーシック」
「ErGw1AZ」
「ErGw2AZ」
「ErGw3AZ」
「ErGwScale」
「ハイパフォーマンス」
「スタンダード」
「ウルトラパフォーマンス」
「VpnGw1」
「VpnGw1AZ」
「VpnGw2」
「VpnGw2AZ」
「VpnGw3」
「VpnGw3AZ」
「VpnGw4」
「VpnGw4AZ」
「VpnGw5」
「VpnGw5AZ」
レベル ゲートウェイ SKU レベル。 「ベーシック」
「ErGw1AZ」
「ErGw2AZ」
「ErGw3AZ」
「ErGwScale」
「ハイパフォーマンス」
「スタンダード」
「ウルトラパフォーマンス」
「VpnGw1」
「VpnGw1AZ」
「VpnGw2」
「VpnGw2AZ」
「VpnGw3」
「VpnGw3AZ」
「VpnGw4」
「VpnGw4AZ」
「VpnGw5」
「VpnGw5AZ」

VngClientConnectionConfiguration (英語)

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

VngClientConnectionConfigurationProperties (英語)

名前 形容 価値
virtualNetworkGatewayPolicyGroups virtualNetworkGatewayPolicyGroups への参照の一覧 共通サブリソース[](必須)
vpnClientAddressPool P2S VpnClient のアドレス空間を表すアドレス空間リソースへの参照。 CommonAddressSpace (必須)

VpnClientConfiguration (英語)

名前 形容 価値
aadオーディエンス AAD 認証に使用される VPN クライアント接続用の VirtualNetworkGateway リソースの AADAudience プロパティ。 文字列
aad発行者 AAD 認証に使用される VPN クライアント接続用の VirtualNetworkGateway リソースの AADIssuer プロパティ。 文字列
aadテナント AAD 認証に使用される VPN クライアント接続用の VirtualNetworkGateway リソースの AADTenant プロパティ。 文字列
radiusサーバーアドレス VPN クライアント接続用の VirtualNetworkGateway リソースの radius サーバー アドレス プロパティ。 文字列
radiusサーバー 複数の radius サーバー構成の radiusServers プロパティ。 RadiusServer[]
radiusサーバーシークレット VPN クライアント接続用の VirtualNetworkGateway リソースの radius シークレット プロパティ。 VirtualNetworkGateway Create/Update/Get/List/UpdateTags API 応答で radiusServerSecret を返さなくなります。 VirtualNetworkGateway ListRadiusSecrets API を使用して、RADIUS サーバー シークレットをフェッチしてください。 string

制約：
機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。
vngClientConnectionConfigurations(vngClientConnectionConfigurations) 仮想ネットワーク ゲートウェイ P2S クライアントの IP アドレス プールごとの接続ポリシー。 VngClientConnectionConfiguration[]
vpnAuthenticationTypes (vpn認証タイプ) 仮想ネットワーク ゲートウェイの VPN 認証の種類。. 次のいずれかを含む文字列配列:
「AAD」
「証明書」
「ラジアス」
vpnClientAddressPool P2S VpnClient のアドレス空間を表すアドレス空間リソースへの参照。 コモンアドレススペース
vpnClientIpsecPolicies (英語) 仮想ネットワーク ゲートウェイ P2S クライアントの VpnClientIpsecPolicies。 イプセックポリシー[]
vpnClientプロトコル 仮想ネットワーク ゲートウェイの VpnClientProtocols。 次のいずれかを含む文字列配列:
「IkeV2」
「OpenVPN」
「SSTP」
vpnClientRevokedCertificates (英語) 仮想ネットワーク ゲートウェイの VpnClientRevokedCertificate。 VpnClientRevokedCertificate[]
vpnClientRoot証明書 仮想ネットワーク ゲートウェイの VpnClientRootCertificate。 VpnClientRoot証明書[]

VpnClientRevokedCertificate (英語)

名前 形容 価値
身分証明書 リソース ID。 文字列
名前 リソース グループ内で一意であるリソースの名前。 この名前は、リソースへのアクセスに使用できます。 文字列
プロパティ VPN クライアントが失効した証明書のプロパティ。 VpnClientRevokedCertificatePropertiesFormat の

VpnClientRevokedCertificatePropertiesFormat

名前 形容 価値
サムプリント 失効した VPN クライアント証明書の拇印。 文字列

VpnClientRoot証明書

名前 形容 価値
身分証明書 リソース ID。 文字列
名前 リソース グループ内で一意であるリソースの名前。 この名前は、リソースへのアクセスに使用できます。 文字列
プロパティ VPN クライアントルート証明書のプロパティ。 VpnClientRootCertificatePropertiesFormat (必須)

VpnClientRootCertificatePropertiesFormat

名前 形容 価値
publicCertData の 証明書のパブリック データ。 string (必須)

VpnNatRuleMapping(英語)

名前 形容 価値
アドレス空間 Vpn NatRule マッピングのアドレス空間。 文字列
ポートレンジ Vpn NatRule マッピングのポート範囲。 文字列

使用例

Bicep サンプル

仮想ネットワーク ゲートウェイをデプロイして、セキュリティで保護されたクロスプレミス接続を確立する基本的な例。

param resourceName string = 'acctest0001'
param location string = 'centralus'

resource publicIPAddress 'Microsoft.Network/publicIPAddresses@2022-07-01' = {
  name: resourceName
  location: location
  properties: {
    ddosSettings: {
      protectionMode: 'VirtualNetworkInherited'
    }
    idleTimeoutInMinutes: 4
    publicIPAddressVersion: 'IPv4'
    publicIPAllocationMethod: 'Static'
  }
  sku: {
    name: 'Standard'
    tier: 'Regional'
  }
}

resource virtualNetwork 'Microsoft.Network/virtualNetworks@2022-07-01' = {
  name: resourceName
  location: location
  properties: {
    addressSpace: {
      addressPrefixes: [
        '10.6.0.0/16'
      ]
    }
    dhcpOptions: {
      dnsServers: []
    }
    subnets: []
  }
  tags: {
    SkipASMAzSecPack: 'true'
  }
}

resource virtualNetworkGateway 'Microsoft.Network/virtualNetworkGateways@2022-07-01' = {
  name: resourceName
  location: location
  properties: {
    activeActive: false
    enableBgp: false
    enablePrivateIpAddress: false
    gatewayType: 'ExpressRoute'
    ipConfigurations: [
      {
        name: 'vnetGatewayConfig'
        properties: {
          privateIPAllocationMethod: 'Dynamic'
          publicIPAddress: {
            id: publicIPAddress.id
          }
          subnet: {
            id: subnet.id
          }
        }
      }
    ]
    sku: {
      name: 'Standard'
      tier: 'Standard'
    }
    vpnType: 'RouteBased'
  }
}

resource subnet 'Microsoft.Network/virtualNetworks/subnets@2022-07-01' = {
  parent: virtualNetwork
  name: 'GatewaySubnet'
  properties: {
    addressPrefix: '10.6.1.0/24'
    delegations: []
    privateEndpointNetworkPolicies: 'Enabled'
    privateLinkServiceNetworkPolicies: 'Enabled'
    serviceEndpointPolicies: []
    serviceEndpoints: []
  }
}

Azure 検証済みモジュール

次の Azure 検証済みモジュール を使用して、このリソースの種類をデプロイできます。

モジュール 形容
仮想ネットワーク ゲートウェイ 仮想ネットワーク ゲートウェイ用の AVM リソース モジュール

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

次 Azure クイック スタート テンプレート、このリソースの種類をデプロイするための Bicep サンプルが含まれています。

Bicep ファイル 形容
BGP VNET から VNET への接続 を作成する このテンプレートを使用すると、仮想ネットワーク ゲートウェイと BGP を使用して 2 つの VNET を接続できます。
Azure AD を使用してポイント対サイト ゲートウェイを作成する このテンプレートは、Azure Active Directory ポイント対サイト接続で構成された VPN Virtual Network Gateway をデプロイします
プライベート ピアリングと Azure VNet を使用した ExpressRoute 回線の このテンプレートは、ExpressRoute Microsoft ピアリングを構成し、Expressroute ゲートウェイを使用して Azure VNet をデプロイし、VNet を ExpressRoute 回線にリンクします
BGP を使用してアクティブ/アクティブ VPN ゲートウェイを使用してサイト間 VPN を する このテンプレートを使用すると、BGP を使用してアクティブ/アクティブ構成の VPN ゲートウェイを持つ 2 つの VNet 間にサイト間 VPN をデプロイできます。 各 Azure VPN Gateway は、リモート ピアの FQDN を解決して、リモート VPN ゲートウェイのパブリック IP を決定します。 テンプレートは、可用性ゾーンを持つ Azure リージョンで想定どおりに実行されます。
ハブ & スポーク トポロジで DNS プロキシとして Azure Firewall を使用する このサンプルでは、Azure Firewall を使用して Azure にハブスポーク トポロジをデプロイする方法を示します。 ハブ仮想ネットワークは、仮想ネットワーク ピアリングを介してハブ仮想ネットワークに接続されている多くのスポーク仮想ネットワークへの接続の中心点として機能します。

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

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

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

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

リソースの形式

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

{
  "type": "Microsoft.Network/virtualNetworkGateways",
  "apiVersion": "2025-05-01",
  "name": "string",
  "extendedLocation": {
    "name": "string",
    "type": "string"
  },
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "activeActive": "bool",
    "adminState": "string",
    "allowRemoteVnetTraffic": "bool",
    "allowVirtualWanTraffic": "bool",
    "autoScaleConfiguration": {
      "bounds": {
        "max": "int",
        "min": "int"
      }
    },
    "bgpSettings": {
      "asn": "int",
      "bgpPeeringAddress": "string",
      "bgpPeeringAddresses": [
        {
          "customBgpIpAddresses": [ "string" ],
          "ipconfigurationId": "string"
        }
      ],
      "peerWeight": "int"
    },
    "customRoutes": {
      "addressPrefixes": [ "string" ],
      "ipamPoolPrefixAllocations": [
        {
          "numberOfIpAddresses": "string",
          "pool": {
            "id": "string"
          }
        }
      ]
    },
    "disableIPSecReplayProtection": "bool",
    "enableBgp": "bool",
    "enableBgpRouteTranslationForNat": "bool",
    "enableDnsForwarding": "bool",
    "enableHighBandwidthVpnGateway": "bool",
    "enablePrivateIpAddress": "bool",
    "gatewayDefaultSite": {
      "id": "string"
    },
    "gatewayType": "string",
    "ipConfigurations": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "privateIPAllocationMethod": "string",
          "publicIPAddress": {
            "id": "string"
          },
          "subnet": {
            "id": "string"
          }
        }
      }
    ],
    "natRules": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "externalMappings": [
            {
              "addressSpace": "string",
              "portRange": "string"
            }
          ],
          "internalMappings": [
            {
              "addressSpace": "string",
              "portRange": "string"
            }
          ],
          "ipConfigurationId": "string",
          "mode": "string",
          "type": "string"
        }
      }
    ],
    "resiliencyModel": "string",
    "sku": {
      "name": "string",
      "tier": "string"
    },
    "virtualNetworkGatewayMigrationStatus": {
      "errorMessage": "string",
      "phase": "string",
      "state": "string"
    },
    "virtualNetworkGatewayPolicyGroups": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "isDefault": "bool",
          "policyMembers": [
            {
              "attributeType": "string",
              "attributeValue": "string",
              "name": "string"
            }
          ],
          "priority": "int"
        }
      }
    ],
    "vNetExtendedLocationResourceId": "string",
    "vpnClientConfiguration": {
      "aadAudience": "string",
      "aadIssuer": "string",
      "aadTenant": "string",
      "radiusServerAddress": "string",
      "radiusServers": [
        {
          "radiusServerAddress": "string",
          "radiusServerScore": "int",
          "radiusServerSecret": "string"
        }
      ],
      "radiusServerSecret": "string",
      "vngClientConnectionConfigurations": [
        {
          "id": "string",
          "name": "string",
          "properties": {
            "virtualNetworkGatewayPolicyGroups": [
              {
                "id": "string"
              }
            ],
            "vpnClientAddressPool": {
              "addressPrefixes": [ "string" ],
              "ipamPoolPrefixAllocations": [
                {
                  "numberOfIpAddresses": "string",
                  "pool": {
                    "id": "string"
                  }
                }
              ]
            }
          }
        }
      ],
      "vpnAuthenticationTypes": [ "string" ],
      "vpnClientAddressPool": {
        "addressPrefixes": [ "string" ],
        "ipamPoolPrefixAllocations": [
          {
            "numberOfIpAddresses": "string",
            "pool": {
              "id": "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"
  }
}

プロパティ値

Microsoft.Network/virtualNetworkGateways

名前 形容 価値
apiVersion (英語) API のバージョン '2025-05-01'
拡張ロケーション ローカル仮想ネットワーク ゲートウェイの種類の拡張された場所。 共通拡張位置
ID 構成されている場合は、仮想ネットワーク ゲートウェイの ID。 CommonManagedServiceIdentity
位置 リソースの場所。 文字列
名前 リソース名 string (必須)
プロパティ 仮想ネットワーク ゲートウェイのプロパティ。 VirtualNetworkGatewayPropertiesFormat (必須)
タグ リソース タグ タグ名と値のディクショナリ。 テンプレート の タグを参照してください
型 リソースの種類 'Microsoft.Network/virtualNetworkGateways'

Bgp設定

名前 形容 価値
ASN（エーエスエヌ） BGP スピーカーの ASN。 int

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

コモンアドレススペース

名前 形容 価値
addressプレフィックス CIDR 表記でこの仮想ネットワーク用に予約されているアドレス ブロックの一覧。 文字列[]
ipamPoolPrefixAllocations(英語) IP アドレス プレフィックスを割り当てる IPAM プールの一覧。 CommonIpamPoolPrefixAllocation[]

共通拡張位置

名前 形容 価値
名前 拡張された場所の名前。 文字列
型 拡張された場所の型。 「エッジゾーン」

CommonIpamPoolPrefixAllocation

名前 形容 価値
numberOfIpAddresses 割り当てる IP アドレスの数。 文字列
プール CommonIpamPoolPrefixAllocationPool

CommonIpamPoolPrefixAllocationPool

名前 形容 価値
身分証明書 関連付けられている Azure IpamPool リソースのリソース ID。 文字列

CommonManagedServiceIdentity

名前 形容 価値
型 リソースに使用される ID の種類。 型 'SystemAssigned, UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 種類 'None' は、仮想マシンからすべての ID を削除します。 「なし」
'システム割り当て'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities (ユーザー割り当て済みアイデンティティ) リソースに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ のキー参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。 CommonManagedServiceIdentityUserAssignedIdentities

CommonManagedServiceIdentityUserAssignedIdentities

名前 形容 価値

CommonResourceTags

名前 形容 価値

コモンサブリソース

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

IPConfigurationBgpPeeringAddress (英語)

名前 形容 価値
customBgpIpアドレス IP 構成に属するカスタム BGP ピアリング アドレスの一覧。 文字列[]
ipconfigurationId (英語) ゲートウェイに属する IP 構成の ID。 文字列

IpsecPolicy (英語)

名前 形容 価値
dhGroupの 初期 SA に IKE フェーズ 1 で使用される DH グループ。 「DHGroup1」
「DHGroup14」
「DHGroup2」
「DHGroup2048」
「DHGroup24」
「ECP256」
「ECP384」
'None' (必須)
ike暗号化 IKE 暗号化アルゴリズム (IKE フェーズ 2)。 「AES128」
「AES192」
「AES256」
「DES」
「DES3」
「GCMAES128」
'GCMAES256' (必須)
ikeIntegrityの IKE 整合性アルゴリズム (IKE フェーズ 2)。 「GCMAES128」
「GCMAES256」
「MD5」
「SHA1」
「SHA256」
'SHA384' (必須)
ipsec暗号化 IPSec 暗号化アルゴリズム (IKE フェーズ 1)。 「AES128」
「AES192」
「AES256」
「DES」
「DES3」
「GCMAES128」
「GCMAES192」
「GCMAES256」
'None' (必須)
ipsec整合性 IPSec 整合性アルゴリズム (IKE フェーズ 1)。 「GCMAES128」
「GCMAES192」
「GCMAES256」
「MD5」
「SHA1」
'SHA256' (必須)
pfsグループ IKE フェーズ 2 で新しい子 SA に使用される Pfs グループ。 「ECP256」
「ECP384」
「なし」
「PFS1」
「PFS14」
「PFS2」
「PFS2048」
「PFS24」
'PFSMM' (必須)
saDataSizeキロバイト サイト間 VPN トンネルの IPSec セキュリティ アソシエーション (クイック モードまたはフェーズ 2 SA とも呼ばれます) ペイロード サイズ (KB)。 int (必須)
saLifeTimeSeconds (英語) サイト間 VPN トンネルの IPSec セキュリティ アソシエーション (クイック モードまたはフェーズ 2 SA とも呼ばれます) の有効期間 (秒単位)。 int (必須)

ManagedServiceIdentityUserAssignedIdentities

名前 形容 価値

Radiusサーバー

名前 形容 価値
radiusサーバーアドレス この Radius サーバーのアドレス。 string (必須)
radiusサーバースコア この Radius サーバーに割り当てられた初期スコア。 整数 (int)
radiusサーバーシークレット この Radius サーバーに使用されるシークレット。 VirtualNetworkGateway Create/Update/Get/List/UpdateTags API 応答で radiusServerSecret を返さなくなります。 VirtualNetworkGateway ListRadiusSecrets API を使用して、RADIUS サーバー シークレットをフェッチしてください。 string

制約：
機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。

VirtualNetworkGatewayAutoScaleBounds

名前 形容 価値
マックス 自動スケール構成の最大スケール ユニット数 整数 (int)
分 自動スケール構成の最小スケール ユニット数 整数 (int)

VirtualNetworkGatewayAutoScaleConfiguration (英語)

名前 形容 価値
切り 自動スケール構成の境界 VirtualNetworkGatewayAutoScaleBounds

VirtualNetworkGatewayIPConfiguration (英語)

名前 形容 価値
身分証明書 リソース ID。 文字列
名前 リソース グループ内で一意であるリソースの名前。 この名前は、リソースへのアクセスに使用できます。 文字列
プロパティ 仮想ネットワーク ゲートウェイの IP 構成のプロパティ。 VirtualNetworkGatewayIPConfigurationPropertiesFormat

VirtualNetworkGatewayIPConfigurationPropertiesFormat

名前 形容 価値
privateIPAllocationメソッド プライベート IP アドレスの割り当て方法。 「ダイナミック」
「静的」
publicIPアドレス パブリック IP リソースへの参照。 コモンサブリソース
サブネット サブネット リソースへの参照。 コモンサブリソース

VirtualNetworkGatewayMigrationStatus

名前 形容 価値
エラーメッセージ 移行中にエラーが発生した場合。 文字列
フェーズ ゲートウェイの現在の移行フェーズを表します。 「中止」
'AbortSucceeded'
「コミット」
'コミット成功'
「実行」
'ExecuteSucceeded'
「なし」
'準備'
「PrepareSucceeded」
状態 ゲートウェイの移行の現在の状態を表します。 「失敗しました」
「インプログレス」
「なし」
「成功しました」

VirtualNetworkGatewayNatRule

名前 形容 価値
身分証明書 リソース ID。 文字列
名前 リソースの名前。 文字列
プロパティ 仮想ネットワーク ゲートウェイ NAT 規則のプロパティ。 VirtualNetworkGatewayNatRuleProperties の

VirtualNetworkGatewayNatRuleプロパティ

名前 形容 価値
externalMappings (英語) NAT のプライベート IP アドレス外部マッピング。 VpnNatRuleマッピング[]
internalMappings (英語) NAT のプライベート IP アドレスの内部マッピング。 VpnNatRuleマッピング[]
ipConfigurationId(イプコンフィグレーションイ この NAT 規則が適用される IP 構成 ID。 文字列
モード VPN NAT のソース NAT の方向。 「エグレスナット」
「イングレススナット」
型 VPN NAT の NAT 規則の種類。 「ダイナミック」
「静的」

VirtualNetworkGatewayPolicyGroup

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

VirtualNetworkGatewayPolicyGroupMember (英語)

名前 形容 価値
属性タイプ Vpn Policy メンバー属性の種類。 「AADGroupId」
'CertificateGroupId'
'RadiusAzureGroupId'
attributeValue(属性値) この VirtualNetworkGatewayPolicyGroupMember に使用される属性の値。 文字列
名前 VirtualNetworkGatewayPolicyGroupMember の名前。 文字列

VirtualNetworkGatewayPolicyGroupプロパティ

名前 形容 価値
isDefault (デフォルト) これが既定の VirtualNetworkGatewayPolicyGroup であるかどうかを示します。 bool (必須)
ポリシーメンバー VirtualNetworkGatewayPolicyGroup の複数の PolicyMembers。 VirtualNetworkGatewayPolicyGroupMember[] (必須)
優先権 VirtualNetworkGatewayPolicyGroup の優先度。 int (必須)

VirtualNetworkGatewayPropertiesFormat

名前 形容 価値
アクティブアクティブ ActiveActive フラグ。 ブール (bool)
adminStateの vnet に複数の Express Route ゲートウェイがある場合に Express Route ゲートウェイがトラフィックを処理するかどうかを示すプロパティ 「無効」
「有効」
allowRemoteVnetTraffic (英語) 他の Azure 仮想ネットワークからのトラフィックを受け入れるように、このゲートウェイを構成します。 この構成では、Azure Virtual WAN への接続はサポートされていません。 ブール (bool)
VirtualWanTraffic を許可する リモート Virtual WAN ネットワークからのトラフィックを受け入れるように、このゲートウェイを構成します。 ブール (bool)
自動スケール構成 仮想ネットワーク ゲートウェイの自動スケーリング構成 VirtualNetworkGatewayAutoScaleConfiguration (英語)
bgp設定 仮想ネットワーク ゲートウェイの BGP スピーカー設定。 Bgp設定
カスタムルート 仮想ネットワーク ゲートウェイと VpnClient に対して顧客によって指定されたカスタム ルートアドレス空間を表すアドレス空間リソースへの参照。 コモンアドレススペース
disableIPSecReplayProtection (IPSecリプレイ保護) disableIPSecReplayProtection フラグ。 ブール (bool)
enableBgpの この仮想ネットワーク ゲートウェイに対して BGP が有効かどうか。 ブール (bool)
enableBgpRouteTranslationForNat EnableBgpRouteTranslationForNat フラグ。 ブール (bool)
enableDnsForwarding(英語) DNS 転送が有効かどうか。 ブール (bool)
enableHighBandwidthVpnGateway VPN ゲートウェイの高度な接続機能を有効にするには ブール (bool)
enablePrivateIpAddress 接続のためにこのゲートウェイでプライベート IP を有効にする必要があるかどうか。 ブール (bool)
ゲートウェイ・デフォルト・サイト 既定のルートを持つローカル ネットワーク サイトを表す LocalNetworkGateway リソースへの参照。 既存の既定のサイト設定を削除する場合は Null 値を割り当てます。 コモンサブリソース
ゲートウェイタイプ この仮想ネットワーク ゲートウェイの種類。 「エクスプレスルート」
「ローカルゲートウェイ」
「VPN」
ipConfigurationsの 仮想ネットワーク ゲートウェイの IP 構成。 VirtualNetworkGatewayIPConfiguration[]
natRulesの 仮想ネットワーク ゲートウェイの NatRules。 VirtualNetworkGatewayNatRule[]
レジリエンシーモデル Express Route ゲートウェイに MultiHomed または SingleHomed の回復性モデルがあるかどうかを示すプロパティ 「マルチホーム」
「シングルホーム」
エスケーユー 仮想ネットワーク ゲートウェイ用に選択された SKU を表す VirtualNetworkGatewaySku リソースへの参照。 VirtualNetworkGatewaySku
virtualNetworkGatewayMigrationStatus (英語) 移行の状態を表す VirtualNetworkGatewayMigrationStatus への参照。 VirtualNetworkGatewayMigrationStatus
virtualNetworkGatewayPolicyGroups ゲートウェイで使用可能な VirtualNetworkGatewayPolicyGroup を表す VirtualNetworkGatewayPolicyGroup リソースへの参照。 VirtualNetworkGatewayPolicyGroup[]
vNetExtendedLocationResourceId 顧客 vnet リソース ID。ローカル ゲートウェイの種類の VirtualNetworkGateway は、顧客の vnet に関連付けられています。 文字列
vpnClientConfiguration (vpnクライアント構成) P2S VpnClient 構成を表す VpnClientConfiguration リソースへの参照。 VpnClientConfiguration の
vpnGatewayGeneration この VirtualNetworkGateway の世代。 gatewayType が VPN でない場合は None にする必要があります。 「ジェネレーション1」
「ジェネレーション2」
「なし」
vpnタイプ この仮想ネットワーク ゲートウェイの種類。 「ポリシーベース」
「ルートベース」

VirtualNetworkGatewaySku

名前 形容 価値
名前 ゲートウェイ SKU 名。 「ベーシック」
「ErGw1AZ」
「ErGw2AZ」
「ErGw3AZ」
「ErGwScale」
「ハイパフォーマンス」
「スタンダード」
「ウルトラパフォーマンス」
「VpnGw1」
「VpnGw1AZ」
「VpnGw2」
「VpnGw2AZ」
「VpnGw3」
「VpnGw3AZ」
「VpnGw4」
「VpnGw4AZ」
「VpnGw5」
「VpnGw5AZ」
レベル ゲートウェイ SKU レベル。 「ベーシック」
「ErGw1AZ」
「ErGw2AZ」
「ErGw3AZ」
「ErGwScale」
「ハイパフォーマンス」
「スタンダード」
「ウルトラパフォーマンス」
「VpnGw1」
「VpnGw1AZ」
「VpnGw2」
「VpnGw2AZ」
「VpnGw3」
「VpnGw3AZ」
「VpnGw4」
「VpnGw4AZ」
「VpnGw5」
「VpnGw5AZ」

VngClientConnectionConfiguration (英語)

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

VngClientConnectionConfigurationProperties (英語)

名前 形容 価値
virtualNetworkGatewayPolicyGroups virtualNetworkGatewayPolicyGroups への参照の一覧 共通サブリソース[](必須)
vpnClientAddressPool P2S VpnClient のアドレス空間を表すアドレス空間リソースへの参照。 CommonAddressSpace (必須)

VpnClientConfiguration (英語)

名前 形容 価値
aadオーディエンス AAD 認証に使用される VPN クライアント接続用の VirtualNetworkGateway リソースの AADAudience プロパティ。 文字列
aad発行者 AAD 認証に使用される VPN クライアント接続用の VirtualNetworkGateway リソースの AADIssuer プロパティ。 文字列
aadテナント AAD 認証に使用される VPN クライアント接続用の VirtualNetworkGateway リソースの AADTenant プロパティ。 文字列
radiusサーバーアドレス VPN クライアント接続用の VirtualNetworkGateway リソースの radius サーバー アドレス プロパティ。 文字列
radiusサーバー 複数の radius サーバー構成の radiusServers プロパティ。 RadiusServer[]
radiusサーバーシークレット VPN クライアント接続用の VirtualNetworkGateway リソースの radius シークレット プロパティ。 VirtualNetworkGateway Create/Update/Get/List/UpdateTags API 応答で radiusServerSecret を返さなくなります。 VirtualNetworkGateway ListRadiusSecrets API を使用して、RADIUS サーバー シークレットをフェッチしてください。 string

制約：
機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。
vngClientConnectionConfigurations(vngClientConnectionConfigurations) 仮想ネットワーク ゲートウェイ P2S クライアントの IP アドレス プールごとの接続ポリシー。 VngClientConnectionConfiguration[]
vpnAuthenticationTypes (vpn認証タイプ) 仮想ネットワーク ゲートウェイの VPN 認証の種類。. 次のいずれかを含む文字列配列:
「AAD」
「証明書」
「ラジアス」
vpnClientAddressPool P2S VpnClient のアドレス空間を表すアドレス空間リソースへの参照。 コモンアドレススペース
vpnClientIpsecPolicies (英語) 仮想ネットワーク ゲートウェイ P2S クライアントの VpnClientIpsecPolicies。 イプセックポリシー[]
vpnClientプロトコル 仮想ネットワーク ゲートウェイの VpnClientProtocols。 次のいずれかを含む文字列配列:
「IkeV2」
「OpenVPN」
「SSTP」
vpnClientRevokedCertificates (英語) 仮想ネットワーク ゲートウェイの VpnClientRevokedCertificate。 VpnClientRevokedCertificate[]
vpnClientRoot証明書 仮想ネットワーク ゲートウェイの VpnClientRootCertificate。 VpnClientRoot証明書[]

VpnClientRevokedCertificate (英語)

名前 形容 価値
身分証明書 リソース ID。 文字列
名前 リソース グループ内で一意であるリソースの名前。 この名前は、リソースへのアクセスに使用できます。 文字列
プロパティ VPN クライアントが失効した証明書のプロパティ。 VpnClientRevokedCertificatePropertiesFormat の

VpnClientRevokedCertificatePropertiesFormat

名前 形容 価値
サムプリント 失効した VPN クライアント証明書の拇印。 文字列

VpnClientRoot証明書

名前 形容 価値
身分証明書 リソース ID。 文字列
名前 リソース グループ内で一意であるリソースの名前。 この名前は、リソースへのアクセスに使用できます。 文字列
プロパティ VPN クライアントルート証明書のプロパティ。 VpnClientRootCertificatePropertiesFormat (必須)

VpnClientRootCertificatePropertiesFormat

名前 形容 価値
publicCertData の 証明書のパブリック データ。 string (必須)

VpnNatRuleMapping(英語)

名前 形容 価値
アドレス空間 Vpn NatRule マッピングのアドレス空間。 文字列
ポートレンジ Vpn NatRule マッピングのポート範囲。 文字列

使用例

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

このリソースの種類 デプロイする Azure クイック スタート テンプレート 次に示します。

テンプレート 形容
Azure SQL バックエンド を使用した App Service Environment の

Azure にデプロイする 		このテンプレートは、プライベート/分離環境で通常使用される関連リソースと共に、Azure SQL バックエンドとプライベート エンドポイントを含む App Service Environment を作成します。
ExpressRoute 回線を VNET に接続する

Azure にデプロイする 		このテンプレートでは、VNET、ExpresRoute ゲートウェイ、および AzurePrivatePeering が構成されたプロビジョニング済みで有効な ExpressRoute 回線への接続が作成されます。
BGP VNET から VNET への接続 を作成する

Azure にデプロイする 		このテンプレートを使用すると、仮想ネットワーク ゲートウェイと BGP を使用して 2 つの VNET を接続できます。
P2S VPN と IIS を使用して DevTest 環境を作成する

Azure にデプロイする 		このテンプレートは、Windows サーバー上にポイント対サイト VPN と IIS を使用して単純な DevTest 環境を作成します。これは、作業を開始するための優れた方法です。
ポイント対サイト ゲートウェイ を作成する

Azure にデプロイする 		このテンプレートを使用すると、VirtualNetworkGateways を使用してポイント対サイト接続を作成できます。
Azure AD を使用してポイント対サイト ゲートウェイを作成する

Azure にデプロイする 		このテンプレートは、Azure Active Directory ポイント対サイト接続で構成された VPN Virtual Network Gateway をデプロイします
サイト間 VPN 接続 を作成する

Azure にデプロイする 		このテンプレートを使用すると、仮想ネットワーク ゲートウェイを使用してサイト間 VPN 接続を作成できます。
VM を使用してサイト間 VPN 接続を作成する

Azure にデプロイする 		このテンプレートを使用すると、仮想ネットワーク ゲートウェイを使用してサイト間 VPN 接続を作成できます。
2 つのリージョン間で VNET 間接続を作成

Azure にデプロイする 		このテンプレートを使用すると、Virtual Network ゲートウェイを使用して、異なるリージョンの 2 つの VNET を接続できます。
ポイント対サイト接続が構成された SQL MI を作成

Azure にデプロイする 		新しい仮想ネットワーク内にポイント対サイト接続用に構成された Azure Sql Database Managed Instance (SQL MI) と仮想ネットワーク ゲートウェイをデプロイします。
推移的な BGP 接続の を示す 3 つの vNet を作成する

Azure にデプロイする 		このテンプレートでは、仮想ネットワーク ゲートウェイと BGP 対応接続を使用して接続された 3 つの vNet をデプロイします
2 つのサブネット、ローカル ネットワーク、ゲートウェイ を含む VNet を作成する

Azure にデプロイする 		このテンプレートは、VNet、2 つのサブネット、およびゲートウェイを作成します。
ハブ アンド スポーク トポロジ サンドボックス をデプロイする

Azure にデプロイする 		このテンプレートは、基本的なハブ アンド スポーク トポロジのセットアップを作成します。 サブネット DMZ、管理、共有、ゲートウェイ (必要に応じて) を含むハブ VNet を作成し、それぞれにワークロード サブネットを含む 2 つのスポーク VNet (開発と運用) を作成します。 また、ハブの管理サブネットに Windows Jump-Host をデプロイし、ハブと 2 つのスポークの間に VNet ピアリングを確立します。
HBase geo レプリケーション をデプロイする

Azure にデプロイする 		このテンプレートを使用すると、VPN vnet 間接続を使用して、2 つの異なるリージョン間で HBase レプリケーション用の Azure 環境を構成できます。
プライベート ピアリングと Azure VNet を使用した ExpressRoute 回線の

Azure にデプロイする 		このテンプレートは、ExpressRoute Microsoft ピアリングを構成し、Expressroute ゲートウェイを使用して Azure VNet をデプロイし、VNet を ExpressRoute 回線にリンクします
既存の Azure VNET をマルチ VNET 構成 に拡張する

Azure にデプロイする 		このテンプレートを使用すると、既存の単一の VNET 環境を、VNET 間ゲートウェイを使用して 2 つのデータセンター リージョンにまたがるマルチ VNET 環境に拡張できます。
BGP を使用してアクティブ/アクティブ VPN ゲートウェイを使用してサイト間 VPN を する

Azure にデプロイする 		このテンプレートを使用すると、BGP を使用してアクティブ/アクティブ構成の VPN ゲートウェイを持つ 2 つの VNet 間にサイト間 VPN をデプロイできます。 各 Azure VPN Gateway は、リモート ピアの FQDN を解決して、リモート VPN ゲートウェイのパブリック IP を決定します。 テンプレートは、可用性ゾーンを持つ Azure リージョンで想定どおりに実行されます。
ハブ & スポーク トポロジで DNS プロキシとして Azure Firewall を使用する

Azure にデプロイする 		このサンプルでは、Azure Firewall を使用して Azure にハブスポーク トポロジをデプロイする方法を示します。 ハブ仮想ネットワークは、仮想ネットワーク ピアリングを介してハブ仮想ネットワークに接続されている多くのスポーク仮想ネットワークへの接続の中心点として機能します。

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

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

  • リソース グループ

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

リソースの形式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/virtualNetworkGateways@2025-05-01"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "string"
    ]
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    extendedLocation = {
      name = "string"
      type = "string"
    }
    properties = {
      activeActive = bool
      adminState = "string"
      allowRemoteVnetTraffic = bool
      allowVirtualWanTraffic = bool
      autoScaleConfiguration = {
        bounds = {
          max = int
          min = int
        }
      }
      bgpSettings = {
        asn = int
        bgpPeeringAddress = "string"
        bgpPeeringAddresses = [
          {
            customBgpIpAddresses = [
              "string"
            ]
            ipconfigurationId = "string"
          }
        ]
        peerWeight = int
      }
      customRoutes = {
        addressPrefixes = [
          "string"
        ]
        ipamPoolPrefixAllocations = [
          {
            numberOfIpAddresses = "string"
            pool = {
              id = "string"
            }
          }
        ]
      }
      disableIPSecReplayProtection = bool
      enableBgp = bool
      enableBgpRouteTranslationForNat = bool
      enableDnsForwarding = bool
      enableHighBandwidthVpnGateway = bool
      enablePrivateIpAddress = bool
      gatewayDefaultSite = {
        id = "string"
      }
      gatewayType = "string"
      ipConfigurations = [
        {
          id = "string"
          name = "string"
          properties = {
            privateIPAllocationMethod = "string"
            publicIPAddress = {
              id = "string"
            }
            subnet = {
              id = "string"
            }
          }
        }
      ]
      natRules = [
        {
          id = "string"
          name = "string"
          properties = {
            externalMappings = [
              {
                addressSpace = "string"
                portRange = "string"
              }
            ]
            internalMappings = [
              {
                addressSpace = "string"
                portRange = "string"
              }
            ]
            ipConfigurationId = "string"
            mode = "string"
            type = "string"
          }
        }
      ]
      resiliencyModel = "string"
      sku = {
        name = "string"
        tier = "string"
      }
      virtualNetworkGatewayMigrationStatus = {
        errorMessage = "string"
        phase = "string"
        state = "string"
      }
      virtualNetworkGatewayPolicyGroups = [
        {
          id = "string"
          name = "string"
          properties = {
            isDefault = bool
            policyMembers = [
              {
                attributeType = "string"
                attributeValue = "string"
                name = "string"
              }
            ]
            priority = int
          }
        }
      ]
      vNetExtendedLocationResourceId = "string"
      vpnClientConfiguration = {
        aadAudience = "string"
        aadIssuer = "string"
        aadTenant = "string"
        radiusServerAddress = "string"
        radiusServers = [
          {
            radiusServerAddress = "string"
            radiusServerScore = int
            radiusServerSecret = "string"
          }
        ]
        radiusServerSecret = "string"
        vngClientConnectionConfigurations = [
          {
            id = "string"
            name = "string"
            properties = {
              virtualNetworkGatewayPolicyGroups = [
                {
                  id = "string"
                }
              ]
              vpnClientAddressPool = {
                addressPrefixes = [
                  "string"
                ]
                ipamPoolPrefixAllocations = [
                  {
                    numberOfIpAddresses = "string"
                    pool = {
                      id = "string"
                    }
                  }
                ]
              }
            }
          }
        ]
        vpnAuthenticationTypes = [
          "string"
        ]
        vpnClientAddressPool = {
          addressPrefixes = [
            "string"
          ]
          ipamPoolPrefixAllocations = [
            {
              numberOfIpAddresses = "string"
              pool = {
                id = "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"
    }
  }
}

プロパティ値

Microsoft.Network/virtualNetworkGateways

名前 形容 価値
拡張ロケーション ローカル仮想ネットワーク ゲートウェイの種類の拡張された場所。 共通拡張位置
ID 構成されている場合は、仮想ネットワーク ゲートウェイの ID。 CommonManagedServiceIdentity
位置 リソースの場所。 文字列
名前 リソース名 string (必須)
プロパティ 仮想ネットワーク ゲートウェイのプロパティ。 VirtualNetworkGatewayPropertiesFormat (必須)
タグ リソース タグ タグ名と値のディクショナリ。
型 リソースの種類 「Microsoft.Network/virtualNetworkGateways@2025-05-01」

Bgp設定

名前 形容 価値
ASN（エーエスエヌ） BGP スピーカーの ASN。 int

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

コモンアドレススペース

名前 形容 価値
addressプレフィックス CIDR 表記でこの仮想ネットワーク用に予約されているアドレス ブロックの一覧。 文字列[]
ipamPoolPrefixAllocations(英語) IP アドレス プレフィックスを割り当てる IPAM プールの一覧。 CommonIpamPoolPrefixAllocation[]

共通拡張位置

名前 形容 価値
名前 拡張された場所の名前。 文字列
型 拡張された場所の型。 「エッジゾーン」

CommonIpamPoolPrefixAllocation

名前 形容 価値
numberOfIpAddresses 割り当てる IP アドレスの数。 文字列
プール CommonIpamPoolPrefixAllocationPool

CommonIpamPoolPrefixAllocationPool

名前 形容 価値
身分証明書 関連付けられている Azure IpamPool リソースのリソース ID。 文字列

CommonManagedServiceIdentity

名前 形容 価値
型 リソースに使用される ID の種類。 型 'SystemAssigned, UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 種類 'None' は、仮想マシンからすべての ID を削除します。 「なし」
'システム割り当て'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities (ユーザー割り当て済みアイデンティティ) リソースに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ のキー参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。 CommonManagedServiceIdentityUserAssignedIdentities

CommonManagedServiceIdentityUserAssignedIdentities

名前 形容 価値

CommonResourceTags

名前 形容 価値

コモンサブリソース

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

IPConfigurationBgpPeeringAddress (英語)

名前 形容 価値
customBgpIpアドレス IP 構成に属するカスタム BGP ピアリング アドレスの一覧。 文字列[]
ipconfigurationId (英語) ゲートウェイに属する IP 構成の ID。 文字列

IpsecPolicy (英語)

名前 形容 価値
dhGroupの 初期 SA に IKE フェーズ 1 で使用される DH グループ。 「DHGroup1」
「DHGroup14」
「DHGroup2」
「DHGroup2048」
「DHGroup24」
「ECP256」
「ECP384」
'None' (必須)
ike暗号化 IKE 暗号化アルゴリズム (IKE フェーズ 2)。 「AES128」
「AES192」
「AES256」
「DES」
「DES3」
「GCMAES128」
'GCMAES256' (必須)
ikeIntegrityの IKE 整合性アルゴリズム (IKE フェーズ 2)。 「GCMAES128」
「GCMAES256」
「MD5」
「SHA1」
「SHA256」
'SHA384' (必須)
ipsec暗号化 IPSec 暗号化アルゴリズム (IKE フェーズ 1)。 「AES128」
「AES192」
「AES256」
「DES」
「DES3」
「GCMAES128」
「GCMAES192」
「GCMAES256」
'None' (必須)
ipsec整合性 IPSec 整合性アルゴリズム (IKE フェーズ 1)。 「GCMAES128」
「GCMAES192」
「GCMAES256」
「MD5」
「SHA1」
'SHA256' (必須)
pfsグループ IKE フェーズ 2 で新しい子 SA に使用される Pfs グループ。 「ECP256」
「ECP384」
「なし」
「PFS1」
「PFS14」
「PFS2」
「PFS2048」
「PFS24」
'PFSMM' (必須)
saDataSizeキロバイト サイト間 VPN トンネルの IPSec セキュリティ アソシエーション (クイック モードまたはフェーズ 2 SA とも呼ばれます) ペイロード サイズ (KB)。 int (必須)
saLifeTimeSeconds (英語) サイト間 VPN トンネルの IPSec セキュリティ アソシエーション (クイック モードまたはフェーズ 2 SA とも呼ばれます) の有効期間 (秒単位)。 int (必須)

ManagedServiceIdentityUserAssignedIdentities

名前 形容 価値

Radiusサーバー

名前 形容 価値
radiusサーバーアドレス この Radius サーバーのアドレス。 string (必須)
radiusサーバースコア この Radius サーバーに割り当てられた初期スコア。 整数 (int)
radiusサーバーシークレット この Radius サーバーに使用されるシークレット。 VirtualNetworkGateway Create/Update/Get/List/UpdateTags API 応答で radiusServerSecret を返さなくなります。 VirtualNetworkGateway ListRadiusSecrets API を使用して、RADIUS サーバー シークレットをフェッチしてください。 string

制約：
機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。

VirtualNetworkGatewayAutoScaleBounds

名前 形容 価値
マックス 自動スケール構成の最大スケール ユニット数 整数 (int)
分 自動スケール構成の最小スケール ユニット数 整数 (int)

VirtualNetworkGatewayAutoScaleConfiguration (英語)

名前 形容 価値
切り 自動スケール構成の境界 VirtualNetworkGatewayAutoScaleBounds

VirtualNetworkGatewayIPConfiguration (英語)

名前 形容 価値
身分証明書 リソース ID。 文字列
名前 リソース グループ内で一意であるリソースの名前。 この名前は、リソースへのアクセスに使用できます。 文字列
プロパティ 仮想ネットワーク ゲートウェイの IP 構成のプロパティ。 VirtualNetworkGatewayIPConfigurationPropertiesFormat

VirtualNetworkGatewayIPConfigurationPropertiesFormat

名前 形容 価値
privateIPAllocationメソッド プライベート IP アドレスの割り当て方法。 「ダイナミック」
「静的」
publicIPアドレス パブリック IP リソースへの参照。 コモンサブリソース
サブネット サブネット リソースへの参照。 コモンサブリソース

VirtualNetworkGatewayMigrationStatus

名前 形容 価値
エラーメッセージ 移行中にエラーが発生した場合。 文字列
フェーズ ゲートウェイの現在の移行フェーズを表します。 「中止」
'AbortSucceeded'
「コミット」
'コミット成功'
「実行」
'ExecuteSucceeded'
「なし」
'準備'
「PrepareSucceeded」
状態 ゲートウェイの移行の現在の状態を表します。 「失敗しました」
「インプログレス」
「なし」
「成功しました」

VirtualNetworkGatewayNatRule

名前 形容 価値
身分証明書 リソース ID。 文字列
名前 リソースの名前。 文字列
プロパティ 仮想ネットワーク ゲートウェイ NAT 規則のプロパティ。 VirtualNetworkGatewayNatRuleProperties の

VirtualNetworkGatewayNatRuleプロパティ

名前 形容 価値
externalMappings (英語) NAT のプライベート IP アドレス外部マッピング。 VpnNatRuleマッピング[]
internalMappings (英語) NAT のプライベート IP アドレスの内部マッピング。 VpnNatRuleマッピング[]
ipConfigurationId(イプコンフィグレーションイ この NAT 規則が適用される IP 構成 ID。 文字列
モード VPN NAT のソース NAT の方向。 「エグレスナット」
「イングレススナット」
型 VPN NAT の NAT 規則の種類。 「ダイナミック」
「静的」

VirtualNetworkGatewayPolicyGroup

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

VirtualNetworkGatewayPolicyGroupMember (英語)

名前 形容 価値
属性タイプ Vpn Policy メンバー属性の種類。 「AADGroupId」
'CertificateGroupId'
'RadiusAzureGroupId'
attributeValue(属性値) この VirtualNetworkGatewayPolicyGroupMember に使用される属性の値。 文字列
名前 VirtualNetworkGatewayPolicyGroupMember の名前。 文字列

VirtualNetworkGatewayPolicyGroupプロパティ

名前 形容 価値
isDefault (デフォルト) これが既定の VirtualNetworkGatewayPolicyGroup であるかどうかを示します。 bool (必須)
ポリシーメンバー VirtualNetworkGatewayPolicyGroup の複数の PolicyMembers。 VirtualNetworkGatewayPolicyGroupMember[] (必須)
優先権 VirtualNetworkGatewayPolicyGroup の優先度。 int (必須)

VirtualNetworkGatewayPropertiesFormat

名前 形容 価値
アクティブアクティブ ActiveActive フラグ。 ブール (bool)
adminStateの vnet に複数の Express Route ゲートウェイがある場合に Express Route ゲートウェイがトラフィックを処理するかどうかを示すプロパティ 「無効」
「有効」
allowRemoteVnetTraffic (英語) 他の Azure 仮想ネットワークからのトラフィックを受け入れるように、このゲートウェイを構成します。 この構成では、Azure Virtual WAN への接続はサポートされていません。 ブール (bool)
VirtualWanTraffic を許可する リモート Virtual WAN ネットワークからのトラフィックを受け入れるように、このゲートウェイを構成します。 ブール (bool)
自動スケール構成 仮想ネットワーク ゲートウェイの自動スケーリング構成 VirtualNetworkGatewayAutoScaleConfiguration (英語)
bgp設定 仮想ネットワーク ゲートウェイの BGP スピーカー設定。 Bgp設定
カスタムルート 仮想ネットワーク ゲートウェイと VpnClient に対して顧客によって指定されたカスタム ルートアドレス空間を表すアドレス空間リソースへの参照。 コモンアドレススペース
disableIPSecReplayProtection (IPSecリプレイ保護) disableIPSecReplayProtection フラグ。 ブール (bool)
enableBgpの この仮想ネットワーク ゲートウェイに対して BGP が有効かどうか。 ブール (bool)
enableBgpRouteTranslationForNat EnableBgpRouteTranslationForNat フラグ。 ブール (bool)
enableDnsForwarding(英語) DNS 転送が有効かどうか。 ブール (bool)
enableHighBandwidthVpnGateway VPN ゲートウェイの高度な接続機能を有効にするには ブール (bool)
enablePrivateIpAddress 接続のためにこのゲートウェイでプライベート IP を有効にする必要があるかどうか。 ブール (bool)
ゲートウェイ・デフォルト・サイト 既定のルートを持つローカル ネットワーク サイトを表す LocalNetworkGateway リソースへの参照。 既存の既定のサイト設定を削除する場合は Null 値を割り当てます。 コモンサブリソース
ゲートウェイタイプ この仮想ネットワーク ゲートウェイの種類。 「エクスプレスルート」
「ローカルゲートウェイ」
「VPN」
ipConfigurationsの 仮想ネットワーク ゲートウェイの IP 構成。 VirtualNetworkGatewayIPConfiguration[]
natRulesの 仮想ネットワーク ゲートウェイの NatRules。 VirtualNetworkGatewayNatRule[]
レジリエンシーモデル Express Route ゲートウェイに MultiHomed または SingleHomed の回復性モデルがあるかどうかを示すプロパティ 「マルチホーム」
「シングルホーム」
エスケーユー 仮想ネットワーク ゲートウェイ用に選択された SKU を表す VirtualNetworkGatewaySku リソースへの参照。 VirtualNetworkGatewaySku
virtualNetworkGatewayMigrationStatus (英語) 移行の状態を表す VirtualNetworkGatewayMigrationStatus への参照。 VirtualNetworkGatewayMigrationStatus
virtualNetworkGatewayPolicyGroups ゲートウェイで使用可能な VirtualNetworkGatewayPolicyGroup を表す VirtualNetworkGatewayPolicyGroup リソースへの参照。 VirtualNetworkGatewayPolicyGroup[]
vNetExtendedLocationResourceId 顧客 vnet リソース ID。ローカル ゲートウェイの種類の VirtualNetworkGateway は、顧客の vnet に関連付けられています。 文字列
vpnClientConfiguration (vpnクライアント構成) P2S VpnClient 構成を表す VpnClientConfiguration リソースへの参照。 VpnClientConfiguration の
vpnGatewayGeneration この VirtualNetworkGateway の世代。 gatewayType が VPN でない場合は None にする必要があります。 「ジェネレーション1」
「ジェネレーション2」
「なし」
vpnタイプ この仮想ネットワーク ゲートウェイの種類。 「ポリシーベース」
「ルートベース」

VirtualNetworkGatewaySku

名前 形容 価値
名前 ゲートウェイ SKU 名。 「ベーシック」
「ErGw1AZ」
「ErGw2AZ」
「ErGw3AZ」
「ErGwScale」
「ハイパフォーマンス」
「スタンダード」
「ウルトラパフォーマンス」
「VpnGw1」
「VpnGw1AZ」
「VpnGw2」
「VpnGw2AZ」
「VpnGw3」
「VpnGw3AZ」
「VpnGw4」
「VpnGw4AZ」
「VpnGw5」
「VpnGw5AZ」
レベル ゲートウェイ SKU レベル。 「ベーシック」
「ErGw1AZ」
「ErGw2AZ」
「ErGw3AZ」
「ErGwScale」
「ハイパフォーマンス」
「スタンダード」
「ウルトラパフォーマンス」
「VpnGw1」
「VpnGw1AZ」
「VpnGw2」
「VpnGw2AZ」
「VpnGw3」
「VpnGw3AZ」
「VpnGw4」
「VpnGw4AZ」
「VpnGw5」
「VpnGw5AZ」

VngClientConnectionConfiguration (英語)

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

VngClientConnectionConfigurationProperties (英語)

名前 形容 価値
virtualNetworkGatewayPolicyGroups virtualNetworkGatewayPolicyGroups への参照の一覧 共通サブリソース[](必須)
vpnClientAddressPool P2S VpnClient のアドレス空間を表すアドレス空間リソースへの参照。 CommonAddressSpace (必須)

VpnClientConfiguration (英語)

名前 形容 価値
aadオーディエンス AAD 認証に使用される VPN クライアント接続用の VirtualNetworkGateway リソースの AADAudience プロパティ。 文字列
aad発行者 AAD 認証に使用される VPN クライアント接続用の VirtualNetworkGateway リソースの AADIssuer プロパティ。 文字列
aadテナント AAD 認証に使用される VPN クライアント接続用の VirtualNetworkGateway リソースの AADTenant プロパティ。 文字列
radiusサーバーアドレス VPN クライアント接続用の VirtualNetworkGateway リソースの radius サーバー アドレス プロパティ。 文字列
radiusサーバー 複数の radius サーバー構成の radiusServers プロパティ。 RadiusServer[]
radiusサーバーシークレット VPN クライアント接続用の VirtualNetworkGateway リソースの radius シークレット プロパティ。 VirtualNetworkGateway Create/Update/Get/List/UpdateTags API 応答で radiusServerSecret を返さなくなります。 VirtualNetworkGateway ListRadiusSecrets API を使用して、RADIUS サーバー シークレットをフェッチしてください。 string

制約：
機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。
vngClientConnectionConfigurations(vngClientConnectionConfigurations) 仮想ネットワーク ゲートウェイ P2S クライアントの IP アドレス プールごとの接続ポリシー。 VngClientConnectionConfiguration[]
vpnAuthenticationTypes (vpn認証タイプ) 仮想ネットワーク ゲートウェイの VPN 認証の種類。. 次のいずれかを含む文字列配列:
「AAD」
「証明書」
「ラジアス」
vpnClientAddressPool P2S VpnClient のアドレス空間を表すアドレス空間リソースへの参照。 コモンアドレススペース
vpnClientIpsecPolicies (英語) 仮想ネットワーク ゲートウェイ P2S クライアントの VpnClientIpsecPolicies。 イプセックポリシー[]
vpnClientプロトコル 仮想ネットワーク ゲートウェイの VpnClientProtocols。 次のいずれかを含む文字列配列:
「IkeV2」
「OpenVPN」
「SSTP」
vpnClientRevokedCertificates (英語) 仮想ネットワーク ゲートウェイの VpnClientRevokedCertificate。 VpnClientRevokedCertificate[]
vpnClientRoot証明書 仮想ネットワーク ゲートウェイの VpnClientRootCertificate。 VpnClientRoot証明書[]

VpnClientRevokedCertificate (英語)

名前 形容 価値
身分証明書 リソース ID。 文字列
名前 リソース グループ内で一意であるリソースの名前。 この名前は、リソースへのアクセスに使用できます。 文字列
プロパティ VPN クライアントが失効した証明書のプロパティ。 VpnClientRevokedCertificatePropertiesFormat の

VpnClientRevokedCertificatePropertiesFormat

名前 形容 価値
サムプリント 失効した VPN クライアント証明書の拇印。 文字列

VpnClientRoot証明書

名前 形容 価値
身分証明書 リソース ID。 文字列
名前 リソース グループ内で一意であるリソースの名前。 この名前は、リソースへのアクセスに使用できます。 文字列
プロパティ VPN クライアントルート証明書のプロパティ。 VpnClientRootCertificatePropertiesFormat (必須)

VpnClientRootCertificatePropertiesFormat

名前 形容 価値
publicCertData の 証明書のパブリック データ。 string (必須)

VpnNatRuleMapping(英語)

名前 形容 価値
アドレス空間 Vpn NatRule マッピングのアドレス空間。 文字列
ポートレンジ Vpn NatRule マッピングのポート範囲。 文字列

使用例

Terraformサンプル

仮想ネットワーク ゲートウェイをデプロイして、セキュリティで保護されたクロスプレミス接続を確立する基本的な例。

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "centralus"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "virtualNetwork" {
  type      = "Microsoft.Network/virtualNetworks@2022-07-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      addressSpace = {
        addressPrefixes = [
          "10.6.0.0/16",
        ]
      }
      dhcpOptions = {
        dnsServers = [
        ]
      }
      subnets = [
      ]
    }
    tags = {
      SkipASMAzSecPack = "true"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
  lifecycle {
    ignore_changes = [body.properties.subnets]
  }
}

resource "azapi_resource" "publicIPAddress" {
  type      = "Microsoft.Network/publicIPAddresses@2022-07-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      ddosSettings = {
        protectionMode = "VirtualNetworkInherited"
      }
      idleTimeoutInMinutes     = 4
      publicIPAddressVersion   = "IPv4"
      publicIPAllocationMethod = "Static"
    }
    sku = {
      name = "Standard"
      tier = "Regional"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "subnet" {
  type      = "Microsoft.Network/virtualNetworks/subnets@2022-07-01"
  parent_id = azapi_resource.virtualNetwork.id
  name      = "GatewaySubnet"
  body = {
    properties = {
      addressPrefix = "10.6.1.0/24"
      delegations = [
      ]
      privateEndpointNetworkPolicies    = "Enabled"
      privateLinkServiceNetworkPolicies = "Enabled"
      serviceEndpointPolicies = [
      ]
      serviceEndpoints = [
      ]
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "virtualNetworkGateway" {
  type      = "Microsoft.Network/virtualNetworkGateways@2022-07-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      activeActive           = false
      enableBgp              = false
      enablePrivateIpAddress = false
      gatewayType            = "ExpressRoute"
      ipConfigurations = [
        {
          name = "vnetGatewayConfig"
          properties = {
            privateIPAllocationMethod = "Dynamic"
            publicIPAddress = {
              id = azapi_resource.publicIPAddress.id
            }
            subnet = {
              id = azapi_resource.subnet.id
            }
          }
        },
      ]
      sku = {
        name = "Standard"
        tier = "Standard"
      }
      vpnType = "RouteBased"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}
  • Last updated on