@pulumi/gcp/projects/getProject.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 projects based on a filter. See the
 * [REST API](https://cloud.google.com/resource-manager/reference/rest/v1/projects/list)
 * for more details.
 *
 * ## Example Usage
 *
 * ### Searching For Projects About To Be Deleted In An Org
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 *
 * const my_org_projects = gcp.projects.getProject({
 *     filter: "parent.id:012345678910 lifecycleState:DELETE_REQUESTED",
 * });
 * const deletion_candidate = my_org_projects.then(my_org_projects => gcp.organizations.getProject({
 *     projectId: my_org_projects.projects?.[0]?.projectId,
 * }));
 * ```
 */
export declare function getProject(args: GetProjectArgs, opts?: pulumi.InvokeOptions): Promise<GetProjectResult>;
/**
 * A collection of arguments for invoking getProject.
 */
export interface GetProjectArgs {
    /**
     * A string filter as defined in the [REST API](https://cloud.google.com/resource-manager/reference/rest/v1/projects/list#query-parameters).
     */
    filter: string;
}
/**
 * A collection of values returned by getProject.
 */
export interface GetProjectResult {
    readonly filter: string;
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    /**
     * A list of projects matching the provided filter. Structure is defined below.
     */
    readonly projects: outputs.projects.GetProjectProject[];
}
/**
 * Retrieve information about a set of projects based on a filter. See the
 * [REST API](https://cloud.google.com/resource-manager/reference/rest/v1/projects/list)
 * for more details.
 *
 * ## Example Usage
 *
 * ### Searching For Projects About To Be Deleted In An Org
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 *
 * const my_org_projects = gcp.projects.getProject({
 *     filter: "parent.id:012345678910 lifecycleState:DELETE_REQUESTED",
 * });
 * const deletion_candidate = my_org_projects.then(my_org_projects => gcp.organizations.getProject({
 *     projectId: my_org_projects.projects?.[0]?.projectId,
 * }));
 * ```
 */
export declare function getProjectOutput(args: GetProjectOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetProjectResult>;
/**
 * A collection of arguments for invoking getProject.
 */
export interface GetProjectOutputArgs {
    /**
     * A string filter as defined in the [REST API](https://cloud.google.com/resource-manager/reference/rest/v1/projects/list#query-parameters).
     */
    filter: pulumi.Input<string>;
}