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

nutanix.getRoleV2

Explore with Pulumi AI

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

    Fetches a role based on the provided external identifier.

    Example Usage

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

const role = nutanix.getRoleV2({
    extId: "<role_uuid>",
});

    import pulumi
import pulumi_nutanix as nutanix

role = nutanix.get_role_v2(ext_id="<role_uuid>")

    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.GetRoleV2(ctx, &nutanix.GetRoleV2Args{
			ExtId: "<role_uuid>",
		}, 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 role = Nutanix.GetRoleV2.Invoke(new()
    {
        ExtId = "<role_uuid>",
    });

});

    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.GetRoleV2Args;
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 role = NutanixFunctions.getRoleV2(GetRoleV2Args.builder()
            .extId("<role_uuid>")
            .build());

    }
}

    variables:
  role:
    fn::invoke:
      function: nutanix:getRoleV2
      arguments:
        extId: <role_uuid>

    Using getRoleV2

    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 getRoleV2(args: GetRoleV2Args, opts?: InvokeOptions): Promise<GetRoleV2Result>
function getRoleV2Output(args: GetRoleV2OutputArgs, opts?: InvokeOptions): Output<GetRoleV2Result>
    def get_role_v2(ext_id: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetRoleV2Result
def get_role_v2_output(ext_id: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetRoleV2Result]
    func GetRoleV2(ctx *Context, args *GetRoleV2Args, opts ...InvokeOption) (*GetRoleV2Result, error)
func GetRoleV2Output(ctx *Context, args *GetRoleV2OutputArgs, opts ...InvokeOption) GetRoleV2ResultOutput

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

    public static class GetRoleV2 
{
    public static Task<GetRoleV2Result> InvokeAsync(GetRoleV2Args args, InvokeOptions? opts = null)
    public static Output<GetRoleV2Result> Invoke(GetRoleV2InvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetRoleV2Result> getRoleV2(GetRoleV2Args args, InvokeOptions options)
public static Output<GetRoleV2Result> getRoleV2(GetRoleV2Args args, InvokeOptions options)

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

    The following arguments are supported:

    ExtId string
    • (Required) ExtId for the Role.
    ExtId string
    • (Required) ExtId for the Role.
    extId String
    • (Required) ExtId for the Role.
    extId string
    • (Required) ExtId for the Role.
    ext_id str
    • (Required) ExtId for the Role.
    extId String
    • (Required) ExtId for the Role.

    getRoleV2 Result

    The following output properties are available:

    AccessibleClients List<string>
    • List of Accessible Clients for the Role.
    AccessibleEntityTypes List<string>
    • List of Accessible Entity Types for the Role.
    AssignedUsersCount int
    • Number of Users assigned to given Role.
    AssignedUsersGroupsCount int
    • Number of User Groups assigned to given Role.
    ClientName string
    • Client that created the entity.
    CreatedBy string
    • User or Service Name that created the Role.
    CreatedTime string
    • The creation time of the Role.
    Description string
    • Description of the Role.
    DisplayName string
    • The display name for the Role.
    ExtId string
    • A globally unique identifier of an instance that is suitable for external consumption.
    Id string
    The provider-assigned unique ID for this managed resource.
    IsSystemDefined bool
    • Flag identifying if the Role is system defined or not.
    LastUpdatedTime string
    • The time when the Role was last updated.
    Links List<PiersKarsenbarg.Nutanix.Outputs.GetRoleV2Link>
    • A HATEOAS style link for the response. Each link contains a user-friendly name identifying the link and an address for retrieving the particular resource.
    Operations List<string>
    • List of operations for the role.
    TenantId string
    • A globally unique identifier that represents the tenant that owns this entity. The system automatically assigns it, and it and is immutable from an API consumer perspective (some use cases may cause this Id to change - For instance, a use case may require the transfer of ownership of the entity, but these cases are handled automatically on the server).
    AccessibleClients []string
    • List of Accessible Clients for the Role.
    AccessibleEntityTypes []string
    • List of Accessible Entity Types for the Role.
    AssignedUsersCount int
    • Number of Users assigned to given Role.
    AssignedUsersGroupsCount int
    • Number of User Groups assigned to given Role.
    ClientName string
    • Client that created the entity.
    CreatedBy string
    • User or Service Name that created the Role.
    CreatedTime string
    • The creation time of the Role.
    Description string
    • Description of the Role.
    DisplayName string
    • The display name for the Role.
    ExtId string
    • A globally unique identifier of an instance that is suitable for external consumption.
    Id string
    The provider-assigned unique ID for this managed resource.
    IsSystemDefined bool
    • Flag identifying if the Role is system defined or not.
    LastUpdatedTime string
    • The time when the Role was last updated.
    Links []GetRoleV2Link
    • A HATEOAS style link for the response. Each link contains a user-friendly name identifying the link and an address for retrieving the particular resource.
    Operations []string
    • List of operations for the role.
    TenantId string
    • A globally unique identifier that represents the tenant that owns this entity. The system automatically assigns it, and it and is immutable from an API consumer perspective (some use cases may cause this Id to change - For instance, a use case may require the transfer of ownership of the entity, but these cases are handled automatically on the server).
    accessibleClients List<String>
    • List of Accessible Clients for the Role.
    accessibleEntityTypes List<String>
    • List of Accessible Entity Types for the Role.
    assignedUsersCount Integer
    • Number of Users assigned to given Role.
    assignedUsersGroupsCount Integer
    • Number of User Groups assigned to given Role.
    clientName String
    • Client that created the entity.
    createdBy String
    • User or Service Name that created the Role.
    createdTime String
    • The creation time of the Role.
    description String
    • Description of the Role.
    displayName String
    • The display name for the Role.
    extId String
    • A globally unique identifier of an instance that is suitable for external consumption.
    id String
    The provider-assigned unique ID for this managed resource.
    isSystemDefined Boolean
    • Flag identifying if the Role is system defined or not.
    lastUpdatedTime String
    • The time when the Role was last updated.
    links List<GetRoleV2Link>
    • A HATEOAS style link for the response. Each link contains a user-friendly name identifying the link and an address for retrieving the particular resource.
    operations List<String>
    • List of operations for the role.
    tenantId String
    • A globally unique identifier that represents the tenant that owns this entity. The system automatically assigns it, and it and is immutable from an API consumer perspective (some use cases may cause this Id to change - For instance, a use case may require the transfer of ownership of the entity, but these cases are handled automatically on the server).
    accessibleClients string[]
    • List of Accessible Clients for the Role.
    accessibleEntityTypes string[]
    • List of Accessible Entity Types for the Role.
    assignedUsersCount number
    • Number of Users assigned to given Role.
    assignedUsersGroupsCount number
    • Number of User Groups assigned to given Role.
    clientName string
    • Client that created the entity.
    createdBy string
    • User or Service Name that created the Role.
    createdTime string
    • The creation time of the Role.
    description string
    • Description of the Role.
    displayName string
    • The display name for the Role.
    extId string
    • A globally unique identifier of an instance that is suitable for external consumption.
    id string
    The provider-assigned unique ID for this managed resource.
    isSystemDefined boolean
    • Flag identifying if the Role is system defined or not.
    lastUpdatedTime string
    • The time when the Role was last updated.
    links GetRoleV2Link[]
    • A HATEOAS style link for the response. Each link contains a user-friendly name identifying the link and an address for retrieving the particular resource.
    operations string[]
    • List of operations for the role.
    tenantId string
    • A globally unique identifier that represents the tenant that owns this entity. The system automatically assigns it, and it and is immutable from an API consumer perspective (some use cases may cause this Id to change - For instance, a use case may require the transfer of ownership of the entity, but these cases are handled automatically on the server).
    accessible_clients Sequence[str]
    • List of Accessible Clients for the Role.
    accessible_entity_types Sequence[str]
    • List of Accessible Entity Types for the Role.
    assigned_users_count int
    • Number of Users assigned to given Role.
    assigned_users_groups_count int
    • Number of User Groups assigned to given Role.
    client_name str
    • Client that created the entity.
    created_by str
    • User or Service Name that created the Role.
    created_time str
    • The creation time of the Role.
    description str
    • Description of the Role.
    display_name str
    • The display name for the Role.
    ext_id str
    • A globally unique identifier of an instance that is suitable for external consumption.
    id str
    The provider-assigned unique ID for this managed resource.
    is_system_defined bool
    • Flag identifying if the Role is system defined or not.
    last_updated_time str
    • The time when the Role was last updated.
    links Sequence[GetRoleV2Link]
    • A HATEOAS style link for the response. Each link contains a user-friendly name identifying the link and an address for retrieving the particular resource.
    operations Sequence[str]
    • List of operations for the role.
    tenant_id str
    • A globally unique identifier that represents the tenant that owns this entity. The system automatically assigns it, and it and is immutable from an API consumer perspective (some use cases may cause this Id to change - For instance, a use case may require the transfer of ownership of the entity, but these cases are handled automatically on the server).
    accessibleClients List<String>
    • List of Accessible Clients for the Role.
    accessibleEntityTypes List<String>
    • List of Accessible Entity Types for the Role.
    assignedUsersCount Number
    • Number of Users assigned to given Role.
    assignedUsersGroupsCount Number
    • Number of User Groups assigned to given Role.
    clientName String
    • Client that created the entity.
    createdBy String
    • User or Service Name that created the Role.
    createdTime String
    • The creation time of the Role.
    description String
    • Description of the Role.
    displayName String
    • The display name for the Role.
    extId String
    • A globally unique identifier of an instance that is suitable for external consumption.
    id String
    The provider-assigned unique ID for this managed resource.
    isSystemDefined Boolean
    • Flag identifying if the Role is system defined or not.
    lastUpdatedTime String
    • The time when the Role was last updated.
    links List<Property Map>
    • A HATEOAS style link for the response. Each link contains a user-friendly name identifying the link and an address for retrieving the particular resource.
    operations List<String>
    • List of operations for the role.
    tenantId String
    • A globally unique identifier that represents the tenant that owns this entity. The system automatically assigns it, and it and is immutable from an API consumer perspective (some use cases may cause this Id to change - For instance, a use case may require the transfer of ownership of the entity, but these cases are handled automatically on the server).

    Supporting Types

    Href string
    • The URL at which the entity described by the link can be accessed.
    Rel string
    • A name that identifies the relationship of the link to the object that is returned by the URL. The unique value of "self" identifies the URL for the object.
    Href string
    • The URL at which the entity described by the link can be accessed.
    Rel string
    • A name that identifies the relationship of the link to the object that is returned by the URL. The unique value of "self" identifies the URL for the object.
    href String
    • The URL at which the entity described by the link can be accessed.
    rel String
    • A name that identifies the relationship of the link to the object that is returned by the URL. The unique value of "self" identifies the URL for the object.
    href string
    • The URL at which the entity described by the link can be accessed.
    rel string
    • A name that identifies the relationship of the link to the object that is returned by the URL. The unique value of "self" identifies the URL for the object.
    href str
    • The URL at which the entity described by the link can be accessed.
    rel str
    • A name that identifies the relationship of the link to the object that is returned by the URL. The unique value of "self" identifies the URL for the object.
    href String
    • The URL at which the entity described by the link can be accessed.
    rel String
    • A name that identifies the relationship of the link to the object that is returned by the URL. The unique value of "self" identifies the URL for the object.

    Package Details

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