Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Avi Provider
  3. API Docs
  4. User
avi 31.1.1 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-avi

avi.User

Explore with Pulumi AI

avi logo
avi 31.1.1 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-avi

    <!–

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

    –>

    layout: “avi”

    page_title: “Avi: avi.User” sidebar_current: “docs-avi-resource-user” description: |- Creates and manages Avi User.

    avi.User

    The User resource allows the creation and management of Avi User

    Example Usage

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    resources:
  foo:
    type: avi:User
    properties:
      tenantRef: /api/tenant/?name=admin

    Create User Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new User(name: string, args?: UserArgs, opts?: CustomResourceOptions);
    @overload
def User(resource_name: str,
         args: Optional[UserArgs] = None,
         opts: Optional[ResourceOptions] = None)

@overload
def User(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         accesses: Optional[Sequence[UserAccessArgs]] = None,
         anonymous_user: Optional[str] = None,
         date_joined: Optional[str] = None,
         default_tenant_ref: Optional[str] = None,
         email: Optional[str] = None,
         full_name: Optional[str] = None,
         is_active: Optional[str] = None,
         is_internal_user: Optional[str] = None,
         is_staff: Optional[str] = None,
         is_superuser: Optional[str] = None,
         local: Optional[str] = None,
         logged_in: Optional[str] = None,
         name: Optional[str] = None,
         password: Optional[str] = None,
         passwordless: Optional[str] = None,
         recovery_token: Optional[str] = None,
         service_user: Optional[str] = None,
         token_expiration_date: Optional[str] = None,
         ui_property: Optional[str] = None,
         uid: Optional[str] = None,
         unix_crypt_password: Optional[str] = None,
         user_id: Optional[str] = None,
         user_profile_ref: Optional[str] = None,
         username: Optional[str] = None,
         uuid: Optional[str] = None)
    func NewUser(ctx *Context, name string, args *UserArgs, opts ...ResourceOption) (*User, error)
    public User(string name, UserArgs? args = null, CustomResourceOptions? opts = null)
    public User(String name, UserArgs args)
public User(String name, UserArgs args, CustomResourceOptions options)

    type: avi:User
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args UserArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args UserArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args UserArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UserArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UserArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var userResource = new Avi.User("userResource", new()
{
    Accesses = new[]
    {
        new Avi.Inputs.UserAccessArgs
        {
            AllTenants = "string",
            RoleRef = "string",
            TenantRef = "string",
        },
    },
    AnonymousUser = "string",
    DateJoined = "string",
    DefaultTenantRef = "string",
    Email = "string",
    FullName = "string",
    IsActive = "string",
    IsInternalUser = "string",
    IsStaff = "string",
    IsSuperuser = "string",
    Local = "string",
    LoggedIn = "string",
    Name = "string",
    Password = "string",
    Passwordless = "string",
    RecoveryToken = "string",
    ServiceUser = "string",
    TokenExpirationDate = "string",
    UiProperty = "string",
    Uid = "string",
    UnixCryptPassword = "string",
    UserId = "string",
    UserProfileRef = "string",
    Username = "string",
    Uuid = "string",
});

    example, err := avi.NewUser(ctx, "userResource", &avi.UserArgs{
	Accesses: avi.UserAccessArray{
		&avi.UserAccessArgs{
			AllTenants: pulumi.String("string"),
			RoleRef:    pulumi.String("string"),
			TenantRef:  pulumi.String("string"),
		},
	},
	AnonymousUser:       pulumi.String("string"),
	DateJoined:          pulumi.String("string"),
	DefaultTenantRef:    pulumi.String("string"),
	Email:               pulumi.String("string"),
	FullName:            pulumi.String("string"),
	IsActive:            pulumi.String("string"),
	IsInternalUser:      pulumi.String("string"),
	IsStaff:             pulumi.String("string"),
	IsSuperuser:         pulumi.String("string"),
	Local:               pulumi.String("string"),
	LoggedIn:            pulumi.String("string"),
	Name:                pulumi.String("string"),
	Password:            pulumi.String("string"),
	Passwordless:        pulumi.String("string"),
	RecoveryToken:       pulumi.String("string"),
	ServiceUser:         pulumi.String("string"),
	TokenExpirationDate: pulumi.String("string"),
	UiProperty:          pulumi.String("string"),
	Uid:                 pulumi.String("string"),
	UnixCryptPassword:   pulumi.String("string"),
	UserId:              pulumi.String("string"),
	UserProfileRef:      pulumi.String("string"),
	Username:            pulumi.String("string"),
	Uuid:                pulumi.String("string"),
})

    var userResource = new User("userResource", UserArgs.builder()
    .accesses(UserAccessArgs.builder()
        .allTenants("string")
        .roleRef("string")
        .tenantRef("string")
        .build())
    .anonymousUser("string")
    .dateJoined("string")
    .defaultTenantRef("string")
    .email("string")
    .fullName("string")
    .isActive("string")
    .isInternalUser("string")
    .isStaff("string")
    .isSuperuser("string")
    .local("string")
    .loggedIn("string")
    .name("string")
    .password("string")
    .passwordless("string")
    .recoveryToken("string")
    .serviceUser("string")
    .tokenExpirationDate("string")
    .uiProperty("string")
    .uid("string")
    .unixCryptPassword("string")
    .userId("string")
    .userProfileRef("string")
    .username("string")
    .uuid("string")
    .build());

    user_resource = avi.User("userResource",
    accesses=[{
        "all_tenants": "string",
        "role_ref": "string",
        "tenant_ref": "string",
    }],
    anonymous_user="string",
    date_joined="string",
    default_tenant_ref="string",
    email="string",
    full_name="string",
    is_active="string",
    is_internal_user="string",
    is_staff="string",
    is_superuser="string",
    local="string",
    logged_in="string",
    name="string",
    password="string",
    passwordless="string",
    recovery_token="string",
    service_user="string",
    token_expiration_date="string",
    ui_property="string",
    uid="string",
    unix_crypt_password="string",
    user_id="string",
    user_profile_ref="string",
    username="string",
    uuid="string")

    const userResource = new avi.User("userResource", {
    accesses: [{
        allTenants: "string",
        roleRef: "string",
        tenantRef: "string",
    }],
    anonymousUser: "string",
    dateJoined: "string",
    defaultTenantRef: "string",
    email: "string",
    fullName: "string",
    isActive: "string",
    isInternalUser: "string",
    isStaff: "string",
    isSuperuser: "string",
    local: "string",
    loggedIn: "string",
    name: "string",
    password: "string",
    passwordless: "string",
    recoveryToken: "string",
    serviceUser: "string",
    tokenExpirationDate: "string",
    uiProperty: "string",
    uid: "string",
    unixCryptPassword: "string",
    userId: "string",
    userProfileRef: "string",
    username: "string",
    uuid: "string",
});

    type: avi:User
