1. Packages
  2. Mso Provider
  3. API Docs
  4. User
mso 1.4.0 published on Monday, Apr 14, 2025 by ciscodevnet

mso.User

Explore with Pulumi AI

mso logo
mso 1.4.0 published on Monday, Apr 14, 2025 by ciscodevnet

    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: UserArgs,
             opts: Optional[ResourceOptions] = None)
    
    @overload
    def User(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             roles: Optional[Sequence[UserRoleArgs]] = None,
             user_password: Optional[str] = None,
             username: Optional[str] = None,
             account_status: Optional[str] = None,
             domain: Optional[str] = None,
             email: Optional[str] = None,
             first_name: Optional[str] = None,
             last_name: Optional[str] = None,
             phone: Optional[str] = None,
             user_id: Optional[str] = None)
    func NewUser(ctx *Context, name string, args UserArgs, opts ...ResourceOption) (*User, error)
    public User(string name, UserArgs args, CustomResourceOptions? opts = null)
    public User(String name, UserArgs args)
    public User(String name, UserArgs args, CustomResourceOptions options)
    
    type: mso: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 Mso.User("userResource", new()
    {
        Roles = new[]
        {
            new Mso.Inputs.UserRoleArgs
            {
                Roleid = "string",
                AccessType = "string",
            },
        },
        UserPassword = "string",
        Username = "string",
        AccountStatus = "string",
        Domain = "string",
        Email = "string",
        FirstName = "string",
        LastName = "string",
        Phone = "string",
        UserId = "string",
    });
    
    example, err := mso.NewUser(ctx, "userResource", &mso.UserArgs{
    	Roles: mso.UserRoleArray{
    		&mso.UserRoleArgs{
    			Roleid:     pulumi.String("string"),
    			AccessType: pulumi.String("string"),
    		},
    	},
    	UserPassword:  pulumi.String("string"),
    	Username:      pulumi.String("string"),
    	AccountStatus: pulumi.String("string"),
    	Domain:        pulumi.String("string"),
    	Email:         pulumi.String("string"),
    	FirstName:     pulumi.String("string"),
    	LastName:      pulumi.String("string"),
    	Phone:         pulumi.String("string"),
    	UserId:        pulumi.String("string"),
    })
    
    var userResource = new User("userResource", UserArgs.builder()
        .roles(UserRoleArgs.builder()
            .roleid("string")
            .accessType("string")
            .build())
        .userPassword("string")
        .username("string")
        .accountStatus("string")
        .domain("string")
        .email("string")
        .firstName("string")
        .lastName("string")
        .phone("string")
        .userId("string")
        .build());
    
    user_resource = mso.User("userResource",
        roles=[{
            "roleid": "string",
            "access_type": "string",
        }],
        user_password="string",
        username="string",
        account_status="string",
        domain="string",
        email="string",
        first_name="string",
        last_name="string",
        phone="string",
        user_id="string")
    
    const userResource = new mso.User("userResource", {
        roles: [{
            roleid: "string",
            accessType: "string",
        }],
        userPassword: "string",
        username: "string",
        accountStatus: "string",
        domain: "string",
        email: "string",
        firstName: "string",
        lastName: "string",
        phone: "string",
        userId: "string",
    });
    
    type: mso:User
    properties:
        accountStatus: string
        domain: string
        email: string
        firstName: string
        lastName: string
        phone: string
        roles:
            - accessType: string
              roleid: string
        userId: string
        userPassword: string
        username: 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:

    Roles List<UserRole>
    UserPassword string
    Username string
    AccountStatus string
    Domain string
    Email string
    FirstName string
    LastName string
    Phone string
    UserId string
    Roles []UserRoleArgs
    UserPassword string
    Username string
    AccountStatus string
    Domain string
    Email string
    FirstName string
    LastName string
    Phone string
    UserId string
    roles List<UserRole>
    userPassword String
    username String
    accountStatus String
    domain String
    email String
    firstName String
    lastName String
    phone String
    userId String
    roles UserRole[]
    userPassword string
    username string
    accountStatus string
    domain string
    email string
    firstName string
    lastName string
    phone string
    userId string
    roles List<Property Map>
    userPassword String
    username String
    accountStatus String
    domain String
    email String
    firstName String
    lastName String
    phone String
    userId String

    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,
            account_status: Optional[str] = None,
            domain: Optional[str] = None,
            email: Optional[str] = None,
            first_name: Optional[str] = None,
            last_name: Optional[str] = None,
            phone: Optional[str] = None,
            roles: Optional[Sequence[UserRoleArgs]] = None,
            user_id: Optional[str] = None,
            user_password: Optional[str] = None,
            username: 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: mso: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:
    AccountStatus string
    Domain string
    Email string
    FirstName string
    LastName string
    Phone string
    Roles List<UserRole>
    UserId string
    UserPassword string
    Username string
    AccountStatus string
    Domain string
    Email string
    FirstName string
    LastName string
    Phone string
    Roles []UserRoleArgs
    UserId string
    UserPassword string
    Username string
    accountStatus String
    domain String
    email String
    firstName String
    lastName String
    phone String
    roles List<UserRole>
    userId String
    userPassword String
    username String
    accountStatus string
    domain string
    email string
    firstName string
    lastName string
    phone string
    roles UserRole[]
    userId string
    userPassword string
    username string
    accountStatus String
    domain String
    email String
    firstName String
    lastName String
    phone String
    roles List<Property Map>
    userId String
    userPassword String
    username String

    Supporting Types

    UserRole, UserRoleArgs

    Roleid string
    AccessType string
    Roleid string
    AccessType string
    roleid String
    accessType String
    roleid string
    accessType string
    roleid String
    accessType String

    Package Details

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