PointToPointVpnGateway

Manages a Point-to-Site VPN Gateway.

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new Azure.Network.PointToPointVpnGateway("example", new Azure.Network.PointToPointVpnGatewayArgs
        {
            Location = azurerm_resource_group.Example.Location,
            ResourceGroupName = azurerm_resource_group.Example.Resource_group_name,
            VirtualHubId = azurerm_virtual_hub.Example.Id,
            VpnServerConfigurationId = azurerm_vpn_server_configuration.Example.Id,
            ScaleUnit = 1,
        });
    }

}

package main

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

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err = network.NewPointToPointVpnGateway(ctx, "example", &network.PointToPointVpnGatewayArgs{
            Location:                 pulumi.String(azurerm_resource_group.Example.Location),
            ResourceGroupName:        pulumi.String(azurerm_resource_group.Example.Resource_group_name),
            VirtualHubId:             pulumi.String(azurerm_virtual_hub.Example.Id),
            VpnServerConfigurationId: pulumi.String(azurerm_vpn_server_configuration.Example.Id),
            ScaleUnit:                pulumi.Int(1),
        })
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_azure as azure

example = azure.network.PointToPointVpnGateway("example",
    location=azurerm_resource_group["example"]["location"],
    resource_group_name=azurerm_resource_group["example"]["resource_group_name"],
    virtual_hub_id=azurerm_virtual_hub["example"]["id"],
    vpn_server_configuration_id=azurerm_vpn_server_configuration["example"]["id"],
    scale_unit=1)

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

const example = new azure.network.PointToPointVpnGateway("example", {
    location: azurerm_resource_group.example.location,
    resourceGroupName: azurerm_resource_group.example.resource_group_name,
    virtualHubId: azurerm_virtual_hub.example.id,
    vpnServerConfigurationId: azurerm_vpn_server_configuration.example.id,
    scaleUnit: 1,
});

Create a PointToPointVpnGateway Resource

new PointToPointVpnGateway(name: string, args: PointToPointVpnGatewayArgs, opts?: CustomResourceOptions);

def PointToPointVpnGateway(resource_name, opts=None, connection_configuration=None, location=None, name=None, resource_group_name=None, scale_unit=None, tags=None, virtual_hub_id=None, vpn_server_configuration_id=None, __props__=None);

func NewPointToPointVpnGateway(ctx *Context, name string, args PointToPointVpnGatewayArgs, opts ...ResourceOption) (*PointToPointVpnGateway, error)

public PointToPointVpnGateway(string name, PointToPointVpnGatewayArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args PointToPointVpnGatewayArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args PointToPointVpnGatewayArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args PointToPointVpnGatewayArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

PointToPointVpnGateway Resource Properties

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

Inputs

The PointToPointVpnGateway resource accepts the following input properties:

ConnectionConfiguration PointToPointVpnGatewayConnectionConfigurationArgs: A connection_configuration block as defined below.
ResourceGroupName 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 int: The Scale Unit for this Point-to-Site VPN Gateway.
VirtualHubId 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 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.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name string: Specifies the name of the Point-to-Site VPN Gateway. 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.

ConnectionConfiguration PointToPointVpnGatewayConnectionConfiguration: A connection_configuration block as defined below.
ResourceGroupName 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 int: The Scale Unit for this Point-to-Site VPN Gateway.
VirtualHubId 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 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.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name string: Specifies the name of the Point-to-Site VPN Gateway. 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.

connectionConfiguration PointToPointVpnGatewayConnectionConfiguration: A connection_configuration block as defined below.
resourceGroupName 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 number: The Scale Unit for this Point-to-Site VPN Gateway.
virtualHubId 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 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.
location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name string: Specifies the name of the Point-to-Site VPN Gateway. 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_configuration Dict[PointToPointVpnGatewayConnectionConfiguration]: A connection_configuration block as defined below.
resource_group_name 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 float: The Scale Unit for this Point-to-Site VPN Gateway.
virtual_hub_id 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 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.
location str: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name str: Specifies the name of the Point-to-Site VPN Gateway. Changing this forces a new resource to be created.
tags Dict[str, str]: 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 str: The provider-assigned unique ID for this managed resource.

Look up an 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

static get(resource_name, id, opts=None, connection_configuration=None, location=None, name=None, resource_group_name=None, scale_unit=None, tags=None, virtual_hub_id=None, vpn_server_configuration_id=None, __props__=None);

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)

name: The unique name of the resulting resource.
id: 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: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: 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: The unique name of the resulting resource.
id: 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:

ConnectionConfiguration PointToPointVpnGatewayConnectionConfigurationArgs: A connection_configuration block as defined below.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name string: Specifies the name of the Point-to-Site VPN Gateway. Changing this forces a new resource to be created.
ResourceGroupName 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 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 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 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.

ConnectionConfiguration PointToPointVpnGatewayConnectionConfiguration: A connection_configuration block as defined below.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name string: Specifies the name of the Point-to-Site VPN Gateway. Changing this forces a new resource to be created.
ResourceGroupName 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 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 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 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.

connectionConfiguration PointToPointVpnGatewayConnectionConfiguration: A connection_configuration block as defined below.
location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name string: Specifies the name of the Point-to-Site VPN Gateway. Changing this forces a new resource to be created.
resourceGroupName 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 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 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 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_configuration Dict[PointToPointVpnGatewayConnectionConfiguration]: A connection_configuration block as defined below.
location str: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name str: Specifies the name of the Point-to-Site VPN Gateway. Changing this forces a new resource to be created.
resource_group_name 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 float: The Scale Unit for this Point-to-Site VPN Gateway.
tags Dict[str, str]: A mapping of tags to assign to the Point-to-Site VPN Gateway.
virtual_hub_id 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 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.

Supporting Types

PointToPointVpnGatewayConnectionConfiguration

See the input and output API doc for this type.

Name string: The Name which should be used for this Connection Configuration.
VpnClientAddressPool PointToPointVpnGatewayConnectionConfigurationVpnClientAddressPoolArgs: A vpn_client_address_pool block as defined below.

Name string: The Name which should be used for this Connection Configuration.
VpnClientAddressPool PointToPointVpnGatewayConnectionConfigurationVpnClientAddressPool: A vpn_client_address_pool block as defined below.

name string: The Name which should be used for this Connection Configuration.
vpnClientAddressPool PointToPointVpnGatewayConnectionConfigurationVpnClientAddressPool: A vpn_client_address_pool block as defined below.

name str: The Name which should be used for this Connection Configuration.
vpnClientAddressPool Dict[PointToPointVpnGatewayConnectionConfigurationVpnClientAddressPool]: A vpn_client_address_pool block as defined below.

PointToPointVpnGatewayConnectionConfigurationVpnClientAddressPool

See the input and output API doc for this type.

AddressPrefixes List<string>: A list of CIDR Ranges which should be used as Address Prefixes.

AddressPrefixes []string: A list of CIDR Ranges which should be used as Address Prefixes.

addressPrefixes string[]: A list of CIDR Ranges which should be used as Address Prefixes.

address_prefixes List[str]: A list of CIDR Ranges which should be used as Address Prefixes.

Package Details

Repository: https://github.com/pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud