@pulumi/scm/getVariableList.d.ts

A Pulumi package for managing resources on Strata Cloud Manager.. Based on terraform-provider-scm: version v0.2.1

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "./types/output";
/**
 * Retrieves a listing of config items.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as scm from "@pulumi/scm";
 *
 * //
 * // Data source to retrieve a list of all variables in a folder.
 * //
 * // Example 1: Fetch a list of all variables in the "Global" aka "All" folder.
 * const allGlobal = scm.getVariableList({
 *     folder: "All",
 * });
 * export const scmVariableListGlobal = allGlobal.then(allGlobal => allGlobal.datas);
 * // Example 2: Use pagination to get the first variables by name.
 * const paginated = scm.getVariableList({
 *     folder: "All",
 *     limit: 5,
 *     offset: 0,
 * });
 * export const scmVariableListPaginated = paginated.then(paginated => paginated.datas);
 * ```
 */
export declare function getVariableList(args?: GetVariableListArgs, opts?: pulumi.InvokeOptions): Promise<GetVariableListResult>;
/**
 * A collection of arguments for invoking getVariableList.
 */
export interface GetVariableListArgs {
    /**
     * The device of the item.
     */
    device?: string;
    /**
     * The folder of the item. Default: Shared.
     */
    folder?: string;
    /**
     * The max number of items to return. Default: 200.
     */
    limit?: number;
    /**
     * The name of the item.
     */
    name?: string;
    /**
     * The offset of the first item to return.
     */
    offset?: number;
    /**
     * The snippet of the item.
     */
    snippet?: string;
}
/**
 * A collection of values returned by getVariableList.
 */
export interface GetVariableListResult {
    /**
     * The data.
     */
    readonly datas: outputs.GetVariableListData[];
    /**
     * The device of the item.
     */
    readonly device?: string;
    /**
     * The folder of the item. Default: Shared.
     */
    readonly folder?: string;
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    /**
     * The max number of items to return. Default: 200.
     */
    readonly limit?: number;
    /**
     * The name of the item.
     */
    readonly name?: string;
    /**
     * The offset of the first item to return.
     */
    readonly offset?: number;
    /**
     * The snippet of the item.
     */
    readonly snippet?: string;
    readonly tfid: string;
    /**
     * The total number of items.
     */
    readonly total: number;
}
/**
 * Retrieves a listing of config items.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as scm from "@pulumi/scm";
 *
 * //
 * // Data source to retrieve a list of all variables in a folder.
 * //
 * // Example 1: Fetch a list of all variables in the "Global" aka "All" folder.
 * const allGlobal = scm.getVariableList({
 *     folder: "All",
 * });
 * export const scmVariableListGlobal = allGlobal.then(allGlobal => allGlobal.datas);
 * // Example 2: Use pagination to get the first variables by name.
 * const paginated = scm.getVariableList({
 *     folder: "All",
 *     limit: 5,
 *     offset: 0,
 * });
 * export const scmVariableListPaginated = paginated.then(paginated => paginated.datas);
 * ```
 */
export declare function getVariableListOutput(args?: GetVariableListOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetVariableListResult>;
/**
 * A collection of arguments for invoking getVariableList.
 */
export interface GetVariableListOutputArgs {
    /**
     * The device of the item.
     */
    device?: pulumi.Input<string>;
    /**
     * The folder of the item. Default: Shared.
     */
    folder?: pulumi.Input<string>;
    /**
     * The max number of items to return. Default: 200.
     */
    limit?: pulumi.Input<number>;
    /**
     * The name of the item.
     */
    name?: pulumi.Input<string>;
    /**
     * The offset of the first item to return.
     */
    offset?: pulumi.Input<number>;
    /**
     * The snippet of the item.
     */
    snippet?: pulumi.Input<string>;
}