@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
69 lines (68 loc) • 2.46 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Gets a list of all organizations.
* See [the official documentation](https://cloud.google.com/resource-manager/docs/creating-managing-organization)
* and [API](https://cloud.google.com/resource-manager/reference/rest/v1/organizations/search).
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const example = gcp.organizations.getS({
* filter: "domain:example.com",
* });
* ```
*/
export declare function getS(args?: GetSArgs, opts?: pulumi.InvokeOptions): Promise<GetSResult>;
/**
* A collection of arguments for invoking getS.
*/
export interface GetSArgs {
/**
* An optional query string used to filter the Organizations to return in the response. Filter rules are case-insensitive. Further information can be found in the [REST API](https://cloud.google.com/resource-manager/reference/rest/v1/organizations/search#request-body).
*/
filter?: string;
}
/**
* A collection of values returned by getS.
*/
export interface GetSResult {
readonly filter?: string;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
/**
* A list of all retrieved organizations. Structure is defined below.
*/
readonly organizations: outputs.organizations.GetSOrganization[];
}
/**
* Gets a list of all organizations.
* See [the official documentation](https://cloud.google.com/resource-manager/docs/creating-managing-organization)
* and [API](https://cloud.google.com/resource-manager/reference/rest/v1/organizations/search).
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const example = gcp.organizations.getS({
* filter: "domain:example.com",
* });
* ```
*/
export declare function getSOutput(args?: GetSOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetSResult>;
/**
* A collection of arguments for invoking getS.
*/
export interface GetSOutputArgs {
/**
* An optional query string used to filter the Organizations to return in the response. Filter rules are case-insensitive. Further information can be found in the [REST API](https://cloud.google.com/resource-manager/reference/rest/v1/organizations/search#request-body).
*/
filter?: pulumi.Input<string>;
}