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

VirtualNetworkGatewayConnection

class VirtualNetworkGatewayConnection : KotlinCustomResource

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, 2019-08-01, 2023-04-01, 2023-05-01.

Example Usage

CreateVirtualNetworkGatewayConnection_S2S

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
    var virtualNetworkGatewayConnection = new AzureNative.Network.VirtualNetworkGatewayConnection("virtualNetworkGatewayConnection", new()
    {
        ConnectionMode = "Default",
        ConnectionProtocol = "IKEv2",
        ConnectionType = "IPsec",
        DpdTimeoutSeconds = 30,
        EgressNatRules = new[]
        {
            new AzureNative.Network.Inputs.SubResourceArgs
            {
                Id = "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule2",
            },
        },
        EnableBgp = false,
        GatewayCustomBgpIpAddresses = new[]
        {
            new AzureNative.Network.Inputs.GatewayCustomBgpIpAddressIpConfigurationArgs
            {
                CustomBgpIpAddress = "169.254.21.1",
                IpConfigurationId = "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/default",
            },
            new AzureNative.Network.Inputs.GatewayCustomBgpIpAddressIpConfigurationArgs
            {
                CustomBgpIpAddress = "169.254.21.3",
                IpConfigurationId = "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/ActiveActive",
            },
        },
        IngressNatRules = new[]
        {
            new AzureNative.Network.Inputs.SubResourceArgs
            {
                Id = "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule1",
            },
        },
        IpsecPolicies = new[] {},
        LocalNetworkGateway2 = new AzureNative.Network.Inputs.LocalNetworkGatewayArgs
        {
            GatewayIpAddress = "x.x.x.x",
            Id = "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/localgw",
            LocalNetworkAddressSpace = new AzureNative.Network.Inputs.AddressSpaceArgs
            {
                AddressPrefixes = new[]
                {
                    "10.1.0.0/16",
                },
            },
            Location = "centralus",
            Tags = null,
        },
        Location = "centralus",
        ResourceGroupName = "rg1",
        RoutingWeight = 0,
        SharedKey = "Abc123",
        TrafficSelectorPolicies = new[] {},
        UsePolicyBasedTrafficSelectors = false,
        VirtualNetworkGateway1 = new AzureNative.Network.Inputs.VirtualNetworkGatewayArgs
        {
            ActiveActive = false,
            BgpSettings = new AzureNative.Network.Inputs.BgpSettingsArgs
            {
                Asn = 65514,
                BgpPeeringAddress = "10.0.1.30",
                PeerWeight = 0,
            },
            EnableBgp = false,
            GatewayType = "Vpn",
            Id = "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw",
            IpConfigurations = new[]
            {
                new AzureNative.Network.Inputs.VirtualNetworkGatewayIPConfigurationArgs
                {
                    Id = "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/gwipconfig1",
                    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",
            Sku = new AzureNative.Network.Inputs.VirtualNetworkGatewaySkuArgs
            {
                Name = "VpnGw1",
                Tier = "VpnGw1",
            },
            Tags = null,
            VpnType = "RouteBased",
        },
        VirtualNetworkGatewayConnectionName = "connS2S",
    });
});
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.NewVirtualNetworkGatewayConnection(ctx, "virtualNetworkGatewayConnection", &network.VirtualNetworkGatewayConnectionArgs{
ConnectionMode: pulumi.String("Default"),
ConnectionProtocol: pulumi.String("IKEv2"),
ConnectionType: pulumi.String("IPsec"),
DpdTimeoutSeconds: pulumi.Int(30),
EgressNatRules: []network.SubResourceArgs{
{
Id: pulumi.String("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule2"),
},
},
EnableBgp: pulumi.Bool(false),
GatewayCustomBgpIpAddresses: []network.GatewayCustomBgpIpAddressIpConfigurationArgs{
{
CustomBgpIpAddress: pulumi.String("169.254.21.1"),
IpConfigurationId: pulumi.String("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/default"),
},
{
CustomBgpIpAddress: pulumi.String("169.254.21.3"),
IpConfigurationId: pulumi.String("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/ActiveActive"),
},
},
IngressNatRules: []network.SubResourceArgs{
{
Id: pulumi.String("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule1"),
},
},
IpsecPolicies: network.IpsecPolicyArray{
},
LocalNetworkGateway2: network.LocalNetworkGatewayResponse{
GatewayIpAddress: pulumi.String("x.x.x.x"),
Id: pulumi.String("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/localgw"),
LocalNetworkAddressSpace: &network.AddressSpaceArgs{
AddressPrefixes: pulumi.StringArray{
pulumi.String("10.1.0.0/16"),
},
},
Location: pulumi.String("centralus"),
Tags: nil,
},
Location: pulumi.String("centralus"),
ResourceGroupName: pulumi.String("rg1"),
RoutingWeight: pulumi.Int(0),
SharedKey: pulumi.String("Abc123"),
TrafficSelectorPolicies: network.TrafficSelectorPolicyArray{
},
UsePolicyBasedTrafficSelectors: pulumi.Bool(false),
VirtualNetworkGateway1: network.VirtualNetworkGatewayResponse{
ActiveActive: pulumi.Bool(false),
BgpSettings: &network.BgpSettingsArgs{
Asn: pulumi.Float64(65514),
BgpPeeringAddress: pulumi.String("10.0.1.30"),
PeerWeight: pulumi.Int(0),
},
EnableBgp: pulumi.Bool(false),
GatewayType: pulumi.String("Vpn"),
Id: pulumi.String("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw"),
IpConfigurations: network.VirtualNetworkGatewayIPConfigurationArray{
interface{}{
Id: pulumi.String("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/gwipconfig1"),
Name: pulumi.String("gwipconfig1"),
PrivateIPAllocationMethod: pulumi.String("Dynamic"),
PublicIPAddress: &network.SubResourceArgs{
Id: pulumi.String("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/gwpip"),
},
Subnet: &network.SubResourceArgs{
Id: pulumi.String("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet"),
},
},
},
Location: pulumi.String("centralus"),
Sku: &network.VirtualNetworkGatewaySkuArgs{
Name: pulumi.String("VpnGw1"),
Tier: pulumi.String("VpnGw1"),
},
Tags: nil,
VpnType: pulumi.String("RouteBased"),
},
VirtualNetworkGatewayConnectionName: pulumi.String("connS2S"),
})
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.VirtualNetworkGatewayConnection;
import com.pulumi.azurenative.network.VirtualNetworkGatewayConnectionArgs;
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 virtualNetworkGatewayConnection = new VirtualNetworkGatewayConnection("virtualNetworkGatewayConnection", VirtualNetworkGatewayConnectionArgs.builder()
            .connectionMode("Default")
            .connectionProtocol("IKEv2")
            .connectionType("IPsec")
            .dpdTimeoutSeconds(30)
            .egressNatRules(Map.of("id", "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule2"))
            .enableBgp(false)
            .gatewayCustomBgpIpAddresses(
                Map.ofEntries(
                    Map.entry("customBgpIpAddress", "169.254.21.1"),
                    Map.entry("ipConfigurationId", "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/default")
                ),
                Map.ofEntries(
                    Map.entry("customBgpIpAddress", "169.254.21.3"),
                    Map.entry("ipConfigurationId", "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/ActiveActive")
                ))
            .ingressNatRules(Map.of("id", "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule1"))
            .ipsecPolicies()
            .localNetworkGateway2(Map.ofEntries(
                Map.entry("gatewayIpAddress", "x.x.x.x"),
                Map.entry("id", "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/localgw"),
                Map.entry("localNetworkAddressSpace", Map.of("addressPrefixes", "10.1.0.0/16")),
                Map.entry("location", "centralus"),
                Map.entry("tags", )
            ))
            .location("centralus")
            .resourceGroupName("rg1")
            .routingWeight(0)
            .sharedKey("Abc123")
            .trafficSelectorPolicies()
            .usePolicyBasedTrafficSelectors(false)
            .virtualNetworkGateway1(Map.ofEntries(
                Map.entry("activeActive", false),
                Map.entry("bgpSettings", Map.ofEntries(
                    Map.entry("asn", 65514),
                    Map.entry("bgpPeeringAddress", "10.0.1.30"),
                    Map.entry("peerWeight", 0)
                )),
                Map.entry("enableBgp", false),
                Map.entry("gatewayType", "Vpn"),
                Map.entry("id", "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw"),
                Map.entry("ipConfigurations", Map.ofEntries(
                    Map.entry("id", "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/gwipconfig1"),
                    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"))
                )),
                Map.entry("location", "centralus"),
                Map.entry("sku", Map.ofEntries(
                    Map.entry("name", "VpnGw1"),
                    Map.entry("tier", "VpnGw1")
                )),
                Map.entry("tags", ),
                Map.entry("vpnType", "RouteBased")
            ))
            .virtualNetworkGatewayConnectionName("connS2S")
            .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:VirtualNetworkGatewayConnection connS2S /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}
