Viewing docs for Twingate v4.0.2
published on Thursday, Mar 12, 2026 by Twingate
published on Thursday, Mar 12, 2026 by Twingate
Viewing docs for Twingate v4.0.2
published on Thursday, Mar 12, 2026 by Twingate
published on Thursday, Mar 12, 2026 by 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 "@twingate/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/v4/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 = Twingate.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)
public static Output<GetTwingateRemoteNetworksResult> getTwingateRemoteNetworks(GetTwingateRemoteNetworksArgs args, InvokeOptions options)
fn::invoke:
function: twingate:index/getTwingateRemoteNetworks:getTwingateRemoteNetworks
arguments:
# arguments dictionaryThe 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.
- Name
Contains string - Match when the value exist in the name of the remote network.
- Name
Exclude string - Match when the exact value does not exist in the name of the remote network.
- Name
Prefix string - The name of the remote network must start with the value.
- Name
Regexp string - The regular expression match of the name of the remote network.
- Name
Suffix 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.
- Name
Contains string - Match when the value exist in the name of the remote network.
- Name
Exclude string - Match when the exact value does not exist in the name of the remote network.
- Name
Prefix string - The name of the remote network must start with the value.
- Name
Regexp string - The regular expression match of the name of the remote network.
- Name
Suffix 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.
- name
Contains String - Match when the value exist in the name of the remote network.
- name
Exclude String - Match when the exact value does not exist in the name of the remote network.
- name
Prefix String - The name of the remote network must start with the value.
- name
Regexp String - The regular expression match of the name of the remote network.
- name
Suffix 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.
- name
Contains string - Match when the value exist in the name of the remote network.
- name
Exclude string - Match when the exact value does not exist in the name of the remote network.
- name
Prefix string - The name of the remote network must start with the value.
- name
Regexp string - The regular expression match of the name of the remote network.
- name
Suffix 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.
- name
Contains String - Match when the value exist in the name of the remote network.
- name
Exclude String - Match when the exact value does not exist in the name of the remote network.
- name
Prefix String - The name of the remote network must start with the value.
- name
Regexp String - The regular expression match of the name of the remote network.
- name
Suffix 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.
- Remote
Networks List<Twingate.Twingate. Outputs. Get Twingate Remote Networks Remote Network> - 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.
- Name
Contains string - Match when the value exist in the name of the remote network.
- Name
Exclude string - Match when the exact value does not exist in the name of the remote network.
- Name
Prefix string - The name of the remote network must start with the value.
- Name
Regexp string - The regular expression match of the name of the remote network.
- Name
Suffix string - The name of the remote network must end with the value.
- Id string
- The ID of this resource.
- Remote
Networks []GetTwingate Remote Networks Remote Network - 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.
- Name
Contains string - Match when the value exist in the name of the remote network.
- Name
Exclude string - Match when the exact value does not exist in the name of the remote network.
- Name
Prefix string - The name of the remote network must start with the value.
- Name
Regexp string - The regular expression match of the name of the remote network.
- Name
Suffix string - The name of the remote network must end with the value.
- id String
- The ID of this resource.
- remote
Networks List<GetTwingate Remote Networks Remote Network> - 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.
- name
Contains String - Match when the value exist in the name of the remote network.
- name
Exclude String - Match when the exact value does not exist in the name of the remote network.
- name
Prefix String - The name of the remote network must start with the value.
- name
Regexp String - The regular expression match of the name of the remote network.
- name
Suffix String - The name of the remote network must end with the value.
- id string
- The ID of this resource.
- remote
Networks GetTwingate Remote Networks Remote Network[] - 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.
- name
Contains string - Match when the value exist in the name of the remote network.
- name
Exclude string - Match when the exact value does not exist in the name of the remote network.
- name
Prefix string - The name of the remote network must start with the value.
- name
Regexp string - The regular expression match of the name of the remote network.
- name
Suffix string - The name of the remote network must end with the value.
- id str
- The ID of this resource.
- remote_
networks Sequence[GetTwingate Remote Networks Remote Network] - 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.
- remote
Networks 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.
- name
Contains String - Match when the value exist in the name of the remote network.
- name
Exclude String - Match when the exact value does not exist in the name of the remote network.
- name
Prefix String - The name of the remote network must start with the value.
- name
Regexp String - The regular expression match of the name of the remote network.
- name
Suffix String - The name of the remote network must end with the value.
Supporting Types
GetTwingateRemoteNetworksRemoteNetwork
Package Details
- Repository
- twingate Twingate/pulumi-twingate
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
twingateTerraform Provider.
Viewing docs for Twingate v4.0.2
published on Thursday, Mar 12, 2026 by Twingate
published on Thursday, Mar 12, 2026 by Twingate
