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

nutanix.getRoles

Explore with Pulumi AI

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

Describes a list of roles.

Example Usage

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

const test = nutanix.getRoles({});
Copy
import pulumi
import pulumi_nutanix as nutanix

test = nutanix.get_roles()
Copy
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
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Nutanix = Pulumi.Nutanix;

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

});
Copy
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();

    }
}
Copy
variables:
  test:
    fn::invoke:
      function: nutanix: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(args: GetRolesArgs, opts?: InvokeOptions): Promise<GetRolesResult>
function getRolesOutput(args: GetRolesOutputArgs, opts?: InvokeOptions): Output<GetRolesResult>
Copy
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]
Copy
func GetRoles(ctx *Context, args *GetRolesArgs, opts ...InvokeOption) (*GetRolesResult, error)
func GetRolesOutput(ctx *Context, args *GetRolesOutputArgs, opts ...InvokeOption) GetRolesResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetRolesResult> getRoles(GetRolesArgs args, InvokeOptions options)
public static Output<GetRolesResult> getRoles(GetRolesArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: nutanix:index/getRoles:getRoles
  arguments:
    # arguments dictionary
Copy

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

GetRolesEntityCategory

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.

GetRolesEntityPermissionReferenceList

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).

GetRolesMetadata

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

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