@pulumi/linode/getUsers.d.ts

A Pulumi package for creating and managing linode cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
 * Provides information about Linode users that match a set of filters.
 * For more information, see the [Linode APIv4 docs](https://techdocs.akamai.com/linode-api/reference/get-users).
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as linode from "@pulumi/linode";
 *
 * const filtered_users = linode.getUsers({
 *     filters: [{
 *         name: "username",
 *         values: ["test-user"],
 *     }],
 * });
 * export const users = filtered_users.then(filtered_users => filtered_users.users);
 * ```
 *
 * ## Filterable Fields
 *
 * * `username`
 *
 * * `email`
 *
 * * `restricted`
 *
 * * `userType`
 *
 * * `passwordCreated`
 *
 * * `tfaEnabled`
 *
 * * `verfiedPhoneNumber`
 */
export declare function getUsers(args?: GetUsersArgs, opts?: pulumi.InvokeOptions): Promise<GetUsersResult>;
/**
 * A collection of arguments for invoking getUsers.
 */
export interface GetUsersArgs {
    filters?: inputs.GetUsersFilter[];
    /**
     * The order in which results should be returned. (`asc`, `desc`; default `asc`)
     */
    order?: string;
    /**
     * The attribute to order the results by. See the Filterable Fields section for a list of valid fields.
     */
    orderBy?: string;
    users?: inputs.GetUsersUser[];
}
/**
 * A collection of values returned by getUsers.
 */
export interface GetUsersResult {
    readonly filters?: outputs.GetUsersFilter[];
    /**
     * The ID of entity this grant applies to.
     */
    readonly id: string;
    readonly order?: string;
    readonly orderBy?: string;
    readonly users?: outputs.GetUsersUser[];
}
/**
 * Provides information about Linode users that match a set of filters.
 * For more information, see the [Linode APIv4 docs](https://techdocs.akamai.com/linode-api/reference/get-users).
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as linode from "@pulumi/linode";
 *
 * const filtered_users = linode.getUsers({
 *     filters: [{
 *         name: "username",
 *         values: ["test-user"],
 *     }],
 * });
 * export const users = filtered_users.then(filtered_users => filtered_users.users);
 * ```
 *
 * ## Filterable Fields
 *
 * * `username`
 *
 * * `email`
 *
 * * `restricted`
 *
 * * `userType`
 *
 * * `passwordCreated`
 *
 * * `tfaEnabled`
 *
 * * `verfiedPhoneNumber`
 */
export declare function getUsersOutput(args?: GetUsersOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetUsersResult>;
/**
 * A collection of arguments for invoking getUsers.
 */
export interface GetUsersOutputArgs {
    filters?: pulumi.Input<pulumi.Input<inputs.GetUsersFilterArgs>[]>;
    /**
     * The order in which results should be returned. (`asc`, `desc`; default `asc`)
     */
    order?: pulumi.Input<string>;
    /**
     * The attribute to order the results by. See the Filterable Fields section for a list of valid fields.
     */
    orderBy?: pulumi.Input<string>;
    users?: pulumi.Input<pulumi.Input<inputs.GetUsersUserArgs>[]>;
}