Microsoft.Network virtualNetworkGateways 2023-06-01
Bicep リソース定義
virtualNetworkGateways リソースの種類は、次を対象とする操作でデプロイできます。
- リソース グループ - リソース グループのデプロイ コマンドに関するページを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.Network/virtualNetworkGateways リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.Network/virtualNetworkGateways@2023-06-01' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
extendedLocation: {
name: 'string'
type: 'EdgeZone'
}
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'
]
}
disableIPSecReplayProtection: bool
enableBgp: bool
enableBgpRouteTranslationForNat: bool
enableDnsForwarding: 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'
}
}
]
sku: {
name: 'string'
tier: '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'
]
}
}
}
]
vpnAuthenticationTypes: [
'string'
]
vpnClientAddressPool: {
addressPrefixes: [
'string'
]
}
vpnClientIpsecPolicies: [
{
dhGroup: 'string'
ikeEncryption: 'string'
ikeIntegrity: 'string'
ipsecEncryption: 'string'
ipsecIntegrity: 'string'
pfsGroup: 'string'
saDataSizeKilobytes: int
saLifeTimeSeconds: int
}
]
vpnClientProtocols: [
'string'
]
vpnClientRevokedCertificates: [
{
id: 'string'
name: 'string'
properties: {
thumbprint: 'string'
}
}
]
vpnClientRootCertificates: [
{
id: 'string'
name: 'string'
properties: {
publicCertData: 'string'
}
}
]
}
vpnGatewayGeneration: 'string'
vpnType: 'string'
}
}
プロパティ値
virtualNetworkGateways
名前 | 説明 | 値 |
---|---|---|
name | リソース名 | string (必須) 文字数制限: 1 から 80 有効な文字: 英数字、アンダースコア、ピリオド、およびハイフン。 英数字で開始します。 英数字またはアンダースコアで終了します。 |
location | リソースの場所。 | string |
tags | リソース タグ。 | タグ名と値のディクショナリ。 「テンプレートのタグ」を参照してください |
extendedLocation | 種類がローカル仮想ネットワーク ゲートウェイの拡張場所。 | ExtendedLocation |
properties | 仮想ネットワーク ゲートウェイのプロパティ。 | VirtualNetworkGatewayPropertiesFormat (必須) |
ExtendedLocation
名前 | 説明 | 値 |
---|---|---|
name | 拡張場所の名前。 | string |
type | 拡張された場所の型。 | 'EdgeZone' |
VirtualNetworkGatewayPropertiesFormat
名前 | 説明 | 値 |
---|---|---|
activeActive | ActiveActive フラグ。 | [bool] |
adminState | vnet に複数の Express Route ゲートウェイがある場合に Express Route Gateway がトラフィックを処理するかどうかを示すプロパティ | 'Disabled' 'Enabled' |
allowRemoteVnetTraffic | 他の Azure 仮想ネットワークからのトラフィックを受け入れるように、このゲートウェイを構成します。 この構成では、Azure Virtual WANへの接続はサポートされていません。 | [bool] |
allowVirtualWanTraffic | リモート Virtual WAN ネットワークからのトラフィックを受け入れるように、このゲートウェイを構成します。 | [bool] |
autoScaleConfiguration | 仮想ネットワーク ゲートウェイの自動スケーリング構成 | VirtualNetworkGatewayAutoScaleConfiguration |
bgpSettings | 仮想ネットワーク ゲートウェイの BGP スピーカー設定。 | BgpSettings |
customRoutes | 仮想ネットワーク ゲートウェイと VpnClient に対して顧客によって指定されたカスタム ルート アドレス空間を表すアドレス空間リソースへの参照。 | AddressSpace |
disableIPSecReplayProtection | disableIPSecReplayProtection フラグ。 | [bool] |
enableBgp | この仮想ネットワーク ゲートウェイに対して BGP が有効かどうか。 | [bool] |
enableBgpRouteTranslationForNat | EnableBgpRouteTranslationForNat フラグ。 | [bool] |
enableDnsForwarding | DNS 転送が有効かどうか。 | [bool] |
enablePrivateIpAddress | 接続に対してこのゲートウェイでプライベート IP を有効にする必要があるかどうか。 | [bool] |
gatewayDefaultSite | 既定のルートを持つローカル ネットワーク サイトを表す LocalNetworkGateway リソースへの参照。 既存の既定のサイト設定を削除する場合は、Null 値を割り当てます。 | サブリソース |
gatewayType | この仮想ネットワーク ゲートウェイの種類。 | 'ExpressRoute' 'LocalGateway' 'Vpn' |
ipConfigurations | 仮想ネットワーク ゲートウェイの IP 構成。 | VirtualNetworkGatewayIPConfiguration[] |
natRules | 仮想ネットワーク ゲートウェイの NatRules。 | VirtualNetworkGatewayNatRule[] |
sku | 仮想ネットワーク ゲートウェイ用に選択された SKU を表す VirtualNetworkGatewaySku リソースへの参照。 | VirtualNetworkGatewaySku |
virtualNetworkGatewayPolicyGroups | ゲートウェイで使用可能な VirtualNetworkGatewayPolicyGroup を表す VirtualNetworkGatewayPolicyGroup リソースへの参照。 | VirtualNetworkGatewayPolicyGroup[] |
vNetExtendedLocationResourceId | 顧客 vnet リソース ID。種類がローカル ゲートウェイの VirtualNetworkGateway は、お客様の vnet に関連付けられています。 | string |
vpnClientConfiguration | P2S VpnClient 構成を表す VpnClientConfiguration リソースへの参照。 | VpnClientConfiguration |
vpnGatewayGeneration | この VirtualNetworkGateway の世代。 gatewayType が VPN でない場合は None にする必要があります。 | 'Generation1' 'Generation2' 'None' |
vpnType | この仮想ネットワーク ゲートウェイの種類。 | 'PolicyBased' 'RouteBased' |
VirtualNetworkGatewayAutoScaleConfiguration
名前 | 説明 | 値 |
---|---|---|
bounds | 自動スケーリング構成の境界 | VirtualNetworkGatewayAutoScaleBounds |
VirtualNetworkGatewayAutoScaleBounds
名前 | 説明 | 値 |
---|---|---|
max | 自動スケーリング構成の最大スケール ユニット数 | INT |
分 | 自動スケーリング構成の最小スケール ユニット数 | INT |
BgpSettings
名前 | 説明 | 値 |
---|---|---|
Asn | BGP スピーカーの ASN。 | INT 制約: 最小値 = 0 最大値 = 4294967295 |
bgpPeeringAddress | この BGP スピーカーの BGP ピアリング アドレスと BGP 識別子。 | string |
bgpPeeringAddresses | 仮想ネットワーク ゲートウェイの IP 構成 ID を持つ BGP ピアリング アドレス。 | IPConfigurationBgpPeeringAddress[] |
peerWeight | この BGP スピーカーから学習したルートに追加された重み。 | INT |
IPConfigurationBgpPeeringAddress
名前 | 説明 | 値 |
---|---|---|
customBgpIpAddresses | IP 構成に属するカスタム BGP ピアリング アドレスの一覧。 | string[] |
ipconfigurationId | ゲートウェイに属する IP 構成の ID。 | string |
AddressSpace
名前 | 説明 | 値 |
---|---|---|
addressPrefixes | CIDR 表記でこの仮想ネットワーク用に予約されているアドレス ブロックの一覧。 | string[] |
サブリソース
名前 | 説明 | 値 |
---|---|---|
id | リソースの ID | string |
VirtualNetworkGatewayIPConfiguration
名前 | 説明 | 値 |
---|---|---|
id | リソースの ID | string |
name | リソース グループ内で一意のリソースの名前。 この名前は、リソースへのアクセスに使用できます。 | string |
properties | 仮想ネットワーク ゲートウェイ IP 構成のプロパティ。 | VirtualNetworkGatewayIPConfigurationPropertiesFormat |
VirtualNetworkGatewayIPConfigurationPropertiesFormat
名前 | 説明 | 値 |
---|---|---|
privateIPAllocationMethod | プライベート IP アドレスの割り当て方法。 | 'Dynamic' 'Static' |
publicIPAddress | パブリック IP リソースへの参照。 | サブリソース |
サブネット | サブネット リソースへの参照。 | サブリソース |
VirtualNetworkGatewayNatRule
名前 | 説明 | 値 |
---|---|---|
id | リソースの ID | string |
name | リソース グループ内で一意のリソースの名前。 この名前は、リソースへのアクセスに使用できます。 | string |
properties | Virtual Network ゲートウェイ NAT 規則のプロパティ。 | VirtualNetworkGatewayNatRuleProperties |
VirtualNetworkGatewayNatRuleProperties
名前 | 説明 | 値 |
---|---|---|
externalMappings | NAT のプライベート IP アドレス外部マッピング。 | VpnNatRuleMapping[] |
internalMappings | NAT のプライベート IP アドレス内部マッピング。 | VpnNatRuleMapping[] |
ipConfigurationId | この NAT 規則が適用される IP 構成 ID。 | string |
mode | VPN NAT のソース NAT の方向。 | 'EgressSnat' 'IngressSnat' |
型 | VPN NAT の NAT 規則の種類。 | 'Dynamic' 'Static' |
VpnNatRuleMapping
名前 | 説明 | 値 |
---|---|---|
addressSpace | Vpn NatRule マッピングのアドレス空間。 | string |
portRange | Vpn NatRule マッピングのポート範囲。 | string |
VirtualNetworkGatewaySku
名前 | 説明 | 値 |
---|---|---|
name | ゲートウェイ SKU 名。 | 'Basic' 'ErGw1AZ' 'ErGw2AZ' 'ErGw3AZ' 'ErGwScale' 'HighPerformance' 'Standard' 'UltraPerformance' 'VpnGw1' 'VpnGw1AZ' 'VpnGw2' 'VpnGw2AZ' 'VpnGw3' 'VpnGw3AZ' 'VpnGw4' 'VpnGw4AZ' 'VpnGw5' 'VpnGw5AZ' |
レベル | ゲートウェイ SKU レベル。 | 'Basic' 'ErGw1AZ' 'ErGw2AZ' 'ErGw3AZ' 'ErGwScale' 'HighPerformance' 'Standard' 'UltraPerformance' 'VpnGw1' 'VpnGw1AZ' 'VpnGw2' 'VpnGw2AZ' 'VpnGw3' 'VpnGw3AZ' 'VpnGw4' 'VpnGw4AZ' 'VpnGw5' 'VpnGw5AZ' |
VirtualNetworkGatewayPolicyGroup
名前 | 説明 | 値 |
---|---|---|
id | リソースの ID | string |
name | リソース グループ内で一意のリソースの名前。 この名前は、リソースへのアクセスに使用できます。 | string |
properties | tVirtualNetworkGatewayPolicyGroup のプロパティ。 | VirtualNetworkGatewayPolicyGroupProperties |
VirtualNetworkGatewayPolicyGroupProperties
名前 | 説明 | 値 |
---|---|---|
isDefault | これが既定の VirtualNetworkGatewayPolicyGroup であるかどうかを示します。 | bool (必須) |
policyMembers | VirtualNetworkGatewayPolicyGroup の複数の PolicyMembers。 | VirtualNetworkGatewayPolicyGroupMember[] (必須) |
priority | VirtualNetworkGatewayPolicyGroup の優先度。 | int (必須) |
VirtualNetworkGatewayPolicyGroupMember
名前 | 説明 | 値 |
---|---|---|
attributeType | Vpn Policy メンバー属性の種類。 | 'AADGroupId' 'CertificateGroupId' 'RadiusAzureGroupId' |
attributeValue | この VirtualNetworkGatewayPolicyGroupMember に使用される Attribute の値。 | string |
name | VirtualNetworkGatewayPolicyGroupMember の名前。 | string |
VpnClientConfiguration
名前 | 説明 | 値 |
---|---|---|
aadAudience | AAD 認証に使用される VPN クライアント接続用の VirtualNetworkGateway リソースの AADAudience プロパティ。 | string |
aadIssuer | AAD 認証に使用される VPN クライアント接続用の VirtualNetworkGateway リソースの AADIssuer プロパティ。 | string |
aadTenant | AAD 認証に使用される VPN クライアント接続用の VirtualNetworkGateway リソースの AADTenant プロパティ。 | string |
radiusServerAddress | VPN クライアント接続用の VirtualNetworkGateway リソースの radius サーバー アドレス プロパティ。 | string |
radiusServers | 複数の radius サーバー構成の radiusServers プロパティ。 | RadiusServer[] |
radiusServerSecret | VPN クライアント接続用の VirtualNetworkGateway リソースの radius シークレット プロパティ。 | string |
vngClientConnectionConfigurations | 仮想ネットワーク ゲートウェイ P2S クライアントの IP アドレス プール接続ポリシーごと。 | VngClientConnectionConfiguration[] |
vpnAuthenticationTypes | 仮想ネットワーク ゲートウェイの VPN 認証の種類。. | 次のいずれかを含む文字列配列: 'AAD' 'Certificate' 'Radius' |
vpnClientAddressPool | P2S VpnClient のアドレス空間を表すアドレス空間リソースへの参照。 | AddressSpace |
vpnClientIpsecPolicies | 仮想ネットワーク ゲートウェイ P2S クライアントの VpnClientIpsecPolicies。 | IpsecPolicy[] |
vpnClientProtocols | 仮想ネットワーク ゲートウェイの VpnClientProtocols。 | 次のいずれかを含む文字列配列: 'IkeV2' 'OpenVPN' 'SSTP' |
vpnClientRevokedCertificates | 仮想ネットワーク ゲートウェイの VpnClientRevokedCertificate。 | VpnClientRevokedCertificate[] |
vpnClientRootCertificates | 仮想ネットワーク ゲートウェイの VpnClientRootCertificate。 | VpnClientRootCertificate[] |
RadiusServer
名前 | 説明 | 値 |
---|---|---|
radiusServerAddress | この radius サーバーのアドレス。 | string (必須) |
radiusServerScore | この radius サーバーに割り当てられた初期スコア。 | INT |
radiusServerSecret | この radius サーバーに使用されるシークレット。 | string |
VngClientConnectionConfiguration
名前 | 説明 | 値 |
---|---|---|
id | リソースの ID | string |
name | リソース グループ内で一意のリソースの名前。 この名前は、リソースへのアクセスに使用できます。 | string |
properties | VPN クライアント ルート証明書のプロパティ。 | VngClientConnectionConfigurationProperties |
VngClientConnectionConfigurationProperties
名前 | 説明 | 値 |
---|---|---|
virtualNetworkGatewayPolicyGroups | virtualNetworkGatewayPolicyGroups への参照の一覧 | SubResource[] (必須) |
vpnClientAddressPool | P2S VpnClient のアドレス空間を表すアドレス空間リソースへの参照。 | AddressSpace (必須) |
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 (必須) |
VpnClientRevokedCertificate
名前 | 説明 | 値 |
---|---|---|
id | リソースの ID | string |
name | リソース グループ内で一意のリソースの名前。 この名前は、リソースへのアクセスに使用できます。 | string |
properties | VPN クライアントが失効した証明書のプロパティ。 | VpnClientRevokedCertificatePropertiesFormat |
VpnClientRevokedCertificatePropertiesFormat
名前 | 説明 | 値 |
---|---|---|
thumbprint | 失効した VPN クライアント証明書の拇印。 | string |
VpnClientRootCertificate
名前 | 説明 | 値 |
---|---|---|
id | リソースの ID | string |
name | リソース グループ内で一意のリソースの名前。 この名前は、リソースへのアクセスに使用できます。 | string |
properties | VPN クライアント ルート証明書のプロパティ。 | VpnClientRootCertificatePropertiesFormat (必須) |
VpnClientRootCertificatePropertiesFormat
名前 | 説明 | 値 |
---|---|---|
publicCertData | 証明書のパブリック データ。 | string (必須) |
クイック スタート テンプレート
次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。
Template | 説明 |
---|---|
BOSH CF クロスリージョン |
このテンプレートは、AZURE 上の 2 つのリージョンに対して BOSH と Cloud Foundry をデプロイするために必要なリソースを設定するのに役立ちます。 |
2 つのサブネット、ローカル ネットワーク、ゲートウェイを使用して VNet をCreateする |
このテンプレートは、VNet、2 つのサブネット、およびゲートウェイを作成します |
P2S VPN と IIS を使用して DevTest 環境をCreateする |
このテンプレートでは、Windows サーバー上にポイント対サイト VPN と IIS を使用して単純な DevTest 環境を作成します。これは、作業を開始するための優れた方法です。 |
ハブアンドスポーク トポロジ サンドボックスをデプロイする |
このテンプレートは、基本的なハブアンドスポーク トポロジのセットアップを作成します。 サブネット DMZ、管理、共有、ゲートウェイ (必要に応じて) を含むハブ VNet を作成し、それぞれにワークロード サブネットを含む 2 つのスポーク VNet (開発と運用) を作成します。 また、ハブの管理サブネットに Windows Jump-Host をデプロイし、ハブと 2 つのスポークの間に VNet ピアリングを確立します。 |
HBase geo レプリケーションをデプロイする |
このテンプレートを使用すると、VPN vnet 間接続を使用して、2 つの異なるリージョンにわたる HBase レプリケーション用の Azure 環境を構成できます。 |
ハブ & スポーク トポロジで dns プロキシとしてAzure Firewallを使用する |
このサンプルでは、Azure Firewallを使用して Azure にハブスポーク トポロジをデプロイする方法を示します。 ハブ仮想ネットワークは、仮想ネットワーク ピアリングを介してハブ仮想ネットワークに接続されている多くのスポーク仮想ネットワークへの接続の中心点として機能します。 |
ExpressRoute 回線を VNET に接続する |
このテンプレートでは、VNET、ExpresRoute ゲートウェイ、および AzurePrivatePeering が構成されたプロビジョニング済みで有効な ExpressRoute 回線への接続が作成されます。 |
プライベート ピアリングと Azure VNet を使用した ExpressRoute 回線 |
このテンプレートは、ExpressRoute Microsoft ピアリングを構成し、ExpressRoute ゲートウェイを使用して Azure VNet をデプロイし、VNet を ExpressRoute 回線にリンクします |
既存の Azure VNET をマルチ VNET 構成に拡張する |
このテンプレートを使用すると、既存の単一の VNET 環境を、VNET 間ゲートウェイを使用して 2 つのデータセンター リージョンにまたがるマルチ VNET 環境に拡張できます |
ポイント対サイト ゲートウェイをCreateする |
このテンプレートを使用すると、VirtualNetworkGateways を使用してポイント対サイト接続を作成できます |
Azure AD を使用してポイント対サイト ゲートウェイをCreateする |
このテンプレートは、Azure Active Directory ポイント対サイト接続で構成された VPN Virtual Network ゲートウェイをデプロイします |
VM とのサイト間 VPN 接続をCreateする |
このテンプレートを使用すると、Virtual Network ゲートウェイを使用してサイト間 VPN 接続を作成できます |
サイト間 VPN 接続をCreateする |
このテンプレートを使用すると、Virtual Network ゲートウェイを使用してサイト間 VPN 接続を作成できます |
BGP を使用したアクティブ/アクティブ VPN ゲートウェイを使用したサイト間 VPN |
このテンプレートを使用すると、BGP を使用したアクティブ/アクティブ構成で、VPN ゲートウェイを持つ 2 つの VNet 間にサイト間 VPN を展開できます。 各 Azure VPN Gatewayは、リモート ピアの FQDN を解決して、リモート VPN Gatewayのパブリック IP を決定します。 テンプレートは、可用性ゾーンを持つ Azure リージョンで想定どおりに実行されます。 |
2 つのリージョン間で VNET 間接続をCreateする |
このテンプレートを使用すると、Virtual Network ゲートウェイを使用して、異なるリージョンの 2 つの VNET を接続できます |
BGP VNET から VNET への接続をCreateする |
このテンプレートを使用すると、Virtual Network ゲートウェイと BGP を使用して 2 つの VNET を接続できます |
推移的な BGP 接続を示す 3 つの vNet をCreateする |
このテンプレートでは、Virtual Network ゲートウェイと BGP 対応接続を使用して接続された 3 つの vNet をデプロイします |
ポイント対サイト接続が構成された SQL MI のCreate |
新しい仮想ネットワーク内でポイント対サイト接続用に構成された Azure Sql Database Managed Instance (SQL MI) と仮想ネットワーク ゲートウェイをデプロイします。 |
Azure SQL バックエンドでのApp Service Environment |
このテンプレートは、プライベート/分離環境で通常使用される関連付けられたリソースと共に、プライベート エンドポイントと共に、Azure SQL バックエンドを含むApp Service Environmentを作成します。 |
ARM テンプレート リソース定義
virtualNetworkGateways リソースの種類は、次をターゲットとする操作でデプロイできます。
- リソース グループ - リソース グループのデプロイ コマンドを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.Network/virtualNetworkGateways リソースを作成するには、次の JSON をテンプレートに追加します。
{
"type": "Microsoft.Network/virtualNetworkGateways",
"apiVersion": "2023-06-01",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"extendedLocation": {
"name": "string",
"type": "EdgeZone"
},
"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" ]
},
"disableIPSecReplayProtection": "bool",
"enableBgp": "bool",
"enableBgpRouteTranslationForNat": "bool",
"enableDnsForwarding": "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"
}
}
],
"sku": {
"name": "string",
"tier": "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" ]
}
}
}
],
"vpnAuthenticationTypes": [ "string" ],
"vpnClientAddressPool": {
"addressPrefixes": [ "string" ]
},
"vpnClientIpsecPolicies": [
{
"dhGroup": "string",
"ikeEncryption": "string",
"ikeIntegrity": "string",
"ipsecEncryption": "string",
"ipsecIntegrity": "string",
"pfsGroup": "string",
"saDataSizeKilobytes": "int",
"saLifeTimeSeconds": "int"
}
],
"vpnClientProtocols": [ "string" ],
"vpnClientRevokedCertificates": [
{
"id": "string",
"name": "string",
"properties": {
"thumbprint": "string"
}
}
],
"vpnClientRootCertificates": [
{
"id": "string",
"name": "string",
"properties": {
"publicCertData": "string"
}
}
]
},
"vpnGatewayGeneration": "string",
"vpnType": "string"
}
}
プロパティ値
virtualNetworkGateways
名前 | 説明 | 値 |
---|---|---|
type | リソースの種類 | 'Microsoft.Network/virtualNetworkGateways' |
apiVersion | リソース API のバージョン | '2023-06-01' |
name | リソース名 | string (必須) 文字制限: 1 から 80 有効な文字: 英数字、アンダースコア、ピリオド、およびハイフン。 英数字で開始します。 英数字またはアンダースコアで終了します。 |
location | リソースの場所。 | string |
tags | リソース タグ。 | タグの名前と値のディクショナリ。 「テンプレート内のタグ」を参照してください |
extendedLocation | 種類がローカル仮想ネットワーク ゲートウェイの拡張場所。 | ExtendedLocation |
properties | 仮想ネットワーク ゲートウェイのプロパティ。 | VirtualNetworkGatewayPropertiesFormat (必須) |
ExtendedLocation
名前 | 説明 | 値 |
---|---|---|
name | 拡張場所の名前。 | string |
type | 拡張場所の型。 | 'EdgeZone' |
VirtualNetworkGatewayPropertiesFormat
名前 | 説明 | 値 |
---|---|---|
activeActive | ActiveActive フラグ。 | [bool] |
adminState | vnet に複数の Express Route Gateway がある場合に Express Route Gateway がトラフィックを処理するかどうかを示すプロパティ | 'Disabled' 'Enabled' |
allowRemoteVnetTraffic | 他の Azure Virtual Networks からのトラフィックを受け入れるように、このゲートウェイを構成します。 この構成では、Azure Virtual WANへの接続はサポートされていません。 | [bool] |
allowVirtualWanTraffic | リモート Virtual WAN ネットワークからのトラフィックを受け入れるように、このゲートウェイを構成します。 | [bool] |
autoScaleConfiguration | virutal ネットワーク ゲートウェイの自動スケーリング構成 | VirtualNetworkGatewayAutoScaleConfiguration |
bgpSettings | 仮想ネットワーク ゲートウェイの BGP スピーカー設定。 | BgpSettings |
customRoutes | 仮想ネットワーク ゲートウェイと VpnClient の顧客によって指定されたカスタム ルートアドレス空間を表すアドレス空間リソースへの参照。 | AddressSpace |
disableIPSecReplayProtection | disableIPSecReplayProtection フラグ。 | [bool] |
enableBgp | この仮想ネットワーク ゲートウェイに対して BGP が有効かどうか。 | [bool] |
enableBgpRouteTranslationForNat | EnableBgpRouteTranslationForNat フラグ。 | [bool] |
enableDnsForwarding | DNS 転送が有効かどうか。 | [bool] |
enablePrivateIpAddress | 接続のためにこのゲートウェイでプライベート IP を有効にする必要があるかどうか。 | [bool] |
gatewayDefaultSite | 既定のルートを持つローカル ネットワーク サイトを表す LocalNetworkGateway リソースへの参照。 既存の既定のサイト設定を削除する場合は Null 値を割り当てます。 | サブリソース |
gatewayType | この仮想ネットワーク ゲートウェイの種類。 | 'ExpressRoute' 'LocalGateway' 'Vpn' |
ipConfigurations | 仮想ネットワーク ゲートウェイの IP 構成。 | VirtualNetworkGatewayIPConfiguration[] |
natRules | 仮想ネットワーク ゲートウェイの NatRules。 | VirtualNetworkGatewayNatRule[] |
sku | 仮想ネットワーク ゲートウェイ用に選択された SKU を表す VirtualNetworkGatewaySku リソースへの参照。 | VirtualNetworkGatewaySku |
virtualNetworkGatewayPolicyGroups | ゲートウェイで使用可能な VirtualNetworkGatewayPolicyGroup を表す VirtualNetworkGatewayPolicyGroup リソースへの参照。 | VirtualNetworkGatewayPolicyGroup[] |
vNetExtendedLocationResourceId | 顧客 vnet リソース ID。種類がローカル ゲートウェイの VirtualNetworkGateway は、お客様の vnet に関連付けられます。 | string |
vpnClientConfiguration | P2S VpnClient 構成を表す VpnClientConfiguration リソースへの参照。 | VpnClientConfiguration |
vpnGatewayGeneration | この VirtualNetworkGateway の生成。 gatewayType が VPN でない場合は None にする必要があります。 | 'Generation1' 'Generation2' 'None' |
vpnType | この仮想ネットワーク ゲートウェイの種類。 | 'PolicyBased' 'RouteBased' |
VirtualNetworkGatewayAutoScaleConfiguration
名前 | 説明 | 値 |
---|---|---|
bounds | 自動スケーリング構成の境界 | VirtualNetworkGatewayAutoScaleBounds |
VirtualNetworkGatewayAutoScaleBounds
名前 | 説明 | 値 |
---|---|---|
max | 自動スケーリング構成の最大スケール ユニット数 | INT |
分 | 自動スケーリング構成の最小スケール ユニット数 | INT |
BgpSettings
名前 | 説明 | 値 |
---|---|---|
Asn | BGP スピーカーの ASN。 | INT 制約: 最小値 = 0 最大値 = 4294967295 |
bgpPeeringAddress | この BGP スピーカーの BGP ピアリング アドレスと BGP 識別子。 | string |
bgpPeeringAddresses | 仮想ネットワーク ゲートウェイの IP 構成 ID を持つ BGP ピアリング アドレス。 | IPConfigurationBgpPeeringAddress[] |
peerWeight | この BGP スピーカーから学習したルートに追加された重み。 | INT |
IPConfigurationBgpPeeringAddress
名前 | 説明 | 値 |
---|---|---|
customBgpIpAddresses | IP 構成に属するカスタム BGP ピアリング アドレスの一覧。 | string[] |
ipconfigurationId | ゲートウェイに属する IP 構成の ID。 | string |
AddressSpace
名前 | 説明 | 値 |
---|---|---|
addressPrefixes | CIDR 表記でこの仮想ネットワーク用に予約されているアドレス ブロックの一覧。 | string[] |
サブリソース
名前 | 説明 | 値 |
---|---|---|
id | リソースの ID | string |
VirtualNetworkGatewayIPConfiguration
名前 | 説明 | 値 |
---|---|---|
id | リソースの ID | string |
name | リソース グループ内で一意のリソースの名前。 この名前は、リソースへのアクセスに使用できます。 | string |
properties | 仮想ネットワーク ゲートウェイ IP 構成のプロパティ。 | VirtualNetworkGatewayIPConfigurationPropertiesFormat |
VirtualNetworkGatewayIPConfigurationPropertiesFormat
名前 | 説明 | 値 |
---|---|---|
privateIPAllocationMethod | プライベート IP アドレスの割り当て方法。 | 'Dynamic' 'Static' |
publicIPAddress | パブリック IP リソースへの参照。 | サブリソース |
サブネット | サブネット リソースへの参照。 | サブリソース |
VirtualNetworkGatewayNatRule
名前 | 説明 | 値 |
---|---|---|
id | リソースの ID | string |
name | リソース グループ内で一意のリソースの名前。 この名前は、リソースへのアクセスに使用できます。 | string |
properties | Virtual Network ゲートウェイ NAT 規則のプロパティ。 | VirtualNetworkGatewayNatRuleProperties |
VirtualNetworkGatewayNatRuleProperties
名前 | 説明 | 値 |
---|---|---|
externalMappings | NAT のプライベート IP アドレス外部マッピング。 | VpnNatRuleMapping[] |
internalMappings | NAT のプライベート IP アドレス内部マッピング。 | VpnNatRuleMapping[] |
ipConfigurationId | この NAT 規則が適用される IP 構成 ID。 | string |
mode | VPN NAT のソース NAT 方向。 | 'EgressSnat' 'IngressSnat' |
型 | VPN NAT の NAT 規則の種類。 | 'Dynamic' 'Static' |
VpnNatRuleMapping
名前 | 説明 | 値 |
---|---|---|
addressSpace | Vpn NatRule マッピングのアドレス空間。 | string |
portRange | Vpn NatRule マッピングのポート範囲。 | string |
VirtualNetworkGatewaySku
名前 | 説明 | 値 |
---|---|---|
name | ゲートウェイ SKU 名。 | 'Basic' 'ErGw1AZ' 'ErGw2AZ' 'ErGw3AZ' 'ErGwScale' 'HighPerformance' 'Standard' 'UltraPerformance' 'VpnGw1' 'VpnGw1AZ' 'VpnGw2' 'VpnGw2AZ' 'VpnGw3' 'VpnGw3AZ' 'VpnGw4' 'VpnGw4AZ' 'VpnGw5' 'VpnGw5AZ' |
レベル | ゲートウェイ SKU レベル。 | 'Basic' 'ErGw1AZ' 'ErGw2AZ' 'ErGw3AZ' 'ErGwScale' 'HighPerformance' 'Standard' 'UltraPerformance' 'VpnGw1' 'VpnGw1AZ' 'VpnGw2' 'VpnGw2AZ' 'VpnGw3' 'VpnGw3AZ' 'VpnGw4' 'VpnGw4AZ' 'VpnGw5' 'VpnGw5AZ' |
VirtualNetworkGatewayPolicyGroup
名前 | 説明 | 値 |
---|---|---|
id | リソースの ID | string |
name | リソース グループ内で一意のリソースの名前。 この名前は、リソースへのアクセスに使用できます。 | string |
properties | tVirtualNetworkGatewayPolicyGroup のプロパティ。 | VirtualNetworkGatewayPolicyGroupProperties |
VirtualNetworkGatewayPolicyGroupProperties
名前 | 説明 | 値 |
---|---|---|
isDefault | これが既定の VirtualNetworkGatewayPolicyGroup であるかどうかを示します。 | bool (必須) |
policyMembers | VirtualNetworkGatewayPolicyGroup の複数の PolicyMembers。 | VirtualNetworkGatewayPolicyGroupMember[] (必須) |
priority | VirtualNetworkGatewayPolicyGroup の優先度。 | int (必須) |
VirtualNetworkGatewayPolicyGroupMember
名前 | 説明 | 値 |
---|---|---|
attributeType | Vpn Policy メンバー属性の種類。 | 'AADGroupId' 'CertificateGroupId' 'RadiusAzureGroupId' |
attributeValue | この VirtualNetworkGatewayPolicyGroupMember に使用される Attribute の値。 | string |
name | VirtualNetworkGatewayPolicyGroupMember の名前。 | string |
VpnClientConfiguration
名前 | 説明 | 値 |
---|---|---|
aadAudience | AAD 認証に使用される VPN クライアント接続用の VirtualNetworkGateway リソースの AADAudience プロパティ。 | string |
aadIssuer | AAD 認証に使用される VPN クライアント接続用の VirtualNetworkGateway リソースの AADIssuer プロパティ。 | string |
aadTenant | AAD 認証に使用される VPN クライアント接続用の VirtualNetworkGateway リソースの AADTenant プロパティ。 | string |
radiusServerAddress | VPN クライアント接続用の VirtualNetworkGateway リソースの radius サーバー アドレス プロパティ。 | string |
radiusServers | 複数の radius サーバー構成の radiusServers プロパティ。 | RadiusServer[] |
radiusServerSecret | VPN クライアント接続用の VirtualNetworkGateway リソースの radius シークレット プロパティ。 | string |
vngClientConnectionConfigurations | 仮想ネットワーク ゲートウェイ P2S クライアントの IP アドレス プール接続ポリシーごと。 | VngClientConnectionConfiguration[] |
vpnAuthenticationTypes | 仮想ネットワーク ゲートウェイの VPN 認証の種類。. | 次のいずれかを含む文字列配列: 'AAD' 'Certificate' 'Radius' |
vpnClientAddressPool | P2S VpnClient のアドレス空間を表すアドレス空間リソースへの参照。 | AddressSpace |
vpnClientIpsecPolicies | 仮想ネットワーク ゲートウェイ P2S クライアントの VpnClientIpsecPolicies。 | IpsecPolicy[] |
vpnClientProtocols | 仮想ネットワーク ゲートウェイの VpnClientProtocols。 | 次のいずれかを含む文字列配列: 'IkeV2' 'OpenVPN' 'SSTP' |
vpnClientRevokedCertificates | 仮想ネットワーク ゲートウェイの VpnClientRevokedCertificate。 | VpnClientRevokedCertificate[] |
vpnClientRootCertificates | 仮想ネットワーク ゲートウェイの VpnClientRootCertificate。 | VpnClientRootCertificate[] |
RadiusServer
名前 | 説明 | 値 |
---|---|---|
radiusServerAddress | この radius サーバーのアドレス。 | string (必須) |
radiusServerScore | この radius サーバーに割り当てられた初期スコア。 | INT |
radiusServerSecret | この radius サーバーに使用されるシークレット。 | string |
VngClientConnectionConfiguration
名前 | 説明 | 値 |
---|---|---|
id | リソースの ID | string |
name | リソース グループ内で一意のリソースの名前。 この名前は、リソースへのアクセスに使用できます。 | string |
properties | VPN クライアント ルート証明書のプロパティ。 | VngClientConnectionConfigurationProperties |
VngClientConnectionConfigurationProperties
名前 | 説明 | 値 |
---|---|---|
virtualNetworkGatewayPolicyGroups | virtualNetworkGatewayPolicyGroups への参照の一覧 | SubResource[] (必須) |
vpnClientAddressPool | P2S VpnClient のアドレス空間を表すアドレス空間リソースへの参照。 | AddressSpace (必須) |
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 (必須) |
VpnClientRevokedCertificate
名前 | 説明 | 値 |
---|---|---|
id | リソースの ID | string |
name | リソース グループ内で一意のリソースの名前。 この名前は、リソースへのアクセスに使用できます。 | string |
properties | VPN クライアントが失効した証明書のプロパティ。 | VpnClientRevokedCertificatePropertiesFormat |
VpnClientRevokedCertificatePropertiesFormat
名前 | 説明 | 値 |
---|---|---|
thumbprint | 失効した VPN クライアント証明書の拇印。 | string |
VpnClientRootCertificate
名前 | 説明 | 値 |
---|---|---|
id | リソースの ID | string |
name | リソース グループ内で一意のリソースの名前。 この名前は、リソースへのアクセスに使用できます。 | string |
properties | VPN クライアント ルート証明書のプロパティ。 | VpnClientRootCertificatePropertiesFormat (必須) |
VpnClientRootCertificatePropertiesFormat
名前 | 説明 | 値 |
---|---|---|
publicCertData | 証明書のパブリック データ。 | string (必須) |
クイック スタート テンプレート
次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。
Template | 説明 |
---|---|
BOSH CF クロスリージョン |
このテンプレートは、AZURE 上の 2 つのリージョンに対して BOSH と Cloud Foundry をデプロイするために必要なリソースを設定するのに役立ちます。 |
2 つのサブネット、ローカル ネットワーク、ゲートウェイを使用して VNet をCreateする |
このテンプレートは、VNet、2 つのサブネット、およびゲートウェイを作成します |
P2S VPN と IIS を使用して DevTest 環境をCreateする |
このテンプレートでは、Windows サーバー上にポイント対サイト VPN と IIS を使用して単純な DevTest 環境を作成します。これは、作業を開始するための優れた方法です。 |
ハブアンドスポーク トポロジ サンドボックスをデプロイする |
このテンプレートは、基本的なハブアンドスポーク トポロジのセットアップを作成します。 サブネット DMZ、管理、共有、ゲートウェイ (必要に応じて) を含むハブ VNet を作成し、それぞれにワークロード サブネットを含む 2 つのスポーク VNet (開発と運用) を作成します。 また、ハブの管理サブネットに Windows Jump-Host をデプロイし、ハブと 2 つのスポークの間に VNet ピアリングを確立します。 |
HBase geo レプリケーションをデプロイする |
このテンプレートを使用すると、VPN vnet 間接続を使用して、2 つの異なるリージョンにわたる HBase レプリケーション用の Azure 環境を構成できます。 |
ハブ & スポーク トポロジで dns プロキシとしてAzure Firewallを使用する |
このサンプルでは、Azure Firewallを使用して Azure にハブスポーク トポロジをデプロイする方法を示します。 ハブ仮想ネットワークは、仮想ネットワーク ピアリングを介してハブ仮想ネットワークに接続されている多くのスポーク仮想ネットワークへの接続の中心点として機能します。 |
ExpressRoute 回線を VNET に接続する |
このテンプレートでは、VNET、ExpresRoute ゲートウェイ、および AzurePrivatePeering が構成されたプロビジョニング済みで有効な ExpressRoute 回線への接続が作成されます。 |
プライベート ピアリングと Azure VNet を使用した ExpressRoute 回線 |
このテンプレートは、ExpressRoute Microsoft ピアリングを構成し、ExpressRoute ゲートウェイを使用して Azure VNet をデプロイし、VNet を ExpressRoute 回線にリンクします |
既存の Azure VNET をマルチ VNET 構成に拡張する |
このテンプレートを使用すると、既存の単一の VNET 環境を、VNET 間ゲートウェイを使用して 2 つのデータセンター リージョンにまたがるマルチ VNET 環境に拡張できます |
ポイント対サイト ゲートウェイをCreateする |
このテンプレートを使用すると、VirtualNetworkGateways を使用してポイント対サイト接続を作成できます |
Azure AD を使用してポイント対サイト ゲートウェイをCreateする |
このテンプレートは、Azure Active Directory ポイント対サイト接続で構成された VPN Virtual Network ゲートウェイをデプロイします |
VM とのサイト間 VPN 接続をCreateする |
このテンプレートを使用すると、Virtual Network ゲートウェイを使用してサイト間 VPN 接続を作成できます |
サイト間 VPN 接続をCreateする |
このテンプレートを使用すると、Virtual Network ゲートウェイを使用してサイト間 VPN 接続を作成できます |
BGP を使用したアクティブ/アクティブ VPN ゲートウェイを使用したサイト間 VPN |
このテンプレートを使用すると、BGP を使用したアクティブ/アクティブ構成の VPN ゲートウェイを使用して、2 つの VNet 間にサイト間 VPN を展開できます。 各 Azure VPN Gatewayは、リモート ピアの FQDN を解決して、リモート VPN Gatewayのパブリック IP を決定します。 テンプレートは、可用性ゾーンを持つ Azure リージョンで想定どおりに実行されます。 |
2 つのリージョン間で VNET 間接続をCreateする |
このテンプレートを使用すると、Virtual Network ゲートウェイを使用して、異なるリージョンの 2 つの VNET を接続できます |
BGP VNET から VNET への接続をCreateする |
このテンプレートを使用すると、Virtual Network ゲートウェイと BGP を使用して 2 つの VNET を接続できます |
推移的な BGP 接続を示すために 3 つの vNet をCreateする |
このテンプレートでは、Virtual Network ゲートウェイと BGP 対応接続を使用して接続された 3 つの vNet をデプロイします |
ポイント対サイト接続が構成された SQL MI のCreate |
新しい仮想ネットワーク内でポイント対サイト接続用に構成された Azure Sql Database Managed Instance (SQL MI) と仮想ネットワーク ゲートウェイをデプロイします。 |
Azure SQL バックエンドを使用したApp Service Environment |
このテンプレートでは、プライベート/分離環境で通常使用される関連リソースと共に、プライベート エンドポイントと共に、Azure SQL バックエンドを含むApp Service Environmentを作成します。 |
Terraform (AzAPI プロバイダー) リソース定義
virtualNetworkGateways リソースの種類は、次を対象とする操作でデプロイできます。
- リソース グループ
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.Network/virtualNetworkGateways リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Network/virtualNetworkGateways@2023-06-01"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
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"
]
}
disableIPSecReplayProtection = bool
enableBgp = bool
enableBgpRouteTranslationForNat = bool
enableDnsForwarding = 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"
}
}
]
sku = {
name = "string"
tier = "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"
]
}
}
}
]
vpnAuthenticationTypes = [
"string"
]
vpnClientAddressPool = {
addressPrefixes = [
"string"
]
}
vpnClientIpsecPolicies = [
{
dhGroup = "string"
ikeEncryption = "string"
ikeIntegrity = "string"
ipsecEncryption = "string"
ipsecIntegrity = "string"
pfsGroup = "string"
saDataSizeKilobytes = int
saLifeTimeSeconds = int
}
]
vpnClientProtocols = [
"string"
]
vpnClientRevokedCertificates = [
{
id = "string"
name = "string"
properties = {
thumbprint = "string"
}
}
]
vpnClientRootCertificates = [
{
id = "string"
name = "string"
properties = {
publicCertData = "string"
}
}
]
}
vpnGatewayGeneration = "string"
vpnType = "string"
}
extendedLocation = {
name = "string"
type = "EdgeZone"
}
})
}
プロパティ値
virtualNetworkGateways
名前 | 説明 | 値 |
---|---|---|
type | リソースの種類 | "Microsoft.Network/virtualNetworkGateways@2023-06-01" |
name | リソース名 | string (必須) 文字数制限: 1 から 80 有効な文字: 英数字、アンダースコア、ピリオド、およびハイフン。 英数字で開始します。 英数字またはアンダースコアで終了します。 |
location | リソースの場所。 | string |
parent_id | リソース グループにデプロイするには、そのリソース グループの ID を使用します。 | string (必須) |
tags | リソース タグ。 | タグ名と値のディクショナリ。 |
extendedLocation | 種類がローカル仮想ネットワーク ゲートウェイの拡張場所。 | ExtendedLocation |
properties | 仮想ネットワーク ゲートウェイのプロパティ。 | VirtualNetworkGatewayPropertiesFormat (必須) |
ExtendedLocation
名前 | 説明 | 値 |
---|---|---|
name | 拡張場所の名前。 | string |
type | 拡張された場所の型。 | "EdgeZone" |
VirtualNetworkGatewayPropertiesFormat
名前 | 説明 | 値 |
---|---|---|
activeActive | ActiveActive フラグ。 | [bool] |
adminState | vnet に複数の Express Route ゲートウェイがある場合に Express Route Gateway がトラフィックを処理するかどうかを示すプロパティ | "無効" "有効" |
allowRemoteVnetTraffic | 他の Azure 仮想ネットワークからのトラフィックを受け入れるように、このゲートウェイを構成します。 この構成では、Azure Virtual WANへの接続はサポートされていません。 | [bool] |
allowVirtualWanTraffic | リモート Virtual WAN ネットワークからのトラフィックを受け入れるように、このゲートウェイを構成します。 | [bool] |
autoScaleConfiguration | 仮想ネットワーク ゲートウェイの自動スケーリング構成 | VirtualNetworkGatewayAutoScaleConfiguration |
bgpSettings | 仮想ネットワーク ゲートウェイの BGP スピーカー設定。 | BgpSettings |
customRoutes | 仮想ネットワーク ゲートウェイと VpnClient に対して顧客によって指定されたカスタム ルート アドレス空間を表すアドレス空間リソースへの参照。 | AddressSpace |
disableIPSecReplayProtection | disableIPSecReplayProtection フラグ。 | [bool] |
enableBgp | この仮想ネットワーク ゲートウェイに対して BGP が有効かどうか。 | [bool] |
enableBgpRouteTranslationForNat | EnableBgpRouteTranslationForNat フラグ。 | [bool] |
enableDnsForwarding | DNS 転送が有効かどうか。 | [bool] |
enablePrivateIpAddress | 接続に対してこのゲートウェイでプライベート IP を有効にする必要があるかどうか。 | [bool] |
gatewayDefaultSite | 既定のルートを持つローカル ネットワーク サイトを表す LocalNetworkGateway リソースへの参照。 既存の既定のサイト設定を削除する場合は、Null 値を割り当てます。 | サブリソース |
gatewayType | この仮想ネットワーク ゲートウェイの種類。 | "ExpressRoute" "LocalGateway" "Vpn" |
ipConfigurations | 仮想ネットワーク ゲートウェイの IP 構成。 | VirtualNetworkGatewayIPConfiguration[] |
natRules | 仮想ネットワーク ゲートウェイの NatRules。 | VirtualNetworkGatewayNatRule[] |
sku | 仮想ネットワーク ゲートウェイ用に選択された SKU を表す VirtualNetworkGatewaySku リソースへの参照。 | VirtualNetworkGatewaySku |
virtualNetworkGatewayPolicyGroups | ゲートウェイで使用可能な VirtualNetworkGatewayPolicyGroup を表す VirtualNetworkGatewayPolicyGroup リソースへの参照。 | VirtualNetworkGatewayPolicyGroup[] |
vNetExtendedLocationResourceId | 顧客 vnet リソース ID。種類がローカル ゲートウェイの VirtualNetworkGateway は、お客様の vnet に関連付けられています。 | string |
vpnClientConfiguration | P2S VpnClient 構成を表す VpnClientConfiguration リソースへの参照。 | VpnClientConfiguration |
vpnGatewayGeneration | この VirtualNetworkGateway の世代。 gatewayType が VPN でない場合は None にする必要があります。 | "Generation1" "Generation2" "None" |
vpnType | この仮想ネットワーク ゲートウェイの種類。 | "PolicyBased" "RouteBased" |
VirtualNetworkGatewayAutoScaleConfiguration
名前 | 説明 | 値 |
---|---|---|
bounds | 自動スケーリング構成の境界 | VirtualNetworkGatewayAutoScaleBounds |
VirtualNetworkGatewayAutoScaleBounds
名前 | 説明 | 値 |
---|---|---|
max | 自動スケーリング構成の最大スケール ユニット数 | INT |
分 | 自動スケーリング構成の最小スケール ユニット数 | INT |
BgpSettings
名前 | 説明 | 値 |
---|---|---|
Asn | BGP スピーカーの ASN。 | INT 制約: 最小値 = 0 最大値 = 4294967295 |
bgpPeeringAddress | この BGP スピーカーの BGP ピアリング アドレスと BGP 識別子。 | string |
bgpPeeringAddresses | 仮想ネットワーク ゲートウェイの IP 構成 ID を持つ BGP ピアリング アドレス。 | IPConfigurationBgpPeeringAddress[] |
peerWeight | この BGP スピーカーから学習したルートに追加された重み。 | INT |
IPConfigurationBgpPeeringAddress
名前 | 説明 | 値 |
---|---|---|
customBgpIpAddresses | IP 構成に属するカスタム BGP ピアリング アドレスの一覧。 | string[] |
ipconfigurationId | ゲートウェイに属する IP 構成の ID。 | string |
AddressSpace
名前 | 説明 | 値 |
---|---|---|
addressPrefixes | CIDR 表記でこの仮想ネットワーク用に予約されているアドレス ブロックの一覧。 | string[] |
サブリソース
名前 | 説明 | 値 |
---|---|---|
id | リソースの ID | string |
VirtualNetworkGatewayIPConfiguration
名前 | 説明 | 値 |
---|---|---|
id | リソースの ID | string |
name | リソース グループ内で一意のリソースの名前。 この名前は、リソースへのアクセスに使用できます。 | string |
properties | 仮想ネットワーク ゲートウェイ IP 構成のプロパティ。 | VirtualNetworkGatewayIPConfigurationPropertiesFormat |
VirtualNetworkGatewayIPConfigurationPropertiesFormat
名前 | 説明 | 値 |
---|---|---|
privateIPAllocationMethod | プライベート IP アドレスの割り当て方法。 | "Dynamic" "Static" |
publicIPAddress | パブリック IP リソースへの参照。 | サブリソース |
サブネット | サブネット リソースへの参照。 | サブリソース |
VirtualNetworkGatewayNatRule
名前 | 説明 | 値 |
---|---|---|
id | リソースの ID | string |
name | リソース グループ内で一意のリソースの名前。 この名前は、リソースへのアクセスに使用できます。 | string |
properties | Virtual Network ゲートウェイ NAT 規則のプロパティ。 | VirtualNetworkGatewayNatRuleProperties |
VirtualNetworkGatewayNatRuleProperties
名前 | 説明 | 値 |
---|---|---|
externalMappings | NAT のプライベート IP アドレス外部マッピング。 | VpnNatRuleMapping[] |
internalMappings | NAT のプライベート IP アドレス内部マッピング。 | VpnNatRuleMapping[] |
ipConfigurationId | この NAT 規則が適用される IP 構成 ID。 | string |
mode | VPN NAT のソース NAT 方向。 | "EgressSnat" "IngressSnat" |
型 | VPN NAT の NAT 規則の種類。 | "Dynamic" "Static" |
VpnNatRuleMapping
名前 | 説明 | 値 |
---|---|---|
addressSpace | Vpn NatRule マッピングのアドレス空間。 | string |
portRange | Vpn NatRule マッピングのポート範囲。 | string |
VirtualNetworkGatewaySku
名前 | 説明 | 値 |
---|---|---|
name | ゲートウェイ SKU 名。 | "Basic" "ErGw1AZ" "ErGw2AZ" "ErGw3AZ" "ErGwScale" "HighPerformance" "Standard" "UltraPerformance" "VpnGw1" "VpnGw1AZ" "VpnGw2" "VpnGw2AZ" "VpnGw3" "VpnGw3AZ" "VpnGw4" "VpnGw4AZ" "VpnGw5" "VpnGw5AZ" |
レベル | ゲートウェイ SKU レベル。 | "Basic" "ErGw1AZ" "ErGw2AZ" "ErGw3AZ" "ErGwScale" "HighPerformance" "Standard" "UltraPerformance" "VpnGw1" "VpnGw1AZ" "VpnGw2" "VpnGw2AZ" "VpnGw3" "VpnGw3AZ" "VpnGw4" "VpnGw4AZ" "VpnGw5" "VpnGw5AZ" |
VirtualNetworkGatewayPolicyGroup
名前 | 説明 | 値 |
---|---|---|
id | リソースの ID | string |
name | リソース グループ内で一意のリソースの名前。 この名前は、リソースへのアクセスに使用できます。 | string |
properties | tVirtualNetworkGatewayPolicyGroup のプロパティ。 | VirtualNetworkGatewayPolicyGroupProperties |
VirtualNetworkGatewayPolicyGroupProperties
名前 | 説明 | 値 |
---|---|---|
isDefault | これが既定の VirtualNetworkGatewayPolicyGroup であるかどうかを示します。 | bool (必須) |
policyMembers | VirtualNetworkGatewayPolicyGroup の複数の PolicyMembers。 | VirtualNetworkGatewayPolicyGroupMember[] (必須) |
priority | VirtualNetworkGatewayPolicyGroup の優先度。 | int (必須) |
VirtualNetworkGatewayPolicyGroupMember
名前 | 説明 | 値 |
---|---|---|
attributeType | Vpn Policy メンバー属性の種類。 | "AADGroupId" "CertificateGroupId" "RadiusAzureGroupId" |
attributeValue | この VirtualNetworkGatewayPolicyGroupMember に使用される Attribute の値。 | string |
name | VirtualNetworkGatewayPolicyGroupMember の名前。 | string |
VpnClientConfiguration
名前 | 説明 | 値 |
---|---|---|
aadAudience | AAD 認証に使用される VPN クライアント接続用の VirtualNetworkGateway リソースの AADAudience プロパティ。 | string |
aadIssuer | AAD 認証に使用される VPN クライアント接続用の VirtualNetworkGateway リソースの AADIssuer プロパティ。 | string |
aadTenant | AAD 認証に使用される VPN クライアント接続用の VirtualNetworkGateway リソースの AADTenant プロパティ。 | string |
radiusServerAddress | VPN クライアント接続用の VirtualNetworkGateway リソースの radius サーバー アドレス プロパティ。 | string |
radiusServers | 複数の radius サーバー構成の radiusServers プロパティ。 | RadiusServer[] |
radiusServerSecret | VPN クライアント接続用の VirtualNetworkGateway リソースの radius シークレット プロパティ。 | string |
vngClientConnectionConfigurations | 仮想ネットワーク ゲートウェイ P2S クライアントの IP アドレス プール接続ポリシーごとに。 | VngClientConnectionConfiguration[] |
vpnAuthenticationTypes | 仮想ネットワーク ゲートウェイの VPN 認証の種類。. | 次のいずれかを含む文字列配列: "AAD" "Certificate" "Radius" |
vpnClientAddressPool | P2S VpnClient のアドレス空間を表すアドレス空間リソースへの参照。 | AddressSpace |
vpnClientIpsecPolicies | 仮想ネットワーク ゲートウェイ P2S クライアントの VpnClientIpsecPolicies。 | IpsecPolicy[] |
vpnClientProtocols | 仮想ネットワーク ゲートウェイの VpnClientProtocols。 | 次のいずれかを含む文字列配列: "IkeV2" "OpenVPN" "SSTP" |
vpnClientRevokedCertificates | 仮想ネットワーク ゲートウェイの VpnClientRevokedCertificate。 | VpnClientRevokedCertificate[] |
vpnClientRootCertificates | 仮想ネットワーク ゲートウェイの VpnClientRootCertificate。 | VpnClientRootCertificate[] |
RadiusServer
名前 | 説明 | 値 |
---|---|---|
radiusServerAddress | この radius サーバーのアドレス。 | string (必須) |
radiusServerScore | この radius サーバーに割り当てられた初期スコア。 | INT |
radiusServerSecret | この radius サーバーに使用されるシークレット。 | string |
VngClientConnectionConfiguration
名前 | 説明 | 値 |
---|---|---|
id | リソースの ID | string |
name | リソース グループ内で一意のリソースの名前。 この名前は、リソースへのアクセスに使用できます。 | string |
properties | VPN クライアント ルート証明書のプロパティ。 | VngClientConnectionConfigurationProperties |
VngClientConnectionConfigurationProperties
名前 | 説明 | 値 |
---|---|---|
virtualNetworkGatewayPolicyGroups | virtualNetworkGatewayPolicyGroups への参照の一覧 | SubResource[] (必須) |
vpnClientAddressPool | P2S VpnClient のアドレス空間を表すアドレス空間リソースへの参照。 | AddressSpace (必須) |
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 (必須) |
VpnClientRevokedCertificate
名前 | 説明 | 値 |
---|---|---|
id | リソースの ID | string |
name | リソース グループ内で一意のリソースの名前。 この名前は、リソースへのアクセスに使用できます。 | string |
properties | VPN クライアントで失効した証明書のプロパティ。 | VpnClientRevokedCertificatePropertiesFormat |
VpnClientRevokedCertificatePropertiesFormat
名前 | 説明 | 値 |
---|---|---|
thumbprint | 失効した VPN クライアント証明書の拇印。 | string |
VpnClientRootCertificate
名前 | 説明 | 値 |
---|---|---|
id | リソースの ID | string |
name | リソース グループ内で一意のリソースの名前。 この名前は、リソースへのアクセスに使用できます。 | string |
properties | VPN クライアント ルート証明書のプロパティ。 | VpnClientRootCertificatePropertiesFormat (必須) |
VpnClientRootCertificatePropertiesFormat
名前 | 説明 | 値 |
---|---|---|
publicCertData | 証明書のパブリック データ。 | string (必須) |