@emailbob/twingate
Version:
A Pulumi package for creating and managing Twingate cloud resources.
79 lines (78 loc) • 2.4 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Groups are how users are authorized to access Resources. For more information, see Twingate's [documentation](https://docs.twingate.com/docs/groups).
*
* ## Example Usage
*
* <!--Start PulumiCodeChooser -->
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as twingate from "@pulumi/twingate";
*
* const foo = twingate.getTwingateGroup({
* id: "<your group's id>",
* });
* ```
* <!--End PulumiCodeChooser -->
*/
export declare function getTwingateGroup(args: GetTwingateGroupArgs, opts?: pulumi.InvokeOptions): Promise<GetTwingateGroupResult>;
/**
* A collection of arguments for invoking getTwingateGroup.
*/
export interface GetTwingateGroupArgs {
/**
* The ID of the Group. The ID for the Group can be obtained from the Admin API or the URL string in the Admin Console.
*/
id: string;
}
/**
* A collection of values returned by getTwingateGroup.
*/
export interface GetTwingateGroupResult {
/**
* The ID of the Group. The ID for the Group can be obtained from the Admin API or the URL string in the Admin Console.
*/
readonly id: string;
/**
* Indicates if the Group is active
*/
readonly isActive: boolean;
/**
* The name of the Group
*/
readonly name: string;
/**
* The Security Policy assigned to the Group.
*/
readonly securityPolicyId: string;
/**
* The type of the Group
*/
readonly type: string;
}
/**
* Groups are how users are authorized to access Resources. For more information, see Twingate's [documentation](https://docs.twingate.com/docs/groups).
*
* ## Example Usage
*
* <!--Start PulumiCodeChooser -->
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as twingate from "@pulumi/twingate";
*
* const foo = twingate.getTwingateGroup({
* id: "<your group's id>",
* });
* ```
* <!--End PulumiCodeChooser -->
*/
export declare function getTwingateGroupOutput(args: GetTwingateGroupOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetTwingateGroupResult>;
/**
* A collection of arguments for invoking getTwingateGroup.
*/
export interface GetTwingateGroupOutputArgs {
/**
* The ID of the Group. The ID for the Group can be obtained from the Admin API or the URL string in the Admin Console.
*/
id: pulumi.Input<string>;
}