1. Packages
  2. Packages
  3. Proxmox Virtual Environment (Proxmox VE)
  4. API Docs
  5. getRoleLegacy
Viewing docs for Proxmox Virtual Environment (Proxmox VE) v8.1.0
published on Sunday, Apr 26, 2026 by Daniel Muehlbachler-Pietrzykowski
proxmoxve logo
Viewing docs for Proxmox Virtual Environment (Proxmox VE) v8.1.0
published on Sunday, Apr 26, 2026 by Daniel Muehlbachler-Pietrzykowski

    Retrieves information about a specific role.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as proxmoxve from "@muhlba91/pulumi-proxmoxve";
    
    const operationsRole = proxmoxve.getRoleLegacy({
        roleId: "operations",
    });
    
    import pulumi
    import pulumi_proxmoxve as proxmoxve
    
    operations_role = proxmoxve.get_role_legacy(role_id="operations")
    
    package main
    
    import (
    	"github.com/muhlba91/pulumi-proxmoxve/sdk/v8/go/proxmoxve"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := proxmoxve.GetRoleLegacy(ctx, &proxmoxve.LookupRoleLegacyArgs{
    			RoleId: "operations",
    		}, 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 operationsRole = ProxmoxVE.Index.GetRoleLegacy.Invoke(new()
        {
            RoleId = "operations",
        });
    
    });
    
    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.GetRoleLegacyArgs;
    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 operationsRole = ProxmoxveFunctions.getRoleLegacy(GetRoleLegacyArgs.builder()
                .roleId("operations")
                .build());
    
        }
    }
    
    variables:
      operationsRole:
        fn::invoke:
          function: proxmoxve:getRoleLegacy
          arguments:
            roleId: operations
    
    Example coming soon!
    

    Using getRoleLegacy

    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 getRoleLegacy(args: GetRoleLegacyArgs, opts?: InvokeOptions): Promise<GetRoleLegacyResult>
    function getRoleLegacyOutput(args: GetRoleLegacyOutputArgs, opts?: InvokeOptions): Output<GetRoleLegacyResult>
    def get_role_legacy(role_id: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetRoleLegacyResult
    def get_role_legacy_output(role_id: pulumi.Input[Optional[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetRoleLegacyResult]
    func LookupRoleLegacy(ctx *Context, args *LookupRoleLegacyArgs, opts ...InvokeOption) (*LookupRoleLegacyResult, error)
    func LookupRoleLegacyOutput(ctx *Context, args *LookupRoleLegacyOutputArgs, opts ...InvokeOption) LookupRoleLegacyResultOutput

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

    public static class GetRoleLegacy 
    {
        public static Task<GetRoleLegacyResult> InvokeAsync(GetRoleLegacyArgs args, InvokeOptions? opts = null)
        public static Output<GetRoleLegacyResult> Invoke(GetRoleLegacyInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetRoleLegacyResult> getRoleLegacy(GetRoleLegacyArgs args, InvokeOptions options)
    public static Output<GetRoleLegacyResult> getRoleLegacy(GetRoleLegacyArgs args, InvokeOptions options)
    
    fn::invoke:
      function: proxmoxve:index/getRoleLegacy:getRoleLegacy
      arguments:
        # arguments dictionary
    data "proxmoxve_getrolelegacy" "name" {
        # arguments
    }

    The following arguments are supported:

    RoleId string
    The role identifier.
    RoleId string
    The role identifier.
    role_id string
    The role identifier.
    roleId String
    The role identifier.
    roleId string
    The role identifier.
    role_id str
    The role identifier.
    roleId String
    The role identifier.

    getRoleLegacy Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Privileges List<string>
    The role privileges
    RoleId string
    Id string
    The provider-assigned unique ID for this managed resource.
    Privileges []string
    The role privileges
    RoleId string
    id string
    The provider-assigned unique ID for this managed resource.
    privileges list(string)
    The role privileges
    role_id string
    id String
    The provider-assigned unique ID for this managed resource.
    privileges List<String>
    The role privileges
    roleId String
    id string
    The provider-assigned unique ID for this managed resource.
    privileges string[]
    The role privileges
    roleId string
    id str
    The provider-assigned unique ID for this managed resource.
    privileges Sequence[str]
    The role privileges
    role_id str
    id String
    The provider-assigned unique ID for this managed resource.
    privileges List<String>
    The role privileges
    roleId String

    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.1.0
    published on Sunday, Apr 26, 2026 by Daniel Muehlbachler-Pietrzykowski
      Try Pulumi Cloud free. Your team will thank you.