1. Packages
  2. Packages
  3. Proxmox Virtual Environment (Proxmox VE)
  4. API Docs
  5. GroupLegacy
Viewing docs for Proxmox Virtual Environment (Proxmox VE) v8.1.0
published on Sunday, Apr 26, 2026 by Daniel Muehlbachler-Pietrzykowski
proxmoxve logo
Viewing docs for Proxmox Virtual Environment (Proxmox VE) v8.1.0
published on Sunday, Apr 26, 2026 by Daniel Muehlbachler-Pietrzykowski

    Manages a user group.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as proxmoxve from "@muhlba91/pulumi-proxmoxve";
    
    const operationsTeam = new proxmoxve.GroupLegacy("operations_team", {
        comment: "Managed by Pulumi",
        groupId: "operations-team",
    });
    
    import pulumi
    import pulumi_proxmoxve as proxmoxve
    
    operations_team = proxmoxve.GroupLegacy("operations_team",
        comment="Managed by Pulumi",
        group_id="operations-team")
    
    package main
    
    import (
    	"github.com/muhlba91/pulumi-proxmoxve/sdk/v8/go/proxmoxve"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := proxmoxve.NewGroupLegacy(ctx, "operations_team", &proxmoxve.GroupLegacyArgs{
    			Comment: pulumi.String("Managed by Pulumi"),
    			GroupId: pulumi.String("operations-team"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using ProxmoxVE = Pulumi.ProxmoxVE;
    
    return await Deployment.RunAsync(() => 
    {
        var operationsTeam = new ProxmoxVE.Index.GroupLegacy("operations_team", new()
        {
            Comment = "Managed by Pulumi",
            GroupId = "operations-team",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import io.muehlbachler.pulumi.proxmoxve.GroupLegacy;
    import io.muehlbachler.pulumi.proxmoxve.GroupLegacyArgs;
    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) {
            var operationsTeam = new GroupLegacy("operationsTeam", GroupLegacyArgs.builder()
                .comment("Managed by Pulumi")
                .groupId("operations-team")
                .build());
    
        }
    }
    
    resources:
      operationsTeam:
        type: proxmoxve:GroupLegacy
        name: operations_team
        properties:
          comment: Managed by Pulumi
          groupId: operations-team
    

    Create GroupLegacy Resource

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

    Constructor syntax

    new GroupLegacy(name: string, args: GroupLegacyArgs, opts?: CustomResourceOptions);
    @overload
    def GroupLegacy(resource_name: str,
                    args: GroupLegacyArgs,
                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def GroupLegacy(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    group_id: Optional[str] = None,
                    acls: Optional[Sequence[GroupLegacyAclArgs]] = None,
                    comment: Optional[str] = None)
    func NewGroupLegacy(ctx *Context, name string, args GroupLegacyArgs, opts ...ResourceOption) (*GroupLegacy, error)
    public GroupLegacy(string name, GroupLegacyArgs args, CustomResourceOptions? opts = null)
    public GroupLegacy(String name, GroupLegacyArgs args)
    public GroupLegacy(String name, GroupLegacyArgs args, CustomResourceOptions options)
    
    type: proxmoxve:GroupLegacy
    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 GroupLegacyArgs
    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 GroupLegacyArgs
    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 GroupLegacyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GroupLegacyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GroupLegacyArgs
    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 proxmoxveGroupLegacyResource = new ProxmoxVE.GroupLegacy("proxmoxveGroupLegacyResource", new()
    {
        GroupId = "string",
        Acls = new[]
        {
            new ProxmoxVE.Inputs.GroupLegacyAclArgs
            {
                Path = "string",
                RoleId = "string",
                Propagate = false,
            },
        },
        Comment = "string",
    });
    
    example, err := proxmoxve.NewGroupLegacy(ctx, "proxmoxveGroupLegacyResource", &proxmoxve.GroupLegacyArgs{
    	GroupId: pulumi.String("string"),
    	Acls: proxmoxve.GroupLegacyAclArray{
    		&proxmoxve.GroupLegacyAclArgs{
    			Path:      pulumi.String("string"),
    			RoleId:    pulumi.String("string"),
    			Propagate: pulumi.Bool(false),
    		},
    	},
    	Comment: pulumi.String("string"),
    })
    
    var proxmoxveGroupLegacyResource = new io.muehlbachler.pulumi.proxmoxve.GroupLegacy("proxmoxveGroupLegacyResource", io.muehlbachler.pulumi.proxmoxve.GroupLegacyArgs.builder()
        .groupId("string")
        .acls(GroupLegacyAclArgs.builder()
            .path("string")
            .roleId("string")
            .propagate(false)
            .build())
        .comment("string")
        .build());
    
    proxmoxve_group_legacy_resource = proxmoxve.GroupLegacy("proxmoxveGroupLegacyResource",
        group_id="string",
        acls=[{
            "path": "string",
            "role_id": "string",
            "propagate": False,
        }],
        comment="string")
    
    const proxmoxveGroupLegacyResource = new proxmoxve.GroupLegacy("proxmoxveGroupLegacyResource", {
        groupId: "string",
        acls: [{
            path: "string",
            roleId: "string",
            propagate: false,
        }],
        comment: "string",
    });
    
    type: proxmoxve:GroupLegacy
    properties:
        acls:
            - path: string
              propagate: false
              roleId: string
        comment: string
        groupId: string
    

    GroupLegacy 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 GroupLegacy resource accepts the following input properties:

    GroupId string
    The group identifier.
    Acls List<Pulumi.ProxmoxVE.Inputs.GroupLegacyAcl>
    The access control list (multiple blocks supported).
    Comment string
    The group comment.
    GroupId string
    The group identifier.
    Acls []GroupLegacyAclArgs
    The access control list (multiple blocks supported).
    Comment string
    The group comment.
    groupId String
    The group identifier.
    acls List<GroupLegacyAcl>
    The access control list (multiple blocks supported).
    comment String
    The group comment.
    groupId string
    The group identifier.
    acls GroupLegacyAcl[]
    The access control list (multiple blocks supported).
    comment string
    The group comment.
    group_id str
    The group identifier.
    acls Sequence[GroupLegacyAclArgs]
    The access control list (multiple blocks supported).
    comment str
    The group comment.
    groupId String
    The group identifier.
    acls List<Property Map>
    The access control list (multiple blocks supported).
    comment String
    The group comment.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Members List<string>
    The group members as a list of username@realm entries
    Id string
    The provider-assigned unique ID for this managed resource.
    Members []string
    The group members as a list of username@realm entries
    id String
    The provider-assigned unique ID for this managed resource.
    members List<String>
    The group members as a list of username@realm entries
    id string
    The provider-assigned unique ID for this managed resource.
    members string[]
    The group members as a list of username@realm entries
    id str
    The provider-assigned unique ID for this managed resource.
    members Sequence[str]
    The group members as a list of username@realm entries
    id String
    The provider-assigned unique ID for this managed resource.
    members List<String>
    The group members as a list of username@realm entries

    Look up Existing GroupLegacy Resource

    Get an existing GroupLegacy 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?: GroupLegacyState, opts?: CustomResourceOptions): GroupLegacy
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            acls: Optional[Sequence[GroupLegacyAclArgs]] = None,
            comment: Optional[str] = None,
            group_id: Optional[str] = None,
            members: Optional[Sequence[str]] = None) -> GroupLegacy
    func GetGroupLegacy(ctx *Context, name string, id IDInput, state *GroupLegacyState, opts ...ResourceOption) (*GroupLegacy, error)
    public static GroupLegacy Get(string name, Input<string> id, GroupLegacyState? state, CustomResourceOptions? opts = null)
    public static GroupLegacy get(String name, Output<String> id, GroupLegacyState state, CustomResourceOptions options)
    resources:  _:    type: proxmoxve:GroupLegacy    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:
    Acls List<Pulumi.ProxmoxVE.Inputs.GroupLegacyAcl>
    The access control list (multiple blocks supported).
    Comment string
    The group comment.
    GroupId string
    The group identifier.
    Members List<string>
    The group members as a list of username@realm entries
    Acls []GroupLegacyAclArgs
    The access control list (multiple blocks supported).
    Comment string
    The group comment.
    GroupId string
    The group identifier.
    Members []string
    The group members as a list of username@realm entries
    acls List<GroupLegacyAcl>
    The access control list (multiple blocks supported).
    comment String
    The group comment.
    groupId String
    The group identifier.
    members List<String>
    The group members as a list of username@realm entries
    acls GroupLegacyAcl[]
    The access control list (multiple blocks supported).
    comment string
    The group comment.
    groupId string
    The group identifier.
    members string[]
    The group members as a list of username@realm entries
    acls Sequence[GroupLegacyAclArgs]
    The access control list (multiple blocks supported).
    comment str
    The group comment.
    group_id str
    The group identifier.
    members Sequence[str]
    The group members as a list of username@realm entries
    acls List<Property Map>
    The access control list (multiple blocks supported).
    comment String
    The group comment.
    groupId String
    The group identifier.
    members List<String>
    The group members as a list of username@realm entries

    Supporting Types

    GroupLegacyAcl, GroupLegacyAclArgs

    Path string
    The path.
    RoleId string
    The role identifier.
    Propagate bool
    Whether to propagate to child paths.
    Path string
    The path.
    RoleId string
    The role identifier.
    Propagate bool
    Whether to propagate to child paths.
    path String
    The path.
    roleId String
    The role identifier.
    propagate Boolean
    Whether to propagate to child paths.
    path string
    The path.
    roleId string
    The role identifier.
    propagate boolean
    Whether to propagate to child paths.
    path str
    The path.
    role_id str
    The role identifier.
    propagate bool
    Whether to propagate to child paths.
    path String
    The path.
    roleId String
    The role identifier.
    propagate Boolean
    Whether to propagate to child paths.

    Import

    Instances can be imported using the groupId, e.g.,

    $ pulumi import proxmoxve:index/groupLegacy:GroupLegacy operations_team operations-team
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    proxmoxve muhlba91/pulumi-proxmoxve
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the proxmox Terraform Provider.
    proxmoxve logo
    Viewing docs for Proxmox Virtual Environment (Proxmox VE) v8.1.0
    published on Sunday, Apr 26, 2026 by Daniel Muehlbachler-Pietrzykowski
      Try Pulumi Cloud free. Your team will thank you.