Documentation
¶
Index ¶
- type Token
- type TokenArgs
- type TokenArray
- type TokenArrayInput
- type TokenArrayOutput
- type TokenInput
- type TokenMap
- type TokenMapInput
- type TokenMapOutput
- type TokenOutput
- func (o TokenOutput) Comment() pulumi.StringPtrOutput
- func (TokenOutput) ElementType() reflect.Type
- func (o TokenOutput) ExpirationDate() pulumi.StringPtrOutput
- func (o TokenOutput) PrivilegesSeparation() pulumi.BoolOutput
- func (o TokenOutput) ToTokenOutput() TokenOutput
- func (o TokenOutput) ToTokenOutputWithContext(ctx context.Context) TokenOutput
- func (o TokenOutput) TokenName() pulumi.StringOutput
- func (o TokenOutput) UserId() pulumi.StringOutput
- func (o TokenOutput) Value() pulumi.StringOutput
- type TokenState
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Token ¶
type Token struct { pulumi.CustomResourceState // Comment for the token. Comment pulumi.StringPtrOutput `pulumi:"comment"` // Expiration date for the token. ExpirationDate pulumi.StringPtrOutput `pulumi:"expirationDate"` // Restrict API token privileges with separate ACLs (default), or give full privileges of corresponding user. PrivilegesSeparation pulumi.BoolOutput `pulumi:"privilegesSeparation"` // User-specific token identifier. TokenName pulumi.StringOutput `pulumi:"tokenName"` // User identifier. UserId pulumi.StringOutput `pulumi:"userId"` // API token value used for authentication. It is populated only when creating a new token, and can't be retrieved at import. Value pulumi.StringOutput `pulumi:"value"` }
User API tokens.
## Example Usage
```go package main
import (
"github.com/muhlba91/pulumi-proxmoxve/sdk/v6/go/proxmoxve/Permission" "github.com/muhlba91/pulumi-proxmoxve/sdk/v6/go/proxmoxve/User" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { // if creating a user token, the user must be created first user, err := Permission.NewUser(ctx, "user", &Permission.UserArgs{ Comment: pulumi.String("Managed by Terraform"), Email: pulumi.String("user@pve"), Enabled: pulumi.Bool(true), ExpirationDate: pulumi.String("2034-01-01T22:00:00Z"), UserId: pulumi.String("user@pve"), }) if err != nil { return err } _, err = User.NewToken(ctx, "userToken", &User.TokenArgs{ Comment: pulumi.String("Managed by Terraform"), ExpirationDate: pulumi.String("2033-01-01T22:00:00Z"), TokenName: pulumi.String("tk1"), UserId: user.UserId, }) if err != nil { return err } return nil }) }
```
## Import
#!/usr/bin/env sh
#Tokens can be imported using they identifiers in format `user_id!token_name` format, e.g.:
```sh $ pulumi import proxmoxve:User/token:Token token1 user@pve!token1 ```
func GetToken ¶
func GetToken(ctx *pulumi.Context, name string, id pulumi.IDInput, state *TokenState, opts ...pulumi.ResourceOption) (*Token, error)
GetToken gets an existing Token resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewToken ¶
func NewToken(ctx *pulumi.Context, name string, args *TokenArgs, opts ...pulumi.ResourceOption) (*Token, error)
NewToken registers a new resource with the given unique name, arguments, and options.
func (*Token) ElementType ¶
func (*Token) ToTokenOutput ¶
func (i *Token) ToTokenOutput() TokenOutput
func (*Token) ToTokenOutputWithContext ¶
func (i *Token) ToTokenOutputWithContext(ctx context.Context) TokenOutput
type TokenArgs ¶
type TokenArgs struct { // Comment for the token. Comment pulumi.StringPtrInput // Expiration date for the token. ExpirationDate pulumi.StringPtrInput // Restrict API token privileges with separate ACLs (default), or give full privileges of corresponding user. PrivilegesSeparation pulumi.BoolPtrInput // User-specific token identifier. TokenName pulumi.StringInput // User identifier. UserId pulumi.StringInput }
The set of arguments for constructing a Token resource.
func (TokenArgs) ElementType ¶
type TokenArray ¶
type TokenArray []TokenInput
func (TokenArray) ElementType ¶
func (TokenArray) ElementType() reflect.Type
func (TokenArray) ToTokenArrayOutput ¶
func (i TokenArray) ToTokenArrayOutput() TokenArrayOutput
func (TokenArray) ToTokenArrayOutputWithContext ¶
func (i TokenArray) ToTokenArrayOutputWithContext(ctx context.Context) TokenArrayOutput
type TokenArrayInput ¶
type TokenArrayInput interface { pulumi.Input ToTokenArrayOutput() TokenArrayOutput ToTokenArrayOutputWithContext(context.Context) TokenArrayOutput }
TokenArrayInput is an input type that accepts TokenArray and TokenArrayOutput values. You can construct a concrete instance of `TokenArrayInput` via:
TokenArray{ TokenArgs{...} }
type TokenArrayOutput ¶
type TokenArrayOutput struct{ *pulumi.OutputState }
func (TokenArrayOutput) ElementType ¶
func (TokenArrayOutput) ElementType() reflect.Type
func (TokenArrayOutput) Index ¶
func (o TokenArrayOutput) Index(i pulumi.IntInput) TokenOutput
func (TokenArrayOutput) ToTokenArrayOutput ¶
func (o TokenArrayOutput) ToTokenArrayOutput() TokenArrayOutput
func (TokenArrayOutput) ToTokenArrayOutputWithContext ¶
func (o TokenArrayOutput) ToTokenArrayOutputWithContext(ctx context.Context) TokenArrayOutput
type TokenInput ¶
type TokenInput interface { pulumi.Input ToTokenOutput() TokenOutput ToTokenOutputWithContext(ctx context.Context) TokenOutput }
type TokenMap ¶
type TokenMap map[string]TokenInput
func (TokenMap) ElementType ¶
func (TokenMap) ToTokenMapOutput ¶
func (i TokenMap) ToTokenMapOutput() TokenMapOutput
func (TokenMap) ToTokenMapOutputWithContext ¶
func (i TokenMap) ToTokenMapOutputWithContext(ctx context.Context) TokenMapOutput
type TokenMapInput ¶
type TokenMapInput interface { pulumi.Input ToTokenMapOutput() TokenMapOutput ToTokenMapOutputWithContext(context.Context) TokenMapOutput }
TokenMapInput is an input type that accepts TokenMap and TokenMapOutput values. You can construct a concrete instance of `TokenMapInput` via:
TokenMap{ "key": TokenArgs{...} }
type TokenMapOutput ¶
type TokenMapOutput struct{ *pulumi.OutputState }
func (TokenMapOutput) ElementType ¶
func (TokenMapOutput) ElementType() reflect.Type
func (TokenMapOutput) MapIndex ¶
func (o TokenMapOutput) MapIndex(k pulumi.StringInput) TokenOutput
func (TokenMapOutput) ToTokenMapOutput ¶
func (o TokenMapOutput) ToTokenMapOutput() TokenMapOutput
func (TokenMapOutput) ToTokenMapOutputWithContext ¶
func (o TokenMapOutput) ToTokenMapOutputWithContext(ctx context.Context) TokenMapOutput
type TokenOutput ¶
type TokenOutput struct{ *pulumi.OutputState }
func (TokenOutput) Comment ¶
func (o TokenOutput) Comment() pulumi.StringPtrOutput
Comment for the token.
func (TokenOutput) ElementType ¶
func (TokenOutput) ElementType() reflect.Type
func (TokenOutput) ExpirationDate ¶
func (o TokenOutput) ExpirationDate() pulumi.StringPtrOutput
Expiration date for the token.
func (TokenOutput) PrivilegesSeparation ¶
func (o TokenOutput) PrivilegesSeparation() pulumi.BoolOutput
Restrict API token privileges with separate ACLs (default), or give full privileges of corresponding user.
func (TokenOutput) ToTokenOutput ¶
func (o TokenOutput) ToTokenOutput() TokenOutput
func (TokenOutput) ToTokenOutputWithContext ¶
func (o TokenOutput) ToTokenOutputWithContext(ctx context.Context) TokenOutput
func (TokenOutput) TokenName ¶
func (o TokenOutput) TokenName() pulumi.StringOutput
User-specific token identifier.
func (TokenOutput) Value ¶
func (o TokenOutput) Value() pulumi.StringOutput
API token value used for authentication. It is populated only when creating a new token, and can't be retrieved at import.
type TokenState ¶
type TokenState struct { // Comment for the token. Comment pulumi.StringPtrInput // Expiration date for the token. ExpirationDate pulumi.StringPtrInput // Restrict API token privileges with separate ACLs (default), or give full privileges of corresponding user. PrivilegesSeparation pulumi.BoolPtrInput // User-specific token identifier. TokenName pulumi.StringPtrInput // User identifier. UserId pulumi.StringPtrInput // API token value used for authentication. It is populated only when creating a new token, and can't be retrieved at import. Value pulumi.StringPtrInput }
func (TokenState) ElementType ¶
func (TokenState) ElementType() reflect.Type