Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Googleworkspace Provider
  3. API Docs
  4. getGroup
googleworkspace 0.7.0 published on Wednesday, Jan 15, 2025 by hashicorp
hashicorp/terraform-provider-googleworkspace

googleworkspace.getGroup

Explore with Pulumi AI

googleworkspace logo
googleworkspace 0.7.0 published on Wednesday, Jan 15, 2025 by hashicorp
hashicorp/terraform-provider-googleworkspace

    Example Usage

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

const sales = googleworkspace.getGroup({
    email: "sales@example.com",
});
export const groupName = sales.then(sales => sales.name);

    import pulumi
import pulumi_googleworkspace as googleworkspace

sales = googleworkspace.get_group(email="sales@example.com")
pulumi.export("groupName", sales.name)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		sales, err := googleworkspace.LookupGroup(ctx, &googleworkspace.LookupGroupArgs{
			Email: pulumi.StringRef("sales@example.com"),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("groupName", sales.Name)
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var sales = Googleworkspace.GetGroup.Invoke(new()
    {
        Email = "sales@example.com",
    });

    return new Dictionary<string, object?>
    {
        ["groupName"] = sales.Apply(getGroupResult => getGroupResult.Name),
    };
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.googleworkspace.GoogleworkspaceFunctions;
import com.pulumi.googleworkspace.inputs.GetGroupArgs;
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 sales = GoogleworkspaceFunctions.getGroup(GetGroupArgs.builder()
            .email("sales@example.com")
            .build());

        ctx.export("groupName", sales.applyValue(getGroupResult -> getGroupResult.name()));
    }
}

    variables:
  sales:
    fn::invoke:
      function: googleworkspace:getGroup
      arguments:
        email: sales@example.com
outputs:
  groupName: ${sales.name}

    Using getGroup

    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 getGroup(args: GetGroupArgs, opts?: InvokeOptions): Promise<GetGroupResult>
