1. Packages
  2. Azure Classic
  3. API Docs
  4. network
  5. PointToPointVpnGateway

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi

azure.network.PointToPointVpnGateway

Explore with Pulumi AI

Manages a Point-to-Site VPN Gateway.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = new azure.core.ResourceGroup("example", {
    name: "example-resources",
    location: "West Europe",
});
const exampleVirtualWan = new azure.network.VirtualWan("example", {
    name: "example-virtualwan",
    resourceGroupName: example.name,
    location: example.location,
});
const exampleVirtualHub = new azure.network.VirtualHub("example", {
    name: "example-virtualhub",
    resourceGroupName: example.name,
    location: example.location,
    virtualWanId: exampleVirtualWan.id,
    addressPrefix: "10.0.0.0/23",
});
const exampleVpnServerConfiguration = new azure.network.VpnServerConfiguration("example", {
    name: "example-config",
    resourceGroupName: example.name,
    location: example.location,
    vpnAuthenticationTypes: ["Certificate"],
    clientRootCertificates: [{
        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=
`,
    }],
});
const examplePointToPointVpnGateway = new azure.network.PointToPointVpnGateway("example", {
    name: "example-vpn-gateway",
    location: example.location,
    resourceGroupName: example.name,
    virtualHubId: exampleVirtualHub.id,
    vpnServerConfigurationId: exampleVpnServerConfiguration.id,
    scaleUnit: 1,
    connectionConfigurations: [{
        name: "example-gateway-config",
        vpnClientAddressPool: {
            addressPrefixes: ["10.0.2.0/24"],
        },
    }],
});
Copy
import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_virtual_wan = azure.network.VirtualWan("example",
    name="example-virtualwan",
    resource_group_name=example.name,
    location=example.location)
example_virtual_hub = azure.network.VirtualHub("example",
    name="example-virtualhub",
    resource_group_name=example.name,
    location=example.location,
    virtual_wan_id=example_virtual_wan.id,
    address_prefix="10.0.0.0/23")
example_vpn_server_configuration = azure.network.VpnServerConfiguration("example",
    name="example-config",
    resource_group_name=example.name,
    location=example.location,
    vpn_authentication_types=["Certificate"],
    client_root_certificates=[{
        "name": "DigiCert-Federated-ID-Root-CA",
        "public_cert_data": """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=
""",
    }])
example_point_to_point_vpn_gateway = azure.network.PointToPointVpnGateway("example",
    name="example-vpn-gateway",
    location=example.location,
    resource_group_name=example.name,
    virtual_hub_id=example_virtual_hub.id,
    vpn_server_configuration_id=example_vpn_server_configuration.id,
    scale_unit=1,
    connection_configurations=[{
        "name": "example-gateway-config",
        "vpn_client_address_pool": {
            "address_prefixes": ["10.0.2.0/24"],
        },
    }])
Copy
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/network"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleVirtualWan, err := network.NewVirtualWan(ctx, "example", &network.VirtualWanArgs{
			Name:              pulumi.String("example-virtualwan"),
			ResourceGroupName: example.Name,
			Location:          example.Location,
		})
		if err != nil {
			return err
		}
		exampleVirtualHub, err := network.NewVirtualHub(ctx, "example", &network.VirtualHubArgs{
			Name:              pulumi.String("example-virtualhub"),
			ResourceGroupName: example.Name,
			Location:          example.Location,
			VirtualWanId:      exampleVirtualWan.ID(),
			AddressPrefix:     pulumi.String("10.0.0.0/23"),
		})
		if err != nil {
			return err
		}
		exampleVpnServerConfiguration, err := network.NewVpnServerConfiguration(ctx, "example", &network.VpnServerConfigurationArgs{
			Name:              pulumi.String("example-config"),
			ResourceGroupName: example.Name,
			Location:          example.Location,
			VpnAuthenticationTypes: pulumi.StringArray{
				pulumi.String("Certificate"),
			},
			ClientRootCertificates: network.VpnServerConfigurationClientRootCertificateArray{
				&network.VpnServerConfigurationClientRootCertificateArgs{
					Name: pulumi.String("DigiCert-Federated-ID-Root-CA"),
					PublicCertData: pulumi.String(`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=
`),
				},
			},
		})
		if err != nil {
			return err
		}
		_, err = network.NewPointToPointVpnGateway(ctx, "example", &network.PointToPointVpnGatewayArgs{
			Name:                     pulumi.String("example-vpn-gateway"),
			Location:                 example.Location,
			ResourceGroupName:        example.Name,
			VirtualHubId:             exampleVirtualHub.ID(),
			VpnServerConfigurationId: exampleVpnServerConfiguration.ID(),
			ScaleUnit:                pulumi.Int(1),
			ConnectionConfigurations: network.PointToPointVpnGatewayConnectionConfigurationArray{
				&network.PointToPointVpnGatewayConnectionConfigurationArgs{
					Name: pulumi.String("example-gateway-config"),
					VpnClientAddressPool: &network.PointToPointVpnGatewayConnectionConfigurationVpnClientAddressPoolArgs{
						AddressPrefixes: pulumi.StringArray{
							pulumi.String("10.0.2.0/24"),
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "example-resources",
        Location = "West Europe",
    });

    var exampleVirtualWan = new Azure.Network.VirtualWan("example", new()
    {
        Name = "example-virtualwan",
        ResourceGroupName = example.Name,
        Location = example.Location,
    });

    var exampleVirtualHub = new Azure.Network.VirtualHub("example", new()
    {
        Name = "example-virtualhub",
        ResourceGroupName = example.Name,
        Location = example.Location,
        VirtualWanId = exampleVirtualWan.Id,
        AddressPrefix = "10.0.0.0/23",
    });

    var exampleVpnServerConfiguration = new Azure.Network.VpnServerConfiguration("example", new()
    {
        Name = "example-config",
        ResourceGroupName = example.Name,
        Location = example.Location,
        VpnAuthenticationTypes = new[]
        {
            "Certificate",
        },
        ClientRootCertificates = new[]
        {
            new Azure.Network.Inputs.VpnServerConfigurationClientRootCertificateArgs
            {
                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=
",
            },
        },
    });

    var examplePointToPointVpnGateway = new Azure.Network.PointToPointVpnGateway("example", new()
    {
        Name = "example-vpn-gateway",
        Location = example.Location,
        ResourceGroupName = example.Name,
        VirtualHubId = exampleVirtualHub.Id,
        VpnServerConfigurationId = exampleVpnServerConfiguration.Id,
        ScaleUnit = 1,
        ConnectionConfigurations = new[]
        {
            new Azure.Network.Inputs.PointToPointVpnGatewayConnectionConfigurationArgs
            {
                Name = "example-gateway-config",
                VpnClientAddressPool = new Azure.Network.Inputs.PointToPointVpnGatewayConnectionConfigurationVpnClientAddressPoolArgs
                {
                    AddressPrefixes = new[]
                    {
                        "10.0.2.0/24",
                    },
                },
            },
        },
    });

});
Copy
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.VirtualWan;
import com.pulumi.azure.network.VirtualWanArgs;
import com.pulumi.azure.network.VirtualHub;
import com.pulumi.azure.network.VirtualHubArgs;
import com.pulumi.azure.network.VpnServerConfiguration;
import com.pulumi.azure.network.VpnServerConfigurationArgs;
import com.pulumi.azure.network.inputs.VpnServerConfigurationClientRootCertificateArgs;
import com.pulumi.azure.network.PointToPointVpnGateway;
import com.pulumi.azure.network.PointToPointVpnGatewayArgs;
import com.pulumi.azure.network.inputs.PointToPointVpnGatewayConnectionConfigurationArgs;
import com.pulumi.azure.network.inputs.PointToPointVpnGatewayConnectionConfigurationVpnClientAddressPoolArgs;
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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-resources")
            .location("West Europe")
            .build());

        var exampleVirtualWan = new VirtualWan("exampleVirtualWan", VirtualWanArgs.builder()
            .name("example-virtualwan")
            .resourceGroupName(example.name())
            .location(example.location())
            .build());

        var exampleVirtualHub = new VirtualHub("exampleVirtualHub", VirtualHubArgs.builder()
            .name("example-virtualhub")
            .resourceGroupName(example.name())
            .location(example.location())
            .virtualWanId(exampleVirtualWan.id())
            .addressPrefix("10.0.0.0/23")
            .build());

        var exampleVpnServerConfiguration = new VpnServerConfiguration("exampleVpnServerConfiguration", VpnServerConfigurationArgs.builder()
            .name("example-config")
            .resourceGroupName(example.name())
            .location(example.location())
            .vpnAuthenticationTypes("Certificate")
            .clientRootCertificates(VpnServerConfigurationClientRootCertificateArgs.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())
            .build());

        var examplePointToPointVpnGateway = new PointToPointVpnGateway("examplePointToPointVpnGateway", PointToPointVpnGatewayArgs.builder()
            .name("example-vpn-gateway")
            .location(example.location())
            .resourceGroupName(example.name())
            .virtualHubId(exampleVirtualHub.id())
            .vpnServerConfigurationId(exampleVpnServerConfiguration.id())
            .scaleUnit(1)
            .connectionConfigurations(PointToPointVpnGatewayConnectionConfigurationArgs.builder()
                .name("example-gateway-config")
                .vpnClientAddressPool(PointToPointVpnGatewayConnectionConfigurationVpnClientAddressPoolArgs.builder()
                    .addressPrefixes("10.0.2.0/24")
                    .build())
                .build())
            .build());

    }
}
Copy
resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleVirtualWan:
    type: azure:network:VirtualWan
    name: example
    properties:
      name: example-virtualwan
      resourceGroupName: ${example.name}
      location: ${example.location}
  exampleVirtualHub:
    type: azure:network:VirtualHub
    name: example
    properties:
      name: example-virtualhub
      resourceGroupName: ${example.name}
      location: ${example.location}
      virtualWanId: ${exampleVirtualWan.id}
      addressPrefix: 10.0.0.0/23
  exampleVpnServerConfiguration:
    type: azure:network:VpnServerConfiguration
    name: example
    properties:
      name: example-config
      resourceGroupName: ${example.name}
      location: ${example.location}
      vpnAuthenticationTypes:
        - Certificate
      clientRootCertificates:
        - 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=            
  examplePointToPointVpnGateway:
    type: azure:network:PointToPointVpnGateway
    name: example
    properties:
      name: example-vpn-gateway
      location: ${example.location}
      resourceGroupName: ${example.name}
      virtualHubId: ${exampleVirtualHub.id}
      vpnServerConfigurationId: ${exampleVpnServerConfiguration.id}
      scaleUnit: 1
      connectionConfigurations:
        - name: example-gateway-config
          vpnClientAddressPool:
            addressPrefixes:
              - 10.0.2.0/24
Copy

Create PointToPointVpnGateway Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new PointToPointVpnGateway(name: string, args: PointToPointVpnGatewayArgs, opts?: CustomResourceOptions);
@overload
def PointToPointVpnGateway(resource_name: str,
                           args: PointToPointVpnGatewayArgs,
                           opts: Optional[ResourceOptions] = None)

@overload
def PointToPointVpnGateway(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           connection_configurations: Optional[Sequence[PointToPointVpnGatewayConnectionConfigurationArgs]] = None,
                           resource_group_name: Optional[str] = None,
                           scale_unit: Optional[int] = None,
                           virtual_hub_id: Optional[str] = None,
                           vpn_server_configuration_id: Optional[str] = None,
                           dns_servers: Optional[Sequence[str]] = None,
                           location: Optional[str] = None,
                           name: Optional[str] = None,
                           routing_preference_internet_enabled: Optional[bool] = None,
                           tags: Optional[Mapping[str, str]] = None)
func NewPointToPointVpnGateway(ctx *Context, name string, args PointToPointVpnGatewayArgs, opts ...ResourceOption) (*PointToPointVpnGateway, error)
public PointToPointVpnGateway(string name, PointToPointVpnGatewayArgs args, CustomResourceOptions? opts = null)
public PointToPointVpnGateway(String name, PointToPointVpnGatewayArgs args)
public PointToPointVpnGateway(String name, PointToPointVpnGatewayArgs args, CustomResourceOptions options)
type: azure:network:PointToPointVpnGateway
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. PointToPointVpnGatewayArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. PointToPointVpnGatewayArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. PointToPointVpnGatewayArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. PointToPointVpnGatewayArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. PointToPointVpnGatewayArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var pointToPointVpnGatewayResource = new Azure.Network.PointToPointVpnGateway("pointToPointVpnGatewayResource", new()
{
    ConnectionConfigurations = new[]
    {
        new Azure.Network.Inputs.PointToPointVpnGatewayConnectionConfigurationArgs
        {
            Name = "string",
            VpnClientAddressPool = new Azure.Network.Inputs.PointToPointVpnGatewayConnectionConfigurationVpnClientAddressPoolArgs
            {
                AddressPrefixes = new[]
                {
                    "string",
                },
            },
            InternetSecurityEnabled = false,
            Route = new Azure.Network.Inputs.PointToPointVpnGatewayConnectionConfigurationRouteArgs
            {
                AssociatedRouteTableId = "string",
                InboundRouteMapId = "string",
                OutboundRouteMapId = "string",
                PropagatedRouteTable = new Azure.Network.Inputs.PointToPointVpnGatewayConnectionConfigurationRoutePropagatedRouteTableArgs
                {
                    Ids = new[]
                    {
                        "string",
                    },
                    Labels = new[]
                    {
                        "string",
                    },
                },
            },
        },
    },
    ResourceGroupName = "string",
    ScaleUnit = 0,
    VirtualHubId = "string",
    VpnServerConfigurationId = "string",
    DnsServers = new[]
    {
        "string",
    },
    Location = "string",
    Name = "string",
    RoutingPreferenceInternetEnabled = false,
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := network.NewPointToPointVpnGateway(ctx, "pointToPointVpnGatewayResource", &network.PointToPointVpnGatewayArgs{
	ConnectionConfigurations: network.PointToPointVpnGatewayConnectionConfigurationArray{
		&network.PointToPointVpnGatewayConnectionConfigurationArgs{
			Name: pulumi.String("string"),
			VpnClientAddressPool: &network.PointToPointVpnGatewayConnectionConfigurationVpnClientAddressPoolArgs{
				AddressPrefixes: pulumi.StringArray{
					pulumi.String("string"),
				},
			},
			InternetSecurityEnabled: pulumi.Bool(false),
			Route: &network.PointToPointVpnGatewayConnectionConfigurationRouteArgs{
				AssociatedRouteTableId: pulumi.String("string"),
				InboundRouteMapId:      pulumi.String("string"),
				OutboundRouteMapId:     pulumi.String("string"),
				PropagatedRouteTable: &network.PointToPointVpnGatewayConnectionConfigurationRoutePropagatedRouteTableArgs{
					Ids: pulumi.StringArray{
						pulumi.String("string"),
					},
					Labels: pulumi.StringArray{
						pulumi.String("string"),
					},
				},
			},
		},
	},
	ResourceGroupName:        pulumi.String("string"),
	ScaleUnit:                pulumi.Int(0),
	VirtualHubId:             pulumi.String("string"),
	VpnServerConfigurationId: pulumi.String("string"),
	DnsServers: pulumi.StringArray{
		pulumi.String("string"),
	},
	Location:                         pulumi.String("string"),
	Name:                             pulumi.String("string"),
	RoutingPreferenceInternetEnabled: pulumi.Bool(false),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var pointToPointVpnGatewayResource = new PointToPointVpnGateway("pointToPointVpnGatewayResource", PointToPointVpnGatewayArgs.builder()
    .connectionConfigurations(PointToPointVpnGatewayConnectionConfigurationArgs.builder()
        .name("string")
        .vpnClientAddressPool(PointToPointVpnGatewayConnectionConfigurationVpnClientAddressPoolArgs.builder()
            .addressPrefixes("string")
            .build())
        .internetSecurityEnabled(false)
        .route(PointToPointVpnGatewayConnectionConfigurationRouteArgs.builder()
            .associatedRouteTableId("string")
            .inboundRouteMapId("string")
            .outboundRouteMapId("string")
            .propagatedRouteTable(PointToPointVpnGatewayConnectionConfigurationRoutePropagatedRouteTableArgs.builder()
                .ids("string")
                .labels("string")
                .build())
            .build())
        .build())
    .resourceGroupName("string")
    .scaleUnit(0)
    .virtualHubId("string")
    .vpnServerConfigurationId("string")
    .dnsServers("string")
    .location("string")
    .name("string")
    .routingPreferenceInternetEnabled(false)
    .tags(Map.of("string", "string"))
    .build());
Copy
point_to_point_vpn_gateway_resource = azure.network.PointToPointVpnGateway("pointToPointVpnGatewayResource",
    connection_configurations=[{
        "name": "string",
        "vpn_client_address_pool": {
            "address_prefixes": ["string"],
        },
        "internet_security_enabled": False,
        "route": {
            "associated_route_table_id": "string",
            "inbound_route_map_id": "string",
            "outbound_route_map_id": "string",
            "propagated_route_table": {
                "ids": ["string"],
                "labels": ["string"],
            },
        },
    }],
    resource_group_name="string",
    scale_unit=0,
    virtual_hub_id="string",
    vpn_server_configuration_id="string",
    dns_servers=["string"],
    location="string",
    name="string",
    routing_preference_internet_enabled=False,
    tags={
        "string": "string",
    })
Copy
const pointToPointVpnGatewayResource = new azure.network.PointToPointVpnGateway("pointToPointVpnGatewayResource", {
    connectionConfigurations: [{
        name: "string",
        vpnClientAddressPool: {
            addressPrefixes: ["string"],
        },
        internetSecurityEnabled: false,
        route: {
            associatedRouteTableId: "string",
            inboundRouteMapId: "string",
            outboundRouteMapId: "string",
            propagatedRouteTable: {
                ids: ["string"],
                labels: ["string"],
            },
        },
    }],
    resourceGroupName: "string",
    scaleUnit: 0,
    virtualHubId: "string",
    vpnServerConfigurationId: "string",
    dnsServers: ["string"],
    location: "string",
    name: "string",
    routingPreferenceInternetEnabled: false,
    tags: {
        string: "string",
    },
});
Copy
type: azure:network:PointToPointVpnGateway
properties:
    connectionConfigurations:
        - internetSecurityEnabled: false
          name: string
          route:
            associatedRouteTableId: string
            inboundRouteMapId: string
            outboundRouteMapId: string
            propagatedRouteTable:
                ids:
                    - string
                labels:
                    - string
          vpnClientAddressPool:
            addressPrefixes:
                - string
    dnsServers:
        - string
    location: string
    name: string
    resourceGroupName: string
    routingPreferenceInternetEnabled: false
    scaleUnit: 0
    tags:
        string: string
    virtualHubId: string
    vpnServerConfigurationId: string
Copy

PointToPointVpnGateway Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The PointToPointVpnGateway resource accepts the following input properties:

ConnectionConfigurations This property is required. List<PointToPointVpnGatewayConnectionConfiguration>
A connection_configuration block as defined below.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group in which to create the Point-to-Site VPN Gateway. Changing this forces a new resource to be created.
ScaleUnit This property is required. int
The Scale Unit for this Point-to-Site VPN Gateway.
VirtualHubId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Virtual Hub where this Point-to-Site VPN Gateway should exist. Changing this forces a new resource to be created.
VpnServerConfigurationId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the VPN Server Configuration which this Point-to-Site VPN Gateway should use. Changing this forces a new resource to be created.
DnsServers List<string>
A list of IP Addresses of DNS Servers for the Point-to-Site VPN Gateway.
Location Changes to this property will trigger replacement. string
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
Specifies the name of the Point-to-Site VPN Gateway. Changing this forces a new resource to be created.
RoutingPreferenceInternetEnabled Changes to this property will trigger replacement. bool
Is the Routing Preference for the Public IP Interface of the VPN Gateway enabled? Defaults to false. Changing this forces a new resource to be created.
Tags Dictionary<string, string>
A mapping of tags to assign to the Point-to-Site VPN Gateway.
ConnectionConfigurations This property is required. []PointToPointVpnGatewayConnectionConfigurationArgs
A connection_configuration block as defined below.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group in which to create the Point-to-Site VPN Gateway. Changing this forces a new resource to be created.
ScaleUnit This property is required. int
The Scale Unit for this Point-to-Site VPN Gateway.
VirtualHubId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Virtual Hub where this Point-to-Site VPN Gateway should exist. Changing this forces a new resource to be created.
VpnServerConfigurationId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the VPN Server Configuration which this Point-to-Site VPN Gateway should use. Changing this forces a new resource to be created.
DnsServers []string
A list of IP Addresses of DNS Servers for the Point-to-Site VPN Gateway.
Location Changes to this property will trigger replacement. string
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
Specifies the name of the Point-to-Site VPN Gateway. Changing this forces a new resource to be created.
RoutingPreferenceInternetEnabled Changes to this property will trigger replacement. bool
Is the Routing Preference for the Public IP Interface of the VPN Gateway enabled? Defaults to false. Changing this forces a new resource to be created.
Tags map[string]string
A mapping of tags to assign to the Point-to-Site VPN Gateway.
connectionConfigurations This property is required. List<PointToPointVpnGatewayConnectionConfiguration>
A connection_configuration block as defined below.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group in which to create the Point-to-Site VPN Gateway. Changing this forces a new resource to be created.
scaleUnit This property is required. Integer
The Scale Unit for this Point-to-Site VPN Gateway.
virtualHubId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the Virtual Hub where this Point-to-Site VPN Gateway should exist. Changing this forces a new resource to be created.
vpnServerConfigurationId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the VPN Server Configuration which this Point-to-Site VPN Gateway should use. Changing this forces a new resource to be created.
dnsServers List<String>
A list of IP Addresses of DNS Servers for the Point-to-Site VPN Gateway.
location Changes to this property will trigger replacement. String
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
Specifies the name of the Point-to-Site VPN Gateway. Changing this forces a new resource to be created.
routingPreferenceInternetEnabled Changes to this property will trigger replacement. Boolean
Is the Routing Preference for the Public IP Interface of the VPN Gateway enabled? Defaults to false. Changing this forces a new resource to be created.
tags Map<String,String>
A mapping of tags to assign to the Point-to-Site VPN Gateway.
connectionConfigurations This property is required. PointToPointVpnGatewayConnectionConfiguration[]
A connection_configuration block as defined below.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group in which to create the Point-to-Site VPN Gateway. Changing this forces a new resource to be created.
scaleUnit This property is required. number
The Scale Unit for this Point-to-Site VPN Gateway.
virtualHubId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Virtual Hub where this Point-to-Site VPN Gateway should exist. Changing this forces a new resource to be created.
vpnServerConfigurationId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the VPN Server Configuration which this Point-to-Site VPN Gateway should use. Changing this forces a new resource to be created.
dnsServers string[]
A list of IP Addresses of DNS Servers for the Point-to-Site VPN Gateway.
location Changes to this property will trigger replacement. string
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. string
Specifies the name of the Point-to-Site VPN Gateway. Changing this forces a new resource to be created.
routingPreferenceInternetEnabled Changes to this property will trigger replacement. boolean
Is the Routing Preference for the Public IP Interface of the VPN Gateway enabled? Defaults to false. Changing this forces a new resource to be created.
tags {[key: string]: string}
A mapping of tags to assign to the Point-to-Site VPN Gateway.
connection_configurations This property is required. Sequence[PointToPointVpnGatewayConnectionConfigurationArgs]
A connection_configuration block as defined below.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group in which to create the Point-to-Site VPN Gateway. Changing this forces a new resource to be created.
scale_unit This property is required. int
The Scale Unit for this Point-to-Site VPN Gateway.
virtual_hub_id
This property is required.
Changes to this property will trigger replacement.
str
The ID of the Virtual Hub where this Point-to-Site VPN Gateway should exist. Changing this forces a new resource to be created.
vpn_server_configuration_id
This property is required.
Changes to this property will trigger replacement.
str
The ID of the VPN Server Configuration which this Point-to-Site VPN Gateway should use. Changing this forces a new resource to be created.
dns_servers Sequence[str]
A list of IP Addresses of DNS Servers for the Point-to-Site VPN Gateway.
location Changes to this property will trigger replacement. str
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. str
Specifies the name of the Point-to-Site VPN Gateway. Changing this forces a new resource to be created.
routing_preference_internet_enabled Changes to this property will trigger replacement. bool
Is the Routing Preference for the Public IP Interface of the VPN Gateway enabled? Defaults to false. Changing this forces a new resource to be created.
tags Mapping[str, str]
A mapping of tags to assign to the Point-to-Site VPN Gateway.
connectionConfigurations This property is required. List<Property Map>
A connection_configuration block as defined below.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group in which to create the Point-to-Site VPN Gateway. Changing this forces a new resource to be created.
scaleUnit This property is required. Number
The Scale Unit for this Point-to-Site VPN Gateway.
virtualHubId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the Virtual Hub where this Point-to-Site VPN Gateway should exist. Changing this forces a new resource to be created.
vpnServerConfigurationId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the VPN Server Configuration which this Point-to-Site VPN Gateway should use. Changing this forces a new resource to be created.
dnsServers List<String>
A list of IP Addresses of DNS Servers for the Point-to-Site VPN Gateway.
location Changes to this property will trigger replacement. String
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
Specifies the name of the Point-to-Site VPN Gateway. Changing this forces a new resource to be created.
routingPreferenceInternetEnabled Changes to this property will trigger replacement. Boolean
Is the Routing Preference for the Public IP Interface of the VPN Gateway enabled? Defaults to false. Changing this forces a new resource to be created.
tags Map<String>
A mapping of tags to assign to the Point-to-Site VPN Gateway.

Outputs

All input properties are implicitly available as output properties. Additionally, the PointToPointVpnGateway resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing PointToPointVpnGateway Resource

Get an existing PointToPointVpnGateway resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: PointToPointVpnGatewayState, opts?: CustomResourceOptions): PointToPointVpnGateway
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        connection_configurations: Optional[Sequence[PointToPointVpnGatewayConnectionConfigurationArgs]] = None,
        dns_servers: Optional[Sequence[str]] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        routing_preference_internet_enabled: Optional[bool] = None,
        scale_unit: Optional[int] = None,
        tags: Optional[Mapping[str, str]] = None,
        virtual_hub_id: Optional[str] = None,
        vpn_server_configuration_id: Optional[str] = None) -> PointToPointVpnGateway
func GetPointToPointVpnGateway(ctx *Context, name string, id IDInput, state *PointToPointVpnGatewayState, opts ...ResourceOption) (*PointToPointVpnGateway, error)
public static PointToPointVpnGateway Get(string name, Input<string> id, PointToPointVpnGatewayState? state, CustomResourceOptions? opts = null)
public static PointToPointVpnGateway get(String name, Output<String> id, PointToPointVpnGatewayState state, CustomResourceOptions options)
resources:  _:    type: azure:network:PointToPointVpnGateway    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
ConnectionConfigurations List<PointToPointVpnGatewayConnectionConfiguration>
A connection_configuration block as defined below.
DnsServers List<string>
A list of IP Addresses of DNS Servers for the Point-to-Site VPN Gateway.
Location Changes to this property will trigger replacement. string
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
Specifies the name of the Point-to-Site VPN Gateway. Changing this forces a new resource to be created.
ResourceGroupName Changes to this property will trigger replacement. string
The name of the resource group in which to create the Point-to-Site VPN Gateway. Changing this forces a new resource to be created.
RoutingPreferenceInternetEnabled Changes to this property will trigger replacement. bool
Is the Routing Preference for the Public IP Interface of the VPN Gateway enabled? Defaults to false. Changing this forces a new resource to be created.
ScaleUnit int
The Scale Unit for this Point-to-Site VPN Gateway.
Tags Dictionary<string, string>
A mapping of tags to assign to the Point-to-Site VPN Gateway.
VirtualHubId Changes to this property will trigger replacement. string
The ID of the Virtual Hub where this Point-to-Site VPN Gateway should exist. Changing this forces a new resource to be created.
VpnServerConfigurationId Changes to this property will trigger replacement. string
The ID of the VPN Server Configuration which this Point-to-Site VPN Gateway should use. Changing this forces a new resource to be created.
ConnectionConfigurations []PointToPointVpnGatewayConnectionConfigurationArgs
A connection_configuration block as defined below.
DnsServers []string
A list of IP Addresses of DNS Servers for the Point-to-Site VPN Gateway.
Location Changes to this property will trigger replacement. string
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
Specifies the name of the Point-to-Site VPN Gateway. Changing this forces a new resource to be created.
ResourceGroupName Changes to this property will trigger replacement. string
The name of the resource group in which to create the Point-to-Site VPN Gateway. Changing this forces a new resource to be created.
RoutingPreferenceInternetEnabled Changes to this property will trigger replacement. bool
Is the Routing Preference for the Public IP Interface of the VPN Gateway enabled? Defaults to false. Changing this forces a new resource to be created.
ScaleUnit int
The Scale Unit for this Point-to-Site VPN Gateway.
Tags map[string]string
A mapping of tags to assign to the Point-to-Site VPN Gateway.
VirtualHubId Changes to this property will trigger replacement. string
The ID of the Virtual Hub where this Point-to-Site VPN Gateway should exist. Changing this forces a new resource to be created.
VpnServerConfigurationId Changes to this property will trigger replacement. string
The ID of the VPN Server Configuration which this Point-to-Site VPN Gateway should use. Changing this forces a new resource to be created.
connectionConfigurations List<PointToPointVpnGatewayConnectionConfiguration>
A connection_configuration block as defined below.
dnsServers List<String>
A list of IP Addresses of DNS Servers for the Point-to-Site VPN Gateway.
location Changes to this property will trigger replacement. String
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
Specifies the name of the Point-to-Site VPN Gateway. Changing this forces a new resource to be created.
resourceGroupName Changes to this property will trigger replacement. String
The name of the resource group in which to create the Point-to-Site VPN Gateway. Changing this forces a new resource to be created.
routingPreferenceInternetEnabled Changes to this property will trigger replacement. Boolean
Is the Routing Preference for the Public IP Interface of the VPN Gateway enabled? Defaults to false. Changing this forces a new resource to be created.
scaleUnit Integer
The Scale Unit for this Point-to-Site VPN Gateway.
tags Map<String,String>
A mapping of tags to assign to the Point-to-Site VPN Gateway.
virtualHubId Changes to this property will trigger replacement. String
The ID of the Virtual Hub where this Point-to-Site VPN Gateway should exist. Changing this forces a new resource to be created.
vpnServerConfigurationId Changes to this property will trigger replacement. String
The ID of the VPN Server Configuration which this Point-to-Site VPN Gateway should use. Changing this forces a new resource to be created.
connectionConfigurations PointToPointVpnGatewayConnectionConfiguration[]
A connection_configuration block as defined below.
dnsServers string[]
A list of IP Addresses of DNS Servers for the Point-to-Site VPN Gateway.
location Changes to this property will trigger replacement. string
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. string
Specifies the name of the Point-to-Site VPN Gateway. Changing this forces a new resource to be created.
resourceGroupName Changes to this property will trigger replacement. string
The name of the resource group in which to create the Point-to-Site VPN Gateway. Changing this forces a new resource to be created.
routingPreferenceInternetEnabled Changes to this property will trigger replacement. boolean
Is the Routing Preference for the Public IP Interface of the VPN Gateway enabled? Defaults to false. Changing this forces a new resource to be created.
scaleUnit number
The Scale Unit for this Point-to-Site VPN Gateway.
tags {[key: string]: string}
A mapping of tags to assign to the Point-to-Site VPN Gateway.
virtualHubId Changes to this property will trigger replacement. string
The ID of the Virtual Hub where this Point-to-Site VPN Gateway should exist. Changing this forces a new resource to be created.
vpnServerConfigurationId Changes to this property will trigger replacement. string
The ID of the VPN Server Configuration which this Point-to-Site VPN Gateway should use. Changing this forces a new resource to be created.
connection_configurations Sequence[PointToPointVpnGatewayConnectionConfigurationArgs]
A connection_configuration block as defined below.
dns_servers Sequence[str]
A list of IP Addresses of DNS Servers for the Point-to-Site VPN Gateway.
location Changes to this property will trigger replacement. str
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. str
Specifies the name of the Point-to-Site VPN Gateway. Changing this forces a new resource to be created.
resource_group_name Changes to this property will trigger replacement. str
The name of the resource group in which to create the Point-to-Site VPN Gateway. Changing this forces a new resource to be created.
routing_preference_internet_enabled Changes to this property will trigger replacement. bool
Is the Routing Preference for the Public IP Interface of the VPN Gateway enabled? Defaults to false. Changing this forces a new resource to be created.
scale_unit int
The Scale Unit for this Point-to-Site VPN Gateway.
tags Mapping[str, str]
A mapping of tags to assign to the Point-to-Site VPN Gateway.
virtual_hub_id Changes to this property will trigger replacement. str
The ID of the Virtual Hub where this Point-to-Site VPN Gateway should exist. Changing this forces a new resource to be created.
vpn_server_configuration_id Changes to this property will trigger replacement. str
The ID of the VPN Server Configuration which this Point-to-Site VPN Gateway should use. Changing this forces a new resource to be created.
connectionConfigurations List<Property Map>
A connection_configuration block as defined below.
dnsServers List<String>
A list of IP Addresses of DNS Servers for the Point-to-Site VPN Gateway.
location Changes to this property will trigger replacement. String
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
Specifies the name of the Point-to-Site VPN Gateway. Changing this forces a new resource to be created.
resourceGroupName Changes to this property will trigger replacement. String
The name of the resource group in which to create the Point-to-Site VPN Gateway. Changing this forces a new resource to be created.
routingPreferenceInternetEnabled Changes to this property will trigger replacement. Boolean
Is the Routing Preference for the Public IP Interface of the VPN Gateway enabled? Defaults to false. Changing this forces a new resource to be created.
scaleUnit Number
The Scale Unit for this Point-to-Site VPN Gateway.
tags Map<String>
A mapping of tags to assign to the Point-to-Site VPN Gateway.
virtualHubId Changes to this property will trigger replacement. String
The ID of the Virtual Hub where this Point-to-Site VPN Gateway should exist. Changing this forces a new resource to be created.
vpnServerConfigurationId Changes to this property will trigger replacement. String
The ID of the VPN Server Configuration which this Point-to-Site VPN Gateway should use. Changing this forces a new resource to be created.

Supporting Types

PointToPointVpnGatewayConnectionConfiguration
, PointToPointVpnGatewayConnectionConfigurationArgs

Name This property is required. string
The Name which should be used for this Connection Configuration.
VpnClientAddressPool This property is required. PointToPointVpnGatewayConnectionConfigurationVpnClientAddressPool
A vpn_client_address_pool block as defined below.
InternetSecurityEnabled Changes to this property will trigger replacement. bool
Should Internet Security be enabled to secure internet traffic? Changing this forces a new resource to be created. Defaults to false.
Route PointToPointVpnGatewayConnectionConfigurationRoute
A route block as defined below.
Name This property is required. string
The Name which should be used for this Connection Configuration.
VpnClientAddressPool This property is required. PointToPointVpnGatewayConnectionConfigurationVpnClientAddressPool
A vpn_client_address_pool block as defined below.
InternetSecurityEnabled Changes to this property will trigger replacement. bool
Should Internet Security be enabled to secure internet traffic? Changing this forces a new resource to be created. Defaults to false.
Route PointToPointVpnGatewayConnectionConfigurationRoute
A route block as defined below.
name This property is required. String
The Name which should be used for this Connection Configuration.
vpnClientAddressPool This property is required. PointToPointVpnGatewayConnectionConfigurationVpnClientAddressPool
A vpn_client_address_pool block as defined below.
internetSecurityEnabled Changes to this property will trigger replacement. Boolean
Should Internet Security be enabled to secure internet traffic? Changing this forces a new resource to be created. Defaults to false.
route PointToPointVpnGatewayConnectionConfigurationRoute
A route block as defined below.
name This property is required. string
The Name which should be used for this Connection Configuration.
vpnClientAddressPool This property is required. PointToPointVpnGatewayConnectionConfigurationVpnClientAddressPool
A vpn_client_address_pool block as defined below.
internetSecurityEnabled Changes to this property will trigger replacement. boolean
Should Internet Security be enabled to secure internet traffic? Changing this forces a new resource to be created. Defaults to false.
route PointToPointVpnGatewayConnectionConfigurationRoute
A route block as defined below.
name This property is required. str
The Name which should be used for this Connection Configuration.
vpn_client_address_pool This property is required. PointToPointVpnGatewayConnectionConfigurationVpnClientAddressPool
A vpn_client_address_pool block as defined below.
internet_security_enabled Changes to this property will trigger replacement. bool
Should Internet Security be enabled to secure internet traffic? Changing this forces a new resource to be created. Defaults to false.
route PointToPointVpnGatewayConnectionConfigurationRoute
A route block as defined below.
name This property is required. String
The Name which should be used for this Connection Configuration.
vpnClientAddressPool This property is required. Property Map
A vpn_client_address_pool block as defined below.
internetSecurityEnabled Changes to this property will trigger replacement. Boolean
Should Internet Security be enabled to secure internet traffic? Changing this forces a new resource to be created. Defaults to false.
route Property Map
A route block as defined below.

PointToPointVpnGatewayConnectionConfigurationRoute
, PointToPointVpnGatewayConnectionConfigurationRouteArgs

AssociatedRouteTableId This property is required. string
The Virtual Hub Route Table resource id associated with this Routing Configuration.
InboundRouteMapId string
The resource ID of the Route Map associated with this Routing Configuration for inbound learned routes.
OutboundRouteMapId string
The resource ID of the Route Map associated with this Routing Configuration for outbound advertised routes.
PropagatedRouteTable PointToPointVpnGatewayConnectionConfigurationRoutePropagatedRouteTable
A propagated_route_table block as defined below.
AssociatedRouteTableId This property is required. string
The Virtual Hub Route Table resource id associated with this Routing Configuration.
InboundRouteMapId string
The resource ID of the Route Map associated with this Routing Configuration for inbound learned routes.
OutboundRouteMapId string
The resource ID of the Route Map associated with this Routing Configuration for outbound advertised routes.
PropagatedRouteTable PointToPointVpnGatewayConnectionConfigurationRoutePropagatedRouteTable
A propagated_route_table block as defined below.
associatedRouteTableId This property is required. String
The Virtual Hub Route Table resource id associated with this Routing Configuration.
inboundRouteMapId String
The resource ID of the Route Map associated with this Routing Configuration for inbound learned routes.
outboundRouteMapId String
The resource ID of the Route Map associated with this Routing Configuration for outbound advertised routes.
propagatedRouteTable PointToPointVpnGatewayConnectionConfigurationRoutePropagatedRouteTable
A propagated_route_table block as defined below.
associatedRouteTableId This property is required. string
The Virtual Hub Route Table resource id associated with this Routing Configuration.
inboundRouteMapId string
The resource ID of the Route Map associated with this Routing Configuration for inbound learned routes.
outboundRouteMapId string
The resource ID of the Route Map associated with this Routing Configuration for outbound advertised routes.
propagatedRouteTable PointToPointVpnGatewayConnectionConfigurationRoutePropagatedRouteTable
A propagated_route_table block as defined below.
associated_route_table_id This property is required. str
The Virtual Hub Route Table resource id associated with this Routing Configuration.
inbound_route_map_id str
The resource ID of the Route Map associated with this Routing Configuration for inbound learned routes.
outbound_route_map_id str
The resource ID of the Route Map associated with this Routing Configuration for outbound advertised routes.
propagated_route_table PointToPointVpnGatewayConnectionConfigurationRoutePropagatedRouteTable
A propagated_route_table block as defined below.
associatedRouteTableId This property is required. String
The Virtual Hub Route Table resource id associated with this Routing Configuration.
inboundRouteMapId String
The resource ID of the Route Map associated with this Routing Configuration for inbound learned routes.
outboundRouteMapId String
The resource ID of the Route Map associated with this Routing Configuration for outbound advertised routes.
propagatedRouteTable Property Map
A propagated_route_table block as defined below.

PointToPointVpnGatewayConnectionConfigurationRoutePropagatedRouteTable
, PointToPointVpnGatewayConnectionConfigurationRoutePropagatedRouteTableArgs

Ids This property is required. List<string>
The list of Virtual Hub Route Table resource id which the routes will be propagated to.
Labels List<string>
The list of labels to logically group Virtual Hub Route Tables which the routes will be propagated to.
Ids This property is required. []string
The list of Virtual Hub Route Table resource id which the routes will be propagated to.
Labels []string
The list of labels to logically group Virtual Hub Route Tables which the routes will be propagated to.
ids This property is required. List<String>
The list of Virtual Hub Route Table resource id which the routes will be propagated to.
labels List<String>
The list of labels to logically group Virtual Hub Route Tables which the routes will be propagated to.
ids This property is required. string[]
The list of Virtual Hub Route Table resource id which the routes will be propagated to.
labels string[]
The list of labels to logically group Virtual Hub Route Tables which the routes will be propagated to.
ids This property is required. Sequence[str]
The list of Virtual Hub Route Table resource id which the routes will be propagated to.
labels Sequence[str]
The list of labels to logically group Virtual Hub Route Tables which the routes will be propagated to.
ids This property is required. List<String>
The list of Virtual Hub Route Table resource id which the routes will be propagated to.
labels List<String>
The list of labels to logically group Virtual Hub Route Tables which the routes will be propagated to.

PointToPointVpnGatewayConnectionConfigurationVpnClientAddressPool
, PointToPointVpnGatewayConnectionConfigurationVpnClientAddressPoolArgs

AddressPrefixes This property is required. List<string>
A list of CIDR Ranges which should be used as Address Prefixes.
AddressPrefixes This property is required. []string
A list of CIDR Ranges which should be used as Address Prefixes.
addressPrefixes This property is required. List<String>
A list of CIDR Ranges which should be used as Address Prefixes.
addressPrefixes This property is required. string[]
A list of CIDR Ranges which should be used as Address Prefixes.
address_prefixes This property is required. Sequence[str]
A list of CIDR Ranges which should be used as Address Prefixes.
addressPrefixes This property is required. List<String>
A list of CIDR Ranges which should be used as Address Prefixes.

Import

Point-to-Site VPN Gateway’s can be imported using the resource id, e.g.

$ pulumi import azure:network/pointToPointVpnGateway:PointToPointVpnGateway example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Network/p2sVpnGateways/gateway1
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Azure Classic pulumi/pulumi-azure
License
Apache-2.0
Notes
This Pulumi package is based on the azurerm Terraform Provider.