1. Packages
  2. Packages
  3. Grafana Cloud
  4. API Docs
  5. oss
  6. getTeam
Viewing docs for Grafana v2.29.0
published on Friday, May 1, 2026 by pulumiverse
Schema (JSON)
pulumiverse/pulumi-grafana

grafana.oss.getTeam

grafana logo
Viewing docs for Grafana v2.29.0
published on Friday, May 1, 2026 by pulumiverse
Schema (JSON)
pulumiverse/pulumi-grafana

    Example Usage

    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,
});

    import pulumi
import pulumi_grafana as grafana
import pulumiverse_grafana as grafana

test = grafana.oss.Team("test",
    name="test-team",
    email="test-team-email@test.com",
    preferences={
        "theme": "dark",
        "timezone": "utc",
    })
from_name = grafana.oss.get_team_output(name=test.name)

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-grafana/sdk/v2/go/grafana/oss"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		test, err := oss.NewTeam(ctx, "test", &oss.TeamArgs{
			Name:  pulumi.String("test-team"),
			Email: pulumi.String("test-team-email@test.com"),
			Preferences: &oss.TeamPreferencesArgs{
				Theme:    pulumi.String("dark"),
				Timezone: pulumi.String("utc"),
			},
		})
		if err != nil {
			return err
		}
		_ = oss.LookupTeamOutput(ctx, oss.GetTeamOutputArgs{
			Name: test.Name,
		}, nil)
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Grafana = Pulumiverse.Grafana;

