Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Nutanix
  3. API Docs
  4. getRole
Nutanix v0.7.4 published on Friday, Mar 21, 2025 by Piers Karsenbarg
pierskarsenbarg/pulumi-nutanix

nutanix.getRole

Explore with Pulumi AI

Nutanix v0.7.4 published on Friday, Mar 21, 2025 by Piers Karsenbarg
pierskarsenbarg/pulumi-nutanix

Describes a Role.

Using getRole

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 getRole(args: GetRoleArgs, opts?: InvokeOptions): Promise<GetRoleResult>
function getRoleOutput(args: GetRoleOutputArgs, opts?: InvokeOptions): Output<GetRoleResult>
Copy
def get_role(categories: Optional[Sequence[GetRoleCategory]] = None,
             role_id: Optional[str] = None,
             role_name: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetRoleResult
def get_role_output(categories: Optional[pulumi.Input[Sequence[pulumi.Input[GetRoleCategoryArgs]]]] = None,
             role_id: Optional[pulumi.Input[str]] = None,
             role_name: Optional[pulumi.Input[str]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetRoleResult]
Copy
func LookupRole(ctx *Context, args *LookupRoleArgs, opts ...InvokeOption) (*LookupRoleResult, error)
func LookupRoleOutput(ctx *Context, args *LookupRoleOutputArgs, opts ...InvokeOption) LookupRoleResultOutput
Copy

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

public static class GetRole 
{
    public static Task<GetRoleResult> InvokeAsync(GetRoleArgs args, InvokeOptions? opts = null)
    public static Output<GetRoleResult> Invoke(GetRoleInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetRoleResult> getRole(GetRoleArgs args, InvokeOptions options)
public static Output<GetRoleResult> getRole(GetRoleArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: nutanix:index/getRole:getRole
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Categories List<PiersKarsenbarg.Nutanix.Inputs.GetRoleCategory>
  • Categories for the Role.
RoleId string
  • (Optional) The UUID of a Role.
RoleName string
  • (Optional) The name of a Role.
Categories []GetRoleCategory
  • Categories for the Role.
RoleId string
  • (Optional) The UUID of a Role.
RoleName string
  • (Optional) The name of a Role.
categories List<GetRoleCategory>
  • Categories for the Role.
roleId String
  • (Optional) The UUID of a Role.
roleName String
  • (Optional) The name of a Role.
categories GetRoleCategory[]
  • Categories for the Role.
roleId string
  • (Optional) The UUID of a Role.
roleName string
  • (Optional) The name of a Role.
categories Sequence[GetRoleCategory]
  • Categories for the Role.
role_id str
  • (Optional) The UUID of a Role.
role_name str
  • (Optional) The name of a Role.
categories List<Property Map>
  • Categories for the Role.
roleId String
  • (Optional) The UUID of a Role.
roleName String
  • (Optional) The name of a Role.

getRole Result

The following output properties are available:

ApiVersion string
The version of the API.
Categories List<PiersKarsenbarg.Nutanix.Outputs.GetRoleCategory>
  • Categories for the Role.
Description string
  • The description of the Role.
Id string
The provider-assigned unique ID for this managed resource.
Metadata Dictionary<string, string>
  • The role kind metadata.
Name string
  • the name(Optional).
OwnerReference Dictionary<string, string>
  • The reference to a user.
PermissionReferenceLists List<PiersKarsenbarg.Nutanix.Outputs.GetRolePermissionReferenceList>
  • (Required) List of permission references.
ProjectReference Dictionary<string, string>
  • The reference to a project.
State string
  • The state of the role.
RoleId string
RoleName string
ApiVersion string
The version of the API.
Categories []GetRoleCategory
  • Categories for the Role.
Description string
  • The description of the Role.
Id string
The provider-assigned unique ID for this managed resource.
Metadata map[string]string
  • The role kind metadata.
Name string
  • the name(Optional).
OwnerReference map[string]string
  • The reference to a user.
PermissionReferenceLists []GetRolePermissionReferenceList
  • (Required) List of permission references.
ProjectReference map[string]string
  • The reference to a project.
State string
  • The state of the role.
RoleId string
RoleName string
apiVersion String
The version of the API.
categories List<GetRoleCategory>
  • Categories for the Role.
description String
  • The description of the Role.
id String
The provider-assigned unique ID for this managed resource.
metadata Map<String,String>
  • The role kind metadata.
name String
  • the name(Optional).
ownerReference Map<String,String>
  • The reference to a user.
permissionReferenceLists List<GetRolePermissionReferenceList>
  • (Required) List of permission references.
projectReference Map<String,String>
  • The reference to a project.
state String
  • The state of the role.
roleId String
roleName String
apiVersion string
The version of the API.
categories GetRoleCategory[]
  • Categories for the Role.
description string
  • The description of the Role.
id string
The provider-assigned unique ID for this managed resource.
metadata {[key: string]: string}
  • The role kind metadata.
name string
  • the name(Optional).
ownerReference {[key: string]: string}
  • The reference to a user.
permissionReferenceLists GetRolePermissionReferenceList[]
  • (Required) List of permission references.
projectReference {[key: string]: string}
  • The reference to a project.
state string
  • The state of the role.
roleId string
roleName string
api_version str
The version of the API.
categories Sequence[GetRoleCategory]
  • Categories for the Role.
description str
  • The description of the Role.
id str
The provider-assigned unique ID for this managed resource.
metadata Mapping[str, str]
  • The role kind metadata.
name str
  • the name(Optional).
owner_reference Mapping[str, str]
  • The reference to a user.
permission_reference_lists Sequence[GetRolePermissionReferenceList]
  • (Required) List of permission references.
project_reference Mapping[str, str]
  • The reference to a project.
state str
  • The state of the role.
role_id str
role_name str
apiVersion String
The version of the API.
categories List<Property Map>
  • Categories for the Role.
description String
  • The description of the Role.
id String
The provider-assigned unique ID for this managed resource.
metadata Map<String>
  • The role kind metadata.
name String
  • the name(Optional).
ownerReference Map<String>
  • The reference to a user.
permissionReferenceLists List<Property Map>
  • (Required) List of permission references.
projectReference Map<String>
  • The reference to a project.
state String
  • The state of the role.
roleId String
roleName String

Supporting Types

GetRoleCategory

Name This property is required. string
  • the name(Optional).
Value This property is required. string
  • value of the key.
Name This property is required. string
  • the name(Optional).
Value This property is required. string
  • value of the key.
name This property is required. String
  • the name(Optional).
value This property is required. String
  • value of the key.
name This property is required. string
  • the name(Optional).
value This property is required. string
  • value of the key.
name This property is required. str
  • the name(Optional).
value This property is required. str
  • value of the key.
name This property is required. String
  • the name(Optional).
value This property is required. String
  • value of the key.

GetRolePermissionReferenceList

Kind This property is required. string
  • The kind name (Default value: project)(Required).
Name This property is required. string
  • the name(Optional).
Uuid This property is required. string
  • the UUID(Required).
Kind This property is required. string
  • The kind name (Default value: project)(Required).
Name This property is required. string
  • the name(Optional).
Uuid This property is required. string
  • the UUID(Required).
kind This property is required. String
  • The kind name (Default value: project)(Required).
name This property is required. String
  • the name(Optional).
uuid This property is required. String
  • the UUID(Required).
kind This property is required. string
  • The kind name (Default value: project)(Required).
name This property is required. string
  • the name(Optional).
uuid This property is required. string
  • the UUID(Required).
kind This property is required. str
  • The kind name (Default value: project)(Required).
name This property is required. str
  • the name(Optional).
uuid This property is required. str
  • the UUID(Required).
kind This property is required. String
  • The kind name (Default value: project)(Required).
name This property is required. String
  • the name(Optional).
uuid This property is required. String
  • the UUID(Required).

Package Details

Repository
nutanix pierskarsenbarg/pulumi-nutanix
License
Apache-2.0
Notes
This Pulumi package is based on the nutanix Terraform Provider.
Nutanix v0.7.4 published on Friday, Mar 21, 2025 by Piers Karsenbarg
pierskarsenbarg/pulumi-nutanix