@natzka-oss/pulumi-netbox/auth/user.d.ts

A Pulumi package for creating and managing Netbox cloud resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * This resource is used to manage users.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as netbox from "@natzka-oss/pulumi-netbox";
 *
 * const test = new netbox.auth.User("test", {
 *     username: "johndoe",
 *     password: "Abcdefghijkl1",
 *     active: true,
 *     staff: true,
 * });
 * ```
 */
export declare class User extends pulumi.CustomResource {
    /**
     * Get an existing User resource's state with the given name, ID, and optional extra
     * properties used to qualify the lookup.
     *
     * @param name The _unique_ name of the resulting resource.
     * @param id The _unique_ provider ID of the resource to lookup.
     * @param state Any extra arguments used during the lookup.
     * @param opts Optional settings to control the behavior of the CustomResource.
     */
    static get(name: string, id: pulumi.Input<pulumi.ID>, state?: UserState, opts?: pulumi.CustomResourceOptions): User;
    /**
     * Returns true if the given object is an instance of User.  This is designed to work even
     * when multiple copies of the Pulumi SDK have been loaded into the same process.
     */
    static isInstance(obj: any): obj is User;
    /**
     * Defaults to `true`.
     */
    readonly active: pulumi.Output<boolean | undefined>;
    readonly groupIds: pulumi.Output<number[] | undefined>;
    readonly password: pulumi.Output<string>;
    /**
     * Defaults to `false`.
     */
    readonly staff: pulumi.Output<boolean | undefined>;
    readonly username: pulumi.Output<string>;
    /**
     * Create a User resource with the given unique name, arguments, and options.
     *
     * @param name The _unique_ name of the resource.
     * @param args The arguments to use to populate this resource's properties.
     * @param opts A bag of options that control this resource's behavior.
     */
    constructor(name: string, args: UserArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering User resources.
 */
export interface UserState {
    /**
     * Defaults to `true`.
     */
    active?: pulumi.Input<boolean>;
    groupIds?: pulumi.Input<pulumi.Input<number>[]>;
    password?: pulumi.Input<string>;
    /**
     * Defaults to `false`.
     */
    staff?: pulumi.Input<boolean>;
    username?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a User resource.
 */
export interface UserArgs {
    /**
     * Defaults to `true`.
     */
    active?: pulumi.Input<boolean>;
    groupIds?: pulumi.Input<pulumi.Input<number>[]>;
    password: pulumi.Input<string>;
    /**
     * Defaults to `false`.
     */
    staff?: pulumi.Input<boolean>;
    username: pulumi.Input<string>;
}