Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Twingate
  3. API Docs
  4. getTwingateRemoteNetwork
Twingate v3.0.18 published on Wednesday, Apr 16, 2025 by Twingate
twingate/pulumi-twingate

twingate.getTwingateRemoteNetwork

Explore with Pulumi AI

Twingate v3.0.18 published on Wednesday, Apr 16, 2025 by Twingate
twingate/pulumi-twingate

A Remote Network represents a single private network in Twingate that can have one or more Connectors and Resources assigned to it. You must create a Remote Network before creating Resources and Connectors that belong to it. For more information, see Twingate’s documentation.

Example Usage

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

const foo = twingate.getTwingateRemoteNetwork({
    name: "<your network's name>",
});
Copy
import pulumi
import pulumi_twingate as twingate

foo = twingate.get_twingate_remote_network(name="<your network's name>")
Copy
package main

import (
	"github.com/Twingate/pulumi-twingate/sdk/v3/go/twingate"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := twingate.LookupTwingateRemoteNetwork(ctx, &twingate.LookupTwingateRemoteNetworkArgs{
			Name: pulumi.StringRef("<your network's name>"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Twingate = Pulumi.Twingate;

return await Deployment.RunAsync(() => 
{
    var foo = Twingate.GetTwingateRemoteNetwork.Invoke(new()
    {
        Name = "<your network's name>",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.twingate.TwingateFunctions;
import com.pulumi.twingate.inputs.GetTwingateRemoteNetworkArgs;
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 = TwingateFunctions.getTwingateRemoteNetwork(GetTwingateRemoteNetworkArgs.builder()
            .name("<your network's name>")
            .build());

    }
}
Copy
variables:
  foo:
    fn::invoke:
      function: twingate:getTwingateRemoteNetwork
      arguments:
        name: <your network's name>
Copy

Using getTwingateRemoteNetwork

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 getTwingateRemoteNetwork(args: GetTwingateRemoteNetworkArgs, opts?: InvokeOptions): Promise<GetTwingateRemoteNetworkResult>
function getTwingateRemoteNetworkOutput(args: GetTwingateRemoteNetworkOutputArgs, opts?: InvokeOptions): Output<GetTwingateRemoteNetworkResult>
Copy
def get_twingate_remote_network(id: Optional[str] = None,
                                name: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> GetTwingateRemoteNetworkResult
def get_twingate_remote_network_output(id: Optional[pulumi.Input[str]] = None,
                                name: Optional[pulumi.Input[str]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetTwingateRemoteNetworkResult]
Copy
func LookupTwingateRemoteNetwork(ctx *Context, args *LookupTwingateRemoteNetworkArgs, opts ...InvokeOption) (*LookupTwingateRemoteNetworkResult, error)
func LookupTwingateRemoteNetworkOutput(ctx *Context, args *LookupTwingateRemoteNetworkOutputArgs, opts ...InvokeOption) LookupTwingateRemoteNetworkResultOutput
Copy

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

public static class GetTwingateRemoteNetwork 
{
    public static Task<GetTwingateRemoteNetworkResult> InvokeAsync(GetTwingateRemoteNetworkArgs args, InvokeOptions? opts = null)
    public static Output<GetTwingateRemoteNetworkResult> Invoke(GetTwingateRemoteNetworkInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetTwingateRemoteNetworkResult> getTwingateRemoteNetwork(GetTwingateRemoteNetworkArgs args, InvokeOptions options)
public static Output<GetTwingateRemoteNetworkResult> getTwingateRemoteNetwork(GetTwingateRemoteNetworkArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: twingate:index/getTwingateRemoteNetwork:getTwingateRemoteNetwork
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Id string
The ID of the Remote Network
Name string
The name of the Remote Network
Id string
The ID of the Remote Network
Name string
The name of the Remote Network
id String
The ID of the Remote Network
name String
The name of the Remote Network
id string
The ID of the Remote Network
name string
The name of the Remote Network
id str
The ID of the Remote Network
name str
The name of the Remote Network
id String
The ID of the Remote Network
name String
The name of the Remote Network

getTwingateRemoteNetwork Result

The following output properties are available:

Location string
The location of the Remote Network. Must be one of the following: AWS, AZURE, GOOGLECLOUD, ONPREMISE, OTHER.
Type string
The type of the Remote Network. Must be one of the following: REGULAR, EXIT.
Id string
The ID of the Remote Network
Name string
The name of the Remote Network
Location string
The location of the Remote Network. Must be one of the following: AWS, AZURE, GOOGLECLOUD, ONPREMISE, OTHER.
Type string
The type of the Remote Network. Must be one of the following: REGULAR, EXIT.
Id string
The ID of the Remote Network
Name string
The name of the Remote Network
location String
The location of the Remote Network. Must be one of the following: AWS, AZURE, GOOGLECLOUD, ONPREMISE, OTHER.
type String
The type of the Remote Network. Must be one of the following: REGULAR, EXIT.
id String
The ID of the Remote Network
name String
The name of the Remote Network
location string
The location of the Remote Network. Must be one of the following: AWS, AZURE, GOOGLECLOUD, ONPREMISE, OTHER.
type string
The type of the Remote Network. Must be one of the following: REGULAR, EXIT.
id string
The ID of the Remote Network
name string
The name of the Remote Network
location str
The location of the Remote Network. Must be one of the following: AWS, AZURE, GOOGLECLOUD, ONPREMISE, OTHER.
type str
The type of the Remote Network. Must be one of the following: REGULAR, EXIT.
id str
The ID of the Remote Network
name str
The name of the Remote Network
location String
The location of the Remote Network. Must be one of the following: AWS, AZURE, GOOGLECLOUD, ONPREMISE, OTHER.
type String
The type of the Remote Network. Must be one of the following: REGULAR, EXIT.
id String
The ID of the Remote Network
name String
The name of the Remote Network

Package Details

Repository
twingate Twingate/pulumi-twingate
License
Apache-2.0
Notes
This Pulumi package is based on the twingate Terraform Provider.
Twingate v3.0.18 published on Wednesday, Apr 16, 2025 by Twingate
twingate/pulumi-twingate