@pulumiverse/grafana/oss/getTeams.d.ts

A Pulumi package for creating and managing grafana.

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
 * Fetches a list of teams from Grafana, optionally filtered by a search keyword.
 *
 * * [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 all = grafana.oss.getTeams({});
 * const dev = grafana.oss.getTeams({
 *     query: "dev",
 * });
 * ```
 */
export declare function getTeams(args?: GetTeamsArgs, opts?: pulumi.InvokeOptions): Promise<GetTeamsResult>;
/**
 * A collection of arguments for invoking getTeams.
 */
export interface GetTeamsArgs {
    /**
     * 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;
    /**
     * A keyword to filter teams by name (substring match). If omitted, all teams are returned.
     */
    query?: string;
}
/**
 * A collection of values returned by getTeams.
 */
export interface GetTeamsResult {
    /**
     * The ID of this resource.
     */
    readonly id: 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;
    /**
     * A keyword to filter teams by name (substring match). If omitted, all teams are returned.
     */
    readonly query?: string;
    /**
     * The list of matching Grafana teams.
     */
    readonly teams: outputs.oss.GetTeamsTeam[];
}
/**
 * Fetches a list of teams from Grafana, optionally filtered by a search keyword.
 *
 * * [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 all = grafana.oss.getTeams({});
 * const dev = grafana.oss.getTeams({
 *     query: "dev",
 * });
 * ```
 */
export declare function getTeamsOutput(args?: GetTeamsOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetTeamsResult>;
/**
 * A collection of arguments for invoking getTeams.
 */
export interface GetTeamsOutputArgs {
    /**
     * 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>;
    /**
     * A keyword to filter teams by name (substring match). If omitted, all teams are returned.
     */
    query?: pulumi.Input<string>;
}