@lbrlabs/pulumi-grafana
Version:
A Pulumi package for creating and managing grafana.
62 lines (61 loc) • 2.12 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "./types/output";
/**
* * [Official documentation](https://grafana.com/docs/grafana/latest/administration/user-management/server-user-management/)
* * [HTTP API](https://grafana.com/docs/grafana/latest/developers/http_api/user/)
*
* This data source uses Grafana's admin APIs for reading users which
* does not currently work with API Tokens. You must use basic auth.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as grafana from "@lbrlabs/pulumi-grafana";
* import * as grafana from "@pulumi/grafana";
*
* const testAllUsers = new grafana.User("testAllUsers", {
* email: "all_users@example.com",
* login: "test-grafana-users",
* password: "my-password",
* });
* const allUsers = grafana.getUsers({});
* ```
*/
export declare function getUsers(opts?: pulumi.InvokeOptions): Promise<GetUsersResult>;
/**
* A collection of values returned by getUsers.
*/
export interface GetUsersResult {
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
/**
* The Grafana instance's users.
*/
readonly users: outputs.GetUsersUser[];
}
/**
* * [Official documentation](https://grafana.com/docs/grafana/latest/administration/user-management/server-user-management/)
* * [HTTP API](https://grafana.com/docs/grafana/latest/developers/http_api/user/)
*
* This data source uses Grafana's admin APIs for reading users which
* does not currently work with API Tokens. You must use basic auth.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as grafana from "@lbrlabs/pulumi-grafana";
* import * as grafana from "@pulumi/grafana";
*
* const testAllUsers = new grafana.User("testAllUsers", {
* email: "all_users@example.com",
* login: "test-grafana-users",
* password: "my-password",
* });
* const allUsers = grafana.getUsers({});
* ```
*/
export declare function getUsersOutput(opts?: pulumi.InvokeOptions): pulumi.Output<GetUsersResult>;