Content copied to clipboard

Properties

Link copied to clipboard
val authorizationKey: Output<String>?

The authorizationKey.

Link copied to clipboard
val connectionMode: Output<String>?

The connection mode for this connection.

Link copied to clipboard
val connectionProtocol: Output<String>?

Connection protocol used for this connection.

Link copied to clipboard
val connectionStatus: Output<String>

Virtual Network Gateway connection status.

Link copied to clipboard
val connectionType: Output<String>

Gateway connection type.

Link copied to clipboard
val dpdTimeoutSeconds: Output<Int>?

The dead peer detection timeout of this connection in seconds.

Link copied to clipboard
val egressBytesTransferred: Output<Double>

The egress bytes transferred in this connection.

Link copied to clipboard
val egressNatRules: Output<List<SubResourceResponse>>?

List of egress NatRules.

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

EnableBgp flag.

Link copied to clipboard
val enablePrivateLinkFastPath: Output<Boolean>?

Bypass the ExpressRoute gateway when accessing private-links. ExpressRoute FastPath (expressRouteGatewayBypass) must be enabled.

Link copied to clipboard
val etag: Output<String>

A unique read-only string that changes whenever the resource is updated.

Link copied to clipboard
val expressRouteGatewayBypass: Output<Boolean>?

Bypass ExpressRoute Gateway for data forwarding.

