1. Packages
  2. Nutanix
  3. API Docs
  4. getRoles
Viewing docs for Nutanix v0.11.0
published on Monday, Nov 24, 2025 by Piers Karsenbarg
Schema (JSON)
pierskarsenbarg/pulumi-nutanix

nutanix.getRoles

nutanix logo
Viewing docs for Nutanix v0.11.0
published on Monday, Nov 24, 2025 by Piers Karsenbarg
Schema (JSON)
pierskarsenbarg/pulumi-nutanix

    Describes a list of roles.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as nutanix from "@pierskarsenbarg/nutanix";

const test = nutanix.getRoles({});

    import pulumi
import pulumi_nutanix as nutanix

test = nutanix.get_roles()

    package main

import (
	"github.com/pierskarsenbarg/pulumi-nutanix/sdk/go/nutanix"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := nutanix.GetRoles(ctx, &nutanix.GetRolesArgs{}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var test = Nutanix.GetRoles.Invoke();

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.nutanix.NutanixFunctions;
import com.pulumi.nutanix.inputs.GetRolesArgs;
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 test = NutanixFunctions.getRoles(GetRolesArgs.builder()
            .build());

    }
}

    variables:
  test:
    fn::invoke:
      function: nutanix:getRoles
      arguments: {}

    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(args: GetRolesArgs, opts?: InvokeOptions): Promise<GetRolesResult>
function getRolesOutput(args: GetRolesOutputArgs, opts?: InvokeOptions): Output<GetRolesResult>
    def get_roles(metadatas: Optional[Sequence[GetRolesMetadata]] = None,
              opts: Optional[InvokeOptions] = None) -> GetRolesResult
