Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Twingate
  3. API Docs
  4. getTwingateRemoteNetworks
Twingate v3.0.12 published on Tuesday, Nov 5, 2024 by Twingate
Twingate/pulumi-twingate

twingate.getTwingateRemoteNetworks

Explore with Pulumi AI

twingate logo
Twingate v3.0.12 published on Tuesday, Nov 5, 2024 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 all = twingate.getTwingateRemoteNetworks({
    name: "<your network's name>",
});

    import pulumi
import pulumi_twingate as twingate

all = twingate.get_twingate_remote_networks(name="<your network's name>")

    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.GetTwingateRemoteNetworks(ctx, &twingate.GetTwingateRemoteNetworksArgs{
			Name: pulumi.StringRef("<your network's name>"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

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

});

    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.GetTwingateRemoteNetworksArgs;
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 all = TwingateFunctions.getTwingateRemoteNetworks(GetTwingateRemoteNetworksArgs.builder()
            .name("<your network's name>")
            .build());

    }
}

    variables:
  all:
    fn::invoke:
      Function: twingate:getTwingateRemoteNetworks
      Arguments:
        name: <your network's name>

    Using getTwingateRemoteNetworks

    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 getTwingateRemoteNetworks(args: GetTwingateRemoteNetworksArgs, opts?: InvokeOptions): Promise<GetTwingateRemoteNetworksResult>