properties:
    accesses:
        - allTenants: string
          roleRef: string
          tenantRef: string
    anonymousUser: string
    dateJoined: string
    defaultTenantRef: string
    email: string
    fullName: string
    isActive: string
    isInternalUser: string
    isStaff: string
    isSuperuser: string
    local: string
    loggedIn: string
    name: string
    password: string
    passwordless: string
    recoveryToken: string
    serviceUser: string
    tokenExpirationDate: string
    uiProperty: string
    uid: string
    unixCryptPassword: string
    userId: string
    userProfileRef: string
    username: string
    uuid: string

    User Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The User resource accepts the following input properties:

    Accesses List<UserAccess>
    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.
    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.
    UserId string
    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 []UserAccessArgs
    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.
    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.
    UserId string
    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<UserAccess>
    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.
    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.
    userId String
    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 UserAccess[]
    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.
    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.
    userId string
    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[UserAccessArgs]
    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.
    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_id str
    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.
    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.
    userId String
    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.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the User resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing User Resource

    Get an existing User resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: UserState, opts?: CustomResourceOptions): User
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        accesses: Optional[Sequence[UserAccessArgs]] = None,
        anonymous_user: Optional[str] = None,
        date_joined: Optional[str] = None,
        default_tenant_ref: Optional[str] = None,
        email: Optional[str] = None,
        full_name: Optional[str] = None,
        is_active: Optional[str] = None,
        is_internal_user: Optional[str] = None,
        is_staff: Optional[str] = None,
        is_superuser: Optional[str] = None,
        local: Optional[str] = None,
        logged_in: Optional[str] = None,
        name: Optional[str] = None,
        password: Optional[str] = None,
        passwordless: Optional[str] = None,
        recovery_token: Optional[str] = None,
        service_user: Optional[str] = None,
        token_expiration_date: Optional[str] = None,
        ui_property: Optional[str] = None,
        uid: Optional[str] = None,
        unix_crypt_password: Optional[str] = None,
        user_id: Optional[str] = None,
        user_profile_ref: Optional[str] = None,
        username: Optional[str] = None,
        uuid: Optional[str] = None) -> User
    func GetUser(ctx *Context, name string, id IDInput, state *UserState, opts ...ResourceOption) (*User, error)
    public static User Get(string name, Input<string> id, UserState? state, CustomResourceOptions? opts = null)
    public static User get(String name, Output<String> id, UserState state, CustomResourceOptions options)
    resources:  _:    type: avi:User    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Accesses List<UserAccess>
    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.
    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.
    UserId string
    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 []UserAccessArgs
    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.
    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.
    UserId string
    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<UserAccess>
    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.
    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.
    userId String
    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 UserAccess[]
    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.
    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.
    userId string
    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[UserAccessArgs]
    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.
    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_id str
    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.
    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.
    userId String
    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.

    Supporting Types

    UserAccess, UserAccessArgs

    AllTenants string
    RoleRef string
    TenantRef string
    AllTenants string
    RoleRef string
    TenantRef string
    allTenants String
    roleRef String
    tenantRef String
    allTenants string
    roleRef string
    tenantRef string
    allTenants String
    roleRef String
    tenantRef String

    Package Details

    Repository
    avi vmware/terraform-provider-avi
    License
    Notes
    This Pulumi package is based on the avi Terraform Provider.
    avi logo
    avi 31.1.1 published on Monday, Apr 14, 2025 by vmware
    vmware/terraform-provider-avi