avi.getUser

avi 31.1.1 published on Monday, Apr 14, 2025 by vmware

<!–

Copyright 2021 VMware, Inc.
SPDX-License-Identifier: Mozilla Public License 2.0

–>

layout: “avi”

page_title: “AVI: avi.User” sidebar_current: “docs-avi-datasource-user” description: |- Get information of Avi User.

avi.User

This data source is used to to get avi.User objects.

Example Usage

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

const fooUser = avi.getUser({
    name: "foo",
    uuid: "user-f9cf6b3e-a411-436f-95e2-2982ba2b217b",
});

import pulumi
import pulumi_avi as avi

foo_user = avi.get_user(name="foo",
    uuid="user-f9cf6b3e-a411-436f-95e2-2982ba2b217b")

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/avi/v31/avi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := avi.LookupUser(ctx, &avi.LookupUserArgs{
			Name: pulumi.StringRef("foo"),
			Uuid: pulumi.StringRef("user-f9cf6b3e-a411-436f-95e2-2982ba2b217b"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var fooUser = Avi.GetUser.Invoke(new()
    {
        Name = "foo",
        Uuid = "user-f9cf6b3e-a411-436f-95e2-2982ba2b217b",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.avi.AviFunctions;
import com.pulumi.avi.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 fooUser = AviFunctions.getUser(GetUserArgs.builder()
            .name("foo")
            .uuid("user-f9cf6b3e-a411-436f-95e2-2982ba2b217b")
            .build());

    }
}

variables:
  fooUser:
    fn::invoke:
      function: avi:getUser
      arguments:
        name: foo
        uuid: user-f9cf6b3e-a411-436f-95e2-2982ba2b217b

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(id: Optional[str] = None,
             name: Optional[str] = None,
             uuid: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetUserResult
def get_user_output(id: Optional[pulumi.Input[str]] = None,
             name: Optional[pulumi.Input[str]] = None,
             uuid: 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)
public static Output<GetUserResult> getUser(GetUserArgs args, InvokeOptions options)

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

The following arguments are supported:

Id string
Name string: Search User by name.
Uuid string: Search User by uuid.

Id string
Name string: Search User by name.
Uuid string: Search User by uuid.

id String
name String: Search User by name.
uuid String: Search User by uuid.

id string
name string: Search User by name.
uuid string: Search User by uuid.

id str
name str: Search User by name.
uuid str: Search User by uuid.

id String
name String: Search User by name.
uuid String: Search User by uuid.

getUser Result

The following output properties are available:

Accesses List<GetUserAccess>: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
AnonymousUser string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
DateJoined string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
DefaultTenantRef string: It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Email string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
FullName string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Id string
IsActive string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
IsInternalUser string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
IsStaff string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
IsSuperuser string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Local string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
LoggedIn string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Name string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Password string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Passwordless string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
RecoveryToken string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ServiceUser string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
TokenExpirationDate string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
UiProperty string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Uid string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
UnixCryptPassword string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
UserProfileRef string: It is a reference to an object of type useraccountprofile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Username string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Uuid string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

Accesses []GetUserAccess: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
AnonymousUser string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
DateJoined string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
DefaultTenantRef string: It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Email string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
FullName string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Id string
IsActive string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
IsInternalUser string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
IsStaff string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
IsSuperuser string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Local string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
LoggedIn string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Name string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Password string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Passwordless string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
RecoveryToken string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ServiceUser string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
TokenExpirationDate string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
UiProperty string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Uid string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
UnixCryptPassword string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
UserProfileRef string: It is a reference to an object of type useraccountprofile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Username string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Uuid string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

accesses List<GetUserAccess>: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
anonymousUser String: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
dateJoined String: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
defaultTenantRef String: It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
email String: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
fullName String: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
id String
isActive String: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
isInternalUser String: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
isStaff String: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
isSuperuser String: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
local String: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
loggedIn String: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
name String: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
password String: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
passwordless String: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
recoveryToken String: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
serviceUser String: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
tokenExpirationDate String: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uiProperty String: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uid String: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
unixCryptPassword String: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
userProfileRef String: It is a reference to an object of type useraccountprofile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
username String: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid String: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

accesses GetUserAccess[]: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
anonymousUser string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
dateJoined string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
defaultTenantRef string: It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
email string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
fullName string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
id string
isActive string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
isInternalUser string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
isStaff string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
isSuperuser string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
local string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
loggedIn string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
name string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
password string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
passwordless string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
recoveryToken string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
serviceUser string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
tokenExpirationDate string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uiProperty string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uid string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
unixCryptPassword string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
userProfileRef string: It is a reference to an object of type useraccountprofile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
username string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

accesses Sequence[GetUserAccess]: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
anonymous_user str: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
date_joined str: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
default_tenant_ref str: It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
email str: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
full_name str: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
id str
is_active str: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
is_internal_user str: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
is_staff str: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
is_superuser str: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
local str: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
logged_in str: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
name str: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
password str: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
passwordless str: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
recovery_token str: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
service_user str: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
token_expiration_date str: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ui_property str: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uid str: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
unix_crypt_password str: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
user_profile_ref str: It is a reference to an object of type useraccountprofile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
username str: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid str: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

accesses List<Property Map>: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
anonymousUser String: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
dateJoined String: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
defaultTenantRef String: It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
email String: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
fullName String: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
id String
isActive String: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
isInternalUser String: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
isStaff String: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
isSuperuser String: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
local String: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
loggedIn String: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
name String: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
password String: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
passwordless String: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
recoveryToken String: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
serviceUser String: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
tokenExpirationDate String: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uiProperty String: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uid String: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
unixCryptPassword String: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
userProfileRef String: It is a reference to an object of type useraccountprofile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
username String: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid String: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.