AuthGroup

lxd 2.7.0, Feb 27 26

Viewing docs for lxd 2.7.0
published on Friday, Feb 27, 2026 by terraform-lxd

Schema (JSON)

terraform-lxd/terraform-provider-lxd

Viewing docs for lxd 2.7.0
published on Friday, Feb 27, 2026 by terraform-lxd

Schema (JSON)

terraform-lxd/terraform-provider-lxd

Create AuthGroup Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new AuthGroup(name: string, args?: AuthGroupArgs, opts?: CustomResourceOptions);

@overload
def AuthGroup(resource_name: str,
              args: Optional[AuthGroupArgs] = None,
              opts: Optional[ResourceOptions] = None)

@overload
def AuthGroup(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              description: Optional[str] = None,
              name: Optional[str] = None,
              permissions: Optional[Sequence[AuthGroupPermissionArgs]] = None,
              remote: Optional[str] = None)

func NewAuthGroup(ctx *Context, name string, args *AuthGroupArgs, opts ...ResourceOption) (*AuthGroup, error)

public AuthGroup(string name, AuthGroupArgs? args = null, CustomResourceOptions? opts = null)

public AuthGroup(String name, AuthGroupArgs args)
public AuthGroup(String name, AuthGroupArgs args, CustomResourceOptions options)

type: lxd:AuthGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args AuthGroupArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args AuthGroupArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args AuthGroupArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args AuthGroupArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args AuthGroupArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var authGroupResource = new Lxd.AuthGroup("authGroupResource", new()
{
    Description = "string",
    Name = "string",
    Permissions = new[]
    {
        new Lxd.Inputs.AuthGroupPermissionArgs
        {
            Entitlement = "string",
            EntityType = "string",
            EntityArgs = 
            {
                { "string", "string" },
            },
        },
    },
    Remote = "string",
});

example, err := lxd.NewAuthGroup(ctx, "authGroupResource", &lxd.AuthGroupArgs{
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
	Permissions: lxd.AuthGroupPermissionArray{
		&lxd.AuthGroupPermissionArgs{
			Entitlement: pulumi.String("string"),
			EntityType:  pulumi.String("string"),
			EntityArgs: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
		},
	},
	Remote: pulumi.String("string"),
})

var authGroupResource = new AuthGroup("authGroupResource", AuthGroupArgs.builder()
    .description("string")
    .name("string")
    .permissions(AuthGroupPermissionArgs.builder()
        .entitlement("string")
        .entityType("string")
        .entityArgs(Map.of("string", "string"))
        .build())
    .remote("string")
    .build());

auth_group_resource = lxd.AuthGroup("authGroupResource",
    description="string",
    name="string",
    permissions=[{
        "entitlement": "string",
        "entity_type": "string",
        "entity_args": {
            "string": "string",
        },
    }],
    remote="string")

const authGroupResource = new lxd.AuthGroup("authGroupResource", {
    description: "string",
    name: "string",
    permissions: [{
        entitlement: "string",
        entityType: "string",
        entityArgs: {
            string: "string",
        },
    }],
    remote: "string",
});

type: lxd:AuthGroup
properties:
    description: string
    name: string
    permissions:
        - entitlement: string
          entityArgs:
            string: string
          entityType: string
    remote: string

AuthGroup Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The AuthGroup resource accepts the following input properties:

Description string: Optional - Description of the group.
Name string: Required - Name of the group.
Permissions List<AuthGroupPermission>: Optional - List of group permissions. If not specified, the group has no permissions. Please, refer to the official LXD documentation for available entity types and entitlements that can be granted against each entity type.
Remote string: Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.

Description string: Optional - Description of the group.
Name string: Required - Name of the group.
Permissions []AuthGroupPermissionArgs: Optional - List of group permissions. If not specified, the group has no permissions. Please, refer to the official LXD documentation for available entity types and entitlements that can be granted against each entity type.
Remote string: Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.

description String: Optional - Description of the group.
name String: Required - Name of the group.
permissions List<AuthGroupPermission>: Optional - List of group permissions. If not specified, the group has no permissions. Please, refer to the official LXD documentation for available entity types and entitlements that can be granted against each entity type.
remote String: Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.

description string: Optional - Description of the group.
name string: Required - Name of the group.
permissions AuthGroupPermission[]: Optional - List of group permissions. If not specified, the group has no permissions. Please, refer to the official LXD documentation for available entity types and entitlements that can be granted against each entity type.
remote string: Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.

description str: Optional - Description of the group.
name str: Required - Name of the group.
permissions Sequence[AuthGroupPermissionArgs]: Optional - List of group permissions. If not specified, the group has no permissions. Please, refer to the official LXD documentation for available entity types and entitlements that can be granted against each entity type.
remote str: Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.

description String: Optional - Description of the group.
name String: Required - Name of the group.
permissions List<Property Map>: Optional - List of group permissions. If not specified, the group has no permissions. Please, refer to the official LXD documentation for available entity types and entitlements that can be granted against each entity type.
remote String: Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.

