1. Packages
  2. Proxmox Virtual Environment (Proxmox VE)
  3. API Docs
  4. getContainer
Viewing docs for Proxmox Virtual Environment (Proxmox VE) v7.13.0
published on Tuesday, Feb 10, 2026 by Daniel Muehlbachler-Pietrzykowski
Schema (JSON)
muhlba91/pulumi-proxmoxve

proxmoxve.getContainer

proxmoxve logo
Viewing docs for Proxmox Virtual Environment (Proxmox VE) v7.13.0
published on Tuesday, Feb 10, 2026 by Daniel Muehlbachler-Pietrzykowski
Schema (JSON)
muhlba91/pulumi-proxmoxve

    Retrieves information about a specific Container.

    Example Usage

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

const testContainer = proxmoxve.getContainer({
    nodeName: "test",
    vmId: 100,
});

    import pulumi
import pulumi_proxmoxve as proxmoxve

test_container = proxmoxve.get_container(node_name="test",
    vm_id=100)

    package main

import (
	"github.com/muhlba91/pulumi-proxmoxve/sdk/v7/go/proxmoxve"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := proxmoxve.GetContainer(ctx, &proxmoxve.GetContainerArgs{
			NodeName: "test",
			VmId:     100,
		}, nil)
		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 testContainer = ProxmoxVE.GetContainer.Invoke(new()
    {
        NodeName = "test",
        VmId = 100,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.proxmoxve.ProxmoxveFunctions;
import com.pulumi.proxmoxve.inputs.GetContainerArgs;
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 testContainer = ProxmoxveFunctions.getContainer(GetContainerArgs.builder()
            .nodeName("test")
            .vmId(100)
            .build());

    }
}

    variables:
  testContainer:
    fn::invoke:
      function: proxmoxve:getContainer
      arguments:
        nodeName: test
        vmId: 100

    Using getContainer

    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 getContainer(args: GetContainerArgs, opts?: InvokeOptions): Promise<GetContainerResult>
function getContainerOutput(args: GetContainerOutputArgs, opts?: InvokeOptions): Output<GetContainerResult>
    def get_container(node_name: Optional[str] = None,
                  status: Optional[str] = None,
                  template: Optional[bool] = None,
                  vm_id: Optional[int] = None,
                  opts: Optional[InvokeOptions] = None) -> GetContainerResult
def get_container_output(node_name: Optional[pulumi.Input[str]] = None,
                  status: Optional[pulumi.Input[str]] = None,
                  template: Optional[pulumi.Input[bool]] = None,
                  vm_id: Optional[pulumi.Input[int]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetContainerResult]
    func GetContainer(ctx *Context, args *GetContainerArgs, opts ...InvokeOption) (*GetContainerResult, error)
func GetContainerOutput(ctx *Context, args *GetContainerOutputArgs, opts ...InvokeOption) GetContainerResultOutput

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

    public static class GetContainer 
{
    public static Task<GetContainerResult> InvokeAsync(GetContainerArgs args, InvokeOptions? opts = null)
    public static Output<GetContainerResult> Invoke(GetContainerInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetContainerResult> getContainer(GetContainerArgs args, InvokeOptions options)
public static Output<GetContainerResult> getContainer(GetContainerArgs args, InvokeOptions options)

    fn::invoke:
  function: proxmoxve:index/getContainer:getContainer
  arguments:
    # arguments dictionary

    The following arguments are supported:

    NodeName string
    The node name.
    VmId int
    The container identifier.
    Status string
    The status of the container.
    Template bool
    Whether the container is a template.
    NodeName string
    The node name.
    VmId int
    The container identifier.
    Status string
    The status of the container.
    Template bool
    Whether the container is a template.
    nodeName String
    The node name.
    vmId Integer
    The container identifier.
    status String
    The status of the container.
    template Boolean
    Whether the container is a template.
    nodeName string
    The node name.
    vmId number
    The container identifier.
    status string
    The status of the container.
    template boolean
    Whether the container is a template.
    node_name str
    The node name.
    vm_id int
    The container identifier.
    status str
    The status of the container.
    template bool
    Whether the container is a template.
    nodeName String
    The node name.
    vmId Number
    The container identifier.
    status String
    The status of the container.
    template Boolean
    Whether the container is a template.

    getContainer Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The container name.
    NodeName string
    Tags List<string>
    A list of tags of the container.
    VmId int
    Status string
    The status of the container.
    Template bool
    Whether the container is a template.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The container name.
    NodeName string
    Tags []string
    A list of tags of the container.
    VmId int
    Status string
    The status of the container.
    Template bool
    Whether the container is a template.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The container name.
    nodeName String
    tags List<String>
    A list of tags of the container.
    vmId Integer
    status String
    The status of the container.
    template Boolean
    Whether the container is a template.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The container name.
    nodeName string
    tags string[]
    A list of tags of the container.
    vmId number
    status string
    The status of the container.
    template boolean
    Whether the container is a template.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The container name.
    node_name str
    tags Sequence[str]
    A list of tags of the container.
    vm_id int
    status str
    The status of the container.
    template bool
    Whether the container is a template.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The container name.
    nodeName String
    tags List<String>
    A list of tags of the container.
    vmId Number
    status String
    The status of the container.
    template Boolean
    Whether the container is a template.

    Package Details

    Repository
    proxmoxve muhlba91/pulumi-proxmoxve
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the proxmox Terraform Provider.
    proxmoxve logo
    Viewing docs for Proxmox Virtual Environment (Proxmox VE) v7.13.0
    published on Tuesday, Feb 10, 2026 by Daniel Muehlbachler-Pietrzykowski
    Schema (JSON)
    muhlba91/pulumi-proxmoxve
      Try Pulumi Cloud free. Your team will thank you.