Twingate v3.0.6, Jun 27 24

Twingate v3.0.6 published on Thursday, Jun 27, 2024 by Twingate

twingate.getTwingateGroups

Explore with Pulumi AI

Twingate v3.0.6 published on Thursday, Jun 27, 2024 by Twingate

Example Usage

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

const foo = twingate.getTwingateGroups({
    name: "<your group's name>",
});

import pulumi
import pulumi_twingate as twingate

foo = twingate.get_twingate_groups(name="<your group'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.GetTwingateGroups(ctx, &twingate.GetTwingateGroupsArgs{
			Name: pulumi.StringRef("<your group'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 foo = Twingate.GetTwingateGroups.Invoke(new()
    {
        Name = "<your group'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.GetTwingateGroupsArgs;
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.getTwingateGroups(GetTwingateGroupsArgs.builder()
            .name("<your group's name>")
            .build());

    }
}

variables:
  foo:
    fn::invoke:
      Function: twingate:getTwingateGroups
      Arguments:
        name: <your group's name>

Using getTwingateGroups

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 getTwingateGroups(args: GetTwingateGroupsArgs, opts?: InvokeOptions): Promise<GetTwingateGroupsResult>
function getTwingateGroupsOutput(args: GetTwingateGroupsOutputArgs, opts?: InvokeOptions): Output<GetTwingateGroupsResult>

def get_twingate_groups(is_active: Optional[bool] = None,
                        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,
                        types: Optional[Sequence[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> GetTwingateGroupsResult
def get_twingate_groups_output(is_active: Optional[pulumi.Input[bool]] = None,
                        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,
                        types: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetTwingateGroupsResult]

func GetTwingateGroups(ctx *Context, args *GetTwingateGroupsArgs, opts ...InvokeOption) (*GetTwingateGroupsResult, error)
func GetTwingateGroupsOutput(ctx *Context, args *GetTwingateGroupsOutputArgs, opts ...InvokeOption) GetTwingateGroupsResultOutput

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

public static class GetTwingateGroups 
{
    public static Task<GetTwingateGroupsResult> InvokeAsync(GetTwingateGroupsArgs args, InvokeOptions? opts = null)
    public static Output<GetTwingateGroupsResult> Invoke(GetTwingateGroupsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetTwingateGroupsResult> getTwingateGroups(GetTwingateGroupsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

The following arguments are supported:

IsActive bool: Returns only Groups matching the specified state.
Name string: Returns only groups that exactly match this name. If no options are passed it will return all resources. Only one option can be used at a time.
NameContains string: Match when the value exist in the name of the group.
NameExclude string: Match when the exact value does not exist in the name of the group.
NamePrefix string: The name of the group must start with the value.
NameRegexp string: The regular expression match of the name of the group.
NameSuffix string: The name of the group must end with the value.
Types List<string>: Returns groups that match a list of types. valid types: MANUAL, SYNCED, SYSTEM.

IsActive bool: Returns only Groups matching the specified state.
Name string: Returns only groups that exactly match this name. If no options are passed it will return all resources. Only one option can be used at a time.
NameContains string: Match when the value exist in the name of the group.
NameExclude string: Match when the exact value does not exist in the name of the group.
NamePrefix string: The name of the group must start with the value.
NameRegexp string: The regular expression match of the name of the group.
NameSuffix string: The name of the group must end with the value.
Types []string: Returns groups that match a list of types. valid types: MANUAL, SYNCED, SYSTEM.

isActive Boolean: Returns only Groups matching the specified state.
name String: Returns only groups that exactly match this name. If no options are passed it will return all resources. Only one option can be used at a time.
nameContains String: Match when the value exist in the name of the group.
nameExclude String: Match when the exact value does not exist in the name of the group.
namePrefix String: The name of the group must start with the value.
nameRegexp String: The regular expression match of the name of the group.
nameSuffix String: The name of the group must end with the value.
types List<String>: Returns groups that match a list of types. valid types: MANUAL, SYNCED, SYSTEM.

isActive boolean: Returns only Groups matching the specified state.
name string: Returns only groups that exactly match this name. If no options are passed it will return all resources. Only one option can be used at a time.
nameContains string: Match when the value exist in the name of the group.
nameExclude string: Match when the exact value does not exist in the name of the group.
namePrefix string: The name of the group must start with the value.
nameRegexp string: The regular expression match of the name of the group.
nameSuffix string: The name of the group must end with the value.
types string[]: Returns groups that match a list of types. valid types: MANUAL, SYNCED, SYSTEM.

is_active bool: Returns only Groups matching the specified state.
name str: Returns only groups that exactly match this name. If no options are passed it will return all resources. Only one option can be used at a time.
name_contains str: Match when the value exist in the name of the group.
name_exclude str: Match when the exact value does not exist in the name of the group.
name_prefix str: The name of the group must start with the value.
name_regexp str: The regular expression match of the name of the group.
name_suffix str: The name of the group must end with the value.
types Sequence[str]: Returns groups that match a list of types. valid types: MANUAL, SYNCED, SYSTEM.

isActive Boolean: Returns only Groups matching the specified state.
name String: Returns only groups that exactly match this name. If no options are passed it will return all resources. Only one option can be used at a time.
nameContains String: Match when the value exist in the name of the group.
nameExclude String: Match when the exact value does not exist in the name of the group.
namePrefix String: The name of the group must start with the value.
nameRegexp String: The regular expression match of the name of the group.
nameSuffix String: The name of the group must end with the value.
types List<String>: Returns groups that match a list of types. valid types: MANUAL, SYNCED, SYSTEM.

getTwingateGroups Result

The following output properties are available:

Groups List<Twingate.Twingate.Outputs.GetTwingateGroupsGroup>: List of Groups
Id string: The ID of this resource.
IsActive bool: Returns only Groups matching the specified state.
Name string: Returns only groups that exactly match this name. If no options are passed it will return all resources. Only one option can be used at a time.
NameContains string: Match when the value exist in the name of the group.
NameExclude string: Match when the exact value does not exist in the name of the group.
NamePrefix string: The name of the group must start with the value.
NameRegexp string: The regular expression match of the name of the group.
NameSuffix string: The name of the group must end with the value.
Types List<string>: Returns groups that match a list of types. valid types: MANUAL, SYNCED, SYSTEM.

Groups []GetTwingateGroupsGroup: List of Groups
Id string: The ID of this resource.
IsActive bool: Returns only Groups matching the specified state.
Name string: Returns only groups that exactly match this name. If no options are passed it will return all resources. Only one option can be used at a time.
NameContains string: Match when the value exist in the name of the group.
NameExclude string: Match when the exact value does not exist in the name of the group.
NamePrefix string: The name of the group must start with the value.
NameRegexp string: The regular expression match of the name of the group.
NameSuffix string: The name of the group must end with the value.
Types []string: Returns groups that match a list of types. valid types: MANUAL, SYNCED, SYSTEM.

groups List<GetTwingateGroupsGroup>: List of Groups
id String: The ID of this resource.
isActive Boolean: Returns only Groups matching the specified state.
name String: Returns only groups that exactly match this name. If no options are passed it will return all resources. Only one option can be used at a time.
nameContains String: Match when the value exist in the name of the group.
nameExclude String: Match when the exact value does not exist in the name of the group.
namePrefix String: The name of the group must start with the value.
nameRegexp String: The regular expression match of the name of the group.
nameSuffix String: The name of the group must end with the value.
types List<String>: Returns groups that match a list of types. valid types: MANUAL, SYNCED, SYSTEM.

groups GetTwingateGroupsGroup[]: List of Groups
id string: The ID of this resource.
isActive boolean: Returns only Groups matching the specified state.
name string: Returns only groups that exactly match this name. If no options are passed it will return all resources. Only one option can be used at a time.
nameContains string: Match when the value exist in the name of the group.
nameExclude string: Match when the exact value does not exist in the name of the group.
namePrefix string: The name of the group must start with the value.
nameRegexp string: The regular expression match of the name of the group.
nameSuffix string: The name of the group must end with the value.
types string[]: Returns groups that match a list of types. valid types: MANUAL, SYNCED, SYSTEM.

groups Sequence[GetTwingateGroupsGroup]: List of Groups
id str: The ID of this resource.
is_active bool: Returns only Groups matching the specified state.
name str: Returns only groups that exactly match this name. If no options are passed it will return all resources. Only one option can be used at a time.
name_contains str: Match when the value exist in the name of the group.
name_exclude str: Match when the exact value does not exist in the name of the group.
name_prefix str: The name of the group must start with the value.
name_regexp str: The regular expression match of the name of the group.
name_suffix str: The name of the group must end with the value.
types Sequence[str]: Returns groups that match a list of types. valid types: MANUAL, SYNCED, SYSTEM.

groups List<Property Map>: List of Groups
id String: The ID of this resource.
isActive Boolean: Returns only Groups matching the specified state.
name String: Returns only groups that exactly match this name. If no options are passed it will return all resources. Only one option can be used at a time.
nameContains String: Match when the value exist in the name of the group.
nameExclude String: Match when the exact value does not exist in the name of the group.
namePrefix String: The name of the group must start with the value.
nameRegexp String: The regular expression match of the name of the group.
nameSuffix String: The name of the group must end with the value.
types List<String>: Returns groups that match a list of types. valid types: MANUAL, SYNCED, SYSTEM.

Supporting Types

GetTwingateGroupsGroup

Id string: The ID of the Group
IsActive bool: Indicates if the Group is active
Name string: The name of the Group
SecurityPolicyId string: The Security Policy assigned to the Group.
Type string: The type of the Group

Id string: The ID of the Group
IsActive bool: Indicates if the Group is active
Name string: The name of the Group
SecurityPolicyId string: The Security Policy assigned to the Group.
Type string: The type of the Group

id String: The ID of the Group
isActive Boolean: Indicates if the Group is active
name String: The name of the Group
securityPolicyId String: The Security Policy assigned to the Group.
type String: The type of the Group

id string: The ID of the Group
isActive boolean: Indicates if the Group is active
name string: The name of the Group
securityPolicyId string: The Security Policy assigned to the Group.
type string: The type of the Group

id str: The ID of the Group
is_active bool: Indicates if the Group is active
name str: The name of the Group
security_policy_id str: The Security Policy assigned to the Group.
type str: The type of the Group

id String: The ID of the Group
isActive Boolean: Indicates if the Group is active
name String: The name of the Group
securityPolicyId String: The Security Policy assigned to the Group.
type String: The type of the Group

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.6 published on Thursday, Jun 27, 2024 by Twingate

Twingate/pulumi-twingate

twingate.getTwingateGroups

On this page

On this page

Example Usage

Using getTwingateGroups

getTwingateGroups Result

Supporting Types

GetTwingateGroupsGroup

Package Details

On this page

On this page