Docs Packages
  1. Pulumi Registry
  2. Grafana Cloud
  3. API Docs
  4. Team
grafana logo
Grafana v0.0.10, May 21 23

grafana.Team

Explore with Pulumi AI

Example Usage

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Grafana = Lbrlabs.PulumiPackage.Grafana;

return await Deployment.RunAsync(() => 
{
    var test_team = new Grafana.Team("test-team", new()
    {
        Email = "teamemail@example.com",
        Members = new[]
        {
            "viewer-01@example.com",
        },
    });

});

package main

import (
	"github.com/lbrlabs/pulumi-grafana/sdk/go/grafana"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := grafana.NewTeam(ctx, "test-team", &grafana.TeamArgs{
			Email: pulumi.String("teamemail@example.com"),
			Members: pulumi.StringArray{
				pulumi.String("viewer-01@example.com"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.grafana.Team;
import com.pulumi.grafana.TeamArgs;
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_team = new Team("test-team", TeamArgs.builder()        
            .email("teamemail@example.com")
            .members("viewer-01@example.com")
            .build());

    }
}

import pulumi
import lbrlabs_pulumi_grafana as grafana

test_team = grafana.Team("test-team",
    email="teamemail@example.com",
    members=["viewer-01@example.com"])

import * as pulumi from "@pulumi/pulumi";
import * as grafana from "@lbrlabs/pulumi-grafana";

const test_team = new grafana.Team("test-team", {
    email: "teamemail@example.com",
    members: ["viewer-01@example.com"],
});

resources:
  test-team:
    type: grafana:Team
    properties:
      email: teamemail@example.com
      members:
        - viewer-01@example.com

Create Team Resource

new Team(name: string, args?: TeamArgs, opts?: CustomResourceOptions);
@overload
def Team(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         email: Optional[str] = None,
         ignore_externally_synced_members: Optional[bool] = None,
         members: Optional[Sequence[str]] = None,
         name: Optional[str] = None,
         preferences: Optional[TeamPreferencesArgs] = None)
@overload
def Team(resource_name: str,
         args: Optional[TeamArgs] = None,
         opts: Optional[ResourceOptions] = None)
func NewTeam(ctx *Context, name string, args *TeamArgs, opts ...ResourceOption) (*Team, error)
public Team(string name, TeamArgs? args = null, CustomResourceOptions? opts = null)
public Team(String name, TeamArgs args)
public Team(String name, TeamArgs args, CustomResourceOptions options)

type: grafana:Team
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args TeamArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args TeamArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args TeamArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args TeamArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args TeamArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Team Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Team resource accepts the following input properties:

Email string

An email address for the team.

IgnoreExternallySyncedMembers bool

Ignores team members that have been added to team by Team Sync. Team Sync can be provisioned using grafanateamexternal_group resource. Defaults to true.

Members List<string>

A set of email addresses corresponding to users who should be given membership to the team. Note: users specified here must already exist in Grafana.

Name string

The display name for the Grafana team created.

Preferences Lbrlabs.PulumiPackage.Grafana.Inputs.TeamPreferencesArgs
Email string

An email address for the team.

IgnoreExternallySyncedMembers bool

Ignores team members that have been added to team by Team Sync. Team Sync can be provisioned using grafanateamexternal_group resource. Defaults to true.

Members []string

A set of email addresses corresponding to users who should be given membership to the team. Note: users specified here must already exist in Grafana.

Name string

The display name for the Grafana team created.

Preferences TeamPreferencesTypeArgs
email String

An email address for the team.

ignoreExternallySyncedMembers Boolean

Ignores team members that have been added to team by Team Sync. Team Sync can be provisioned using grafanateamexternal_group resource. Defaults to true.

members List<String>

A set of email addresses corresponding to users who should be given membership to the team. Note: users specified here must already exist in Grafana.

name String

The display name for the Grafana team created.

preferences TeamPreferencesArgs
email string

An email address for the team.

ignoreExternallySyncedMembers boolean

Ignores team members that have been added to team by Team Sync. Team Sync can be provisioned using grafanateamexternal_group resource. Defaults to true.

members string[]

A set of email addresses corresponding to users who should be given membership to the team. Note: users specified here must already exist in Grafana.

name string

The display name for the Grafana team created.

preferences TeamPreferencesArgs
email str

An email address for the team.

ignore_externally_synced_members bool

Ignores team members that have been added to team by Team Sync. Team Sync can be provisioned using grafanateamexternal_group resource. Defaults to true.

members Sequence[str]

A set of email addresses corresponding to users who should be given membership to the team. Note: users specified here must already exist in Grafana.

name str

The display name for the Grafana team created.

preferences TeamPreferencesArgs
email String

An email address for the team.

ignoreExternallySyncedMembers Boolean

Ignores team members that have been added to team by Team Sync. Team Sync can be provisioned using grafanateamexternal_group resource. Defaults to true.

members List<String>

A set of email addresses corresponding to users who should be given membership to the team. Note: users specified here must already exist in Grafana.

name String

The display name for the Grafana team created.

preferences Property Map

Outputs

All input properties are implicitly available as output properties. Additionally, the Team resource produces the following output properties:

Id string

The provider-assigned unique ID for this managed resource.

TeamId int

The team id assigned to this team by Grafana.

Id string

The provider-assigned unique ID for this managed resource.

TeamId int

The team id assigned to this team by Grafana.

id String

The provider-assigned unique ID for this managed resource.

teamId Integer

The team id assigned to this team by Grafana.

id string

The provider-assigned unique ID for this managed resource.

teamId number

The team id assigned to this team by Grafana.

id str

The provider-assigned unique ID for this managed resource.

team_id int

The team id assigned to this team by Grafana.

id String

The provider-assigned unique ID for this managed resource.

teamId Number

The team id assigned to this team by Grafana.

Look up Existing Team Resource

Get an existing Team resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: TeamState, opts?: CustomResourceOptions): Team
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        email: Optional[str] = None,
        ignore_externally_synced_members: Optional[bool] = None,
        members: Optional[Sequence[str]] = None,
        name: Optional[str] = None,
        preferences: Optional[TeamPreferencesArgs] = None,
        team_id: Optional[int] = None) -> Team
func GetTeam(ctx *Context, name string, id IDInput, state *TeamState, opts ...ResourceOption) (*Team, error)
public static Team Get(string name, Input<string> id, TeamState? state, CustomResourceOptions? opts = null)
public static Team get(String name, Output<String> id, TeamState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Email string

An email address for the team.

IgnoreExternallySyncedMembers bool

Ignores team members that have been added to team by Team Sync. Team Sync can be provisioned using grafanateamexternal_group resource. Defaults to true.

Members List<string>

A set of email addresses corresponding to users who should be given membership to the team. Note: users specified here must already exist in Grafana.

Name string

The display name for the Grafana team created.

Preferences Lbrlabs.PulumiPackage.Grafana.Inputs.TeamPreferencesArgs
TeamId int

The team id assigned to this team by Grafana.

Email string

An email address for the team.

IgnoreExternallySyncedMembers bool

Ignores team members that have been added to team by Team Sync. Team Sync can be provisioned using grafanateamexternal_group resource. Defaults to true.

Members []string

A set of email addresses corresponding to users who should be given membership to the team. Note: users specified here must already exist in Grafana.

Name string

The display name for the Grafana team created.

Preferences TeamPreferencesTypeArgs
TeamId int

The team id assigned to this team by Grafana.

email String

An email address for the team.

ignoreExternallySyncedMembers Boolean

Ignores team members that have been added to team by Team Sync. Team Sync can be provisioned using grafanateamexternal_group resource. Defaults to true.

members List<String>

A set of email addresses corresponding to users who should be given membership to the team. Note: users specified here must already exist in Grafana.

name String

The display name for the Grafana team created.

preferences TeamPreferencesArgs
teamId Integer

The team id assigned to this team by Grafana.

email string

An email address for the team.

ignoreExternallySyncedMembers boolean

Ignores team members that have been added to team by Team Sync. Team Sync can be provisioned using grafanateamexternal_group resource. Defaults to true.

members string[]

A set of email addresses corresponding to users who should be given membership to the team. Note: users specified here must already exist in Grafana.

name string

The display name for the Grafana team created.

preferences TeamPreferencesArgs
teamId number

The team id assigned to this team by Grafana.

email str

An email address for the team.

ignore_externally_synced_members bool

Ignores team members that have been added to team by Team Sync. Team Sync can be provisioned using grafanateamexternal_group resource. Defaults to true.

members Sequence[str]

A set of email addresses corresponding to users who should be given membership to the team. Note: users specified here must already exist in Grafana.

name str

The display name for the Grafana team created.

preferences TeamPreferencesArgs
team_id int

The team id assigned to this team by Grafana.

email String

An email address for the team.

ignoreExternallySyncedMembers Boolean

Ignores team members that have been added to team by Team Sync. Team Sync can be provisioned using grafanateamexternal_group resource. Defaults to true.

members List<String>

A set of email addresses corresponding to users who should be given membership to the team. Note: users specified here must already exist in Grafana.

name String

The display name for the Grafana team created.

preferences Property Map
teamId Number

The team id assigned to this team by Grafana.

Supporting Types

TeamPreferences

HomeDashboardUid string

The UID of the dashboard to display when a team member logs in. Defaults to ``.

Theme string

The default theme for this team. Available themes are light, dark, or an empty string for the default theme. Defaults to ``.

Timezone string

The default timezone for this team. Available values are utc, browser, or an empty string for the default. Defaults to ``.

HomeDashboardUid string

The UID of the dashboard to display when a team member logs in. Defaults to ``.

Theme string

The default theme for this team. Available themes are light, dark, or an empty string for the default theme. Defaults to ``.

Timezone string

The default timezone for this team. Available values are utc, browser, or an empty string for the default. Defaults to ``.

homeDashboardUid String

The UID of the dashboard to display when a team member logs in. Defaults to ``.

theme String

The default theme for this team. Available themes are light, dark, or an empty string for the default theme. Defaults to ``.

timezone String

The default timezone for this team. Available values are utc, browser, or an empty string for the default. Defaults to ``.

homeDashboardUid string

The UID of the dashboard to display when a team member logs in. Defaults to ``.

theme string

The default theme for this team. Available themes are light, dark, or an empty string for the default theme. Defaults to ``.

timezone string

The default timezone for this team. Available values are utc, browser, or an empty string for the default. Defaults to ``.

home_dashboard_uid str

The UID of the dashboard to display when a team member logs in. Defaults to ``.

theme str

The default theme for this team. Available themes are light, dark, or an empty string for the default theme. Defaults to ``.

timezone str

The default timezone for this team. Available values are utc, browser, or an empty string for the default. Defaults to ``.

homeDashboardUid String

The UID of the dashboard to display when a team member logs in. Defaults to ``.

theme String

The default theme for this team. Available themes are light, dark, or an empty string for the default theme. Defaults to ``.

timezone String

The default timezone for this team. Available values are utc, browser, or an empty string for the default. Defaults to ``.

Package Details

Repository
grafana lbrlabs/pulumi-grafana
License
Apache-2.0
Notes

This Pulumi package is based on the grafana Terraform Provider.