1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. quickbi
  5. User
Alibaba Cloud v3.66.0 published on Friday, Nov 15, 2024 by Pulumi

alicloud.quickbi.User

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.66.0 published on Friday, Nov 15, 2024 by Pulumi

    Provides a Quick BI User resource.

    For information about Quick BI User and how to use it, see What is User.

    NOTE: Available in v1.136.0+.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as alicloud from "@pulumi/alicloud";
    
    const example = new alicloud.quickbi.User("example", {
        accountName: "example_value",
        adminUser: false,
        authAdminUser: false,
        nickName: "example_value",
        userType: "Analyst",
    });
    
    import pulumi
    import pulumi_alicloud as alicloud
    
    example = alicloud.quickbi.User("example",
        account_name="example_value",
        admin_user=False,
        auth_admin_user=False,
        nick_name="example_value",
        user_type="Analyst")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/quickbi"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := quickbi.NewUser(ctx, "example", &quickbi.UserArgs{
    			AccountName:   pulumi.String("example_value"),
    			AdminUser:     pulumi.Bool(false),
    			AuthAdminUser: pulumi.Bool(false),
    			NickName:      pulumi.String("example_value"),
    			UserType:      pulumi.String("Analyst"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AliCloud = Pulumi.AliCloud;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new AliCloud.QuickBI.User("example", new()
        {
            AccountName = "example_value",
            AdminUser = false,
            AuthAdminUser = false,
            NickName = "example_value",
            UserType = "Analyst",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.alicloud.quickbi.User;
    import com.pulumi.alicloud.quickbi.UserArgs;
    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 example = new User("example", UserArgs.builder()
                .accountName("example_value")
                .adminUser(false)
                .authAdminUser(false)
                .nickName("example_value")
                .userType("Analyst")
                .build());
    
        }
    }
    
    resources:
      example:
        type: alicloud:quickbi:User
        properties:
          accountName: example_value
          adminUser: false
          authAdminUser: false
          nickName: example_value
          userType: Analyst
    

    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,
             account_name: Optional[str] = None,
             admin_user: Optional[bool] = None,
             auth_admin_user: Optional[bool] = None,
             nick_name: Optional[str] = None,
             user_type: Optional[str] = None,
             account_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: alicloud:quickbi: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 exampleuserResourceResourceFromQuickbiuser = new AliCloud.QuickBI.User("exampleuserResourceResourceFromQuickbiuser", new()
    {
        AccountName = "string",
        AdminUser = false,
        AuthAdminUser = false,
        NickName = "string",
        UserType = "string",
        AccountId = "string",
    });
    
    example, err := quickbi.NewUser(ctx, "exampleuserResourceResourceFromQuickbiuser", &quickbi.UserArgs{
    	AccountName:   pulumi.String("string"),
    	AdminUser:     pulumi.Bool(false),
    	AuthAdminUser: pulumi.Bool(false),
    	NickName:      pulumi.String("string"),
    	UserType:      pulumi.String("string"),
    	AccountId:     pulumi.String("string"),
    })
    
    var exampleuserResourceResourceFromQuickbiuser = new User("exampleuserResourceResourceFromQuickbiuser", UserArgs.builder()
        .accountName("string")
        .adminUser(false)
        .authAdminUser(false)
        .nickName("string")
        .userType("string")
        .accountId("string")
        .build());
    
    exampleuser_resource_resource_from_quickbiuser = alicloud.quickbi.User("exampleuserResourceResourceFromQuickbiuser",
        account_name="string",
        admin_user=False,
        auth_admin_user=False,
        nick_name="string",
        user_type="string",
        account_id="string")
    
    const exampleuserResourceResourceFromQuickbiuser = new alicloud.quickbi.User("exampleuserResourceResourceFromQuickbiuser", {
        accountName: "string",
        adminUser: false,
        authAdminUser: false,
        nickName: "string",
        userType: "string",
        accountId: "string",
    });
    
    type: alicloud:quickbi:User
    properties:
        accountId: string
        accountName: string
        adminUser: false
        authAdminUser: false
        nickName: string
        userType: 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:

    AccountName string
    An Alibaba Cloud account, Alibaba Cloud name.
    AdminUser bool
    Whether it is the administrator. Valid values: true and false.
    AuthAdminUser bool
    Whether this is a permissions administrator. Valid values: false, true.
    NickName string
    The nickname of the user.
    UserType string
    The members of the organization of the type of role separately. Valid values: Analyst, Developer and Visitor.
    AccountId string
    Alibaba Cloud account ID.
    AccountName string
    An Alibaba Cloud account, Alibaba Cloud name.
    AdminUser bool
    Whether it is the administrator. Valid values: true and false.
    AuthAdminUser bool
    Whether this is a permissions administrator. Valid values: false, true.
    NickName string
    The nickname of the user.
    UserType string
    The members of the organization of the type of role separately. Valid values: Analyst, Developer and Visitor.
    AccountId string
    Alibaba Cloud account ID.
    accountName String
    An Alibaba Cloud account, Alibaba Cloud name.
    adminUser Boolean
    Whether it is the administrator. Valid values: true and false.
    authAdminUser Boolean
    Whether this is a permissions administrator. Valid values: false, true.
    nickName String
    The nickname of the user.
    userType String
    The members of the organization of the type of role separately. Valid values: Analyst, Developer and Visitor.
    accountId String
    Alibaba Cloud account ID.
    accountName string
    An Alibaba Cloud account, Alibaba Cloud name.
    adminUser boolean
    Whether it is the administrator. Valid values: true and false.
    authAdminUser boolean
    Whether this is a permissions administrator. Valid values: false, true.
    nickName string
    The nickname of the user.
    userType string
    The members of the organization of the type of role separately. Valid values: Analyst, Developer and Visitor.
    accountId string
    Alibaba Cloud account ID.
    account_name str
    An Alibaba Cloud account, Alibaba Cloud name.
    admin_user bool
    Whether it is the administrator. Valid values: true and false.
    auth_admin_user bool
    Whether this is a permissions administrator. Valid values: false, true.
    nick_name str
    The nickname of the user.
    user_type str
    The members of the organization of the type of role separately. Valid values: Analyst, Developer and Visitor.
    account_id str
    Alibaba Cloud account ID.
    accountName String
    An Alibaba Cloud account, Alibaba Cloud name.
    adminUser Boolean
    Whether it is the administrator. Valid values: true and false.
    authAdminUser Boolean
    Whether this is a permissions administrator. Valid values: false, true.
    nickName String
    The nickname of the user.
    userType String
    The members of the organization of the type of role separately. Valid values: Analyst, Developer and Visitor.
    accountId String
    Alibaba Cloud account ID.

    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_id: Optional[str] = None,
            account_name: Optional[str] = None,
            admin_user: Optional[bool] = None,
            auth_admin_user: Optional[bool] = None,
            nick_name: Optional[str] = None,
            user_type: 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)
    Resource lookup is not supported in YAML
    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:
    AccountId string
    Alibaba Cloud account ID.
    AccountName string
    An Alibaba Cloud account, Alibaba Cloud name.
    AdminUser bool
    Whether it is the administrator. Valid values: true and false.
    AuthAdminUser bool
    Whether this is a permissions administrator. Valid values: false, true.
    NickName string
    The nickname of the user.
    UserType string
    The members of the organization of the type of role separately. Valid values: Analyst, Developer and Visitor.
    AccountId string
    Alibaba Cloud account ID.
    AccountName string
    An Alibaba Cloud account, Alibaba Cloud name.
    AdminUser bool
    Whether it is the administrator. Valid values: true and false.
    AuthAdminUser bool
    Whether this is a permissions administrator. Valid values: false, true.
    NickName string
    The nickname of the user.
    UserType string
    The members of the organization of the type of role separately. Valid values: Analyst, Developer and Visitor.
    accountId String
    Alibaba Cloud account ID.
    accountName String
    An Alibaba Cloud account, Alibaba Cloud name.
    adminUser Boolean
    Whether it is the administrator. Valid values: true and false.
    authAdminUser Boolean
    Whether this is a permissions administrator. Valid values: false, true.
    nickName String
    The nickname of the user.
    userType String
    The members of the organization of the type of role separately. Valid values: Analyst, Developer and Visitor.
    accountId string
    Alibaba Cloud account ID.
    accountName string
    An Alibaba Cloud account, Alibaba Cloud name.
    adminUser boolean
    Whether it is the administrator. Valid values: true and false.
    authAdminUser boolean
    Whether this is a permissions administrator. Valid values: false, true.
    nickName string
    The nickname of the user.
    userType string
    The members of the organization of the type of role separately. Valid values: Analyst, Developer and Visitor.
    account_id str
    Alibaba Cloud account ID.
    account_name str
    An Alibaba Cloud account, Alibaba Cloud name.
    admin_user bool
    Whether it is the administrator. Valid values: true and false.
    auth_admin_user bool
    Whether this is a permissions administrator. Valid values: false, true.
    nick_name str
    The nickname of the user.
    user_type str
    The members of the organization of the type of role separately. Valid values: Analyst, Developer and Visitor.
    accountId String
    Alibaba Cloud account ID.
    accountName String
    An Alibaba Cloud account, Alibaba Cloud name.
    adminUser Boolean
    Whether it is the administrator. Valid values: true and false.
    authAdminUser Boolean
    Whether this is a permissions administrator. Valid values: false, true.
    nickName String
    The nickname of the user.
    userType String
    The members of the organization of the type of role separately. Valid values: Analyst, Developer and Visitor.

    Import

    Quick BI User can be imported using the id, e.g.

    $ pulumi import alicloud:quickbi/user:User example <id>
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Alibaba Cloud pulumi/pulumi-alicloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the alicloud Terraform Provider.
    alicloud logo
    Alibaba Cloud v3.66.0 published on Friday, Nov 15, 2024 by Pulumi