Microsoft.Network vpnGateways 2019-04-01

• 最新の を する
• 2024-05-01
• 2024-03-01
• 2024-01-01
• 2023-11-01
• 2023-09-01
• 2023-06-01
• 2023-05-01
• 2023-04-01
• 2023-02-01
• 2022-11-01
• 2022-09-01
• 2022-07-01
• 2022-05-01
• 2022-01-01
• 2021-08-01
• 2021-05-01
• 2021-03-01
• 2021-02-01
• 2020-11-01
• 2020-08-01
• 2020-07-01
• 2020-06-01
• 2020-05-01
• 2020-04-01
• 2020-03-01
• 2019-12-01
• 2019-11-01
• 2019-09-01
• 2019-08-01
• 2019-07-01
• 2019-06-01
• 2019-04-01
• 2019-02-01
• 2018-12-01
• 2018-11-01
• 2018-10-01
• 2018-08-01
• 2018-07-01
• 2018-06-01
• 2018-04-01

Bicep リソース定義

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

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

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

リソースの形式

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

resource symbolicname 'Microsoft.Network/vpnGateways@2019-04-01' = {
  location: 'string'
  name: 'string'
  properties: {
    bgpSettings: {
      asn: int
      bgpPeeringAddress: 'string'
      peerWeight: int
    }
    connections: [
      {
        id: 'string'
        name: 'string'
        properties: {
          connectionBandwidth: 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'
          }
          routingWeight: int
          sharedKey: 'string'
          useLocalAzureIpAddress: bool
          usePolicyBasedTrafficSelectors: bool
          vpnConnectionProtocolType: 'string'
        }
      }
    ]
    virtualHub: {
      id: 'string'
    }
    vpnGatewayScaleUnit: int
  }
  tags: {
    {customized property}: 'string'
  }
}

プロパティ値

BgpSettings

名前	形容	価値
asn	BGP スピーカーの ASN。	int
bgpPeeringAddress	この BGP スピーカーの BGP ピアリング アドレスと BGP 識別子。	糸
peerWeight	この BGP スピーカーから学習したルートに追加された重み。	int

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 の
タグ	リソース タグ	タグ名と値のディクショナリ。 テンプレート の タグを参照してください

ResourceTags

名前	形容	価値

SubResource

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

VpnConnection

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

VpnConnectionProperties

名前	形容	価値
connectionBandwidth	予想される帯域幅 (MBPS)。	int
enableBgp	EnableBgp フラグ。	bool
enableInternetSecurity	インターネット セキュリティを有効にします。	bool
enableRateLimiting	EnableBgp フラグ。	bool
ipsecPolicies	この接続によって考慮される IPSec ポリシー。	IpsecPolicy[]
remoteVpnSite	接続されている VPN サイトの ID。	SubResource の
routingWeight	VPN 接続のルーティングの重み。	int
sharedKey	VPN 接続の SharedKey。	糸
useLocalAzureIpAddress	ローカル Azure IP を使用して接続を開始します。	bool
usePolicyBasedTrafficSelectors	ポリシー ベースのトラフィック セレクターを有効にします。	bool
vpnConnectionProtocolType	この接続に使用される接続プロトコル。	'IKEv1' 'IKEv2'

VpnGatewayProperties

名前	形容	価値
bgpSettings	ローカル ネットワーク ゲートウェイの BGP スピーカー設定。	BgpSettings
コネ	ゲートウェイへのすべての VPN 接続の一覧。	VpnConnection[]
virtualHub	ゲートウェイが属する VirtualHub。	SubResource の
vpnGatewayScaleUnit	この VPN ゲートウェイのスケール ユニット。	int

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

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

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": "2019-04-01",
  "name": "string",
  "location": "string",
  "properties": {
    "bgpSettings": {
      "asn": "int",
      "bgpPeeringAddress": "string",
      "peerWeight": "int"
    },
    "connections": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "connectionBandwidth": "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"
          },
          "routingWeight": "int",
          "sharedKey": "string",
          "useLocalAzureIpAddress": "bool",
          "usePolicyBasedTrafficSelectors": "bool",
          "vpnConnectionProtocolType": "string"
        }
      }
    ],
    "virtualHub": {
      "id": "string"
    },
    "vpnGatewayScaleUnit": "int"
  },
  "tags": {
    "{customized property}": "string"
  }
}

プロパティ値

BgpSettings

