Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Vsphere Provider
  3. API Docs
  4. Role
vSphere v4.13.2 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-vsphere

vsphere.Role

Explore with Pulumi AI

vSphere v4.13.2 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-vsphere

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
Copy

Use vsphere_role data source

to read information about system roles.

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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. String
The unique name of the resource.
args This property is required. 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",
    },
});
Copy
example, err := vsphere.NewRole(ctx, "roleResource", &vsphere.RoleArgs{
	Name: pulumi.String("string"),
	RolePrivileges: pulumi.StringArray{
		pulumi.String("string"),
	},
})
Copy
var roleResource = new Role("roleResource", RoleArgs.builder()
    .name("string")
    .rolePrivileges("string")
    .build());
Copy
role_resource = vsphere.Role("roleResource",
    name="string",
    role_privileges=["string"])
Copy
const roleResource = new vsphere.Role("roleResource", {
    name: "string",
    rolePrivileges: ["string"],
});
Copy
type: vsphere:Role
properties:
    name: string
    rolePrivileges:
        - string
Copy

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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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.

Package Details

Repository
vSphere pulumi/pulumi-vsphere
License
Apache-2.0
Notes
This Pulumi package is based on the vsphere Terraform Provider.
vSphere v4.13.2 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-vsphere