tencentcloud 1.82.35, Nov 7 25

tencentcloud 1.82.35 published on Friday, Nov 7, 2025 by tencentcloudstack

tencentcloudstack/terraform-provider-tencentcloud

tencentcloud.getVpnGateways

Start a Neo task

Explain and create a tencentcloud.getVpnGateways resource

tencentcloud 1.82.35 published on Friday, Nov 7, 2025 by tencentcloudstack

tencentcloudstack/terraform-provider-tencentcloud

Example Usage

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

const foo = tencentcloud.getVpnGateways({
    name: "main",
    id: "vpngw-8ccsnclt",
    publicIpAddress: "1.1.1.1",
    zone: "ap-guangzhou-3",
    vpcId: "vpc-dk8zmwuf",
    tags: {
        test: "tf",
    },
});

import pulumi
import pulumi_tencentcloud as tencentcloud

foo = tencentcloud.get_vpn_gateways(name="main",
    id="vpngw-8ccsnclt",
    public_ip_address="1.1.1.1",
    zone="ap-guangzhou-3",
    vpc_id="vpc-dk8zmwuf",
    tags={
        "test": "tf",
    })

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/tencentcloud/tencentcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := tencentcloud.GetVpnGateways(ctx, &tencentcloud.GetVpnGatewaysArgs{
			Name:            pulumi.StringRef("main"),
			Id:              pulumi.StringRef("vpngw-8ccsnclt"),
			PublicIpAddress: pulumi.StringRef("1.1.1.1"),
			Zone:            pulumi.StringRef("ap-guangzhou-3"),
			VpcId:           pulumi.StringRef("vpc-dk8zmwuf"),
			Tags: map[string]interface{}{
				"test": "tf",
			},
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Tencentcloud = Pulumi.Tencentcloud;

return await Deployment.RunAsync(() => 
{
    var foo = Tencentcloud.GetVpnGateways.Invoke(new()
    {
        Name = "main",
        Id = "vpngw-8ccsnclt",
        PublicIpAddress = "1.1.1.1",
        Zone = "ap-guangzhou-3",
        VpcId = "vpc-dk8zmwuf",
        Tags = 
        {
            { "test", "tf" },
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.TencentcloudFunctions;
import com.pulumi.tencentcloud.inputs.GetVpnGatewaysArgs;
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) {
        final var foo = TencentcloudFunctions.getVpnGateways(GetVpnGatewaysArgs.builder()
            .name("main")
            .id("vpngw-8ccsnclt")
            .publicIpAddress("1.1.1.1")
            .zone("ap-guangzhou-3")
            .vpcId("vpc-dk8zmwuf")
            .tags(Map.of("test", "tf"))
            .build());

    }
}

variables:
  foo:
    fn::invoke:
      function: tencentcloud:getVpnGateways
      arguments:
        name: main
        id: vpngw-8ccsnclt
        publicIpAddress: 1.1.1.1
        zone: ap-guangzhou-3
        vpcId: vpc-dk8zmwuf
        tags:
          test: tf

Using getVpnGateways

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getVpnGateways(args: GetVpnGatewaysArgs, opts?: InvokeOptions): Promise<GetVpnGatewaysResult>
function getVpnGatewaysOutput(args: GetVpnGatewaysOutputArgs, opts?: InvokeOptions): Output<GetVpnGatewaysResult>

def get_vpn_gateways(id: Optional[str] = None,
                     name: Optional[str] = None,
                     public_ip_address: Optional[str] = None,
                     result_output_file: Optional[str] = None,
                     tags: Optional[Mapping[str, str]] = None,
                     vpc_id: Optional[str] = None,
                     zone: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetVpnGatewaysResult
def get_vpn_gateways_output(id: Optional[pulumi.Input[str]] = None,
                     name: Optional[pulumi.Input[str]] = None,
                     public_ip_address: Optional[pulumi.Input[str]] = None,
                     result_output_file: Optional[pulumi.Input[str]] = None,
                     tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                     vpc_id: Optional[pulumi.Input[str]] = None,
                     zone: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetVpnGatewaysResult]

func GetVpnGateways(ctx *Context, args *GetVpnGatewaysArgs, opts ...InvokeOption) (*GetVpnGatewaysResult, error)
func GetVpnGatewaysOutput(ctx *Context, args *GetVpnGatewaysOutputArgs, opts ...InvokeOption) GetVpnGatewaysResultOutput

> Note: This function is named GetVpnGateways in the Go SDK.

public static class GetVpnGateways 
{
    public static Task<GetVpnGatewaysResult> InvokeAsync(GetVpnGatewaysArgs args, InvokeOptions? opts = null)
    public static Output<GetVpnGatewaysResult> Invoke(GetVpnGatewaysInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetVpnGatewaysResult> getVpnGateways(GetVpnGatewaysArgs args, InvokeOptions options)
public static Output<GetVpnGatewaysResult> getVpnGateways(GetVpnGatewaysArgs args, InvokeOptions options)

fn::invoke:
  function: tencentcloud:index/getVpnGateways:getVpnGateways
  arguments:
    # arguments dictionary

The following arguments are supported:

Id string: ID of the VPN gateway.
Name string: Name of the VPN gateway. The length of character is limited to 1-60.
PublicIpAddress string: Public ip address of the VPN gateway.
ResultOutputFile string: Used to save results.
Tags Dictionary<string, string>: Tags of the VPN gateway to be queried.
VpcId string: ID of the VPC.
Zone string: Zone of the VPN gateway.

Id string: ID of the VPN gateway.
Name string: Name of the VPN gateway. The length of character is limited to 1-60.
PublicIpAddress string: Public ip address of the VPN gateway.
ResultOutputFile string: Used to save results.
Tags map[string]string: Tags of the VPN gateway to be queried.
VpcId string: ID of the VPC.
Zone string: Zone of the VPN gateway.

id String: ID of the VPN gateway.
name String: Name of the VPN gateway. The length of character is limited to 1-60.
publicIpAddress String: Public ip address of the VPN gateway.
resultOutputFile String: Used to save results.
tags Map<String,String>: Tags of the VPN gateway to be queried.
vpcId String: ID of the VPC.
zone String: Zone of the VPN gateway.

id string: ID of the VPN gateway.
name string: Name of the VPN gateway. The length of character is limited to 1-60.
publicIpAddress string: Public ip address of the VPN gateway.
resultOutputFile string: Used to save results.
tags {[key: string]: string}: Tags of the VPN gateway to be queried.
vpcId string: ID of the VPC.
zone string: Zone of the VPN gateway.

id str: ID of the VPN gateway.
name str: Name of the VPN gateway. The length of character is limited to 1-60.
public_ip_address str: Public ip address of the VPN gateway.
result_output_file str: Used to save results.
tags Mapping[str, str]: Tags of the VPN gateway to be queried.
vpc_id str: ID of the VPC.
zone str: Zone of the VPN gateway.

id String: ID of the VPN gateway.
name String: Name of the VPN gateway. The length of character is limited to 1-60.
publicIpAddress String: Public ip address of the VPN gateway.
resultOutputFile String: Used to save results.
tags Map<String>: Tags of the VPN gateway to be queried.
vpcId String: ID of the VPC.
zone String: Zone of the VPN gateway.

getVpnGateways Result

The following output properties are available:

GatewayLists List<GetVpnGatewaysGatewayList>: Information list of the dedicated gateways.
Id string: ID of the VPN gateway.
Name string: Name of the VPN gateway.
PublicIpAddress string: Public ip of the VPN gateway.
ResultOutputFile string
Tags Dictionary<string, string>: A list of tags used to associate different resources.
VpcId string: ID of the VPC.
Zone string: Zone of the VPN gateway.

GatewayLists []GetVpnGatewaysGatewayList: Information list of the dedicated gateways.
Id string: ID of the VPN gateway.
Name string: Name of the VPN gateway.
PublicIpAddress string: Public ip of the VPN gateway.
ResultOutputFile string
Tags map[string]string: A list of tags used to associate different resources.
VpcId string: ID of the VPC.
Zone string: Zone of the VPN gateway.

gatewayLists List<GetVpnGatewaysGatewayList>: Information list of the dedicated gateways.
id String: ID of the VPN gateway.
name String: Name of the VPN gateway.
publicIpAddress String: Public ip of the VPN gateway.
resultOutputFile String
tags Map<String,String>: A list of tags used to associate different resources.
vpcId String: ID of the VPC.
zone String: Zone of the VPN gateway.

gatewayLists GetVpnGatewaysGatewayList[]: Information list of the dedicated gateways.
id string: ID of the VPN gateway.
name string: Name of the VPN gateway.
publicIpAddress string: Public ip of the VPN gateway.
resultOutputFile string
tags {[key: string]: string}: A list of tags used to associate different resources.
vpcId string: ID of the VPC.
zone string: Zone of the VPN gateway.

gateway_lists Sequence[GetVpnGatewaysGatewayList]: Information list of the dedicated gateways.
id str: ID of the VPN gateway.
name str: Name of the VPN gateway.
public_ip_address str: Public ip of the VPN gateway.
result_output_file str
tags Mapping[str, str]: A list of tags used to associate different resources.
vpc_id str: ID of the VPC.
zone str: Zone of the VPN gateway.

gatewayLists List<Property Map>: Information list of the dedicated gateways.
id String: ID of the VPN gateway.
name String: Name of the VPN gateway.
publicIpAddress String: Public ip of the VPN gateway.
resultOutputFile String
tags Map<String>: A list of tags used to associate different resources.
vpcId String: ID of the VPC.
zone String: Zone of the VPN gateway.

Supporting Types

GetVpnGatewaysGatewayList

Bandwidth double: The maximum public network output bandwidth of VPN gateway (unit: Mbps).
ChargeType string: Charge Type of the VPN gateway.
CreateTime string: Create time of the VPN gateway.
ExpiredTime string: Expired time of the VPN gateway when charge type is PREPAID.
Id string: ID of the VPN gateway.
IsAddressBlocked bool: Indicates whether ip address is blocked.
Name string: Name of the VPN gateway. The length of character is limited to 1-60.
NewPurchasePlan string: The plan of new purchase.
PrepaidRenewFlag string: Flag indicates whether to renew or not.
PublicIpAddress string: Public ip address of the VPN gateway.
RestrictState string: Restrict state of VPN gateway.
State string: State of the VPN gateway.
Tags Dictionary<string, string>: Tags of the VPN gateway to be queried.
Type string: Type of gateway instance.
VpcId string: ID of the VPC.
Zone string: Zone of the VPN gateway.

Bandwidth float64: The maximum public network output bandwidth of VPN gateway (unit: Mbps).
ChargeType string: Charge Type of the VPN gateway.
CreateTime string: Create time of the VPN gateway.
ExpiredTime string: Expired time of the VPN gateway when charge type is PREPAID.
Id string: ID of the VPN gateway.
IsAddressBlocked bool: Indicates whether ip address is blocked.
Name string: Name of the VPN gateway. The length of character is limited to 1-60.
NewPurchasePlan string: The plan of new purchase.
PrepaidRenewFlag string: Flag indicates whether to renew or not.
PublicIpAddress string: Public ip address of the VPN gateway.
RestrictState string: Restrict state of VPN gateway.
State string: State of the VPN gateway.
Tags map[string]string: Tags of the VPN gateway to be queried.
Type string: Type of gateway instance.
VpcId string: ID of the VPC.
Zone string: Zone of the VPN gateway.

bandwidth Double: The maximum public network output bandwidth of VPN gateway (unit: Mbps).
chargeType String: Charge Type of the VPN gateway.
createTime String: Create time of the VPN gateway.
expiredTime String: Expired time of the VPN gateway when charge type is PREPAID.
id String: ID of the VPN gateway.
isAddressBlocked Boolean: Indicates whether ip address is blocked.
name String: Name of the VPN gateway. The length of character is limited to 1-60.
newPurchasePlan String: The plan of new purchase.
prepaidRenewFlag String: Flag indicates whether to renew or not.
publicIpAddress String: Public ip address of the VPN gateway.
restrictState String: Restrict state of VPN gateway.
state String: State of the VPN gateway.
tags Map<String,String>: Tags of the VPN gateway to be queried.
type String: Type of gateway instance.
vpcId String: ID of the VPC.
zone String: Zone of the VPN gateway.

bandwidth number: The maximum public network output bandwidth of VPN gateway (unit: Mbps).
chargeType string: Charge Type of the VPN gateway.
createTime string: Create time of the VPN gateway.
expiredTime string: Expired time of the VPN gateway when charge type is PREPAID.
id string: ID of the VPN gateway.
isAddressBlocked boolean: Indicates whether ip address is blocked.
name string: Name of the VPN gateway. The length of character is limited to 1-60.
newPurchasePlan string: The plan of new purchase.
prepaidRenewFlag string: Flag indicates whether to renew or not.
publicIpAddress string: Public ip address of the VPN gateway.
restrictState string: Restrict state of VPN gateway.
state string: State of the VPN gateway.
tags {[key: string]: string}: Tags of the VPN gateway to be queried.
type string: Type of gateway instance.
vpcId string: ID of the VPC.
zone string: Zone of the VPN gateway.

bandwidth float: The maximum public network output bandwidth of VPN gateway (unit: Mbps).
charge_type str: Charge Type of the VPN gateway.
create_time str: Create time of the VPN gateway.
expired_time str: Expired time of the VPN gateway when charge type is PREPAID.
id str: ID of the VPN gateway.
is_address_blocked bool: Indicates whether ip address is blocked.
name str: Name of the VPN gateway. The length of character is limited to 1-60.
new_purchase_plan str: The plan of new purchase.
prepaid_renew_flag str: Flag indicates whether to renew or not.
public_ip_address str: Public ip address of the VPN gateway.
restrict_state str: Restrict state of VPN gateway.
state str: State of the VPN gateway.
tags Mapping[str, str]: Tags of the VPN gateway to be queried.
type str: Type of gateway instance.
vpc_id str: ID of the VPC.
zone str: Zone of the VPN gateway.

bandwidth Number: The maximum public network output bandwidth of VPN gateway (unit: Mbps).
chargeType String: Charge Type of the VPN gateway.
createTime String: Create time of the VPN gateway.
expiredTime String: Expired time of the VPN gateway when charge type is PREPAID.
id String: ID of the VPN gateway.
isAddressBlocked Boolean: Indicates whether ip address is blocked.
name String: Name of the VPN gateway. The length of character is limited to 1-60.
newPurchasePlan String: The plan of new purchase.
prepaidRenewFlag String: Flag indicates whether to renew or not.
publicIpAddress String: Public ip address of the VPN gateway.
restrictState String: Restrict state of VPN gateway.
state String: State of the VPN gateway.
tags Map<String>: Tags of the VPN gateway to be queried.
type String: Type of gateway instance.
vpcId String: ID of the VPC.
zone String: Zone of the VPN gateway.

Package Details

Repository: tencentcloud tencentcloudstack/terraform-provider-tencentcloud
License
Notes: This Pulumi package is based on the tencentcloud Terraform Provider.

tencentcloud 1.82.35 published on Friday, Nov 7, 2025 by tencentcloudstack

tencentcloudstack/terraform-provider-tencentcloud

tencentcloud.getVpnGateways

On this page

On this page

Example Usage

Using getVpnGateways

getVpnGateways Result

Supporting Types

GetVpnGatewaysGatewayList

Package Details

On this page

On this page