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

VirtualNetworkGatewayArgs

data class VirtualNetworkGatewayArgs(val activeActive: Output<Boolean>? = null, val bgpSettings: Output<VirtualNetworkGatewayBgpSettingsArgs>? = null, val customRoute: Output<VirtualNetworkGatewayCustomRouteArgs>? = null, val defaultLocalNetworkGatewayId: Output<String>? = null, val edgeZone: Output<String>? = null, val enableBgp: Output<Boolean>? = null, val generation: Output<String>? = null, val ipConfigurations: Output<List<VirtualNetworkGatewayIpConfigurationArgs>>? = null, val location: Output<String>? = null, val name: Output<String>? = null, val privateIpAddressEnabled: Output<Boolean>? = null, val resourceGroupName: Output<String>? = null, val sku: Output<String>? = null, val tags: Output<Map<String, String>>? = null, val type: Output<String>? = null, val vpnClientConfiguration: Output<VirtualNetworkGatewayVpnClientConfigurationArgs>? = null, val vpnType: Output<String>? = null) : ConvertibleToJava<VirtualNetworkGatewayArgs>

Manages a Virtual Network Gateway to establish secure, cross-premises connectivity.

Note: Please be aware that provisioning a Virtual Network Gateway takes a long time (between 30 minutes and 1 hour)

Example Usage

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.network.VirtualNetwork;
import com.pulumi.azure.network.VirtualNetworkArgs;
import com.pulumi.azure.network.Subnet;
import com.pulumi.azure.network.SubnetArgs;
import com.pulumi.azure.network.PublicIp;
import com.pulumi.azure.network.PublicIpArgs;
import com.pulumi.azure.network.VirtualNetworkGateway;
import com.pulumi.azure.network.VirtualNetworkGatewayArgs;
import com.pulumi.azure.network.inputs.VirtualNetworkGatewayIpConfigurationArgs;
import com.pulumi.azure.network.inputs.VirtualNetworkGatewayVpnClientConfigurationArgs;
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 exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()
            .location("West Europe")
            .build());
        var exampleVirtualNetwork = new VirtualNetwork("exampleVirtualNetwork", VirtualNetworkArgs.builder()
            .location(exampleResourceGroup.location())
            .resourceGroupName(exampleResourceGroup.name())
            .addressSpaces("10.0.0.0/16")
            .build());
        var exampleSubnet = new Subnet("exampleSubnet", SubnetArgs.builder()
            .resourceGroupName(exampleResourceGroup.name())
            .virtualNetworkName(exampleVirtualNetwork.name())
            .addressPrefixes("10.0.1.0/24")
            .build());
        var examplePublicIp = new PublicIp("examplePublicIp", PublicIpArgs.builder()
            .location(exampleResourceGroup.location())
            .resourceGroupName(exampleResourceGroup.name())
            .allocationMethod("Dynamic")
            .build());
        var exampleVirtualNetworkGateway = new VirtualNetworkGateway("exampleVirtualNetworkGateway", VirtualNetworkGatewayArgs.builder()
            .location(exampleResourceGroup.location())
            .resourceGroupName(exampleResourceGroup.name())
            .type("Vpn")
            .vpnType("RouteBased")
            .activeActive(false)
            .enableBgp(false)
            .sku("Basic")
            .ipConfigurations(VirtualNetworkGatewayIpConfigurationArgs.builder()
                .name("vnetGatewayConfig")
                .publicIpAddressId(examplePublicIp.id())
                .privateIpAddressAllocation("Dynamic")
                .subnetId(exampleSubnet.id())
                .build())
            .vpnClientConfiguration(VirtualNetworkGatewayVpnClientConfigurationArgs.builder()
                .addressSpaces("10.2.0.0/24")
                .rootCertificates(VirtualNetworkGatewayVpnClientConfigurationRootCertificateArgs.builder()
                    .name("DigiCert-Federated-ID-Root-CA")
                    .publicCertData("""
MIIDuzCCAqOgAwIBAgIQCHTZWCM+IlfFIRXIvyKSrjANBgkqhkiG9w0BAQsFADBn
MQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMRkwFwYDVQQLExB3
d3cuZGlnaWNlcnQuY29tMSYwJAYDVQQDEx1EaWdpQ2VydCBGZWRlcmF0ZWQgSUQg
Um9vdCBDQTAeFw0xMzAxMTUxMjAwMDBaFw0zMzAxMTUxMjAwMDBaMGcxCzAJBgNV
BAYTAlVTMRUwEwYDVQQKEwxEaWdpQ2VydCBJbmMxGTAXBgNVBAsTEHd3dy5kaWdp
Y2VydC5jb20xJjAkBgNVBAMTHURpZ2lDZXJ0IEZlZGVyYXRlZCBJRCBSb290IENB
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAvAEB4pcCqnNNOWE6Ur5j
QPUH+1y1F9KdHTRSza6k5iDlXq1kGS1qAkuKtw9JsiNRrjltmFnzMZRBbX8Tlfl8
zAhBmb6dDduDGED01kBsTkgywYPxXVTKec0WxYEEF0oMn4wSYNl0lt2eJAKHXjNf
GTwiibdP8CUR2ghSM2sUTI8Nt1Omfc4SMHhGhYD64uJMbX98THQ/4LMGuYegou+d
GTiahfHtjn7AboSEknwAMJHCh5RlYZZ6B1O4QbKJ+34Q0eKgnI3X6Vc9u0zf6DH8
Dk+4zQDYRRTqTnVO3VT8jzqDlCRuNtq6YvryOWN74/dq8LQhUnXHvFyrsdMaE1X2
DwIDAQABo2MwYTAPBgNVHRMBAf8EBTADAQH/MA4GA1UdDwEB/wQEAwIBhjAdBgNV
HQ4EFgQUGRdkFnbGt1EWjKwbUne+5OaZvRYwHwYDVR0jBBgwFoAUGRdkFnbGt1EW
jKwbUne+5OaZvRYwDQYJKoZIhvcNAQELBQADggEBAHcqsHkrjpESqfuVTRiptJfP
9JbdtWqRTmOf6uJi2c8YVqI6XlKXsD8C1dUUaaHKLUJzvKiazibVuBwMIT84AyqR
QELn3e0BtgEymEygMU569b01ZPxoFSnNXc7qDZBDef8WfqAV/sxkTi8L9BkmFYfL
uGLOhRJOFprPdoDIUBB+tmCl3oDcBy3vnUeOEioz8zAkprcb3GHwHAK+vHmmfgcn
WsfMLH4JCLa/tRYL+Rw/N3ybCkDp00s0WUZ+AoDywSl0Q/ZEnNY0MsFiw6LyIdbq
M/s/1JRtO3bDSzD9TazRVzn2oBqzSa8VgIo5C1nOnoAKJTlsClJKvIhnRlaLQqk=
                    """)
                    .build())
                .revokedCertificates(VirtualNetworkGatewayVpnClientConfigurationRevokedCertificateArgs.builder()
                    .name("Verizon-Global-Root-CA")
                    .thumbprint("912198EEF23DCAC40939312FEE97DD560BAE49B1")
                    .build())
                .build())
            .build());
    }
}
Content copied to clipboard

