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

proxmoxve.Permission.getPool

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 information about a specific resource pool.

Example Usage

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

const operationsPool = proxmoxve.Permission.getPool({
    poolId: "operations",
});
Copy
import pulumi
import pulumi_proxmoxve as proxmoxve

operations_pool = proxmoxve.Permission.get_pool(pool_id="operations")
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.GetPool(ctx, &permission.GetPoolArgs{
			PoolId: "operations",
		}, 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 operationsPool = ProxmoxVE.Permission.GetPool.Invoke(new()
    {
        PoolId = "operations",
    });

});
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.GetPoolArgs;
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 operationsPool = PermissionFunctions.getPool(GetPoolArgs.builder()
            .poolId("operations")
            .build());

    }
}
Copy
variables:
  operationsPool:
    fn::invoke:
      function: proxmoxve:Permission:getPool
      arguments:
        poolId: operations
Copy

Using getPool

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 getPool(args: GetPoolArgs, opts?: InvokeOptions): Promise<GetPoolResult>
function getPoolOutput(args: GetPoolOutputArgs, opts?: InvokeOptions): Output<GetPoolResult>
Copy
def get_pool(pool_id: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetPoolResult
def get_pool_output(pool_id: Optional[pulumi.Input[str]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetPoolResult]
Copy
func GetPool(ctx *Context, args *GetPoolArgs, opts ...InvokeOption) (*GetPoolResult, error)
func GetPoolOutput(ctx *Context, args *GetPoolOutputArgs, opts ...InvokeOption) GetPoolResultOutput
Copy

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

public static class GetPool 
{
    public static Task<GetPoolResult> InvokeAsync(GetPoolArgs args, InvokeOptions? opts = null)
    public static Output<GetPoolResult> Invoke(GetPoolInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetPoolResult> getPool(GetPoolArgs args, InvokeOptions options)
public static Output<GetPoolResult> getPool(GetPoolArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: proxmoxve:Permission/getPool:getPool
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

PoolId This property is required. string
The pool identifier.
PoolId This property is required. string
The pool identifier.
poolId This property is required. String
The pool identifier.
poolId This property is required. string
The pool identifier.
pool_id This property is required. str
The pool identifier.
poolId This property is required. String
The pool identifier.

getPool Result

The following output properties are available:

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

Supporting Types

GetPoolMember

DatastoreId This property is required. string
The datastore identifier.
Id This property is required. string
The member identifier.
NodeName This property is required. string
The node name.
Type This property is required. string
The member type.
VmId This property is required. int
The virtual machine identifier.
DatastoreId This property is required. string
The datastore identifier.
Id This property is required. string
The member identifier.
NodeName This property is required. string
The node name.
Type This property is required. string
The member type.
VmId This property is required. int
The virtual machine identifier.
datastoreId This property is required. String
The datastore identifier.
id This property is required. String
The member identifier.
nodeName This property is required. String
The node name.
type This property is required. String
The member type.
vmId This property is required. Integer
The virtual machine identifier.
datastoreId This property is required. string
The datastore identifier.
id This property is required. string
The member identifier.
nodeName This property is required. string
The node name.
type This property is required. string
The member type.
vmId This property is required. number
The virtual machine identifier.
datastore_id This property is required. str
The datastore identifier.
id This property is required. str
The member identifier.
node_name This property is required. str
The node name.
type This property is required. str
The member type.
vm_id This property is required. int
The virtual machine identifier.
datastoreId This property is required. String
The datastore identifier.
id This property is required. String
The member identifier.
nodeName This property is required. String
The node name.
type This property is required. String
The member type.
vmId This property is required. Number
The virtual machine 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) v7.0.0 published on Tuesday, Apr 1, 2025 by Daniel Muehlbachler-Pietrzykowski
muhlba91/pulumi-proxmoxve