Outputs

All input properties are implicitly available as output properties. Additionally, the AuthGroup resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing AuthGroup Resource

Get an existing AuthGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: AuthGroupState, opts?: CustomResourceOptions): AuthGroup

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        permissions: Optional[Sequence[AuthGroupPermissionArgs]] = None,
        remote: Optional[str] = None) -> AuthGroup

func GetAuthGroup(ctx *Context, name string, id IDInput, state *AuthGroupState, opts ...ResourceOption) (*AuthGroup, error)

public static AuthGroup Get(string name, Input<string> id, AuthGroupState? state, CustomResourceOptions? opts = null)

public static AuthGroup get(String name, Output<String> id, AuthGroupState state, CustomResourceOptions options)

resources:  _:    type: lxd:AuthGroup    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Description string: Optional - Description of the group.
Name string: Required - Name of the group.
Permissions List<AuthGroupPermission>: Optional - List of group permissions. If not specified, the group has no permissions. Please, refer to the official LXD documentation for available entity types and entitlements that can be granted against each entity type.
Remote string: Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.

Description string: Optional - Description of the group.
Name string: Required - Name of the group.
Permissions []AuthGroupPermissionArgs: Optional - List of group permissions. If not specified, the group has no permissions. Please, refer to the official LXD documentation for available entity types and entitlements that can be granted against each entity type.
Remote string: Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.

description String: Optional - Description of the group.
name String: Required - Name of the group.
permissions List<AuthGroupPermission>: Optional - List of group permissions. If not specified, the group has no permissions. Please, refer to the official LXD documentation for available entity types and entitlements that can be granted against each entity type.
remote String: Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.

description string: Optional - Description of the group.
name string: Required - Name of the group.
permissions AuthGroupPermission[]: Optional - List of group permissions. If not specified, the group has no permissions. Please, refer to the official LXD documentation for available entity types and entitlements that can be granted against each entity type.
remote string: Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.

description str: Optional - Description of the group.
name str: Required - Name of the group.
permissions Sequence[AuthGroupPermissionArgs]: Optional - List of group permissions. If not specified, the group has no permissions. Please, refer to the official LXD documentation for available entity types and entitlements that can be granted against each entity type.
remote str: Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.

description String: Optional - Description of the group.
name String: Required - Name of the group.
permissions List<Property Map>: Optional - List of group permissions. If not specified, the group has no permissions. Please, refer to the official LXD documentation for available entity types and entitlements that can be granted against each entity type.
remote String: Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.

Supporting Types

AuthGroupPermission, AuthGroupPermissionArgs

Entitlement string: Required - Entitlement granted against the specified entity type. Available values depend on the entity_type. Examples: can_edit, can_view, can_delete.
EntityType string: Required - Entity type represents LXD API resource. Examples: server, project, instance.
EntityArgs Dictionary<string, string>: Optional - Map of key-value pairs used to identify a specific entity. Available keys depend on the entity_type, and are not required for certain entity types, such as server.

Entitlement string: Required - Entitlement granted against the specified entity type. Available values depend on the entity_type. Examples: can_edit, can_view, can_delete.
EntityType string: Required - Entity type represents LXD API resource. Examples: server, project, instance.
EntityArgs map[string]string: Optional - Map of key-value pairs used to identify a specific entity. Available keys depend on the entity_type, and are not required for certain entity types, such as server.

entitlement String: Required - Entitlement granted against the specified entity type. Available values depend on the entity_type. Examples: can_edit, can_view, can_delete.
entityType String: Required - Entity type represents LXD API resource. Examples: server, project, instance.
entityArgs Map<String,String>: Optional - Map of key-value pairs used to identify a specific entity. Available keys depend on the entity_type, and are not required for certain entity types, such as server.

entitlement string: Required - Entitlement granted against the specified entity type. Available values depend on the entity_type. Examples: can_edit, can_view, can_delete.
entityType string: Required - Entity type represents LXD API resource. Examples: server, project, instance.
entityArgs {[key: string]: string}: Optional - Map of key-value pairs used to identify a specific entity. Available keys depend on the entity_type, and are not required for certain entity types, such as server.

entitlement str: Required - Entitlement granted against the specified entity type. Available values depend on the entity_type. Examples: can_edit, can_view, can_delete.
entity_type str: Required - Entity type represents LXD API resource. Examples: server, project, instance.
entity_args Mapping[str, str]: Optional - Map of key-value pairs used to identify a specific entity. Available keys depend on the entity_type, and are not required for certain entity types, such as server.

entitlement String: Required - Entitlement granted against the specified entity type. Available values depend on the entity_type. Examples: can_edit, can_view, can_delete.
entityType String: Required - Entity type represents LXD API resource. Examples: server, project, instance.
entityArgs Map<String>: Optional - Map of key-value pairs used to identify a specific entity. Available keys depend on the entity_type, and are not required for certain entity types, such as server.