Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Formal Provider
  3. API Docs
  4. getGroup
Formal v1.0.3 published on Monday, Aug 18, 2025 by Formal
formalco/pulumi-formal

formal.getGroup

Explore with Pulumi AI

formal logo
Formal v1.0.3 published on Monday, Aug 18, 2025 by Formal
formalco/pulumi-formal

    Data source for looking up a Group by 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(name: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetGroupResult
def get_group_output(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:

    Name string
    The name of the Group.
    Name string
    The name of the Group.
    name String
    The name of the Group.
    name string
    The name of the Group.
    name str
    The name of the Group.
    name String
    The name of the Group.

    getGroup Result

    The following output properties are available:

    Description string
    Description for this Group.
    Id string
    The Formal ID for this Group.
    Name string
    The name of the Group.
    TerminationProtection bool
    If set to true, this Group cannot be deleted.
    Description string
    Description for this Group.
    Id string
    The Formal ID for this Group.
    Name string
    The name of the Group.
    TerminationProtection bool
    If set to true, this Group cannot be deleted.
    description String
    Description for this Group.
    id String
    The Formal ID for this Group.
    name String
    The name of the Group.
    terminationProtection Boolean
    If set to true, this Group cannot be deleted.
    description string
    Description for this Group.
    id string
    The Formal ID for this Group.
    name string
    The name of the Group.
    terminationProtection boolean
    If set to true, this Group cannot be deleted.
    description str
    Description for this Group.
    id str
    The Formal ID for this Group.
    name str
    The name of the Group.
    termination_protection bool
    If set to true, this Group cannot be deleted.
    description String
    Description for this Group.
    id String
    The Formal ID for this Group.
    name String
    The name of the Group.
    terminationProtection Boolean
    If set to true, this Group cannot be deleted.

    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.0.3 published on Monday, Aug 18, 2025 by Formal
    formalco/pulumi-formal