1. Packages
  2. Proxmox Virtual Environment (Proxmox VE)
  3. API Docs
  4. Permission
  5. getGroup
Proxmox Virtual Environment (Proxmox VE) v6.18.1 published on Tuesday, Jan 7, 2025 by Daniel Muehlbachler-Pietrzykowski

proxmoxve.Permission.getGroup

Explore with Pulumi AI

Proxmox Virtual Environment (Proxmox VE) v6.18.1 published on Tuesday, Jan 7, 2025 by Daniel Muehlbachler-Pietrzykowski

Retrieves information about a specific user group.

Example Usage

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

const operationsTeam = proxmoxve.Permission.getGroup({
    groupId: "operations-team",
});
Copy
import pulumi
import pulumi_proxmoxve as proxmoxve

operations_team = proxmoxve.Permission.get_group(group_id="operations-team")
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.GetGroup(ctx, &permission.GetGroupArgs{
			GroupId: "operations-team",
		}, 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 operationsTeam = ProxmoxVE.Permission.GetGroup.Invoke(new()
    {
        GroupId = "operations-team",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.proxmoxve.Permission.PermissionFunctions;
import com.pulumi.proxmoxve.Permission.inputs.GetGroupArgs;
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 operationsTeam = PermissionFunctions.getGroup(GetGroupArgs.builder()
            .groupId("operations-team")
            .build());

    }
}
Copy
variables:
  operationsTeam:
    fn::invoke:
      function: proxmoxve:Permission:getGroup
      arguments:
        groupId: operations-team
Copy

Using getGroup

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 getGroup(args: GetGroupArgs, opts?: InvokeOptions): Promise<GetGroupResult>
function getGroupOutput(args: GetGroupOutputArgs, opts?: InvokeOptions): Output<GetGroupResult>
Copy
def get_group(group_id: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetGroupResult
def get_group_output(group_id: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetGroupResult]
Copy
func GetGroup(ctx *Context, args *GetGroupArgs, opts ...InvokeOption) (*GetGroupResult, error)
func GetGroupOutput(ctx *Context, args *GetGroupOutputArgs, opts ...InvokeOption) GetGroupResultOutput
Copy

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

public static class GetGroup 
{
    public static Task<GetGroupResult> InvokeAsync(GetGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetGroupResult> Invoke(GetGroupInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetGroupResult> getGroup(GetGroupArgs args, InvokeOptions options)
public static Output<GetGroupResult> getGroup(GetGroupArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: proxmoxve:Permission/getGroup:getGroup
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

GroupId This property is required. string
The group identifier.
GroupId This property is required. string
The group identifier.
groupId This property is required. String
The group identifier.
groupId This property is required. string
The group identifier.
group_id This property is required. str
The group identifier.
groupId This property is required. String
The group identifier.

getGroup Result

The following output properties are available:

Acls List<Pulumi.ProxmoxVE.Permission.Outputs.GetGroupAcl>
The access control list.
Comment string
The group comment.
GroupId string
Id string
The provider-assigned unique ID for this managed resource.
Members List<string>
The group members as a list with username@realm entries.
Acls []GetGroupAcl
The access control list.
Comment string
The group comment.
GroupId string
Id string
The provider-assigned unique ID for this managed resource.
Members []string
The group members as a list with username@realm entries.
acls List<GetGroupAcl>
The access control list.
comment String
The group comment.
groupId String
id String
The provider-assigned unique ID for this managed resource.
members List<String>
The group members as a list with username@realm entries.
acls GetGroupAcl[]
The access control list.
comment string
The group comment.
groupId string
id string
The provider-assigned unique ID for this managed resource.
members string[]
The group members as a list with username@realm entries.
acls Sequence[permission.GetGroupAcl]
The access control list.
comment str
The group comment.
group_id str
id str
The provider-assigned unique ID for this managed resource.
members Sequence[str]
The group members as a list with username@realm entries.
acls List<Property Map>
The access control list.
comment String
The group comment.
groupId String
id String
The provider-assigned unique ID for this managed resource.
members List<String>
The group members as a list with username@realm entries.

Supporting Types

GetGroupAcl

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

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) v6.18.1 published on Tuesday, Jan 7, 2025 by Daniel Muehlbachler-Pietrzykowski