Import

Virtual Network Gateways can be imported using the resource id, e.g.

$ pulumi import azure:network/virtualNetworkGateway:VirtualNetworkGateway exampleGateway /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myGroup1/providers/Microsoft.Network/virtualNetworkGateways/myGateway1
Content copied to clipboard

Constructors

Link copied to clipboard
fun VirtualNetworkGatewayArgs(activeActive: Output<Boolean>? = null, bgpSettings: Output<VirtualNetworkGatewayBgpSettingsArgs>? = null, customRoute: Output<VirtualNetworkGatewayCustomRouteArgs>? = null, defaultLocalNetworkGatewayId: Output<String>? = null, edgeZone: Output<String>? = null, enableBgp: Output<Boolean>? = null, generation: Output<String>? = null, ipConfigurations: Output<List<VirtualNetworkGatewayIpConfigurationArgs>>? = null, location: Output<String>? = null, name: Output<String>? = null, privateIpAddressEnabled: Output<Boolean>? = null, resourceGroupName: Output<String>? = null, sku: Output<String>? = null, tags: Output<Map<String, String>>? = null, type: Output<String>? = null, vpnClientConfiguration: Output<VirtualNetworkGatewayVpnClientConfigurationArgs>? = null, vpnType: Output<String>? = null)

Functions

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

Properties

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

If true, an active-active Virtual Network Gateway will be created. An active-active gateway requires a HighPerformance or an UltraPerformance SKU. If false, an active-standby gateway will be created. Defaults to false.

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

A bgp_settings block which is documented below. In this block the BGP specific settings can be defined.

Link copied to clipboard
val customRoute: Output<VirtualNetworkGatewayCustomRouteArgs>? = null

A custom_route block as defined below. Specifies a custom routes address space for a virtual network gateway and a VpnClient.

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

The ID of the local network gateway through which outbound Internet traffic from the virtual network in which the gateway is created will be routed (forced tunnelling). Refer to the Azure documentation on forced tunnelling. If not specified, forced tunnelling is disabled.

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

Specifies the Edge Zone within the Azure Region where this Virtual Network Gateway should exist. Changing this forces a new Virtual Network Gateway to be created.

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

If true, BGP (Border Gateway Protocol) will be enabled for this Virtual Network Gateway. Defaults to false.

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

The Generation of the Virtual Network gateway. Possible values include Generation1, Generation2 or None. Changing this forces a new resource to be created.

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

One, two or three ip_configuration blocks documented below. An active-standby gateway requires exactly one ip_configuration block, an active-active gateway requires exactly two ip_configuration blocks whereas an active-active zone redundant gateway with P2S configuration requires exactly three ip_configuration blocks.

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

The location/region where the Virtual Network Gateway is located. Changing this forces a new resource to be created.

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

The name of the Virtual Network Gateway. Changing this forces a new resource to be created.

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

Should private IP be enabled on this gateway for connections? Changing this forces a new resource to be created.

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

The name of the resource group in which to create the Virtual Network Gateway. Changing this forces a new resource to be created.

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

Configuration of the size and capacity of the virtual network gateway. Valid options are Basic, Standard, HighPerformance, UltraPerformance, ErGw1AZ, ErGw2AZ, ErGw3AZ, VpnGw1, VpnGw2, VpnGw3, VpnGw4,VpnGw5, VpnGw1AZ, VpnGw2AZ, VpnGw3AZ,VpnGw4AZ and VpnGw5AZ and depend on the type, vpn_type and generation arguments. A PolicyBased gateway only supports the Basic SKU. Further, the UltraPerformance SKU is only supported by an ExpressRoute gateway.

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

A mapping of tags to assign to the resource.

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

The type of the Virtual Network Gateway. Valid options are Vpn or ExpressRoute. Changing the type forces a new resource to be created.

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

A vpn_client_configuration block which is documented below. In this block the Virtual Network Gateway can be configured to accept IPSec point-to-site connections.

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

The routing type of the Virtual Network Gateway. Valid options are RouteBased or PolicyBased. Defaults to RouteBased. Changing this forces a new resource to be created.