return await Deployment.RunAsync(() => 
{
    var test = new Grafana.Oss.Team("test", new()
    {
        Name = "test-team",
        Email = "test-team-email@test.com",
        Preferences = new Grafana.Oss.Inputs.TeamPreferencesArgs
        {
            Theme = "dark",
            Timezone = "utc",
        },
    });

    var fromName = Grafana.Oss.GetTeam.Invoke(new()
    {
        Name = test.Name,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.grafana.oss.Team;
import com.pulumi.grafana.oss.TeamArgs;
import com.pulumi.grafana.oss.inputs.TeamPreferencesArgs;
import com.pulumi.grafana.oss.OssFunctions;
import com.pulumi.grafana.oss.inputs.GetTeamArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var test = new Team("test", TeamArgs.builder()
            .name("test-team")
            .email("test-team-email@test.com")
            .preferences(TeamPreferencesArgs.builder()
                .theme("dark")
                .timezone("utc")
                .build())
            .build());

        final var fromName = OssFunctions.getTeam(GetTeamArgs.builder()
            .name(test.name())
            .build());

    }
}

    resources:
  test:
    type: grafana:oss:Team
    properties:
      name: test-team
      email: test-team-email@test.com
      preferences:
        theme: dark
        timezone: utc
variables:
  fromName:
    fn::invoke:
      function: grafana:oss:getTeam
      arguments:
        name: ${test.name}

    Using getTeam

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getTeam(args: GetTeamArgs, opts?: InvokeOptions): Promise<GetTeamResult>
function getTeamOutput(args: GetTeamOutputArgs, opts?: InvokeOptions): Output<GetTeamResult>
    def get_team(name: Optional[str] = None,
             org_id: Optional[str] = None,
             preferences: Optional[Sequence[GetTeamPreference]] = None,
             read_team_sync: Optional[bool] = None,
             team_syncs: Optional[Sequence[GetTeamTeamSync]] = None,
             opts: Optional[InvokeOptions] = None) -> GetTeamResult
def get_team_output(name: pulumi.Input[Optional[str]] = None,
             org_id: pulumi.Input[Optional[str]] = None,
             preferences: pulumi.Input[Optional[Sequence[pulumi.Input[GetTeamPreferenceArgs]]]] = None,
             read_team_sync: pulumi.Input[Optional[bool]] = None,
             team_syncs: pulumi.Input[Optional[Sequence[pulumi.Input[GetTeamTeamSyncArgs]]]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetTeamResult]
    func LookupTeam(ctx *Context, args *LookupTeamArgs, opts ...InvokeOption) (*LookupTeamResult, error)
func LookupTeamOutput(ctx *Context, args *LookupTeamOutputArgs, opts ...InvokeOption) LookupTeamResultOutput

    > Note: This function is named LookupTeam in the Go SDK.

    public static class GetTeam 
{
    public static Task<GetTeamResult> InvokeAsync(GetTeamArgs args, InvokeOptions? opts = null)
    public static Output<GetTeamResult> Invoke(GetTeamInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetTeamResult> getTeam(GetTeamArgs args, InvokeOptions options)
public static Output<GetTeamResult> getTeam(GetTeamArgs args, InvokeOptions options)

    fn::invoke:
  function: grafana:oss/getTeam:getTeam
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Name string
    The name of the Grafana team.
    OrgId 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.
    Preferences List<Pulumiverse.Grafana.Oss.Inputs.GetTeamPreference>
    Team preferences.
    ReadTeamSync bool
    Whether to read the team sync settings. This is only available in Grafana Enterprise.
    TeamSyncs List<Pulumiverse.Grafana.Oss.Inputs.GetTeamTeamSync>
    Sync external auth provider groups with this Grafana team. Only available in Grafana Enterprise.
    Name string
    The name of the Grafana team.
    OrgId 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.
    Preferences []GetTeamPreference
    Team preferences.
    ReadTeamSync bool
    Whether to read the team sync settings. This is only available in Grafana Enterprise.
    TeamSyncs []GetTeamTeamSync
    Sync external auth provider groups with this Grafana team. Only available in Grafana Enterprise.
    name String
    The name of the Grafana team.
    orgId 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.
    preferences List<GetTeamPreference>
    Team preferences.
    readTeamSync Boolean
    Whether to read the team sync settings. This is only available in Grafana Enterprise.
    teamSyncs List<GetTeamTeamSync>
    Sync external auth provider groups with this Grafana team. Only available in Grafana Enterprise.
    name string
    The name of the Grafana team.
    orgId 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.
    preferences GetTeamPreference[]
    Team preferences.
    readTeamSync boolean
    Whether to read the team sync settings. This is only available in Grafana Enterprise.
    teamSyncs GetTeamTeamSync[]
    Sync external auth provider groups with this Grafana team. Only available in Grafana Enterprise.
    name str
    The name of the Grafana team.
    org_id str
    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.
    preferences Sequence[GetTeamPreference]
    Team preferences.
    read_team_sync bool
    Whether to read the team sync settings. This is only available in Grafana Enterprise.
    team_syncs Sequence[GetTeamTeamSync]
    Sync external auth provider groups with this Grafana team. Only available in Grafana Enterprise.
    name String
    The name of the Grafana team.
    orgId 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.
    preferences List<Property Map>
    Team preferences.
    readTeamSync Boolean
    Whether to read the team sync settings. This is only available in Grafana Enterprise.
    teamSyncs List<Property Map>
    Sync external auth provider groups with this Grafana team. Only available in Grafana Enterprise.

    getTeam Result

    The following output properties are available:

    Email string
    An email address for the team.
    Id string
    The ID of this resource.
    Members List<string>
    A set of email addresses corresponding to users who are members of the team.
    Name string
    The name of the Grafana team.
    OrgId 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.
    TeamId int
    The team id assigned to this team by Grafana.
    TeamUid string
    The team uid assigned to this team by Grafana.
    Preferences List<Pulumiverse.Grafana.Oss.Outputs.GetTeamPreference>
    Team preferences.
    ReadTeamSync bool
    Whether to read the team sync settings. This is only available in Grafana Enterprise.
    TeamSyncs List<Pulumiverse.Grafana.Oss.Outputs.GetTeamTeamSync>
    Sync external auth provider groups with this Grafana team. Only available in Grafana Enterprise.
    Email string
    An email address for the team.
    Id string
    The ID of this resource.
    Members []string
    A set of email addresses corresponding to users who are members of the team.
    Name string
    The name of the Grafana team.
    OrgId 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.
    TeamId int
    The team id assigned to this team by Grafana.
    TeamUid string
    The team uid assigned to this team by Grafana.
    Preferences []GetTeamPreference
    Team preferences.
    ReadTeamSync bool
    Whether to read the team sync settings. This is only available in Grafana Enterprise.
    TeamSyncs []GetTeamTeamSync
    Sync external auth provider groups with this Grafana team. Only available in Grafana Enterprise.
    email String
    An email address for the team.
    id String
    The ID of this resource.
    members List<String>
    A set of email addresses corresponding to users who are members of the team.
    name String
    The name of the Grafana team.
    orgId 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.
    teamId Integer
    The team id assigned to this team by Grafana.
    teamUid String
    The team uid assigned to this team by Grafana.
    preferences List<GetTeamPreference>
    Team preferences.
    readTeamSync Boolean
    Whether to read the team sync settings. This is only available in Grafana Enterprise.
    teamSyncs List<GetTeamTeamSync>
    Sync external auth provider groups with this Grafana team. Only available in Grafana Enterprise.
    email string
    An email address for the team.
    id string
    The ID of this resource.
    members string[]
    A set of email addresses corresponding to users who are members of the team.
    name string
    The name of the Grafana team.
    orgId 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.
    teamId number
    The team id assigned to this team by Grafana.
    teamUid string
    The team uid assigned to this team by Grafana.
    preferences GetTeamPreference[]
    Team preferences.
    readTeamSync boolean
    Whether to read the team sync settings. This is only available in Grafana Enterprise.
    teamSyncs GetTeamTeamSync[]
    Sync external auth provider groups with this Grafana team. Only available in Grafana Enterprise.
    email str
    An email address for the team.
    id str
    The ID of this resource.
    members Sequence[str]
    A set of email addresses corresponding to users who are members of the team.
    name str
    The name of the Grafana team.
    org_id str
    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.
    team_id int
    The team id assigned to this team by Grafana.
    team_uid str
    The team uid assigned to this team by Grafana.
    preferences Sequence[GetTeamPreference]
    Team preferences.
    read_team_sync bool
    Whether to read the team sync settings. This is only available in Grafana Enterprise.
    team_syncs Sequence[GetTeamTeamSync]
    Sync external auth provider groups with this Grafana team. Only available in Grafana Enterprise.
    email String
    An email address for the team.
    id String
    The ID of this resource.
    members List<String>
    A set of email addresses corresponding to users who are members of the team.
    name String
    The name of the Grafana team.
    orgId 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.
    teamId Number
    The team id assigned to this team by Grafana.
    teamUid String
    The team uid assigned to this team by Grafana.
    preferences List<Property Map>
    Team preferences.
    readTeamSync Boolean
    Whether to read the team sync settings. This is only available in Grafana Enterprise.
    teamSyncs List<Property Map>
    Sync external auth provider groups with this Grafana team. Only available in Grafana Enterprise.

    Supporting Types

    GetTeamPreference

    HomeDashboardUid string
    The UID of the dashboard to display when a team member logs in.
    Theme string
    The default theme for this team.
    Timezone string
    The default timezone for this team.
    WeekStart string
    The default week start day for this team.
    HomeDashboardUid string
    The UID of the dashboard to display when a team member logs in.
    Theme string
    The default theme for this team.
    Timezone string
    The default timezone for this team.
    WeekStart string
    The default week start day for this team.
    homeDashboardUid String
    The UID of the dashboard to display when a team member logs in.
    theme String
    The default theme for this team.
    timezone String
    The default timezone for this team.
    weekStart String
    The default week start day for this team.
    homeDashboardUid string
    The UID of the dashboard to display when a team member logs in.
    theme string
    The default theme for this team.
    timezone string
    The default timezone for this team.
    weekStart string
    The default week start day for this team.
    home_dashboard_uid str
    The UID of the dashboard to display when a team member logs in.
    theme str
    The default theme for this team.
    timezone str
    The default timezone for this team.
    week_start str
    The default week start day for this team.
    homeDashboardUid String
    The UID of the dashboard to display when a team member logs in.
    theme String
    The default theme for this team.
    timezone String
    The default timezone for this team.
    weekStart String
    The default week start day for this team.

    GetTeamTeamSync

    Groups List<string>
    Groups []string
    groups List<String>
    groups string[]
    groups Sequence[str]
    groups List<String>

    Package Details

    Repository
    grafana pulumiverse/pulumi-grafana
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the grafana Terraform Provider.
    grafana logo
    Viewing docs for Grafana v2.29.0
    published on Friday, May 1, 2026 by pulumiverse
    Schema (JSON)
    pulumiverse/pulumi-grafana
      Try Pulumi Cloud free. Your team will thank you.