function getGroupOutput(args: GetGroupOutputArgs, opts?: InvokeOptions): Output<GetGroupResult>
    def get_group(email: Optional[str] = None,
              id: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetGroupResult
def get_group_output(email: Optional[pulumi.Input[str]] = None,
              id: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetGroupResult]
    func LookupGroup(ctx *Context, args *LookupGroupArgs, opts ...InvokeOption) (*LookupGroupResult, error)
func LookupGroupOutput(ctx *Context, args *LookupGroupOutputArgs, opts ...InvokeOption) LookupGroupResultOutput

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

    public static class GetGroup 
{
    public static Task<GetGroupResult> InvokeAsync(GetGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetGroupResult> Invoke(GetGroupInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetGroupResult> getGroup(GetGroupArgs args, InvokeOptions options)
public static Output<GetGroupResult> getGroup(GetGroupArgs args, InvokeOptions options)

    fn::invoke:
  function: googleworkspace:index/getGroup:getGroup
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Email string
    The group's email address. If your account has multiple domains,select the appropriate domain for the email address. The email must be unique.
    Id string
    The unique ID of a group. A group id can be used as a group request URI's groupKey.
    Email string
    The group's email address. If your account has multiple domains,select the appropriate domain for the email address. The email must be unique.
    Id string
    The unique ID of a group. A group id can be used as a group request URI's groupKey.
    email String
    The group's email address. If your account has multiple domains,select the appropriate domain for the email address. The email must be unique.
    id String
    The unique ID of a group. A group id can be used as a group request URI's groupKey.
    email string
    The group's email address. If your account has multiple domains,select the appropriate domain for the email address. The email must be unique.
    id string
    The unique ID of a group. A group id can be used as a group request URI's groupKey.
    email str
    The group's email address. If your account has multiple domains,select the appropriate domain for the email address. The email must be unique.
    id str
    The unique ID of a group. A group id can be used as a group request URI's groupKey.
    email String
    The group's email address. If your account has multiple domains,select the appropriate domain for the email address. The email must be unique.
    id String
    The unique ID of a group. A group id can be used as a group request URI's groupKey.

    getGroup Result

    The following output properties are available:

    AdminCreated bool
    Value is true if this group was created by an administrator rather than a user.
    Aliases List<string>
    asps.list of group's email addresses.
    Description string
    An extended description to help users determine the purpose of a group.For example, you can include information about who should join the group,the types of messages to send to the group, links to FAQs about the group, or related groups.
    DirectMembersCount double
    The number of users that are direct members of the group.If a group is a member (child) of this group (the parent),members of the child group are not counted in the directMembersCount property of the parent group.
    Email string
    The group's email address. If your account has multiple domains,select the appropriate domain for the email address. The email must be unique.
    Etag string
    ETag of the resource.
    Id string
    The unique ID of a group. A group id can be used as a group request URI's groupKey.
    Name string
    The group's display name.
    NonEditableAliases List<string>
    asps.list of the group's non-editable alias email addresses that are outside of the account's primary domain or subdomains. These are functioning email addresses used by the group.
    AdminCreated bool
    Value is true if this group was created by an administrator rather than a user.
    Aliases []string
    asps.list of group's email addresses.
    Description string
    An extended description to help users determine the purpose of a group.For example, you can include information about who should join the group,the types of messages to send to the group, links to FAQs about the group, or related groups.
    DirectMembersCount float64
    The number of users that are direct members of the group.If a group is a member (child) of this group (the parent),members of the child group are not counted in the directMembersCount property of the parent group.
    Email string
    The group's email address. If your account has multiple domains,select the appropriate domain for the email address. The email must be unique.
    Etag string
    ETag of the resource.
    Id string
    The unique ID of a group. A group id can be used as a group request URI's groupKey.
    Name string
    The group's display name.
    NonEditableAliases []string
    asps.list of the group's non-editable alias email addresses that are outside of the account's primary domain or subdomains. These are functioning email addresses used by the group.
    adminCreated Boolean
    Value is true if this group was created by an administrator rather than a user.
    aliases List<String>
    asps.list of group's email addresses.
    description String
    An extended description to help users determine the purpose of a group.For example, you can include information about who should join the group,the types of messages to send to the group, links to FAQs about the group, or related groups.
    directMembersCount Double
    The number of users that are direct members of the group.If a group is a member (child) of this group (the parent),members of the child group are not counted in the directMembersCount property of the parent group.
    email String
    The group's email address. If your account has multiple domains,select the appropriate domain for the email address. The email must be unique.
    etag String
    ETag of the resource.
    id String
    The unique ID of a group. A group id can be used as a group request URI's groupKey.
    name String
    The group's display name.
    nonEditableAliases List<String>
    asps.list of the group's non-editable alias email addresses that are outside of the account's primary domain or subdomains. These are functioning email addresses used by the group.
    adminCreated boolean
    Value is true if this group was created by an administrator rather than a user.
    aliases string[]
    asps.list of group's email addresses.
    description string
    An extended description to help users determine the purpose of a group.For example, you can include information about who should join the group,the types of messages to send to the group, links to FAQs about the group, or related groups.
    directMembersCount number
    The number of users that are direct members of the group.If a group is a member (child) of this group (the parent),members of the child group are not counted in the directMembersCount property of the parent group.
    email string
    The group's email address. If your account has multiple domains,select the appropriate domain for the email address. The email must be unique.
    etag string
    ETag of the resource.
    id string
    The unique ID of a group. A group id can be used as a group request URI's groupKey.
    name string
    The group's display name.
    nonEditableAliases string[]
    asps.list of the group's non-editable alias email addresses that are outside of the account's primary domain or subdomains. These are functioning email addresses used by the group.
    admin_created bool
    Value is true if this group was created by an administrator rather than a user.
    aliases Sequence[str]
    asps.list of group's email addresses.
    description str
    An extended description to help users determine the purpose of a group.For example, you can include information about who should join the group,the types of messages to send to the group, links to FAQs about the group, or related groups.
    direct_members_count float
    The number of users that are direct members of the group.If a group is a member (child) of this group (the parent),members of the child group are not counted in the directMembersCount property of the parent group.
    email str
    The group's email address. If your account has multiple domains,select the appropriate domain for the email address. The email must be unique.
    etag str
    ETag of the resource.
    id str
    The unique ID of a group. A group id can be used as a group request URI's groupKey.
    name str
    The group's display name.
    non_editable_aliases Sequence[str]
    asps.list of the group's non-editable alias email addresses that are outside of the account's primary domain or subdomains. These are functioning email addresses used by the group.
    adminCreated Boolean
    Value is true if this group was created by an administrator rather than a user.
    aliases List<String>
    asps.list of group's email addresses.
    description String
    An extended description to help users determine the purpose of a group.For example, you can include information about who should join the group,the types of messages to send to the group, links to FAQs about the group, or related groups.
    directMembersCount Number
    The number of users that are direct members of the group.If a group is a member (child) of this group (the parent),members of the child group are not counted in the directMembersCount property of the parent group.
    email String
    The group's email address. If your account has multiple domains,select the appropriate domain for the email address. The email must be unique.
    etag String
    ETag of the resource.
    id String
    The unique ID of a group. A group id can be used as a group request URI's groupKey.
    name String
    The group's display name.
    nonEditableAliases List<String>
    asps.list of the group's non-editable alias email addresses that are outside of the account's primary domain or subdomains. These are functioning email addresses used by the group.

    Package Details

    Repository
    googleworkspace hashicorp/terraform-provider-googleworkspace
    License
    Notes
    This Pulumi package is based on the googleworkspace Terraform Provider.
    googleworkspace logo
    googleworkspace 0.7.0 published on Wednesday, Jan 15, 2025 by hashicorp
    hashicorp/terraform-provider-googleworkspace