def get_roles_output(metadatas: Optional[pulumi.Input[Sequence[pulumi.Input[GetRolesMetadataArgs]]]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetRolesResult]
    func GetRoles(ctx *Context, args *GetRolesArgs, opts ...InvokeOption) (*GetRolesResult, error)
func GetRolesOutput(ctx *Context, args *GetRolesOutputArgs, opts ...InvokeOption) GetRolesResultOutput

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

    public static class GetRoles 
{
    public static Task<GetRolesResult> InvokeAsync(GetRolesArgs args, InvokeOptions? opts = null)
    public static Output<GetRolesResult> Invoke(GetRolesInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetRolesResult> getRoles(GetRolesArgs args, InvokeOptions options)
public static Output<GetRolesResult> getRoles(GetRolesArgs args, InvokeOptions options)

    fn::invoke:
  function: nutanix:index/getRoles:getRoles
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Metadatas []GetRolesMetadata
    • The role kind metadata.
    metadatas List<GetRolesMetadata>
    • The role kind metadata.
    metadatas GetRolesMetadata[]
    • The role kind metadata.
    metadatas Sequence[GetRolesMetadata]
    • The role kind metadata.
    metadatas List<Property Map>
    • The role kind metadata.

    getRoles Result

    The following output properties are available:

    ApiVersion string
    The version of the API.
    Entities List<PiersKarsenbarg.Nutanix.Outputs.GetRolesEntity>
    List of Roles
    Id string
    The provider-assigned unique ID for this managed resource.
    Metadatas List<PiersKarsenbarg.Nutanix.Outputs.GetRolesMetadata>
    • The role kind metadata.
    ApiVersion string
    The version of the API.
    Entities []GetRolesEntity
    List of Roles
    Id string
    The provider-assigned unique ID for this managed resource.
    Metadatas []GetRolesMetadata
    • The role kind metadata.
    apiVersion String
    The version of the API.
    entities List<GetRolesEntity>
    List of Roles
    id String
    The provider-assigned unique ID for this managed resource.
    metadatas List<GetRolesMetadata>
    • The role kind metadata.
    apiVersion string
    The version of the API.
    entities GetRolesEntity[]
    List of Roles
    id string
    The provider-assigned unique ID for this managed resource.
    metadatas GetRolesMetadata[]
    • The role kind metadata.
    api_version str
    The version of the API.
    entities Sequence[GetRolesEntity]
    List of Roles
    id str
    The provider-assigned unique ID for this managed resource.
    metadatas Sequence[GetRolesMetadata]
    • The role kind metadata.
    apiVersion String
    The version of the API.
    entities List<Property Map>
    List of Roles
    id String
    The provider-assigned unique ID for this managed resource.
    metadatas List<Property Map>
    • The role kind metadata.

    Supporting Types

    GetRolesEntity

    ApiVersion string
    The version of the API.
    Categories List<PiersKarsenbarg.Nutanix.Inputs.GetRolesEntityCategory>
    • Categories for the role.
    Description string
    • The description of the role.
    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.Inputs.GetRolesEntityPermissionReferenceList>
    • (Required) List of permission references.
    ProjectReference Dictionary<string, string>
    • The reference to a project.
    RoleId string
    State string
    • The state of the role.
    ApiVersion string
    The version of the API.
    Categories []GetRolesEntityCategory
    • Categories for the role.
    Description string
    • The description of the role.
    Metadata map[string]string
    • The role kind metadata.
    Name string
    • the name(Optional).
    OwnerReference map[string]string
    • The reference to a user.
    PermissionReferenceLists []GetRolesEntityPermissionReferenceList
    • (Required) List of permission references.
    ProjectReference map[string]string
    • The reference to a project.
    RoleId string
    State string
    • The state of the role.
    apiVersion String
    The version of the API.
    categories List<GetRolesEntityCategory>
    • Categories for the role.
    description String
    • The description of the role.
    metadata Map<String,String>
    • The role kind metadata.
    name String
    • the name(Optional).
    ownerReference Map<String,String>
    • The reference to a user.
    permissionReferenceLists List<GetRolesEntityPermissionReferenceList>
    • (Required) List of permission references.
    projectReference Map<String,String>
    • The reference to a project.
    roleId String
    state String
    • The state of the role.
    apiVersion string
    The version of the API.
    categories GetRolesEntityCategory[]
    • Categories for the role.
    description string
    • The description of the role.
    metadata {[key: string]: string}
    • The role kind metadata.
    name string
    • the name(Optional).
    ownerReference {[key: string]: string}
    • The reference to a user.
    permissionReferenceLists GetRolesEntityPermissionReferenceList[]
    • (Required) List of permission references.
    projectReference {[key: string]: string}
    • The reference to a project.
    roleId string
    state string
    • The state of the role.
    api_version str
    The version of the API.
    categories Sequence[GetRolesEntityCategory]
    • Categories for the role.
    description str
    • The description of the role.
    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[GetRolesEntityPermissionReferenceList]
    • (Required) List of permission references.
    project_reference Mapping[str, str]
    • The reference to a project.
    role_id str
    state str
    • The state of the role.
    apiVersion String
    The version of the API.
    categories List<Property Map>
    • Categories for the role.
    description String
    • The description of the role.
    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.
    roleId String
    state String
    • The state of the role.

    GetRolesEntityCategory

    Name string
    • the name(Optional).
    Value string
    • value of the key.
    Name string
    • the name(Optional).
    Value string
    • value of the key.
    name String
    • the name(Optional).
    value String
    • value of the key.
    name string
    • the name(Optional).
    value string
    • value of the key.
    name str
    • the name(Optional).
    value str
    • value of the key.
    name String
    • the name(Optional).
    value String
    • value of the key.

    GetRolesEntityPermissionReferenceList

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

    GetRolesMetadata

    Filter string
    Kind string
    • The kind name (Default value: project)(Required).
    Length int
    Offset int
    SortAttribute string
    SortOrder string
    Filter string
    Kind string
    • The kind name (Default value: project)(Required).
    Length int
    Offset int
    SortAttribute string
    SortOrder string
    filter String
    kind String
    • The kind name (Default value: project)(Required).
    length Integer
    offset Integer
    sortAttribute String
    sortOrder String
    filter string
    kind string
    • The kind name (Default value: project)(Required).
    length number
    offset number
    sortAttribute string
    sortOrder string
    filter str
    kind str
    • The kind name (Default value: project)(Required).
    length int
    offset int
    sort_attribute str
    sort_order str
    filter String
    kind String
    • The kind name (Default value: project)(Required).
    length Number
    offset Number
    sortAttribute String
    sortOrder String

    Package Details

    Repository
    nutanix pierskarsenbarg/pulumi-nutanix
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the nutanix Terraform Provider.
    nutanix logo
    Viewing docs for Nutanix v0.11.0
    published on Monday, Nov 24, 2025 by Piers Karsenbarg
    Schema (JSON)
    pierskarsenbarg/pulumi-nutanix
      Try Pulumi Cloud free. Your team will thank you.