pulumi-azure-native-kotlin/com.pulumi.azurenative.network.kotlin/VirtualNetworkGatewayArgs

VirtualNetworkGatewayArgs

data class VirtualNetworkGatewayArgs(val activeActive: Output<Boolean>? = null, val adminState: Output<Either<String, AdminState>>? = null, val allowRemoteVnetTraffic: Output<Boolean>? = null, val allowVirtualWanTraffic: Output<Boolean>? = null, val bgpSettings: Output<BgpSettingsArgs>? = null, val customRoutes: Output<AddressSpaceArgs>? = null, val disableIPSecReplayProtection: Output<Boolean>? = null, val enableBgp: Output<Boolean>? = null, val enableBgpRouteTranslationForNat: Output<Boolean>? = null, val enableDnsForwarding: Output<Boolean>? = null, val enablePrivateIpAddress: Output<Boolean>? = null, val extendedLocation: Output<ExtendedLocationArgs>? = null, val gatewayDefaultSite: Output<SubResourceArgs>? = null, val gatewayType: Output<Either<String, VirtualNetworkGatewayType>>? = null, val id: Output<String>? = null, val ipConfigurations: Output<List<VirtualNetworkGatewayIPConfigurationArgs>>? = null, val location: Output<String>? = null, val natRules: Output<List<VirtualNetworkGatewayNatRuleArgs>>? = null, val resourceGroupName: Output<String>? = null, val sku: Output<VirtualNetworkGatewaySkuArgs>? = null, val tags: Output<Map<String, String>>? = null, val vNetExtendedLocationResourceId: Output<String>? = null, val virtualNetworkGatewayName: Output<String>? = null, val virtualNetworkGatewayPolicyGroups: Output<List<VirtualNetworkGatewayPolicyGroupArgs>>? = null, val vpnClientConfiguration: Output<VpnClientConfigurationArgs>? = null, val vpnGatewayGeneration: Output<Either<String, VpnGatewayGeneration>>? = null, val vpnType: Output<Either<String, VpnType>>? = null) : ConvertibleToJava<VirtualNetworkGatewayArgs>

A common class for general resource information. Azure REST API version: 2023-02-01. Prior API version in Azure Native 1.x: 2020-11-01. Other available API versions: 2016-06-01, 2016-09-01, 2019-08-01, 2023-04-01, 2023-05-01.

Example Usage