function getTwingateRemoteNetworksOutput(args: GetTwingateRemoteNetworksOutputArgs, opts?: InvokeOptions): Output<GetTwingateRemoteNetworksResult>
    def get_twingate_remote_networks(name: Optional[str] = None,
                                 name_contains: Optional[str] = None,
                                 name_exclude: Optional[str] = None,
                                 name_prefix: Optional[str] = None,
                                 name_regexp: Optional[str] = None,
                                 name_suffix: Optional[str] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetTwingateRemoteNetworksResult
def get_twingate_remote_networks_output(name: Optional[pulumi.Input[str]] = None,
                                 name_contains: Optional[pulumi.Input[str]] = None,
                                 name_exclude: Optional[pulumi.Input[str]] = None,
                                 name_prefix: Optional[pulumi.Input[str]] = None,
                                 name_regexp: Optional[pulumi.Input[str]] = None,
                                 name_suffix: Optional[pulumi.Input[str]] = None,
                                 opts: Optional[InvokeOptions] = None) -> Output[GetTwingateRemoteNetworksResult]
    func GetTwingateRemoteNetworks(ctx *Context, args *GetTwingateRemoteNetworksArgs, opts ...InvokeOption) (*GetTwingateRemoteNetworksResult, error)
func GetTwingateRemoteNetworksOutput(ctx *Context, args *GetTwingateRemoteNetworksOutputArgs, opts ...InvokeOption) GetTwingateRemoteNetworksResultOutput

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

    public static class GetTwingateRemoteNetworks 
{
    public static Task<GetTwingateRemoteNetworksResult> InvokeAsync(GetTwingateRemoteNetworksArgs args, InvokeOptions? opts = null)
    public static Output<GetTwingateRemoteNetworksResult> Invoke(GetTwingateRemoteNetworksInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetTwingateRemoteNetworksResult> getTwingateRemoteNetworks(GetTwingateRemoteNetworksArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: twingate:index/getTwingateRemoteNetworks:getTwingateRemoteNetworks
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Name string
    Returns only remote networks that exactly match this name. If no options are passed it will return all remote networks. Only one option can be used at a time.
    NameContains string
    Match when the value exist in the name of the remote network.
    NameExclude string
    Match when the exact value does not exist in the name of the remote network.
    NamePrefix string
    The name of the remote network must start with the value.
    NameRegexp string
    The regular expression match of the name of the remote network.
    NameSuffix string
    The name of the remote network must end with the value.
    Name string
    Returns only remote networks that exactly match this name. If no options are passed it will return all remote networks. Only one option can be used at a time.
    NameContains string
    Match when the value exist in the name of the remote network.
    NameExclude string
    Match when the exact value does not exist in the name of the remote network.
    NamePrefix string
    The name of the remote network must start with the value.
    NameRegexp string
    The regular expression match of the name of the remote network.
    NameSuffix string
    The name of the remote network must end with the value.
    name String
    Returns only remote networks that exactly match this name. If no options are passed it will return all remote networks. Only one option can be used at a time.
    nameContains String
    Match when the value exist in the name of the remote network.
    nameExclude String
    Match when the exact value does not exist in the name of the remote network.
    namePrefix String
    The name of the remote network must start with the value.
    nameRegexp String
    The regular expression match of the name of the remote network.
    nameSuffix String
    The name of the remote network must end with the value.
    name string
    Returns only remote networks that exactly match this name. If no options are passed it will return all remote networks. Only one option can be used at a time.
    nameContains string
    Match when the value exist in the name of the remote network.
    nameExclude string
    Match when the exact value does not exist in the name of the remote network.
    namePrefix string
    The name of the remote network must start with the value.
    nameRegexp string
    The regular expression match of the name of the remote network.
    nameSuffix string
    The name of the remote network must end with the value.
    name str
    Returns only remote networks that exactly match this name. If no options are passed it will return all remote networks. Only one option can be used at a time.
    name_contains str
    Match when the value exist in the name of the remote network.
    name_exclude str
    Match when the exact value does not exist in the name of the remote network.
    name_prefix str
    The name of the remote network must start with the value.
    name_regexp str
    The regular expression match of the name of the remote network.
    name_suffix str
    The name of the remote network must end with the value.
    name String
    Returns only remote networks that exactly match this name. If no options are passed it will return all remote networks. Only one option can be used at a time.
    nameContains String
    Match when the value exist in the name of the remote network.
    nameExclude String
    Match when the exact value does not exist in the name of the remote network.
    namePrefix String
    The name of the remote network must start with the value.
    nameRegexp String
    The regular expression match of the name of the remote network.
    nameSuffix String
    The name of the remote network must end with the value.

    getTwingateRemoteNetworks Result

    The following output properties are available:

    Id string
    The ID of this resource.
    RemoteNetworks List<Twingate.Twingate.Outputs.GetTwingateRemoteNetworksRemoteNetwork>
    List of Remote Networks
    Name string
    Returns only remote networks that exactly match this name. If no options are passed it will return all remote networks. Only one option can be used at a time.
    NameContains string
    Match when the value exist in the name of the remote network.
    NameExclude string
    Match when the exact value does not exist in the name of the remote network.
    NamePrefix string
    The name of the remote network must start with the value.
    NameRegexp string
    The regular expression match of the name of the remote network.
    NameSuffix string
    The name of the remote network must end with the value.
    Id string
    The ID of this resource.
    RemoteNetworks []GetTwingateRemoteNetworksRemoteNetwork
    List of Remote Networks
    Name string
    Returns only remote networks that exactly match this name. If no options are passed it will return all remote networks. Only one option can be used at a time.
    NameContains string
    Match when the value exist in the name of the remote network.
    NameExclude string
    Match when the exact value does not exist in the name of the remote network.
    NamePrefix string
    The name of the remote network must start with the value.
    NameRegexp string
    The regular expression match of the name of the remote network.
    NameSuffix string
    The name of the remote network must end with the value.
    id String
    The ID of this resource.
    remoteNetworks List<GetTwingateRemoteNetworksRemoteNetwork>
    List of Remote Networks
    name String
    Returns only remote networks that exactly match this name. If no options are passed it will return all remote networks. Only one option can be used at a time.
    nameContains String
    Match when the value exist in the name of the remote network.
    nameExclude String
    Match when the exact value does not exist in the name of the remote network.
    namePrefix String
    The name of the remote network must start with the value.
    nameRegexp String
    The regular expression match of the name of the remote network.
    nameSuffix String
    The name of the remote network must end with the value.
    id string
    The ID of this resource.
    remoteNetworks GetTwingateRemoteNetworksRemoteNetwork[]
    List of Remote Networks
    name string
    Returns only remote networks that exactly match this name. If no options are passed it will return all remote networks. Only one option can be used at a time.
    nameContains string
    Match when the value exist in the name of the remote network.
    nameExclude string
    Match when the exact value does not exist in the name of the remote network.
    namePrefix string
    The name of the remote network must start with the value.
    nameRegexp string
    The regular expression match of the name of the remote network.
    nameSuffix string
    The name of the remote network must end with the value.
    id str
    The ID of this resource.
    remote_networks Sequence[GetTwingateRemoteNetworksRemoteNetwork]
    List of Remote Networks
    name str
    Returns only remote networks that exactly match this name. If no options are passed it will return all remote networks. Only one option can be used at a time.
    name_contains str
    Match when the value exist in the name of the remote network.
    name_exclude str
    Match when the exact value does not exist in the name of the remote network.
    name_prefix str
    The name of the remote network must start with the value.
    name_regexp str
    The regular expression match of the name of the remote network.
    name_suffix str
    The name of the remote network must end with the value.
    id String
    The ID of this resource.
    remoteNetworks List<Property Map>
    List of Remote Networks
    name String
    Returns only remote networks that exactly match this name. If no options are passed it will return all remote networks. Only one option can be used at a time.
    nameContains String
    Match when the value exist in the name of the remote network.
    nameExclude String
    Match when the exact value does not exist in the name of the remote network.
    namePrefix String
    The name of the remote network must start with the value.
    nameRegexp String
    The regular expression match of the name of the remote network.
    nameSuffix String
    The name of the remote network must end with the value.

    Supporting Types

    GetTwingateRemoteNetworksRemoteNetwork

    Id string
    The ID of the Remote Network.
    Location string
    The location of the Remote Network. Must be one of the following: AWS, AZURE, GOOGLECLOUD, ONPREMISE, OTHER.
    Name string
    The name of the Remote Network.
    Id string
    The ID of the Remote Network.
    Location string
    The location of the Remote Network. Must be one of the following: AWS, AZURE, GOOGLECLOUD, ONPREMISE, OTHER.
    Name string
    The name of the Remote Network.
    id String
    The ID of the Remote Network.
    location String
    The location of the Remote Network. Must be one of the following: AWS, AZURE, GOOGLECLOUD, ONPREMISE, OTHER.
    name String
    The name of the Remote Network.
    id string
    The ID of the Remote Network.
    location string
    The location of the Remote Network. Must be one of the following: AWS, AZURE, GOOGLECLOUD, ONPREMISE, OTHER.
    name string
    The name of the Remote Network.
    id str
    The ID of the Remote Network.
    location str
    The location of the Remote Network. Must be one of the following: AWS, AZURE, GOOGLECLOUD, ONPREMISE, OTHER.
    name str
    The name of the Remote Network.
    id String
    The ID of the Remote Network.
    location String
    The location of the Remote Network. Must be one of the following: AWS, AZURE, GOOGLECLOUD, ONPREMISE, OTHER.
    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 logo
    Twingate v3.0.12 published on Tuesday, Nov 5, 2024 by Twingate
    Twingate/pulumi-twingate