1. Packages
  2. Proxmox Virtual Environment (Proxmox VE)
  3. API Docs
  4. pool
  5. Membership
Viewing docs for Proxmox Virtual Environment (Proxmox VE) v8.0.0
published on Sunday, Apr 5, 2026 by Daniel Muehlbachler-Pietrzykowski
Schema (JSON)
muhlba91/pulumi-proxmoxve

proxmoxve.pool.Membership

proxmoxve logo
Viewing docs for Proxmox Virtual Environment (Proxmox VE) v8.0.0
published on Sunday, Apr 5, 2026 by Daniel Muehlbachler-Pietrzykowski
Schema (JSON)
muhlba91/pulumi-proxmoxve

    Manages resource pool memberships for containers, virtual machines and storages

    This resource requires the Pool.Allocate permission on the pool path (e.g., /pool/{poolid}).

    Create Membership Resource

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

    Constructor syntax

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

@overload
def Membership(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               pool_id: Optional[str] = None,
               storage_id: Optional[str] = None,
               vm_id: Optional[int] = None)
    func NewMembership(ctx *Context, name string, args MembershipArgs, opts ...ResourceOption) (*Membership, error)
    public Membership(string name, MembershipArgs args, CustomResourceOptions? opts = null)
    public Membership(String name, MembershipArgs args)
public Membership(String name, MembershipArgs args, CustomResourceOptions options)

    type: proxmoxve:pool:Membership
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 MembershipArgs
    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 MembershipArgs
    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 MembershipArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MembershipArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MembershipArgs
    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 membershipResource = new ProxmoxVE.Pool.Membership("membershipResource", new()
{
    PoolId = "string",
    StorageId = "string",
    VmId = 0,
});

    example, err := pool.NewMembership(ctx, "membershipResource", &pool.MembershipArgs{
	PoolId:    pulumi.String("string"),
	StorageId: pulumi.String("string"),
	VmId:      pulumi.Int(0),
})

    var membershipResource = new Membership("membershipResource", MembershipArgs.builder()
    .poolId("string")
    .storageId("string")
    .vmId(0)
    .build());

    membership_resource = proxmoxve.pool.Membership("membershipResource",
    pool_id="string",
    storage_id="string",
    vm_id=0)

    const membershipResource = new proxmoxve.pool.Membership("membershipResource", {
    poolId: "string",
    storageId: "string",
    vmId: 0,
});

    type: proxmoxve:pool:Membership
properties:
    poolId: string
    storageId: string
    vmId: 0

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

    PoolId string
    Resource pool id
    StorageId string
    Storage id
    VmId int
    VM or CT id
    PoolId string
    Resource pool id
    StorageId string
    Storage id
    VmId int
    VM or CT id
    poolId String
    Resource pool id
    storageId String
    Storage id
    vmId Integer
    VM or CT id
    poolId string
    Resource pool id
    storageId string
    Storage id
    vmId number
    VM or CT id
    pool_id str
    Resource pool id
    storage_id str
    Storage id
    vm_id int
    VM or CT id
    poolId String
    Resource pool id
    storageId String
    Storage id
    vmId Number
    VM or CT id

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Type string
    Resource pool membership type (can be vm for VMs and CTs or storage for storages)
    Id string
    The provider-assigned unique ID for this managed resource.
    Type string
    Resource pool membership type (can be vm for VMs and CTs or storage for storages)
    id String
    The provider-assigned unique ID for this managed resource.
    type String
    Resource pool membership type (can be vm for VMs and CTs or storage for storages)
    id string
    The provider-assigned unique ID for this managed resource.
    type string
    Resource pool membership type (can be vm for VMs and CTs or storage for storages)
    id str
    The provider-assigned unique ID for this managed resource.
    type str
    Resource pool membership type (can be vm for VMs and CTs or storage for storages)
    id String
    The provider-assigned unique ID for this managed resource.
    type String
    Resource pool membership type (can be vm for VMs and CTs or storage for storages)

    Look up Existing Membership Resource

    Get an existing Membership 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?: MembershipState, opts?: CustomResourceOptions): Membership
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        pool_id: Optional[str] = None,
        storage_id: Optional[str] = None,
        type: Optional[str] = None,
        vm_id: Optional[int] = None) -> Membership
    func GetMembership(ctx *Context, name string, id IDInput, state *MembershipState, opts ...ResourceOption) (*Membership, error)
    public static Membership Get(string name, Input<string> id, MembershipState? state, CustomResourceOptions? opts = null)
    public static Membership get(String name, Output<String> id, MembershipState state, CustomResourceOptions options)
    resources:  _:    type: proxmoxve:pool:Membership    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:
    PoolId string
    Resource pool id
    StorageId string
    Storage id
    Type string
    Resource pool membership type (can be vm for VMs and CTs or storage for storages)
    VmId int
    VM or CT id
    PoolId string
    Resource pool id
    StorageId string
    Storage id
    Type string
    Resource pool membership type (can be vm for VMs and CTs or storage for storages)
    VmId int
    VM or CT id
    poolId String
    Resource pool id
    storageId String
    Storage id
    type String
    Resource pool membership type (can be vm for VMs and CTs or storage for storages)
    vmId Integer
    VM or CT id
    poolId string
    Resource pool id
    storageId string
    Storage id
    type string
    Resource pool membership type (can be vm for VMs and CTs or storage for storages)
    vmId number
    VM or CT id
    pool_id str
    Resource pool id
    storage_id str
    Storage id
    type str
    Resource pool membership type (can be vm for VMs and CTs or storage for storages)
    vm_id int
    VM or CT id
    poolId String
    Resource pool id
    storageId String
    Storage id
    type String
    Resource pool membership type (can be vm for VMs and CTs or storage for storages)
    vmId Number
    VM or CT id

    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) v8.0.0
    published on Sunday, Apr 5, 2026 by Daniel Muehlbachler-Pietrzykowski
    Schema (JSON)
    muhlba91/pulumi-proxmoxve
      Try Pulumi Cloud free. Your team will thank you.