1. Packages
  2. Formal Provider
  3. API Docs
  4. getGroup
Formal v1.1.0 published on Sunday, Mar 1, 2026 by Formal
Schema (JSON)
formalco/pulumi-formal

formal.getGroup

formal logo
Formal v1.1.0 published on Sunday, Mar 1, 2026 by Formal
Schema (JSON)
formalco/pulumi-formal

    Data source for looking up a Group by ID or by name. Use either id or name, but not both.

    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(id: Optional[str] = None,
              name: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetGroupResult
def get_group_output(id: Optional[pulumi.Input[str]] = None,
              name: 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: formal:index/getGroup:getGroup
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Id string
    The ID of this Group.
    Name string
    The name of the Group to look up. Use this to fetch a group by name.
    Id string
    The ID of this Group.
    Name string
    The name of the Group to look up. Use this to fetch a group by name.
    id String
    The ID of this Group.
    name String
    The name of the Group to look up. Use this to fetch a group by name.
    id string
    The ID of this Group.
    name string
    The name of the Group to look up. Use this to fetch a group by name.
    id str
    The ID of this Group.
    name str
    The name of the Group to look up. Use this to fetch a group by name.
    id String
    The ID of this Group.
    name String
    The name of the Group to look up. Use this to fetch a group by name.

    getGroup Result

    The following output properties are available:

    Description string
    Description for this Group.
    TerminationProtection bool
    If set to true, this Group cannot be deleted.
    Id string
    The ID of this Group.
    Name string
    The name of the Group to look up. Use this to fetch a group by name.
    Description string
    Description for this Group.
    TerminationProtection bool
    If set to true, this Group cannot be deleted.
    Id string
    The ID of this Group.
    Name string
    The name of the Group to look up. Use this to fetch a group by name.
    description String
    Description for this Group.
    terminationProtection Boolean
    If set to true, this Group cannot be deleted.
    id String
    The ID of this Group.
    name String
    The name of the Group to look up. Use this to fetch a group by name.
    description string
    Description for this Group.
    terminationProtection boolean
    If set to true, this Group cannot be deleted.
    id string
    The ID of this Group.
    name string
    The name of the Group to look up. Use this to fetch a group by name.
    description str
    Description for this Group.
    termination_protection bool
    If set to true, this Group cannot be deleted.
    id str
    The ID of this Group.
    name str
    The name of the Group to look up. Use this to fetch a group by name.
    description String
    Description for this Group.
    terminationProtection Boolean
    If set to true, this Group cannot be deleted.
    id String
    The ID of this Group.
    name String
    The name of the Group to look up. Use this to fetch a group by name.

    Package Details

    Repository
    formal formalco/pulumi-formal
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the formal Terraform Provider.
    formal logo
    Formal v1.1.0 published on Sunday, Mar 1, 2026 by Formal
    Schema (JSON)
    formalco/pulumi-formal
      Meet Neo: Your AI Platform Teammate