1. Packages
  2. Proxmox Virtual Environment (Proxmox VE)
  3. API Docs
  4. Permission
  5. Pool
Proxmox Virtual Environment (Proxmox VE) v7.0.0 published on Tuesday, Apr 1, 2025 by Daniel Muehlbachler-Pietrzykowski

proxmoxve.Permission.Pool

Explore with Pulumi AI

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

Manages a resource pool.

Example Usage

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

const operationsPool = new proxmoxve.permission.Pool("operationsPool", {
    comment: "Managed by Pulumi",
    poolId: "operations-pool",
});
Copy
import pulumi
import pulumi_proxmoxve as proxmoxve

operations_pool = proxmoxve.permission.Pool("operationsPool",
    comment="Managed by Pulumi",
    pool_id="operations-pool")
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.NewPool(ctx, "operationsPool", &permission.PoolArgs{
			Comment: pulumi.String("Managed by Pulumi"),
			PoolId:  pulumi.String("operations-pool"),
		})
		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 operationsPool = new ProxmoxVE.Permission.Pool("operationsPool", new()
    {
        Comment = "Managed by Pulumi",
        PoolId = "operations-pool",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.proxmoxve.Permission.Pool;
import com.pulumi.proxmoxve.Permission.PoolArgs;
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 operationsPool = new Pool("operationsPool", PoolArgs.builder()
            .comment("Managed by Pulumi")
            .poolId("operations-pool")
            .build());

    }
}
Copy
resources:
  operationsPool:
    type: proxmoxve:Permission:Pool
    properties:
      comment: Managed by Pulumi
      poolId: operations-pool
Copy

Create Pool Resource

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

Constructor syntax

new Pool(name: string, args: PoolArgs, opts?: CustomResourceOptions);
@overload
def Pool(resource_name: str,
         args: PoolArgs,
         opts: Optional[ResourceOptions] = None)

@overload
def Pool(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         pool_id: Optional[str] = None,
         comment: Optional[str] = None)
func NewPool(ctx *Context, name string, args PoolArgs, opts ...ResourceOption) (*Pool, error)
public Pool(string name, PoolArgs args, CustomResourceOptions? opts = null)
public Pool(String name, PoolArgs args)
public Pool(String name, PoolArgs args, CustomResourceOptions options)
type: proxmoxve:Permission:Pool
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. PoolArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. PoolArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. PoolArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. PoolArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. PoolArgs
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 poolResource = new ProxmoxVE.Permission.Pool("poolResource", new()
{
    PoolId = "string",
    Comment = "string",
});
Copy
example, err := Permission.NewPool(ctx, "poolResource", &Permission.PoolArgs{
	PoolId:  pulumi.String("string"),
	Comment: pulumi.String("string"),
})
Copy
var poolResource = new Pool("poolResource", PoolArgs.builder()
    .poolId("string")
    .comment("string")
    .build());
Copy
pool_resource = proxmoxve.permission.Pool("poolResource",
    pool_id="string",
    comment="string")
Copy
const poolResource = new proxmoxve.permission.Pool("poolResource", {
    poolId: "string",
    comment: "string",
});
Copy
type: proxmoxve:Permission:Pool
properties:
    comment: string
    poolId: string
Copy

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

PoolId
This property is required.
Changes to this property will trigger replacement.
string
The pool identifier.
Comment string
The pool comment.
PoolId
This property is required.
Changes to this property will trigger replacement.
string
The pool identifier.
Comment string
The pool comment.
poolId
This property is required.
Changes to this property will trigger replacement.
String
The pool identifier.
comment String
The pool comment.
poolId
This property is required.
Changes to this property will trigger replacement.
string
The pool identifier.
comment string
The pool comment.
pool_id
This property is required.
Changes to this property will trigger replacement.
str
The pool identifier.
comment str
The pool comment.
poolId
This property is required.
Changes to this property will trigger replacement.
String
The pool identifier.
comment String
The pool comment.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Members List<Pulumi.ProxmoxVE.Permission.Outputs.PoolMember>
The pool members.
Id string
The provider-assigned unique ID for this managed resource.
Members []PoolMember
The pool members.
id String
The provider-assigned unique ID for this managed resource.
members List<PoolMember>
The pool members.
id string
The provider-assigned unique ID for this managed resource.
members PoolMember[]
The pool members.
id str
The provider-assigned unique ID for this managed resource.
members Sequence[permission.PoolMember]
The pool members.
id String
The provider-assigned unique ID for this managed resource.
members List<Property Map>
The pool members.

Look up Existing Pool Resource

Get an existing Pool 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?: PoolState, opts?: CustomResourceOptions): Pool
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        comment: Optional[str] = None,
        members: Optional[Sequence[_permission.PoolMemberArgs]] = None,
        pool_id: Optional[str] = None) -> Pool
func GetPool(ctx *Context, name string, id IDInput, state *PoolState, opts ...ResourceOption) (*Pool, error)
public static Pool Get(string name, Input<string> id, PoolState? state, CustomResourceOptions? opts = null)
public static Pool get(String name, Output<String> id, PoolState state, CustomResourceOptions options)
resources:  _:    type: proxmoxve:Permission:Pool    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Comment string
The pool comment.
Members List<Pulumi.ProxmoxVE.Permission.Inputs.PoolMember>
The pool members.
PoolId Changes to this property will trigger replacement. string
The pool identifier.
Comment string
The pool comment.
Members []PoolMemberArgs
The pool members.
PoolId Changes to this property will trigger replacement. string
The pool identifier.
comment String
The pool comment.
members List<PoolMember>
The pool members.
poolId Changes to this property will trigger replacement. String
The pool identifier.
comment string
The pool comment.
members PoolMember[]
The pool members.
poolId Changes to this property will trigger replacement. string
The pool identifier.
comment str
The pool comment.
members Sequence[permission.PoolMemberArgs]
The pool members.
pool_id Changes to this property will trigger replacement. str
The pool identifier.
comment String
The pool comment.
members List<Property Map>
The pool members.
poolId Changes to this property will trigger replacement. String
The pool identifier.

Supporting Types

PoolMember
, PoolMemberArgs

DatastoreId string
The datastore identifier.
Id string
The member identifier.
NodeName string
The node name.
Type string
The member type.
VmId int
The virtual machine identifier.
DatastoreId string
The datastore identifier.
Id string
The member identifier.
NodeName string
The node name.
Type string
The member type.
VmId int
The virtual machine identifier.
datastoreId String
The datastore identifier.
id String
The member identifier.
nodeName String
The node name.
type String
The member type.
vmId Integer
The virtual machine identifier.
datastoreId string
The datastore identifier.
id string
The member identifier.
nodeName string
The node name.
type string
The member type.
vmId number
The virtual machine identifier.
datastore_id str
The datastore identifier.
id str
The member identifier.
node_name str
The node name.
type str
The member type.
vm_id int
The virtual machine identifier.
datastoreId String
The datastore identifier.
id String
The member identifier.
nodeName String
The node name.
type String
The member type.
vmId Number
The virtual machine identifier.

Import

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

bash

$ pulumi import proxmoxve:Permission/pool:Pool operations_pool operations-pool
Copy

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) v7.0.0 published on Tuesday, Apr 1, 2025 by Daniel Muehlbachler-Pietrzykowski