1. Packages
  2. Avi Provider
  3. API Docs
  4. Useraccount
avi 31.1.1 published on Monday, Apr 14, 2025 by vmware

avi.Useraccount

Explore with Pulumi AI

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

    The Useraccount resource allows the password update of a user and setting up admin password in the bootstrap.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as avi from "@pulumi/avi";
    
    const foo = new avi.Useraccount("foo", {
        username: _var.avi_username,
        oldPassword: _var.avi_current_password,
        password: _var.avi_new_password,
    });
    
    import pulumi
    import pulumi_avi as avi
    
    foo = avi.Useraccount("foo",
        username=var["avi_username"],
        old_password=var["avi_current_password"],
        password=var["avi_new_password"])
    
    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.NewUseraccount(ctx, "foo", &avi.UseraccountArgs{
    			Username:    pulumi.Any(_var.Avi_username),
    			OldPassword: pulumi.Any(_var.Avi_current_password),
    			Password:    pulumi.Any(_var.Avi_new_password),
    		})
    		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 foo = new Avi.Useraccount("foo", new()
        {
            Username = @var.Avi_username,
            OldPassword = @var.Avi_current_password,
            Password = @var.Avi_new_password,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.avi.Useraccount;
    import com.pulumi.avi.UseraccountArgs;
    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) {
            var foo = new Useraccount("foo", UseraccountArgs.builder()
                .username(var_.avi_username())
                .oldPassword(var_.avi_current_password())
                .password(var_.avi_new_password())
                .build());
    
        }
    }
    
    resources:
      foo:
        type: avi:Useraccount
        properties:
          username: ${var.avi_username}
          oldPassword: ${var.avi_current_password}
          password: ${var.avi_new_password}
    

    Create Useraccount Resource

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

    Constructor syntax

    new Useraccount(name: string, args: UseraccountArgs, opts?: CustomResourceOptions);
    @overload
    def Useraccount(resource_name: str,
                    args: UseraccountArgs,
                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def Useraccount(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    username: Optional[str] = None,
                    email: Optional[str] = None,
                    full_name: Optional[str] = None,
                    local: Optional[bool] = None,
                    name: Optional[str] = None,
                    old_password: Optional[str] = None,
                    password: Optional[str] = None,
                    useraccount_id: Optional[str] = None)
    func NewUseraccount(ctx *Context, name string, args UseraccountArgs, opts ...ResourceOption) (*Useraccount, error)
    public Useraccount(string name, UseraccountArgs args, CustomResourceOptions? opts = null)
    public Useraccount(String name, UseraccountArgs args)
    public Useraccount(String name, UseraccountArgs args, CustomResourceOptions options)
    
    type: avi:Useraccount
    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 UseraccountArgs
    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 UseraccountArgs
    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 UseraccountArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UseraccountArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UseraccountArgs
    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 useraccountResource = new Avi.Useraccount("useraccountResource", new()
    {
        Username = "string",
        Email = "string",
        FullName = "string",
        Local = false,
        Name = "string",
        OldPassword = "string",
        Password = "string",
        UseraccountId = "string",
    });
    
    example, err := avi.NewUseraccount(ctx, "useraccountResource", &avi.UseraccountArgs{
    	Username:      pulumi.String("string"),
    	Email:         pulumi.String("string"),
    	FullName:      pulumi.String("string"),
    	Local:         pulumi.Bool(false),
    	Name:          pulumi.String("string"),
    	OldPassword:   pulumi.String("string"),
    	Password:      pulumi.String("string"),
    	UseraccountId: pulumi.String("string"),
    })
    
    var useraccountResource = new Useraccount("useraccountResource", UseraccountArgs.builder()
        .username("string")
        .email("string")
        .fullName("string")
        .local(false)
        .name("string")
        .oldPassword("string")
        .password("string")
        .useraccountId("string")
        .build());
    
    useraccount_resource = avi.Useraccount("useraccountResource",
        username="string",
        email="string",
        full_name="string",
        local=False,
        name="string",
        old_password="string",
        password="string",
        useraccount_id="string")
    
    const useraccountResource = new avi.Useraccount("useraccountResource", {
        username: "string",
        email: "string",
        fullName: "string",
        local: false,
        name: "string",
        oldPassword: "string",
        password: "string",
        useraccountId: "string",
    });
    
    type: avi:Useraccount
    properties:
        email: string
        fullName: string
        local: false
        name: string
        oldPassword: string
        password: string
        useraccountId: string
        username: string
    

    Useraccount 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 Useraccount resource accepts the following input properties:

    Username string
    User name of a user who's password needs to be updated.
    Email string
    To set email for the useraccount.
    FullName string
    To set full name for the user account.
    Local bool
    Is local user.
    Name string
    To set name for the user account.
    OldPassword string
    Old/currant password of the user.
    Password string
    New paswword for the given user.
    UseraccountId string
    Username string
    User name of a user who's password needs to be updated.
    Email string
    To set email for the useraccount.
    FullName string
    To set full name for the user account.
    Local bool
    Is local user.
    Name string
    To set name for the user account.
    OldPassword string
    Old/currant password of the user.
    Password string
    New paswword for the given user.
    UseraccountId string
    username String
    User name of a user who's password needs to be updated.
    email String
    To set email for the useraccount.
    fullName String
    To set full name for the user account.
    local Boolean
    Is local user.
    name String
    To set name for the user account.
    oldPassword String
    Old/currant password of the user.
    password String
    New paswword for the given user.
    useraccountId String
    username string
    User name of a user who's password needs to be updated.
    email string
    To set email for the useraccount.
    fullName string
    To set full name for the user account.
    local boolean
    Is local user.
    name string
    To set name for the user account.
    oldPassword string
    Old/currant password of the user.
    password string
    New paswword for the given user.
    useraccountId string
    username str
    User name of a user who's password needs to be updated.
    email str
    To set email for the useraccount.
    full_name str
    To set full name for the user account.
    local bool
    Is local user.
    name str
    To set name for the user account.
    old_password str
    Old/currant password of the user.
    password str
    New paswword for the given user.
    useraccount_id str
    username String
    User name of a user who's password needs to be updated.
    email String
    To set email for the useraccount.
    fullName String
    To set full name for the user account.
    local Boolean
    Is local user.
    name String
    To set name for the user account.
    oldPassword String
    Old/currant password of the user.
    password String
    New paswword for the given user.
    useraccountId String

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Useraccount 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 Useraccount Resource

    Get an existing Useraccount 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?: UseraccountState, opts?: CustomResourceOptions): Useraccount
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            email: Optional[str] = None,
            full_name: Optional[str] = None,
            local: Optional[bool] = None,
            name: Optional[str] = None,
            old_password: Optional[str] = None,
            password: Optional[str] = None,
            useraccount_id: Optional[str] = None,
            username: Optional[str] = None) -> Useraccount
    func GetUseraccount(ctx *Context, name string, id IDInput, state *UseraccountState, opts ...ResourceOption) (*Useraccount, error)
    public static Useraccount Get(string name, Input<string> id, UseraccountState? state, CustomResourceOptions? opts = null)
    public static Useraccount get(String name, Output<String> id, UseraccountState state, CustomResourceOptions options)
    resources:  _:    type: avi:Useraccount    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:
    Email string
    To set email for the useraccount.
    FullName string
    To set full name for the user account.
    Local bool
    Is local user.
    Name string
    To set name for the user account.
    OldPassword string
    Old/currant password of the user.
    Password string
    New paswword for the given user.
    UseraccountId string
    Username string
    User name of a user who's password needs to be updated.
    Email string
    To set email for the useraccount.
    FullName string
    To set full name for the user account.
    Local bool
    Is local user.
    Name string
    To set name for the user account.
    OldPassword string
    Old/currant password of the user.
    Password string
    New paswword for the given user.
    UseraccountId string
    Username string
    User name of a user who's password needs to be updated.
    email String
    To set email for the useraccount.
    fullName String
    To set full name for the user account.
    local Boolean
    Is local user.
    name String
    To set name for the user account.
    oldPassword String
    Old/currant password of the user.
    password String
    New paswword for the given user.
    useraccountId String
    username String
    User name of a user who's password needs to be updated.
    email string
    To set email for the useraccount.
    fullName string
    To set full name for the user account.
    local boolean
    Is local user.
    name string
    To set name for the user account.
    oldPassword string
    Old/currant password of the user.
    password string
    New paswword for the given user.
    useraccountId string
    username string
    User name of a user who's password needs to be updated.
    email str
    To set email for the useraccount.
    full_name str
    To set full name for the user account.
    local bool
    Is local user.
    name str
    To set name for the user account.
    old_password str
    Old/currant password of the user.
    password str
    New paswword for the given user.
    useraccount_id str
    username str
    User name of a user who's password needs to be updated.
    email String
    To set email for the useraccount.
    fullName String
    To set full name for the user account.
    local Boolean
    Is local user.
    name String
    To set name for the user account.
    oldPassword String
    Old/currant password of the user.
    password String
    New paswword for the given user.
    useraccountId String
    username String
    User name of a user who's password needs to be updated.

    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