@pulumiverse/grafana
Version:
A Pulumi package for creating and managing grafana.
147 lines (146 loc) • 4.61 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* * [Official documentation](https://grafana.com/docs/grafana/latest/administration/team-management/)
* * [HTTP API](https://grafana.com/docs/grafana/latest/developer-resources/api-reference/http-api/api-legacy/team/)
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as grafana from "@pulumiverse/grafana";
*
* const test = new grafana.oss.Team("test", {
* name: "test-team",
* email: "test-team-email@test.com",
* preferences: {
* theme: "dark",
* timezone: "utc",
* },
* });
* const fromName = grafana.oss.getTeamOutput({
* name: test.name,
* });
* ```
*/
export declare function getTeam(args: GetTeamArgs, opts?: pulumi.InvokeOptions): Promise<GetTeamResult>;
/**
* A collection of arguments for invoking getTeam.
*/
export interface GetTeamArgs {
/**
* The name of the Grafana team.
*/
name: string;
/**
* The Organization ID. If not set, the default organization is used for basic authentication, or the one that owns your service account for token authentication.
*/
orgId?: string;
/**
* Team preferences.
*/
preferences?: inputs.oss.GetTeamPreference[];
/**
* Whether to read the team sync settings. This is only available in Grafana Enterprise.
*/
readTeamSync?: boolean;
/**
* Sync external auth provider groups with this Grafana team. Only available in Grafana Enterprise.
*/
teamSyncs?: inputs.oss.GetTeamTeamSync[];
}
/**
* A collection of values returned by getTeam.
*/
export interface GetTeamResult {
/**
* An email address for the team.
*/
readonly email: string;
/**
* The ID of this resource.
*/
readonly id: string;
/**
* A set of email addresses corresponding to users who are members of the team.
*/
readonly members: string[];
/**
* The name of the Grafana team.
*/
readonly name: string;
/**
* The Organization ID. If not set, the default organization is used for basic authentication, or the one that owns your service account for token authentication.
*/
readonly orgId: string;
/**
* Team preferences.
*/
readonly preferences?: outputs.oss.GetTeamPreference[];
/**
* Whether to read the team sync settings. This is only available in Grafana Enterprise.
*/
readonly readTeamSync?: boolean;
/**
* The team id assigned to this team by Grafana.
*/
readonly teamId: number;
/**
* Sync external auth provider groups with this Grafana team. Only available in Grafana Enterprise.
*/
readonly teamSyncs?: outputs.oss.GetTeamTeamSync[];
/**
* The team uid assigned to this team by Grafana.
*/
readonly teamUid: string;
}
/**
* * [Official documentation](https://grafana.com/docs/grafana/latest/administration/team-management/)
* * [HTTP API](https://grafana.com/docs/grafana/latest/developer-resources/api-reference/http-api/api-legacy/team/)
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as grafana from "@pulumiverse/grafana";
*
* const test = new grafana.oss.Team("test", {
* name: "test-team",
* email: "test-team-email@test.com",
* preferences: {
* theme: "dark",
* timezone: "utc",
* },
* });
* const fromName = grafana.oss.getTeamOutput({
* name: test.name,
* });
* ```
*/
export declare function getTeamOutput(args: GetTeamOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetTeamResult>;
/**
* A collection of arguments for invoking getTeam.
*/
export interface GetTeamOutputArgs {
/**
* The name of the Grafana team.
*/
name: pulumi.Input<string>;
/**
* The Organization ID. If not set, the default organization is used for basic authentication, or the one that owns your service account for token authentication.
*/
orgId?: pulumi.Input<string>;
/**
* Team preferences.
*/
preferences?: pulumi.Input<pulumi.Input<inputs.oss.GetTeamPreferenceArgs>[]>;
/**
* Whether to read the team sync settings. This is only available in Grafana Enterprise.
*/
readTeamSync?: pulumi.Input<boolean>;
/**
* Sync external auth provider groups with this Grafana team. Only available in Grafana Enterprise.
*/
teamSyncs?: pulumi.Input<pulumi.Input<inputs.oss.GetTeamTeamSyncArgs>[]>;
}