vsphere.Role

vSphere v4.16.3, Feb 26 26

Viewing docs for vSphere v4.16.3
published on Thursday, Feb 26, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-vsphere

Viewing docs for vSphere v4.16.3
published on Thursday, Feb 26, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-vsphere

Example Usage

This example creates a role with name my_terraform_role and privileges create, acknowledge for Alarm and create, move for Datacenter. While providing role_privileges, the id of the privilege has to be provided. The format of the privilege id is privilege name preceded by its categories joined by a .. For example a privilege with path category->subcategory->privilege should be provided as category.subcategory.privilege. Keep the role_privileges sorted alphabetically for a better user experience.

NOTE: While providing role_privileges, the id of the privilege and its categories are to be provided joined by a . .

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

const role1 = new vsphere.Role("role1", {
    name: "my_terraform_role",
    rolePrivileges: [
        "Alarm.Acknowledge",
        "Alarm.Create",
        "Datacenter.Create",
        "Datacenter.Move",
    ],
});

import pulumi
import pulumi_vsphere as vsphere

role1 = vsphere.Role("role1",
    name="my_terraform_role",
    role_privileges=[
        "Alarm.Acknowledge",
        "Alarm.Create",
        "Datacenter.Create",
        "Datacenter.Move",
    ])

package main

import (
	"github.com/pulumi/pulumi-vsphere/sdk/v4/go/vsphere"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vsphere.NewRole(ctx, "role1", &vsphere.RoleArgs{
			Name: pulumi.String("my_terraform_role"),
			RolePrivileges: pulumi.StringArray{
				pulumi.String("Alarm.Acknowledge"),
				pulumi.String("Alarm.Create"),
				pulumi.String("Datacenter.Create"),
				pulumi.String("Datacenter.Move"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using VSphere = Pulumi.VSphere;

return await Deployment.RunAsync(() => 
{
    var role1 = new VSphere.Role("role1", new()
    {
        Name = "my_terraform_role",
        RolePrivileges = new[]
        {
            "Alarm.Acknowledge",
            "Alarm.Create",
            "Datacenter.Create",
            "Datacenter.Move",
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vsphere.Role;
import com.pulumi.vsphere.RoleArgs;
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) {
        var role1 = new Role("role1", RoleArgs.builder()
            .name("my_terraform_role")
            .rolePrivileges(            
                "Alarm.Acknowledge",
                "Alarm.Create",
                "Datacenter.Create",
                "Datacenter.Move")
            .build());

    }
}

resources:
  role1:
    type: vsphere:Role
    properties:
      name: my_terraform_role
      rolePrivileges:
        - Alarm.Acknowledge
        - Alarm.Create
        - Datacenter.Create
        - Datacenter.Move

Create Role Resource

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

Constructor syntax

new Role(name: string, args?: RoleArgs, opts?: CustomResourceOptions);

@overload
def Role(resource_name: str,
         args: Optional[RoleArgs] = None,
         opts: Optional[ResourceOptions] = None)

@overload
def Role(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         name: Optional[str] = None,
         role_privileges: Optional[Sequence[str]] = None)

func NewRole(ctx *Context, name string, args *RoleArgs, opts ...ResourceOption) (*Role, error)

public Role(string name, RoleArgs? args = null, CustomResourceOptions? opts = null)

public Role(String name, RoleArgs args)
public Role(String name, RoleArgs args, CustomResourceOptions options)

type: vsphere:Role
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 RoleArgs: 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 RoleArgs: 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 RoleArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args RoleArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args RoleArgs: 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 roleResource = new VSphere.Role("roleResource", new()
{
    Name = "string",
    RolePrivileges = new[]
    {
        "string",
    },
});

example, err := vsphere.NewRole(ctx, "roleResource", &vsphere.RoleArgs{
	Name: pulumi.String("string"),
	RolePrivileges: pulumi.StringArray{
		pulumi.String("string"),
	},
})

var roleResource = new Role("roleResource", RoleArgs.builder()
    .name("string")
    .rolePrivileges("string")
    .build());

role_resource = vsphere.Role("roleResource",
    name="string",
    role_privileges=["string"])

const roleResource = new vsphere.Role("roleResource", {
    name: "string",
    rolePrivileges: ["string"],
});

type: vsphere:Role
properties:
    name: string
    rolePrivileges:
        - string

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

Name string: The name of the role.
RolePrivileges List<string>: The privileges to be associated with this role.

Name string: The name of the role.
RolePrivileges []string: The privileges to be associated with this role.

name String: The name of the role.
rolePrivileges List<String>: The privileges to be associated with this role.

name string: The name of the role.
rolePrivileges string[]: The privileges to be associated with this role.

name str: The name of the role.
role_privileges Sequence[str]: The privileges to be associated with this role.

name String: The name of the role.
rolePrivileges List<String>: The privileges to be associated with this role.

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.
Label string: The display label of the role.

Id string: The provider-assigned unique ID for this managed resource.
Label string: The display label of the role.

id String: The provider-assigned unique ID for this managed resource.
label String: The display label of the role.

id string: The provider-assigned unique ID for this managed resource.
label string: The display label of the role.

id str: The provider-assigned unique ID for this managed resource.
label str: The display label of the role.

id String: The provider-assigned unique ID for this managed resource.
label String: The display label of the role.

Look up Existing Role Resource

Get an existing Role 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?: RoleState, opts?: CustomResourceOptions): Role

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        label: Optional[str] = None,
        name: Optional[str] = None,
        role_privileges: Optional[Sequence[str]] = None) -> Role

func GetRole(ctx *Context, name string, id IDInput, state *RoleState, opts ...ResourceOption) (*Role, error)

public static Role Get(string name, Input<string> id, RoleState? state, CustomResourceOptions? opts = null)

public static Role get(String name, Output<String> id, RoleState state, CustomResourceOptions options)

resources:  _:    type: vsphere:Role    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:

Label string: The display label of the role.
Name string: The name of the role.
RolePrivileges List<string>: The privileges to be associated with this role.

Label string: The display label of the role.
Name string: The name of the role.
RolePrivileges []string: The privileges to be associated with this role.

label String: The display label of the role.
name String: The name of the role.
rolePrivileges List<String>: The privileges to be associated with this role.

label string: The display label of the role.
name string: The name of the role.
rolePrivileges string[]: The privileges to be associated with this role.

label str: The display label of the role.
name str: The name of the role.
role_privileges Sequence[str]: The privileges to be associated with this role.

label String: The display label of the role.
name String: The name of the role.
rolePrivileges List<String>: The privileges to be associated with this role.

Import

An existing role can be imported into this resource by supplying the role id. An example is below:

$ pulumi import vsphere:index/role:Role role1 -709298051

NOTE: System roles can’t be imported because they can’t be modified or deleted. Use vsphere.Role data source to read information about system roles.

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository: vSphere pulumi/pulumi-vsphere
License: Apache-2.0
Notes: This Pulumi package is based on the vsphere Terraform Provider.

Viewing docs for vSphere v4.16.3
published on Thursday, Feb 26, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-vsphere

On this page

On this page

Example Usage

Create Role Resource

Constructor syntax

Parameters

Constructor example

Role Resource Properties

Inputs

Outputs

Look up Existing Role Resource

Import

Package Details

On this page

On this page