@pulumi/gcp/organizations/getFolders.d.ts

A Pulumi package for creating and managing Google Cloud Platform resources.

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
 * Retrieve information about a set of folders based on a parent ID. See the
 * [REST API](https://cloud.google.com/resource-manager/reference/rest/v3/folders/list)
 * for more details.
 *
 * ## Example Usage
 *
 * ### Searching For Folders At The Root Of An Org
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 *
 * const my_org_folders = gcp.organizations.getFolders({
 *     parentId: `organizations/${organizationId}`,
 * });
 * const first_folder = my_org_folders.then(my_org_folders => gcp.organizations.getFolder({
 *     folder: my_org_folders.folders?.[0]?.name,
 * }));
 * ```
 */
export declare function getFolders(args: GetFoldersArgs, opts?: pulumi.InvokeOptions): Promise<GetFoldersResult>;
/**
 * A collection of arguments for invoking getFolders.
 */
export interface GetFoldersArgs {
    /**
     * A string parent as defined in the [REST API](https://cloud.google.com/resource-manager/reference/rest/v3/folders/list#query-parameters).
     */
    parentId: string;
}
/**
 * A collection of values returned by getFolders.
 */
export interface GetFoldersResult {
    /**
     * A list of folders matching the provided filter. Structure is defined below.
     */
    readonly folders: outputs.organizations.GetFoldersFolder[];
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    readonly parentId: string;
}
/**
 * Retrieve information about a set of folders based on a parent ID. See the
 * [REST API](https://cloud.google.com/resource-manager/reference/rest/v3/folders/list)
 * for more details.
 *
 * ## Example Usage
 *
 * ### Searching For Folders At The Root Of An Org
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 *
 * const my_org_folders = gcp.organizations.getFolders({
 *     parentId: `organizations/${organizationId}`,
 * });
 * const first_folder = my_org_folders.then(my_org_folders => gcp.organizations.getFolder({
 *     folder: my_org_folders.folders?.[0]?.name,
 * }));
 * ```
 */
export declare function getFoldersOutput(args: GetFoldersOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetFoldersResult>;
/**
 * A collection of arguments for invoking getFolders.
 */
export interface GetFoldersOutputArgs {
    /**
     * A string parent as defined in the [REST API](https://cloud.google.com/resource-manager/reference/rest/v3/folders/list#query-parameters).
     */
    parentId: pulumi.Input<string>;
}