@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
78 lines • 3.08 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Use this data source to look up the resource name of a Cloud Identity Group by its [EntityKey](https://cloud.google.com/identity/docs/reference/rest/v1/EntityKey), i.e. the group's email.
*
* https://cloud.google.com/identity/docs/concepts/overview#groups
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const group = gcp.cloudidentity.getGroupLookup({
* groupKey: {
* id: "my-group@example.com",
* },
* });
* ```
*/
export declare function getGroupLookup(args: GetGroupLookupArgs, opts?: pulumi.InvokeOptions): Promise<GetGroupLookupResult>;
/**
* A collection of arguments for invoking getGroupLookup.
*/
export interface GetGroupLookupArgs {
/**
* The EntityKey of the Group to lookup. A unique identifier for an entity in the Cloud Identity Groups API.
* An entity can represent either a group with an optional namespace or a user without a namespace.
* The combination of id and namespace must be unique; however, the same id can be used with different namespaces. Structure is documented below.
*/
groupKey: inputs.cloudidentity.GetGroupLookupGroupKey;
}
/**
* A collection of values returned by getGroupLookup.
*/
export interface GetGroupLookupResult {
readonly groupKey: outputs.cloudidentity.GetGroupLookupGroupKey;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
/**
* Resource name of the Group in the format: groups/{group_id}, where `groupId` is the unique ID assigned to the Group.
*/
readonly name: string;
}
/**
* Use this data source to look up the resource name of a Cloud Identity Group by its [EntityKey](https://cloud.google.com/identity/docs/reference/rest/v1/EntityKey), i.e. the group's email.
*
* https://cloud.google.com/identity/docs/concepts/overview#groups
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const group = gcp.cloudidentity.getGroupLookup({
* groupKey: {
* id: "my-group@example.com",
* },
* });
* ```
*/
export declare function getGroupLookupOutput(args: GetGroupLookupOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetGroupLookupResult>;
/**
* A collection of arguments for invoking getGroupLookup.
*/
export interface GetGroupLookupOutputArgs {
/**
* The EntityKey of the Group to lookup. A unique identifier for an entity in the Cloud Identity Groups API.
* An entity can represent either a group with an optional namespace or a user without a namespace.
* The combination of id and namespace must be unique; however, the same id can be used with different namespaces. Structure is documented below.
*/
groupKey: pulumi.Input<inputs.cloudidentity.GetGroupLookupGroupKeyArgs>;
}
//# sourceMappingURL=getGroupLookup.d.ts.map