Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Rancher2
  3. API Docs
  4. getUser
Rancher 2 v7.1.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-rancher2

rancher2.getUser

Explore with Pulumi AI

rancher2 logo
Rancher 2 v7.1.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-rancher2

    Use this data source to retrieve information about a Rancher v2 user

    Example Usage

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

const foo = rancher2.getUser({
    username: "foo",
});

    import pulumi
import pulumi_rancher2 as rancher2

foo = rancher2.get_user(username="foo")

    package main

import (
	"github.com/pulumi/pulumi-rancher2/sdk/v7/go/rancher2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := rancher2.LookupUser(ctx, &rancher2.LookupUserArgs{
			Username: pulumi.StringRef("foo"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var foo = Rancher2.GetUser.Invoke(new()
    {
        Username = "foo",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.rancher2.Rancher2Functions;
import com.pulumi.rancher2.inputs.GetUserArgs;
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 foo = Rancher2Functions.getUser(GetUserArgs.builder()
            .username("foo")
            .build());

    }
}

    variables:
  foo:
    fn::invoke:
      Function: rancher2:getUser
      Arguments:
        username: foo

    Using getUser

    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 getUser(args: GetUserArgs, opts?: InvokeOptions): Promise<GetUserResult>
function getUserOutput(args: GetUserOutputArgs, opts?: InvokeOptions): Output<GetUserResult>
    def get_user(is_external: Optional[bool] = None,
             name: Optional[str] = None,
             username: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetUserResult
def get_user_output(is_external: Optional[pulumi.Input[bool]] = None,
             name: Optional[pulumi.Input[str]] = None,
             username: Optional[pulumi.Input[str]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetUserResult]
    func LookupUser(ctx *Context, args *LookupUserArgs, opts ...InvokeOption) (*LookupUserResult, error)
func LookupUserOutput(ctx *Context, args *LookupUserOutputArgs, opts ...InvokeOption) LookupUserResultOutput

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

    public static class GetUser 
{
    public static Task<GetUserResult> InvokeAsync(GetUserArgs args, InvokeOptions? opts = null)
    public static Output<GetUserResult> Invoke(GetUserInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetUserResult> getUser(GetUserArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: rancher2:index/getUser:getUser
  arguments:
    # arguments dictionary

    The following arguments are supported:

    IsExternal bool
    Set is the user if the user is external. Default: false (bool)
    Name string
    The name of the user (string)
    Username string
    The username of the user (string)
    IsExternal bool
    Set is the user if the user is external. Default: false (bool)
    Name string
    The name of the user (string)
    Username string
    The username of the user (string)
    isExternal Boolean
    Set is the user if the user is external. Default: false (bool)
    name String
    The name of the user (string)
    username String
    The username of the user (string)
    isExternal boolean
    Set is the user if the user is external. Default: false (bool)
    name string
    The name of the user (string)
    username string
    The username of the user (string)
    is_external bool
    Set is the user if the user is external. Default: false (bool)
    name str
    The name of the user (string)
    username str
    The username of the user (string)
    isExternal Boolean
    Set is the user if the user is external. Default: false (bool)
    name String
    The name of the user (string)
    username String
    The username of the user (string)

    getUser Result

    The following output properties are available:

    Annotations Dictionary<string, string>
    (Computed) Annotations of the resource (map)
    Enabled bool
    (Computed) The user is enabled (bool)
    Id string
    The provider-assigned unique ID for this managed resource.
    Labels Dictionary<string, string>
    (Computed) Labels of the resource (map)
    Name string
    (Computed) The user common name (string)
    PrincipalIds List<string>
    (Computed) The user principal IDs (list)
    Username string
    IsExternal bool
    Annotations map[string]string
    (Computed) Annotations of the resource (map)
    Enabled bool
    (Computed) The user is enabled (bool)
    Id string
    The provider-assigned unique ID for this managed resource.
    Labels map[string]string
    (Computed) Labels of the resource (map)
    Name string
    (Computed) The user common name (string)
    PrincipalIds []string
    (Computed) The user principal IDs (list)
    Username string
    IsExternal bool
    annotations Map<String,String>
    (Computed) Annotations of the resource (map)
    enabled Boolean
    (Computed) The user is enabled (bool)
    id String
    The provider-assigned unique ID for this managed resource.
    labels Map<String,String>
    (Computed) Labels of the resource (map)
    name String
    (Computed) The user common name (string)
    principalIds List<String>
    (Computed) The user principal IDs (list)
    username String
    isExternal Boolean
    annotations {[key: string]: string}
    (Computed) Annotations of the resource (map)
    enabled boolean
    (Computed) The user is enabled (bool)
    id string
    The provider-assigned unique ID for this managed resource.
    labels {[key: string]: string}
    (Computed) Labels of the resource (map)
    name string
    (Computed) The user common name (string)
    principalIds string[]
    (Computed) The user principal IDs (list)
    username string
    isExternal boolean
    annotations Mapping[str, str]
    (Computed) Annotations of the resource (map)
    enabled bool
    (Computed) The user is enabled (bool)
    id str
    The provider-assigned unique ID for this managed resource.
    labels Mapping[str, str]
    (Computed) Labels of the resource (map)
    name str
    (Computed) The user common name (string)
    principal_ids Sequence[str]
    (Computed) The user principal IDs (list)
    username str
    is_external bool
    annotations Map<String>
    (Computed) Annotations of the resource (map)
    enabled Boolean
    (Computed) The user is enabled (bool)
    id String
    The provider-assigned unique ID for this managed resource.
    labels Map<String>
    (Computed) Labels of the resource (map)
    name String
    (Computed) The user common name (string)
    principalIds List<String>
    (Computed) The user principal IDs (list)
    username String
    isExternal Boolean

    Package Details

    Repository
    Rancher2 pulumi/pulumi-rancher2
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the rancher2 Terraform Provider.
    rancher2 logo
    Rancher 2 v7.1.0 published on Friday, Sep 27, 2024 by Pulumi
    pulumi/pulumi-rancher2