Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Proxmox Virtual Environment (Proxmox VE)
  3. API Docs
  4. Permission
  5. getGroups
Proxmox Virtual Environment (Proxmox VE) v7.0.0 published on Tuesday, Apr 1, 2025 by Daniel Muehlbachler-Pietrzykowski
muhlba91/pulumi-proxmoxve

proxmoxve.Permission.getGroups

Explore with Pulumi AI

Proxmox Virtual Environment (Proxmox VE) v7.0.0 published on Tuesday, Apr 1, 2025 by Daniel Muehlbachler-Pietrzykowski
muhlba91/pulumi-proxmoxve

Retrieves basic information about all available user groups.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as proxmoxve from "@pulumi/proxmoxve";

const availableGroups = proxmoxve.Permission.getGroups({});
Copy
import pulumi
import pulumi_proxmoxve as proxmoxve

available_groups = proxmoxve.Permission.get_groups()
Copy
package main

import (
	"github.com/muhlba91/pulumi-proxmoxve/sdk/v6/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
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using ProxmoxVE = Pulumi.ProxmoxVE;

return await Deployment.RunAsync(() => 
{
    var availableGroups = ProxmoxVE.Permission.GetGroups.Invoke();

});
Copy
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();

    }
}
Copy
variables:
  availableGroups:
    fn::invoke:
      function: proxmoxve:Permission:getGroups
      arguments: {}
Copy

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

> 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)
}
Copy
public static CompletableFuture<GetGroupsResult> getGroups(InvokeOptions options)
public static Output<GetGroupsResult> getGroups(InvokeOptions options)
Copy
fn::invoke:
  function: proxmoxve:Permission/getGroups:getGroups
  arguments:
    # arguments dictionary
Copy

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.
Proxmox Virtual Environment (Proxmox VE) v7.0.0 published on Tuesday, Apr 1, 2025 by Daniel Muehlbachler-Pietrzykowski
muhlba91/pulumi-proxmoxve