Proxmox Virtual Environment (Proxmox VE)

v2.0.0 published on Friday, Jul 15, 2022 by Daniel Muehlbachler-Pietrzykowski

User

Create User Resource

new User(name: string, args: UserArgs, opts?: CustomResourceOptions);
@overload
def User(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         acls: Optional[Sequence[_permission.UserAclArgs]] = None,
         comment: Optional[str] = None,
         email: Optional[str] = None,
         enabled: Optional[bool] = None,
         expiration_date: Optional[str] = None,
         first_name: Optional[str] = None,
         groups: Optional[Sequence[str]] = None,
         keys: Optional[str] = None,
         last_name: Optional[str] = None,
         password: Optional[str] = None,
         user_id: Optional[str] = None)
@overload
def User(resource_name: str,
         args: UserArgs,
         opts: Optional[ResourceOptions] = 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: proxmoxve:Permission:User
properties: # The arguments to resource properties.
options: # 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.
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.

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

The User resource accepts the following input properties:

Password string

The user's password

UserId string

The user id

Acls List<Pulumi.ProxmoxVE.Permission.Inputs.UserAclArgs>

The access control list

Comment string

The user comment

Email string

The user's email address

Enabled bool

Whether the user account is enabled

ExpirationDate string

The user account's expiration date

FirstName string

The user's first name

Groups List<string>

The user's groups

Keys string

The user's keys

LastName string

The user's last name

Password string

The user's password

UserId string

The user id

Acls []UserAclArgs

The access control list

Comment string

The user comment

Email string

The user's email address

Enabled bool

Whether the user account is enabled

ExpirationDate string

The user account's expiration date

FirstName string

The user's first name

Groups []string

The user's groups

Keys string

The user's keys

LastName string

The user's last name

password String

The user's password

userId String

The user id

acls List<UserAclArgs>

The access control list

comment String

The user comment

email String

The user's email address

enabled Boolean

Whether the user account is enabled

expirationDate String

The user account's expiration date

firstName String

The user's first name

groups List<String>

The user's groups

keys String

The user's keys

lastName String

The user's last name

password string

The user's password

userId string

The user id

acls UserAclArgs[]

The access control list

comment string

The user comment

email string

The user's email address

enabled boolean

Whether the user account is enabled

expirationDate string

The user account's expiration date

firstName string

The user's first name

groups string[]

The user's groups

keys string

The user's keys

lastName string

The user's last name

password str

The user's password

user_id str

The user id

acls UserAclArgs]

The access control list

comment str

The user comment

email str

The user's email address

enabled bool

Whether the user account is enabled

expiration_date str

The user account's expiration date

first_name str

The user's first name

groups Sequence[str]

The user's groups

keys str

The user's keys

last_name str

The user's last name

password String

The user's password

userId String

The user id

acls List<Property Map>

The access control list

comment String

The user comment

email String

The user's email address

enabled Boolean

Whether the user account is enabled

expirationDate String

The user account's expiration date

firstName String

The user's first name

groups List<String>

The user's groups

keys String

The user's keys

lastName String

The user's last name

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,
        acls: Optional[Sequence[_permission.UserAclArgs]] = None,
        comment: Optional[str] = None,
        email: Optional[str] = None,
        enabled: Optional[bool] = None,
        expiration_date: Optional[str] = None,
        first_name: Optional[str] = None,
        groups: Optional[Sequence[str]] = None,
        keys: Optional[str] = None,
        last_name: Optional[str] = None,
        password: Optional[str] = None,
        user_id: 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:
Acls List<Pulumi.ProxmoxVE.Permission.Inputs.UserAclArgs>

The access control list

Comment string

The user comment

Email string

The user's email address

Enabled bool

Whether the user account is enabled

ExpirationDate string

The user account's expiration date

FirstName string

The user's first name

Groups List<string>

The user's groups

Keys string

The user's keys

LastName string

The user's last name

Password string

The user's password

UserId string

The user id

Acls []UserAclArgs

The access control list

Comment string

The user comment

Email string

The user's email address

Enabled bool

Whether the user account is enabled

ExpirationDate string

The user account's expiration date

FirstName string

The user's first name

Groups []string

The user's groups

Keys string

The user's keys

LastName string

The user's last name

Password string

The user's password

UserId string

The user id

acls List<UserAclArgs>

The access control list

comment String

The user comment

email String

The user's email address

enabled Boolean

Whether the user account is enabled

expirationDate String

The user account's expiration date

firstName String

The user's first name

groups List<String>

The user's groups

keys String

The user's keys

lastName String

The user's last name

password String

The user's password

userId String

The user id

acls UserAclArgs[]

The access control list

comment string

The user comment

email string

The user's email address

enabled boolean

Whether the user account is enabled

expirationDate string

The user account's expiration date

firstName string

The user's first name

groups string[]

The user's groups

keys string

The user's keys

lastName string

The user's last name

password string

The user's password

userId string

The user id

acls UserAclArgs]

The access control list

comment str

The user comment

email str

The user's email address

enabled bool

Whether the user account is enabled

expiration_date str

The user account's expiration date

first_name str

The user's first name

groups Sequence[str]

The user's groups

keys str

The user's keys

last_name str

The user's last name

password str

The user's password

user_id str

The user id

acls List<Property Map>

The access control list

comment String

The user comment

email String

The user's email address

enabled Boolean

Whether the user account is enabled

expirationDate String

The user account's expiration date

firstName String

The user's first name

groups List<String>

The user's groups

keys String

The user's keys

lastName String

The user's last name

password String

The user's password

userId String

The user id

Supporting Types

UserAcl

Path string
RoleId string
Propagate bool
Path string
RoleId string
Propagate bool
path String
roleId String
propagate Boolean
path string
roleId string
propagate boolean
path String
roleId String
propagate Boolean

Package Details

Repository
https://github.com/muhlba91/pulumi-proxmoxve
License
Apache-2.0
Notes

This Pulumi package is based on the proxmoxve Terraform Provider.