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

proxmoxve.Permission.getRoles

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 all the available roles.

Example Usage

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

const availableRoles = proxmoxve.Permission.getRoles({});
Copy
import pulumi
import pulumi_proxmoxve as proxmoxve

available_roles = proxmoxve.Permission.get_roles()
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.GetRoles(ctx, map[string]interface{}{}, 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 availableRoles = ProxmoxVE.Permission.GetRoles.Invoke();

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.proxmoxve.Permission.PermissionFunctions;
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 availableRoles = PermissionFunctions.getRoles();

    }
}
Copy
variables:
  availableRoles:
    fn::invoke:
      function: proxmoxve:Permission:getRoles
      arguments: {}
Copy

Using getRoles

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 getRoles(opts?: InvokeOptions): Promise<GetRolesResult>
function getRolesOutput(opts?: InvokeOptions): Output<GetRolesResult>
Copy
def get_roles(opts: Optional[InvokeOptions] = None) -> GetRolesResult
def get_roles_output(opts: Optional[InvokeOptions] = None) -> Output[GetRolesResult]
Copy
func GetRoles(ctx *Context, opts ...InvokeOption) (*GetRolesResult, error)
func GetRolesOutput(ctx *Context, opts ...InvokeOption) GetRolesResultOutput
Copy

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

public static class GetRoles 
{
    public static Task<GetRolesResult> InvokeAsync(InvokeOptions? opts = null)
    public static Output<GetRolesResult> Invoke(InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetRolesResult> getRoles(InvokeOptions options)
public static Output<GetRolesResult> getRoles(InvokeOptions options)
Copy
fn::invoke:
  function: proxmoxve:Permission/getRoles:getRoles
  arguments:
    # arguments dictionary
Copy

getRoles Result

The following output properties are available:

Id string
The provider-assigned unique ID for this managed resource.
Privileges List<ImmutableArray<string>>
The role privileges.
RoleIds List<string>
The role identifiers.
Specials List<bool>
Whether the role is special (built-in).
Id string
The provider-assigned unique ID for this managed resource.
Privileges [][]string
The role privileges.
RoleIds []string
The role identifiers.
Specials []bool
Whether the role is special (built-in).
id String
The provider-assigned unique ID for this managed resource.
privileges List<List<String>>
The role privileges.
roleIds List<String>
The role identifiers.
specials List<Boolean>
Whether the role is special (built-in).
id string
The provider-assigned unique ID for this managed resource.
privileges string[][]
The role privileges.
roleIds string[]
The role identifiers.
specials boolean[]
Whether the role is special (built-in).
id str
The provider-assigned unique ID for this managed resource.
privileges Sequence[Sequence[str]]
The role privileges.
role_ids Sequence[str]
The role identifiers.
specials Sequence[bool]
Whether the role is special (built-in).
id String
The provider-assigned unique ID for this managed resource.
privileges List<List<String>>
The role privileges.
roleIds List<String>
The role identifiers.
specials List<Boolean>
Whether the role is special (built-in).

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