UpdateVirtualNetworkGateway

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
    var virtualNetworkGateway = new AzureNative.Network.VirtualNetworkGateway("virtualNetworkGateway", new()
    {
        ActiveActive = false,
        AllowRemoteVnetTraffic = false,
        AllowVirtualWanTraffic = false,
        BgpSettings = new AzureNative.Network.Inputs.BgpSettingsArgs
        {
            Asn = 65515,
            BgpPeeringAddress = "10.0.1.30",
            PeerWeight = 0,
        },
        CustomRoutes = new AzureNative.Network.Inputs.AddressSpaceArgs
        {
            AddressPrefixes = new[]
            {
                "101.168.0.6/32",
            },
        },
        DisableIPSecReplayProtection = false,
        EnableBgp = false,
        EnableBgpRouteTranslationForNat = false,
        EnableDnsForwarding = true,
        GatewayType = "Vpn",
        IpConfigurations = new[]
        {
            new AzureNative.Network.Inputs.VirtualNetworkGatewayIPConfigurationArgs
            {
                Name = "gwipconfig1",
                PrivateIPAllocationMethod = "Dynamic",
                PublicIPAddress = new AzureNative.Network.Inputs.SubResourceArgs
                {
                    Id = "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/gwpip",
                },
                Subnet = new AzureNative.Network.Inputs.SubResourceArgs
                {
                    Id = "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet",
                },
            },
        },
        Location = "centralus",
        NatRules = new[]
        {
            new AzureNative.Network.Inputs.VirtualNetworkGatewayNatRuleArgs
            {
                ExternalMappings = new[]
                {
                    new AzureNative.Network.Inputs.VpnNatRuleMappingArgs
                    {
                        AddressSpace = "50.0.0.0/24",
                    },
                },
                Id = "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule1",
                InternalMappings = new[]
                {
                    new AzureNative.Network.Inputs.VpnNatRuleMappingArgs
                    {
                        AddressSpace = "10.10.0.0/24",
                    },
                },
                IpConfigurationId = "",
                Mode = "EgressSnat",
                Name = "natRule1",
                Type = "Static",
            },
            new AzureNative.Network.Inputs.VirtualNetworkGatewayNatRuleArgs
            {
                ExternalMappings = new[]
                {
                    new AzureNative.Network.Inputs.VpnNatRuleMappingArgs
                    {
                        AddressSpace = "30.0.0.0/24",
                    },
                },
                Id = "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule2",
                InternalMappings = new[]
                {
                    new AzureNative.Network.Inputs.VpnNatRuleMappingArgs
                    {
                        AddressSpace = "20.10.0.0/24",
                    },
                },
                IpConfigurationId = "",
                Mode = "IngressSnat",
                Name = "natRule2",
                Type = "Static",
            },
        },
        ResourceGroupName = "rg1",
        Sku = new AzureNative.Network.Inputs.VirtualNetworkGatewaySkuArgs
        {
            Name = "VpnGw1",
            Tier = "VpnGw1",
        },
        VirtualNetworkGatewayName = "vpngw",
        VpnClientConfiguration = new AzureNative.Network.Inputs.VpnClientConfigurationArgs
        {
            RadiusServers = new[]
            {
                new AzureNative.Network.Inputs.RadiusServerArgs
                {
                    RadiusServerAddress = "10.2.0.0",
                    RadiusServerScore = 20,
                    RadiusServerSecret = "radiusServerSecret",
                },
            },
            VpnClientProtocols = new[]
            {
                "OpenVPN",
            },
            VpnClientRevokedCertificates = new() { },
            VpnClientRootCertificates = new() { },
        },
        VpnType = "RouteBased",
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-azure-native-sdk/network/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := network.NewVirtualNetworkGateway(ctx, "virtualNetworkGateway", &network.VirtualNetworkGatewayArgs{
			ActiveActive:           pulumi.Bool(false),
			AllowRemoteVnetTraffic: pulumi.Bool(false),
			AllowVirtualWanTraffic: pulumi.Bool(false),
			BgpSettings: &network.BgpSettingsArgs{
				Asn:               pulumi.Float64(65515),
				BgpPeeringAddress: pulumi.String("10.0.1.30"),
				PeerWeight:        pulumi.Int(0),
			},
			CustomRoutes: &network.AddressSpaceArgs{
				AddressPrefixes: pulumi.StringArray{
					pulumi.String("101.168.0.6/32"),
				},
			},
			DisableIPSecReplayProtection:    pulumi.Bool(false),
			EnableBgp:                       pulumi.Bool(false),
			EnableBgpRouteTranslationForNat: pulumi.Bool(false),
			EnableDnsForwarding:             pulumi.Bool(true),
			GatewayType:                     pulumi.String("Vpn"),
			IpConfigurations: []network.VirtualNetworkGatewayIPConfigurationArgs{
				{
					Name:                      pulumi.String("gwipconfig1"),
					PrivateIPAllocationMethod: pulumi.String("Dynamic"),
					PublicIPAddress: {
						Id: pulumi.String("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/gwpip"),
					},
					Subnet: {
						Id: pulumi.String("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet"),
					},
				},
			},
			Location: pulumi.String("centralus"),
			NatRules: []network.VirtualNetworkGatewayNatRuleTypeArgs{
				{
					ExternalMappings: network.VpnNatRuleMappingArray{
						{
							AddressSpace: pulumi.String("50.0.0.0/24"),
						},
					},
					Id: pulumi.String("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule1"),
					InternalMappings: network.VpnNatRuleMappingArray{
						{
							AddressSpace: pulumi.String("10.10.0.0/24"),
						},
					},
					IpConfigurationId: pulumi.String(""),
					Mode:              pulumi.String("EgressSnat"),
					Name:              pulumi.String("natRule1"),
					Type:              pulumi.String("Static"),
				},
				{
					ExternalMappings: network.VpnNatRuleMappingArray{
						{
							AddressSpace: pulumi.String("30.0.0.0/24"),
						},
					},
					Id: pulumi.String("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule2"),
					InternalMappings: network.VpnNatRuleMappingArray{
						{
							AddressSpace: pulumi.String("20.10.0.0/24"),
						},
					},
					IpConfigurationId: pulumi.String(""),
					Mode:              pulumi.String("IngressSnat"),
					Name:              pulumi.String("natRule2"),
					Type:              pulumi.String("Static"),
				},
			},
			ResourceGroupName: pulumi.String("rg1"),
			Sku: &network.VirtualNetworkGatewaySkuArgs{
				Name: pulumi.String("VpnGw1"),
				Tier: pulumi.String("VpnGw1"),
			},
			VirtualNetworkGatewayName: pulumi.String("vpngw"),
			VpnClientConfiguration: network.VpnClientConfigurationResponse{
				RadiusServers: network.RadiusServerArray{
					&network.RadiusServerArgs{
						RadiusServerAddress: pulumi.String("10.2.0.0"),
						RadiusServerScore:   pulumi.Float64(20),
						RadiusServerSecret:  pulumi.String("radiusServerSecret"),
					},
				},
				VpnClientProtocols: pulumi.StringArray{
					pulumi.String("OpenVPN"),
				},
				VpnClientRevokedCertificates: network.VpnClientRevokedCertificateArray{},
				VpnClientRootCertificates:    network.VpnClientRootCertificateArray{},
			},
			VpnType: pulumi.String("RouteBased"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.network.VirtualNetworkGateway;
import com.pulumi.azurenative.network.VirtualNetworkGatewayArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var virtualNetworkGateway = new VirtualNetworkGateway("virtualNetworkGateway", VirtualNetworkGatewayArgs.builder()
            .activeActive(false)
            .allowRemoteVnetTraffic(false)
            .allowVirtualWanTraffic(false)
            .bgpSettings(Map.ofEntries(
                Map.entry("asn", 65515),
                Map.entry("bgpPeeringAddress", "10.0.1.30"),
                Map.entry("peerWeight", 0)
            ))
            .customRoutes(Map.of("addressPrefixes", "101.168.0.6/32"))
            .disableIPSecReplayProtection(false)
            .enableBgp(false)
            .enableBgpRouteTranslationForNat(false)
            .enableDnsForwarding(true)
            .gatewayType("Vpn")
            .ipConfigurations(Map.ofEntries(
                Map.entry("name", "gwipconfig1"),
                Map.entry("privateIPAllocationMethod", "Dynamic"),
                Map.entry("publicIPAddress", Map.of("id", "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/gwpip")),
                Map.entry("subnet", Map.of("id", "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet"))
            ))
            .location("centralus")
            .natRules(
                Map.ofEntries(
                    Map.entry("externalMappings", Map.of("addressSpace", "50.0.0.0/24")),
                    Map.entry("id", "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule1"),
                    Map.entry("internalMappings", Map.of("addressSpace", "10.10.0.0/24")),
                    Map.entry("ipConfigurationId", ""),
                    Map.entry("mode", "EgressSnat"),
                    Map.entry("name", "natRule1"),
                    Map.entry("type", "Static")
                ),
                Map.ofEntries(
                    Map.entry("externalMappings", Map.of("addressSpace", "30.0.0.0/24")),
                    Map.entry("id", "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule2"),
                    Map.entry("internalMappings", Map.of("addressSpace", "20.10.0.0/24")),
                    Map.entry("ipConfigurationId", ""),
                    Map.entry("mode", "IngressSnat"),
                    Map.entry("name", "natRule2"),
                    Map.entry("type", "Static")
                ))
            .resourceGroupName("rg1")
            .sku(Map.ofEntries(
                Map.entry("name", "VpnGw1"),
                Map.entry("tier", "VpnGw1")
            ))
            .virtualNetworkGatewayName("vpngw")
            .vpnClientConfiguration(Map.ofEntries(
                Map.entry("radiusServers", Map.ofEntries(
                    Map.entry("radiusServerAddress", "10.2.0.0"),
                    Map.entry("radiusServerScore", 20),
                    Map.entry("radiusServerSecret", "radiusServerSecret")
                )),
                Map.entry("vpnClientProtocols", "OpenVPN"),
                Map.entry("vpnClientRevokedCertificates", ),
                Map.entry("vpnClientRootCertificates", )
            ))
            .vpnType("RouteBased")
            .build());
    }
}
Content copied to clipboard

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:network:VirtualNetworkGateway vpngw /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}
Content copied to clipboard

Constructors

Link copied to clipboard
fun VirtualNetworkGatewayArgs(activeActive: Output<Boolean>? = null, adminState: Output<Either<String, AdminState>>? = null, allowRemoteVnetTraffic: Output<Boolean>? = null, allowVirtualWanTraffic: Output<Boolean>? = null, bgpSettings: Output<BgpSettingsArgs>? = null, customRoutes: Output<AddressSpaceArgs>? = null, disableIPSecReplayProtection: Output<Boolean>? = null, enableBgp: Output<Boolean>? = null, enableBgpRouteTranslationForNat: Output<Boolean>? = null, enableDnsForwarding: Output<Boolean>? = null, enablePrivateIpAddress: Output<Boolean>? = null, extendedLocation: Output<ExtendedLocationArgs>? = null, gatewayDefaultSite: Output<SubResourceArgs>? = null, gatewayType: Output<Either<String, VirtualNetworkGatewayType>>? = null, id: Output<String>? = null, ipConfigurations: Output<List<VirtualNetworkGatewayIPConfigurationArgs>>? = null, location: Output<String>? = null, natRules: Output<List<VirtualNetworkGatewayNatRuleArgs>>? = null, resourceGroupName: Output<String>? = null, sku: Output<VirtualNetworkGatewaySkuArgs>? = null, tags: Output<Map<String, String>>? = null, vNetExtendedLocationResourceId: Output<String>? = null, virtualNetworkGatewayName: Output<String>? = null, virtualNetworkGatewayPolicyGroups: Output<List<VirtualNetworkGatewayPolicyGroupArgs>>? = null, vpnClientConfiguration: Output<VpnClientConfigurationArgs>? = null, vpnGatewayGeneration: Output<Either<String, VpnGatewayGeneration>>? = null, vpnType: Output<Either<String, VpnType>>? = null)

Functions

Link copied to clipboard
open override fun toJava(): VirtualNetworkGatewayArgs

Properties

Link copied to clipboard
val activeActive: Output<Boolean>? = null

ActiveActive flag.

Link copied to clipboard
val adminState: Output<Either<String, AdminState>>? = null

Property to indicate if the Express Route Gateway serves traffic when there are multiple Express Route Gateways in the vnet

Link copied to clipboard
val allowRemoteVnetTraffic: Output<Boolean>? = null

Configure this gateway to accept traffic from other Azure Virtual Networks. This configuration does not support connectivity to Azure Virtual WAN.

Link copied to clipboard
val allowVirtualWanTraffic: Output<Boolean>? = null

Configures this gateway to accept traffic from remote Virtual WAN networks.

Link copied to clipboard
val bgpSettings: Output<BgpSettingsArgs>? = null

Virtual network gateway's BGP speaker settings.

Link copied to clipboard
val customRoutes: Output<AddressSpaceArgs>? = null

The reference to the address space resource which represents the custom routes address space specified by the customer for virtual network gateway and VpnClient.

Link copied to clipboard
val disableIPSecReplayProtection: Output<Boolean>? = null

disableIPSecReplayProtection flag.

Link copied to clipboard
val enableBgp: Output<Boolean>? = null

Whether BGP is enabled for this virtual network gateway or not.

Link copied to clipboard
val enableBgpRouteTranslationForNat: Output<Boolean>? = null

EnableBgpRouteTranslationForNat flag.

Link copied to clipboard
val enableDnsForwarding: Output<Boolean>? = null

Whether dns forwarding is enabled or not.

Link copied to clipboard
val enablePrivateIpAddress: Output<Boolean>? = null

Whether private IP needs to be enabled on this gateway for connections or not.

Link copied to clipboard
val extendedLocation: Output<ExtendedLocationArgs>? = null

The extended location of type local virtual network gateway.

Link copied to clipboard
val gatewayDefaultSite: Output<SubResourceArgs>? = null

The reference to the LocalNetworkGateway resource which represents local network site having default routes. Assign Null value in case of removing existing default site setting.

Link copied to clipboard
val gatewayType: Output<Either<String, VirtualNetworkGatewayType>>? = null

The type of this virtual network gateway.

Link copied to clipboard
val id: Output<String>? = null

Resource ID.

Link copied to clipboard
val ipConfigurations: Output<List<VirtualNetworkGatewayIPConfigurationArgs>>? = null

IP configurations for virtual network gateway.

Link copied to clipboard
val location: Output<String>? = null

Resource location.

Link copied to clipboard
val natRules: Output<List<VirtualNetworkGatewayNatRuleArgs>>? = null

NatRules for virtual network gateway. These are also available as standalone resources. Do not mix inline and standalone resource as they will conflict with each other, leading to resources deletion.

Link copied to clipboard
val resourceGroupName: Output<String>? = null

The name of the resource group.

Link copied to clipboard
val sku: Output<VirtualNetworkGatewaySkuArgs>? = null

The reference to the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway.

Link copied to clipboard
val tags: Output<Map<String, String>>? = null

Resource tags.

Link copied to clipboard
val virtualNetworkGatewayName: Output<String>? = null

The name of the virtual network gateway.

Link copied to clipboard
val virtualNetworkGatewayPolicyGroups: Output<List<VirtualNetworkGatewayPolicyGroupArgs>>? = null

The reference to the VirtualNetworkGatewayPolicyGroup resource which represents the available VirtualNetworkGatewayPolicyGroup for the gateway.

Link copied to clipboard
val vNetExtendedLocationResourceId: Output<String>? = null

Customer vnet resource id. VirtualNetworkGateway of type local gateway is associated with the customer vnet.

Link copied to clipboard
val vpnClientConfiguration: Output<VpnClientConfigurationArgs>? = null

The reference to the VpnClientConfiguration resource which represents the P2S VpnClient configurations.

Link copied to clipboard
val vpnGatewayGeneration: Output<Either<String, VpnGatewayGeneration>>? = null

The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN.

Link copied to clipboard
val vpnType: Output<Either<String, VpnType>>? = null

The type of this virtual network gateway.