名前	形容	価値
asn	BGP スピーカーの ASN。	int
bgpPeeringAddress	この BGP スピーカーの BGP ピアリング アドレスと BGP 識別子。	糸
peerWeight	この BGP スピーカーから学習したルートに追加された重み。	int

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 のバージョン	'2019-04-01'
場所	リソースの場所。	糸
名前	リソース名	string (必須)
プロパティ	VPN ゲートウェイのプロパティ。	VpnGatewayProperties の
タグ	リソース タグ	タグ名と値のディクショナリ。 テンプレート の タグを参照してください
種類	リソースの種類	'Microsoft.Network/vpnGateways'

ResourceTags

名前	形容	価値

SubResource

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

VpnConnection

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

VpnConnectionProperties

名前	形容	価値
connectionBandwidth	予想される帯域幅 (MBPS)。	int
enableBgp	EnableBgp フラグ。	bool
enableInternetSecurity	インターネット セキュリティを有効にします。	bool
enableRateLimiting	EnableBgp フラグ。	bool
ipsecPolicies	この接続によって考慮される IPSec ポリシー。	IpsecPolicy[]
remoteVpnSite	接続されている VPN サイトの ID。	SubResource の
routingWeight	VPN 接続のルーティングの重み。	int
sharedKey	VPN 接続の SharedKey。	糸
useLocalAzureIpAddress	ローカル Azure IP を使用して接続を開始します。	bool
usePolicyBasedTrafficSelectors	ポリシー ベースのトラフィック セレクターを有効にします。	bool
vpnConnectionProtocolType	この接続に使用される接続プロトコル。	'IKEv1' 'IKEv2'

VpnGatewayProperties

名前	形容	価値
bgpSettings	ローカル ネットワーク ゲートウェイの BGP スピーカー設定。	BgpSettings
コネ	ゲートウェイへのすべての VPN 接続の一覧。	VpnConnection[]
virtualHub	ゲートウェイが属する VirtualHub。	SubResource の
vpnGatewayScaleUnit	この VPN ゲートウェイのスケール ユニット。	int

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

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

テンプレート	形容
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@2019-04-01"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      bgpSettings = {
        asn = int
        bgpPeeringAddress = "string"
        peerWeight = int
      }
      connections = [
        {
          id = "string"
          name = "string"
          properties = {
            connectionBandwidth = 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"
            }
            routingWeight = int
            sharedKey = "string"
            useLocalAzureIpAddress = bool
            usePolicyBasedTrafficSelectors = bool
            vpnConnectionProtocolType = "string"
          }
        }
      ]
      virtualHub = {
        id = "string"
      }
      vpnGatewayScaleUnit = int
    }
  })
}

プロパティ値

BgpSettings

名前	形容	価値
asn	BGP スピーカーの ASN。	int
bgpPeeringAddress	この BGP スピーカーの BGP ピアリング アドレスと BGP 識別子。	糸
peerWeight	この BGP スピーカーから学習したルートに追加された重み。	int

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@2019-04-01"

ResourceTags

名前	形容	価値

SubResource

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

VpnConnection

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

VpnConnectionProperties

名前	形容	価値
connectionBandwidth	予想される帯域幅 (MBPS)。	int
enableBgp	EnableBgp フラグ。	bool
enableInternetSecurity	インターネット セキュリティを有効にします。	bool
enableRateLimiting	EnableBgp フラグ。	bool
ipsecPolicies	この接続によって考慮される IPSec ポリシー。	IpsecPolicy[]
remoteVpnSite	接続されている VPN サイトの ID。	SubResource の
routingWeight	VPN 接続のルーティングの重み。	int
sharedKey	VPN 接続の SharedKey。	糸
useLocalAzureIpAddress	ローカル Azure IP を使用して接続を開始します。	bool
usePolicyBasedTrafficSelectors	ポリシー ベースのトラフィック セレクターを有効にします。	bool
vpnConnectionProtocolType	この接続に使用される接続プロトコル。	'IKEv1' 'IKEv2'

VpnGatewayProperties

名前	形容	価値
bgpSettings	ローカル ネットワーク ゲートウェイの BGP スピーカー設定。	BgpSettings
コネ	ゲートウェイへのすべての VPN 接続の一覧。	VpnConnection[]
virtualHub	ゲートウェイが属する VirtualHub。	SubResource の
vpnGatewayScaleUnit	この VPN ゲートウェイのスケール ユニット。	int