1. Packages
  2. Proxmox Virtual Environment (Proxmox VE)
  3. API Docs
  4. Permission
  5. getUsers
Proxmox Virtual Environment (Proxmox VE) v6.15.3 published on Monday, Nov 11, 2024 by Daniel Muehlbachler-Pietrzykowski

proxmoxve.Permission.getUsers

Explore with Pulumi AI

proxmoxve logo
Proxmox Virtual Environment (Proxmox VE) v6.15.3 published on Monday, Nov 11, 2024 by Daniel Muehlbachler-Pietrzykowski

    Retrieves information about all the available users.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as proxmoxve from "@pulumi/proxmoxve";
    
    const availableUsers = proxmoxve.Permission.getUsers({});
    
    import pulumi
    import pulumi_proxmoxve as proxmoxve
    
    available_users = proxmoxve.Permission.get_users()
    
    package main
    
    import (
    	"github.com/muhlba91/pulumi-proxmoxve/sdk/v6/go/proxmoxve/Permission"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := Permission.GetUsers(ctx, map[string]interface{}{}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using ProxmoxVE = Pulumi.ProxmoxVE;
    
    return await Deployment.RunAsync(() => 
    {
        var availableUsers = ProxmoxVE.Permission.GetUsers.Invoke();
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.proxmoxve.Permission.PermissionFunctions;
    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) {
            final var availableUsers = PermissionFunctions.getUsers();
    
        }
    }
    
    variables:
      availableUsers:
        fn::invoke:
          Function: proxmoxve:Permission:getUsers
          Arguments: {}
    

    Using getUsers

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getUsers(opts?: InvokeOptions): Promise<GetUsersResult>
    function getUsersOutput(opts?: InvokeOptions): Output<GetUsersResult>
    def get_users(opts: Optional[InvokeOptions] = None) -> GetUsersResult
    def get_users_output(opts: Optional[InvokeOptions] = None) -> Output[GetUsersResult]
    func GetUsers(ctx *Context, opts ...InvokeOption) (*GetUsersResult, error)
    func GetUsersOutput(ctx *Context, opts ...InvokeOption) GetUsersResultOutput

    > Note: This function is named GetUsers in the Go SDK.

    public static class GetUsers 
    {
        public static Task<GetUsersResult> InvokeAsync(InvokeOptions? opts = null)
        public static Output<GetUsersResult> Invoke(InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetUsersResult> getUsers(InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: proxmoxve:Permission/getUsers:getUsers
      arguments:
        # arguments dictionary

    getUsers Result

    The following output properties are available:

    Comments List<string>
    The user comments.
    Emails List<string>
    The users' email addresses.
    Enableds List<bool>
    Whether a user account is enabled.
    ExpirationDates List<string>
    The user accounts' expiration dates (RFC 3339).
    FirstNames List<string>
    The users' first names.
    Groups List<ImmutableArray<string>>
    The users' groups.
    Id string
    The provider-assigned unique ID for this managed resource.
    Keys List<string>
    The users' keys.
    LastNames List<string>
    The users' last names.
    UserIds List<string>
    The user identifiers.
    Comments []string
    The user comments.
    Emails []string
    The users' email addresses.
    Enableds []bool
    Whether a user account is enabled.
    ExpirationDates []string
    The user accounts' expiration dates (RFC 3339).
    FirstNames []string
    The users' first names.
    Groups [][]string
    The users' groups.
    Id string
    The provider-assigned unique ID for this managed resource.
    Keys []string
    The users' keys.
    LastNames []string
    The users' last names.
    UserIds []string
    The user identifiers.
    comments List<String>
    The user comments.
    emails List<String>
    The users' email addresses.
    enableds List<Boolean>
    Whether a user account is enabled.
    expirationDates List<String>
    The user accounts' expiration dates (RFC 3339).
    firstNames List<String>
    The users' first names.
    groups List<List<String>>
    The users' groups.
    id String
    The provider-assigned unique ID for this managed resource.
    keys List<String>
    The users' keys.
    lastNames List<String>
    The users' last names.
    userIds List<String>
    The user identifiers.
    comments string[]
    The user comments.
    emails string[]
    The users' email addresses.
    enableds boolean[]
    Whether a user account is enabled.
    expirationDates string[]
    The user accounts' expiration dates (RFC 3339).
    firstNames string[]
    The users' first names.
    groups string[][]
    The users' groups.
    id string
    The provider-assigned unique ID for this managed resource.
    keys string[]
    The users' keys.
    lastNames string[]
    The users' last names.
    userIds string[]
    The user identifiers.
    comments Sequence[str]
    The user comments.
    emails Sequence[str]
    The users' email addresses.
    enableds Sequence[bool]
    Whether a user account is enabled.
    expiration_dates Sequence[str]
    The user accounts' expiration dates (RFC 3339).
    first_names Sequence[str]
    The users' first names.
    groups Sequence[Sequence[str]]
    The users' groups.
    id str
    The provider-assigned unique ID for this managed resource.
    keys Sequence[str]
    The users' keys.
    last_names Sequence[str]
    The users' last names.
    user_ids Sequence[str]
    The user identifiers.
    comments List<String>
    The user comments.
    emails List<String>
    The users' email addresses.
    enableds List<Boolean>
    Whether a user account is enabled.
    expirationDates List<String>
    The user accounts' expiration dates (RFC 3339).
    firstNames List<String>
    The users' first names.
    groups List<List<String>>
    The users' groups.
    id String
    The provider-assigned unique ID for this managed resource.
    keys List<String>
    The users' keys.
    lastNames List<String>
    The users' last names.
    userIds List<String>
    The user identifiers.

    Package Details

    Repository
    proxmoxve muhlba91/pulumi-proxmoxve
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the proxmox Terraform Provider.
    proxmoxve logo
    Proxmox Virtual Environment (Proxmox VE) v6.15.3 published on Monday, Nov 11, 2024 by Daniel Muehlbachler-Pietrzykowski