1. Packages
  2. Proxmox Virtual Environment (Proxmox VE)
  3. API Docs
  4. Permission
  5. getGroups
Viewing docs for Proxmox Virtual Environment (Proxmox VE) v7.13.0
published on Tuesday, Feb 10, 2026 by Daniel Muehlbachler-Pietrzykowski
proxmoxve logo
Viewing docs for Proxmox Virtual Environment (Proxmox VE) v7.13.0
published on Tuesday, Feb 10, 2026 by Daniel Muehlbachler-Pietrzykowski

    Retrieves basic information about all available user groups.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as proxmoxve from "@muhlba91/pulumi-proxmoxve";
    
    const availableGroups = proxmoxve.Permission.getGroups({});
    
    import pulumi
    import pulumi_proxmoxve as proxmoxve
    
    available_groups = proxmoxve.Permission.get_groups()
    
    package main
    
    import (
    	"github.com/muhlba91/pulumi-proxmoxve/sdk/v7/go/proxmoxve/permission"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := permission.GetGroups(ctx, map[string]interface{}{}, nil)
    		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 availableGroups = ProxmoxVE.Permission.GetGroups.Invoke();
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.proxmoxve.Permission.PermissionFunctions;
    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 availableGroups = PermissionFunctions.getGroups(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference);
    
        }
    }
    
    variables:
      availableGroups:
        fn::invoke:
          function: proxmoxve:Permission:getGroups
          arguments: {}
    

    Using getGroups

    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 getGroups(opts?: InvokeOptions): Promise<GetGroupsResult>
    function getGroupsOutput(opts?: InvokeOptions): Output<GetGroupsResult>
    def get_groups(opts: Optional[InvokeOptions] = None) -> GetGroupsResult
    def get_groups_output(opts: Optional[InvokeOptions] = None) -> Output[GetGroupsResult]
    func GetGroups(ctx *Context, opts ...InvokeOption) (*GetGroupsResult, error)
    func GetGroupsOutput(ctx *Context, opts ...InvokeOption) GetGroupsResultOutput

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

    public static class GetGroups 
    {
        public static Task<GetGroupsResult> InvokeAsync(InvokeOptions? opts = null)
        public static Output<GetGroupsResult> Invoke(InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetGroupsResult> getGroups(InvokeOptions options)
    public static Output<GetGroupsResult> getGroups(InvokeOptions options)
    
    fn::invoke:
      function: proxmoxve:Permission/getGroups:getGroups
      arguments:
        # arguments dictionary

    getGroups Result

    The following output properties are available:

    Comments List<string>
    The group comments.
    GroupIds List<string>
    The group identifiers.
    Id string
    The provider-assigned unique ID for this managed resource.
    Comments []string
    The group comments.
    GroupIds []string
    The group identifiers.
    Id string
    The provider-assigned unique ID for this managed resource.
    comments List<String>
    The group comments.
    groupIds List<String>
    The group identifiers.
    id String
    The provider-assigned unique ID for this managed resource.
    comments string[]
    The group comments.
    groupIds string[]
    The group identifiers.
    id string
    The provider-assigned unique ID for this managed resource.
    comments Sequence[str]
    The group comments.
    group_ids Sequence[str]
    The group identifiers.
    id str
    The provider-assigned unique ID for this managed resource.
    comments List<String>
    The group comments.
    groupIds List<String>
    The group identifiers.
    id String
    The provider-assigned unique ID for this managed resource.

    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) v7.13.0
    published on Tuesday, Feb 10, 2026 by Daniel Muehlbachler-Pietrzykowski
      Try Pulumi Cloud free. Your team will thank you.