1. Packages
  2. Grafana Cloud
  3. API Docs
  4. oss
  5. getTeam
Grafana v0.16.3 published on Monday, Apr 7, 2025 by pulumiverse

grafana.oss.getTeam

Explore with Pulumi AI

Grafana v0.16.3 published on Monday, Apr 7, 2025 by pulumiverse

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as grafana from "@pulumi/grafana";
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,
});
Copy
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)
Copy
package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-grafana/sdk/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
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Grafana = Pulumi.Grafana;
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,
    });

});
Copy
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());

    }
}
Copy
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}
Copy

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>
Copy
def get_team(name: Optional[str] = None,
             org_id: Optional[str] = None,
             read_team_sync: Optional[bool] = None,
             opts: Optional[InvokeOptions] = None) -> GetTeamResult
def get_team_output(name: Optional[pulumi.Input[str]] = None,
             org_id: Optional[pulumi.Input[str]] = None,
             read_team_sync: Optional[pulumi.Input[bool]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetTeamResult]
Copy
func LookupTeam(ctx *Context, args *LookupTeamArgs, opts ...InvokeOption) (*LookupTeamResult, error)
func LookupTeamOutput(ctx *Context, args *LookupTeamOutputArgs, opts ...InvokeOption) LookupTeamResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetTeamResult> getTeam(GetTeamArgs args, InvokeOptions options)
public static Output<GetTeamResult> getTeam(GetTeamArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: grafana:oss/getTeam:getTeam
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name This property is required. string
OrgId Changes to this property will trigger replacement. string
ReadTeamSync bool
Name This property is required. string
OrgId Changes to this property will trigger replacement. string
ReadTeamSync bool
name This property is required. String
orgId Changes to this property will trigger replacement. String
readTeamSync Boolean
name This property is required. string
orgId Changes to this property will trigger replacement. string
readTeamSync boolean
name This property is required. str
org_id Changes to this property will trigger replacement. str
read_team_sync bool
name This property is required. String
orgId Changes to this property will trigger replacement. String
readTeamSync Boolean

getTeam Result

The following output properties are available:

Email string
Id string
The provider-assigned unique ID for this managed resource.
Members []string
Name string
Preferences []GetTeamPreference
TeamId int
TeamSyncs []GetTeamTeamSync
TeamUid string
OrgId string
ReadTeamSync bool
email String
id String
The provider-assigned unique ID for this managed resource.
members List<String>
name String
preferences List<GetTeamPreference>
teamId Integer
teamSyncs List<GetTeamTeamSync>
teamUid String
orgId String
readTeamSync Boolean
email string
id string
The provider-assigned unique ID for this managed resource.
members string[]
name string
preferences GetTeamPreference[]
teamId number
teamSyncs GetTeamTeamSync[]
teamUid string
orgId string
readTeamSync boolean
email str
id str
The provider-assigned unique ID for this managed resource.
members Sequence[str]
name str
preferences Sequence[GetTeamPreference]
team_id int
team_syncs Sequence[GetTeamTeamSync]
team_uid str
org_id str
read_team_sync bool
email String
id String
The provider-assigned unique ID for this managed resource.
members List<String>
name String
preferences List<Property Map>
teamId Number
teamSyncs List<Property Map>
teamUid String
orgId String
readTeamSync Boolean

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. Available themes are light, dark, system, or an empty string for the default theme.
Timezone string
The default timezone for this team. Available values are utc, browser, or an empty string for the default.
WeekStart string
The default week start day for this team. Available values are sunday, monday, saturday, or an empty string for the default.
HomeDashboardUid string
The UID of the dashboard to display when a team member logs in.
Theme string
The default theme for this team. Available themes are light, dark, system, or an empty string for the default theme.
Timezone string
The default timezone for this team. Available values are utc, browser, or an empty string for the default.
WeekStart string
The default week start day for this team. Available values are sunday, monday, saturday, or an empty string for the default.
homeDashboardUid String
The UID of the dashboard to display when a team member logs in.
theme String
The default theme for this team. Available themes are light, dark, system, or an empty string for the default theme.
timezone String
The default timezone for this team. Available values are utc, browser, or an empty string for the default.
weekStart String
The default week start day for this team. Available values are sunday, monday, saturday, or an empty string for the default.
homeDashboardUid string
The UID of the dashboard to display when a team member logs in.
theme string
The default theme for this team. Available themes are light, dark, system, or an empty string for the default theme.
timezone string
The default timezone for this team. Available values are utc, browser, or an empty string for the default.
weekStart string
The default week start day for this team. Available values are sunday, monday, saturday, or an empty string for the default.
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. Available themes are light, dark, system, or an empty string for the default theme.
timezone str
The default timezone for this team. Available values are utc, browser, or an empty string for the default.
week_start str
The default week start day for this team. Available values are sunday, monday, saturday, or an empty string for the default.
homeDashboardUid String
The UID of the dashboard to display when a team member logs in.
theme String
The default theme for this team. Available themes are light, dark, system, or an empty string for the default theme.
timezone String
The default timezone for this team. Available values are utc, browser, or an empty string for the default.
weekStart String
The default week start day for this team. Available values are sunday, monday, saturday, or an empty string for the default.

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 v0.16.3 published on Monday, Apr 7, 2025 by pulumiverse