Link copied to clipboard
val gatewayCustomBgpIpAddresses: Output<List<GatewayCustomBgpIpAddressIpConfigurationResponse>>?

GatewayCustomBgpIpAddresses to be used for virtual network gateway Connection.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val ingressBytesTransferred: Output<Double>

The ingress bytes transferred in this connection.

Link copied to clipboard
val ingressNatRules: Output<List<SubResourceResponse>>?

List of ingress NatRules.

Link copied to clipboard
val ipsecPolicies: Output<List<IpsecPolicyResponse>>?

The IPSec Policies to be considered by this connection.

Link copied to clipboard
val localNetworkGateway2: Output<LocalNetworkGatewayResponse>?

The reference to local network gateway resource.

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

Resource location.

Link copied to clipboard
val name: Output<String>

Resource name.

Link copied to clipboard
val peer: Output<SubResourceResponse>?

The reference to peerings resource.

Link copied to clipboard
val provisioningState: Output<String>

The provisioning state of the virtual network gateway connection resource.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val resourceGuid: Output<String>

The resource GUID property of the virtual network gateway connection resource.

Link copied to clipboard
val routingWeight: Output<Int>?

The routing weight.

Link copied to clipboard
val sharedKey: Output<String>?

The IPSec shared key.

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

Resource tags.

Link copied to clipboard
val trafficSelectorPolicies: Output<List<TrafficSelectorPolicyResponse>>?

The Traffic Selector Policies to be considered by this connection.

Link copied to clipboard
val tunnelConnectionStatus: Output<List<TunnelConnectionHealthResponse>>

Collection of all tunnels' connection health status.

Link copied to clipboard
val type: Output<String>

Resource type.

Link copied to clipboard
val urn: Output<String>
Link copied to clipboard
val useLocalAzureIpAddress: Output<Boolean>?

Use private local Azure IP for the connection.

Link copied to clipboard
val usePolicyBasedTrafficSelectors: Output<Boolean>?

Enable policy-based traffic selectors.

Link copied to clipboard
val virtualNetworkGateway1: Output<VirtualNetworkGatewayResponse>

The reference to virtual network gateway resource.

Link copied to clipboard
val virtualNetworkGateway2: Output<VirtualNetworkGatewayResponse>?

The reference to virtual network gateway resource.