Proxmox Virtual Environment (Proxmox VE) v6.18.1, Jan 7 25

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

proxmoxve.Permission.Group

Explore with Pulumi AI

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

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

const operationsTeam = new proxmoxve.permission.Group("operationsTeam", {
    comment: "Managed by Pulumi",
    groupId: "operations-team",
});

import pulumi
import pulumi_proxmoxve as proxmoxve

operations_team = proxmoxve.permission.Group("operationsTeam",
    comment="Managed by Pulumi",
    group_id="operations-team")

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.NewGroup(ctx, "operationsTeam", &Permission.GroupArgs{
			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.Permission.Group("operationsTeam", 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 com.pulumi.proxmoxve.Permission.Group;
import com.pulumi.proxmoxve.Permission.GroupArgs;
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 Group("operationsTeam", GroupArgs.builder()
            .comment("Managed by Pulumi")
            .groupId("operations-team")
            .build());

    }
}

resources:
  operationsTeam:
    type: proxmoxve:Permission:Group
    properties:
      comment: Managed by Pulumi
      groupId: operations-team

Create Group Resource

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

Constructor syntax

TypeScript
Python
Go
C#
Java
YAML

new Group(name: string, args: GroupArgs, opts?: CustomResourceOptions);

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

@overload
def Group(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          group_id: Optional[str] = None,
          acls: Optional[Sequence[_permission.GroupAclArgs]] = None,
          comment: Optional[str] = None)

func NewGroup(ctx *Context, name string, args GroupArgs, opts ...ResourceOption) (*Group, error)

public Group(string name, GroupArgs args, CustomResourceOptions? opts = null)

public Group(String name, GroupArgs args)
public Group(String name, GroupArgs args, CustomResourceOptions options)

type: proxmoxve:Permission:Group
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 GroupArgs: 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 GroupArgs: 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 GroupArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

name String: The unique name of the resource.
args GroupArgs: 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.

TypeScript
Python
Go
C#
Java
YAML

var groupResource = new ProxmoxVE.Permission.Group("groupResource", new()
{
    GroupId = "string",
    Acls = new[]
    {
        new ProxmoxVE.Permission.Inputs.GroupAclArgs
        {
            Path = "string",
            RoleId = "string",
            Propagate = false,
        },
    },
    Comment = "string",
});

example, err := Permission.NewGroup(ctx, "groupResource", &Permission.GroupArgs{
	GroupId: pulumi.String("string"),
	Acls: permission.GroupAclArray{
		&permission.GroupAclArgs{
			Path:      pulumi.String("string"),
			RoleId:    pulumi.String("string"),
			Propagate: pulumi.Bool(false),
		},
	},
	Comment: pulumi.String("string"),
})

var groupResource = new Group("groupResource", GroupArgs.builder()
    .groupId("string")
    .acls(GroupAclArgs.builder()
        .path("string")
        .roleId("string")
        .propagate(false)
        .build())
    .comment("string")
    .build());

group_resource = proxmoxve.permission.Group("groupResource",
    group_id="string",
    acls=[{
        "path": "string",
        "role_id": "string",
        "propagate": False,
    }],
    comment="string")

const groupResource = new proxmoxve.permission.Group("groupResource", {
    groupId: "string",
    acls: [{
        path: "string",
        roleId: "string",
        propagate: false,
    }],
    comment: "string",
});

type: proxmoxve:Permission:Group
properties:
    acls:
        - path: string
          propagate: false
          roleId: string
    comment: string
    groupId: string

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

GroupId string: The group identifier.
Acls List<Pulumi.ProxmoxVE.Permission.Inputs.GroupAcl>: The access control list (multiple blocks supported).
Comment string: The group comment.

GroupId string: The group identifier.
Acls []GroupAclArgs: The access control list (multiple blocks supported).
Comment string: The group comment.

groupId String: The group identifier.
acls List<GroupAcl>: The access control list (multiple blocks supported).
comment String: The group comment.

groupId string: The group identifier.
acls GroupAcl[]: The access control list (multiple blocks supported).
comment string: The group comment.

group_id str: The group identifier.
acls Sequence[permission.GroupAclArgs]: 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 Group 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 Group Resource

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

TypeScript
Python
Go
C#
Java
YAML

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        acls: Optional[Sequence[_permission.GroupAclArgs]] = None,
        comment: Optional[str] = None,
        group_id: Optional[str] = None,
        members: Optional[Sequence[str]] = None) -> Group

func GetGroup(ctx *Context, name string, id IDInput, state *GroupState, opts ...ResourceOption) (*Group, error)

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

public static Group get(String name, Output<String> id, GroupState state, CustomResourceOptions options)

resources:  _:    type: proxmoxve:Permission:Group    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.Permission.Inputs.GroupAcl>: 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 []GroupAclArgs: 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<GroupAcl>: 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 GroupAcl[]: 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[permission.GroupAclArgs]: 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

GroupAcl
, GroupAclArgs

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 group_id, e.g.,

bash

$ pulumi import proxmoxve:Permission/group:Group 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.

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

muhlba91/pulumi-proxmoxve

proxmoxve.Permission.Group

On this page

On this page

Example Usage

Create Group Resource

Constructor syntax

Parameters

Constructor example

Group Resource Properties

Inputs

Outputs

Look up Existing Group Resource

Supporting Types

GroupAcl
, GroupAclArgs

Import

Package Details

On this page

On this page

proxmoxve.Permission.Group

On this page

On this page

Example Usage

Create Group Resource

Constructor syntax

Parameters

Constructor example

Group Resource Properties

Inputs

Outputs

Look up Existing Group Resource

Supporting Types

GroupAcl, GroupAclArgs

Import

Package Details

On this page

On this page

GroupAcl
, GroupAclArgs