1. Packages
  2. Lxd Provider
  3. API Docs
  4. getAuthGroup
Viewing docs for lxd 2.7.0
published on Friday, Feb 27, 2026 by terraform-lxd
lxd logo
Viewing docs for lxd 2.7.0
published on Friday, Feb 27, 2026 by terraform-lxd

    #<span pulumi-lang-nodejs=" lxd.AuthGroup

    " pulumi-lang-dotnet=" lxd.AuthGroup " pulumi-lang-go=" AuthGroup " pulumi-lang-python=" AuthGroup " pulumi-lang-yaml=" lxd.AuthGroup " pulumi-lang-java=" lxd.AuthGroup “> lxd.AuthGroup Provides information about an existing LXD authorization group.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as lxd from "@pulumi/lxd";
    
    const group = lxd.getAuthGroup({
        name: "admins",
    });
    
    import pulumi
    import pulumi_lxd as lxd
    
    group = lxd.get_auth_group(name="admins")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/lxd/v2/lxd"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := lxd.LookupAuthGroup(ctx, &lxd.LookupAuthGroupArgs{
    			Name: "admins",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Lxd = Pulumi.Lxd;
    
    return await Deployment.RunAsync(() => 
    {
        var @group = Lxd.GetAuthGroup.Invoke(new()
        {
            Name = "admins",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.lxd.LxdFunctions;
    import com.pulumi.lxd.inputs.GetAuthGroupArgs;
    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 group = LxdFunctions.getAuthGroup(GetAuthGroupArgs.builder()
                .name("admins")
                .build());
    
        }
    }
    
    variables:
      group:
        fn::invoke:
          function: lxd:getAuthGroup
          arguments:
            name: admins
    

    Using getAuthGroup

    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 getAuthGroup(args: GetAuthGroupArgs, opts?: InvokeOptions): Promise<GetAuthGroupResult>
    function getAuthGroupOutput(args: GetAuthGroupOutputArgs, opts?: InvokeOptions): Output<GetAuthGroupResult>
    def get_auth_group(name: Optional[str] = None,
                       remote: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetAuthGroupResult
    def get_auth_group_output(name: Optional[pulumi.Input[str]] = None,
                       remote: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetAuthGroupResult]
    func LookupAuthGroup(ctx *Context, args *LookupAuthGroupArgs, opts ...InvokeOption) (*LookupAuthGroupResult, error)
    func LookupAuthGroupOutput(ctx *Context, args *LookupAuthGroupOutputArgs, opts ...InvokeOption) LookupAuthGroupResultOutput

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

    public static class GetAuthGroup 
    {
        public static Task<GetAuthGroupResult> InvokeAsync(GetAuthGroupArgs args, InvokeOptions? opts = null)
        public static Output<GetAuthGroupResult> Invoke(GetAuthGroupInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetAuthGroupResult> getAuthGroup(GetAuthGroupArgs args, InvokeOptions options)
    public static Output<GetAuthGroupResult> getAuthGroup(GetAuthGroupArgs args, InvokeOptions options)
    
    fn::invoke:
      function: lxd:index/getAuthGroup:getAuthGroup
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string
    Required - Name of the group.
    Remote string
    Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.
    Name string
    Required - Name of the group.
    Remote string
    Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.
    name String
    Required - Name of the group.
    remote String
    Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.
    name string
    Required - Name of the group.
    remote string
    Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.
    name str
    Required - Name of the group.
    remote str
    Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.
    name String
    Required - Name of the group.
    remote String
    Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.

    getAuthGroup Result

    The following output properties are available:

    Description string
    Description of the group.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Permissions List<GetAuthGroupPermission>
    List of group permissions.
    Remote string
    Description string
    Description of the group.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Permissions []GetAuthGroupPermission
    List of group permissions.
    Remote string
    description String
    Description of the group.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    permissions List<GetAuthGroupPermission>
    List of group permissions.
    remote String
    description string
    Description of the group.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    permissions GetAuthGroupPermission[]
    List of group permissions.
    remote string
    description str
    Description of the group.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    permissions Sequence[GetAuthGroupPermission]
    List of group permissions.
    remote str
    description String
    Description of the group.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    permissions List<Property Map>
    List of group permissions.
    remote String

    Supporting Types

    GetAuthGroupPermission

    Entitlement string
    EntityArgs Dictionary<string, string>
    EntityType string
    Entitlement string
    EntityArgs map[string]string
    EntityType string
    entitlement String
    entityArgs Map<String,String>
    entityType String
    entitlement string
    entityArgs {[key: string]: string}
    entityType string
    entitlement str
    entity_args Mapping[str, str]
    entity_type str
    entitlement String
    entityArgs Map<String>
    entityType String

    Package Details

    Repository
    lxd terraform-lxd/terraform-provider-lxd
    License
    Notes
    This Pulumi package is based on the lxd Terraform Provider.
    lxd logo
    Viewing docs for lxd 2.7.0
    published on Friday, Feb 27, 2026 by terraform-lxd
      Try Pulumi Cloud free. Your team will thank you.