grafana.DashboardPermission
Explore with Pulumi AI
Example Usage
using System.Collections.Generic;
using System.IO;
using System.Linq;
using Pulumi;
using Grafana = Lbrlabs.PulumiPackage.Grafana;
return await Deployment.RunAsync(() =>
{
var team = new Grafana.Team("team");
var user = new Grafana.User("user", new()
{
Email = "user.name@example.com",
});
var metrics = new Grafana.Dashboard("metrics", new()
{
ConfigJson = File.ReadAllText("grafana-dashboard.json"),
});
var collectionPermission = new Grafana.DashboardPermission("collectionPermission", new()
{
DashboardUid = metrics.Uid,
Permissions = new[]
{
new Grafana.Inputs.DashboardPermissionPermissionArgs
{
Role = "Editor",
Permission = "Edit",
},
new Grafana.Inputs.DashboardPermissionPermissionArgs
{
TeamId = team.Id,
Permission = "View",
},
new Grafana.Inputs.DashboardPermissionPermissionArgs
{
UserId = user.Id,
Permission = "Admin",
},
},
});
});
package main
import (
"os"
"github.com/lbrlabs/pulumi-grafana/sdk/go/grafana"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func readFileOrPanic(path string) pulumi.StringPtrInput {
data, err := os.ReadFile(path)
if err != nil {
panic(err.Error())
}
return pulumi.String(string(data))
}
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
team, err := grafana.NewTeam(ctx, "team", nil)
if err != nil {
return err
}
user, err := grafana.NewUser(ctx, "user", &grafana.UserArgs{
Email: pulumi.String("user.name@example.com"),
})
if err != nil {
return err
}
metrics, err := grafana.NewDashboard(ctx, "metrics", &grafana.DashboardArgs{
ConfigJson: readFileOrPanic("grafana-dashboard.json"),
})
if err != nil {
return err
}
_, err = grafana.NewDashboardPermission(ctx, "collectionPermission", &grafana.DashboardPermissionArgs{
DashboardUid: metrics.Uid,
Permissions: grafana.DashboardPermissionPermissionArray{
&grafana.DashboardPermissionPermissionArgs{
Role: pulumi.String("Editor"),
Permission: pulumi.String("Edit"),
},
&grafana.DashboardPermissionPermissionArgs{
TeamId: team.ID(),
Permission: pulumi.String("View"),
},
&grafana.DashboardPermissionPermissionArgs{
UserId: user.ID(),
Permission: pulumi.String("Admin"),
},
},
})
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.User;
import com.pulumi.grafana.UserArgs;
import com.pulumi.grafana.Dashboard;
import com.pulumi.grafana.DashboardArgs;
import com.pulumi.grafana.DashboardPermission;
import com.pulumi.grafana.DashboardPermissionArgs;
import com.pulumi.grafana.inputs.DashboardPermissionPermissionArgs;
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 team = new Team("team");
var user = new User("user", UserArgs.builder()
.email("user.name@example.com")
.build());
var metrics = new Dashboard("metrics", DashboardArgs.builder()
.configJson(Files.readString(Paths.get("grafana-dashboard.json")))
.build());
var collectionPermission = new DashboardPermission("collectionPermission", DashboardPermissionArgs.builder()
.dashboardUid(metrics.uid())
.permissions(
DashboardPermissionPermissionArgs.builder()
.role("Editor")
.permission("Edit")
.build(),
DashboardPermissionPermissionArgs.builder()
.teamId(team.id())
.permission("View")
.build(),
DashboardPermissionPermissionArgs.builder()
.userId(user.id())
.permission("Admin")
.build())
.build());
}
}
import pulumi
import lbrlabs_pulumi_grafana as grafana
team = grafana.Team("team")
user = grafana.User("user", email="user.name@example.com")
metrics = grafana.Dashboard("metrics", config_json=(lambda path: open(path).read())("grafana-dashboard.json"))
collection_permission = grafana.DashboardPermission("collectionPermission",
dashboard_uid=metrics.uid,
permissions=[
grafana.DashboardPermissionPermissionArgs(
role="Editor",
permission="Edit",
),
grafana.DashboardPermissionPermissionArgs(
team_id=team.id,
permission="View",
),
grafana.DashboardPermissionPermissionArgs(
user_id=user.id,
permission="Admin",
),
])
import * as pulumi from "@pulumi/pulumi";
import * as fs from "fs";
import * as grafana from "@lbrlabs/pulumi-grafana";
const team = new grafana.Team("team", {});
const user = new grafana.User("user", {email: "user.name@example.com"});
const metrics = new grafana.Dashboard("metrics", {configJson: fs.readFileSync("grafana-dashboard.json")});
const collectionPermission = new grafana.DashboardPermission("collectionPermission", {
dashboardUid: metrics.uid,
permissions: [
{
role: "Editor",
permission: "Edit",
},
{
teamId: team.id,
permission: "View",
},
{
userId: user.id,
permission: "Admin",
},
],
});
resources:
team:
type: grafana:Team
user:
type: grafana:User
properties:
email: user.name@example.com
metrics:
type: grafana:Dashboard
properties:
configJson:
fn::readFile: grafana-dashboard.json
collectionPermission:
type: grafana:DashboardPermission
properties:
dashboardUid: ${metrics.uid}
permissions:
- role: Editor
permission: Edit
- teamId: ${team.id}
permission: View
- userId: ${user.id}
permission: Admin
Create DashboardPermission Resource
new DashboardPermission(name: string, args: DashboardPermissionArgs, opts?: CustomResourceOptions);
@overload
def DashboardPermission(resource_name: str,
opts: Optional[ResourceOptions] = None,
dashboard_id: Optional[int] = None,
dashboard_uid: Optional[str] = None,
org_id: Optional[str] = None,
permissions: Optional[Sequence[DashboardPermissionPermissionArgs]] = None)
@overload
def DashboardPermission(resource_name: str,
args: DashboardPermissionArgs,
opts: Optional[ResourceOptions] = None)
func NewDashboardPermission(ctx *Context, name string, args DashboardPermissionArgs, opts ...ResourceOption) (*DashboardPermission, error)
public DashboardPermission(string name, DashboardPermissionArgs args, CustomResourceOptions? opts = null)
public DashboardPermission(String name, DashboardPermissionArgs args)
public DashboardPermission(String name, DashboardPermissionArgs args, CustomResourceOptions options)
type: grafana:DashboardPermission
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DashboardPermissionArgs
- 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 DashboardPermissionArgs
- 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 DashboardPermissionArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DashboardPermissionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DashboardPermissionArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
DashboardPermission 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 DashboardPermission resource accepts the following input properties:
- Permissions
List<Lbrlabs.
Pulumi Package. Grafana. Inputs. Dashboard Permission Permission> The permission items to add/update. Items that are omitted from the list will be removed.
- Dashboard
Id int ID of the dashboard to apply permissions to. Deprecated: use
dashboard_uid
instead.use
dashboard_uid
instead- Dashboard
Uid string UID of the dashboard to apply permissions to.
- Org
Id string The Organization ID. If not set, the Org ID defined in the provider block will be used.
- Permissions
[]Dashboard
Permission Permission Args The permission items to add/update. Items that are omitted from the list will be removed.
- Dashboard
Id int ID of the dashboard to apply permissions to. Deprecated: use
dashboard_uid
instead.use
dashboard_uid
instead- Dashboard
Uid string UID of the dashboard to apply permissions to.
- Org
Id string The Organization ID. If not set, the Org ID defined in the provider block will be used.
- permissions
List<Dashboard
Permission Permission> The permission items to add/update. Items that are omitted from the list will be removed.
- dashboard
Id Integer ID of the dashboard to apply permissions to. Deprecated: use
dashboard_uid
instead.use
dashboard_uid
instead- dashboard
Uid String UID of the dashboard to apply permissions to.
- org
Id String The Organization ID. If not set, the Org ID defined in the provider block will be used.
- permissions
Dashboard
Permission Permission[] The permission items to add/update. Items that are omitted from the list will be removed.
- dashboard
Id number ID of the dashboard to apply permissions to. Deprecated: use
dashboard_uid
instead.use
dashboard_uid
instead- dashboard
Uid string UID of the dashboard to apply permissions to.
- org
Id string The Organization ID. If not set, the Org ID defined in the provider block will be used.
- permissions
Sequence[Dashboard
Permission Permission Args] The permission items to add/update. Items that are omitted from the list will be removed.
- dashboard_
id int ID of the dashboard to apply permissions to. Deprecated: use
dashboard_uid
instead.use
dashboard_uid
instead- dashboard_
uid str UID of the dashboard to apply permissions to.
- org_
id str The Organization ID. If not set, the Org ID defined in the provider block will be used.
- permissions List<Property Map>
The permission items to add/update. Items that are omitted from the list will be removed.
- dashboard
Id Number ID of the dashboard to apply permissions to. Deprecated: use
dashboard_uid
instead.use
dashboard_uid
instead- dashboard
Uid String UID of the dashboard to apply permissions to.
- org
Id String The Organization ID. If not set, the Org ID defined in the provider block will be used.
Outputs
All input properties are implicitly available as output properties. Additionally, the DashboardPermission resource produces the following output properties:
- Id string
The provider-assigned unique ID for this managed resource.
- Id string
The provider-assigned unique ID for this managed resource.
- id String
The provider-assigned unique ID for this managed resource.
- id string
The provider-assigned unique ID for this managed resource.
- id str
The provider-assigned unique ID for this managed resource.
- id String
The provider-assigned unique ID for this managed resource.
Look up Existing DashboardPermission Resource
Get an existing DashboardPermission 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?: DashboardPermissionState, opts?: CustomResourceOptions): DashboardPermission
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
dashboard_id: Optional[int] = None,
dashboard_uid: Optional[str] = None,
org_id: Optional[str] = None,
permissions: Optional[Sequence[DashboardPermissionPermissionArgs]] = None) -> DashboardPermission
func GetDashboardPermission(ctx *Context, name string, id IDInput, state *DashboardPermissionState, opts ...ResourceOption) (*DashboardPermission, error)
public static DashboardPermission Get(string name, Input<string> id, DashboardPermissionState? state, CustomResourceOptions? opts = null)
public static DashboardPermission get(String name, Output<String> id, DashboardPermissionState 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.
- Dashboard
Id int ID of the dashboard to apply permissions to. Deprecated: use
dashboard_uid
instead.use
dashboard_uid
instead- Dashboard
Uid string UID of the dashboard to apply permissions to.
- Org
Id string The Organization ID. If not set, the Org ID defined in the provider block will be used.
- Permissions
List<Lbrlabs.
Pulumi Package. Grafana. Inputs. Dashboard Permission Permission> The permission items to add/update. Items that are omitted from the list will be removed.
- Dashboard
Id int ID of the dashboard to apply permissions to. Deprecated: use
dashboard_uid
instead.use
dashboard_uid
instead- Dashboard
Uid string UID of the dashboard to apply permissions to.
- Org
Id string The Organization ID. If not set, the Org ID defined in the provider block will be used.
- Permissions
[]Dashboard
Permission Permission Args The permission items to add/update. Items that are omitted from the list will be removed.
- dashboard
Id Integer ID of the dashboard to apply permissions to. Deprecated: use
dashboard_uid
instead.use
dashboard_uid
instead- dashboard
Uid String UID of the dashboard to apply permissions to.
- org
Id String The Organization ID. If not set, the Org ID defined in the provider block will be used.
- permissions
List<Dashboard
Permission Permission> The permission items to add/update. Items that are omitted from the list will be removed.
- dashboard
Id number ID of the dashboard to apply permissions to. Deprecated: use
dashboard_uid
instead.use
dashboard_uid
instead- dashboard
Uid string UID of the dashboard to apply permissions to.
- org
Id string The Organization ID. If not set, the Org ID defined in the provider block will be used.
- permissions
Dashboard
Permission Permission[] The permission items to add/update. Items that are omitted from the list will be removed.
- dashboard_
id int ID of the dashboard to apply permissions to. Deprecated: use
dashboard_uid
instead.use
dashboard_uid
instead- dashboard_
uid str UID of the dashboard to apply permissions to.
- org_
id str The Organization ID. If not set, the Org ID defined in the provider block will be used.
- permissions
Sequence[Dashboard
Permission Permission Args] The permission items to add/update. Items that are omitted from the list will be removed.
- dashboard
Id Number ID of the dashboard to apply permissions to. Deprecated: use
dashboard_uid
instead.use
dashboard_uid
instead- dashboard
Uid String UID of the dashboard to apply permissions to.
- org
Id String The Organization ID. If not set, the Org ID defined in the provider block will be used.
- permissions List<Property Map>
The permission items to add/update. Items that are omitted from the list will be removed.
Supporting Types
DashboardPermissionPermission, DashboardPermissionPermissionArgs
- Permission string
Permission to associate with item. Must be one of
View
,Edit
, orAdmin
.- Role string
Manage permissions for
Viewer
orEditor
roles.- Team
Id string ID of the team to manage permissions for. Defaults to
0
.- User
Id string ID of the user or service account to manage permissions for. Defaults to
0
.
- Permission string
Permission to associate with item. Must be one of
View
,Edit
, orAdmin
.- Role string
Manage permissions for
Viewer
orEditor
roles.- Team
Id string ID of the team to manage permissions for. Defaults to
0
.- User
Id string ID of the user or service account to manage permissions for. Defaults to
0
.
- permission String
Permission to associate with item. Must be one of
View
,Edit
, orAdmin
.- role String
Manage permissions for
Viewer
orEditor
roles.- team
Id String ID of the team to manage permissions for. Defaults to
0
.- user
Id String ID of the user or service account to manage permissions for. Defaults to
0
.
- permission string
Permission to associate with item. Must be one of
View
,Edit
, orAdmin
.- role string
Manage permissions for
Viewer
orEditor
roles.- team
Id string ID of the team to manage permissions for. Defaults to
0
.- user
Id string ID of the user or service account to manage permissions for. Defaults to
0
.
- permission str
Permission to associate with item. Must be one of
View
,Edit
, orAdmin
.- role str
Manage permissions for
Viewer
orEditor
roles.- team_
id str ID of the team to manage permissions for. Defaults to
0
.- user_
id str ID of the user or service account to manage permissions for. Defaults to
0
.
- permission String
Permission to associate with item. Must be one of
View
,Edit
, orAdmin
.- role String
Manage permissions for
Viewer
orEditor
roles.- team
Id String ID of the team to manage permissions for. Defaults to
0
.- user
Id String ID of the user or service account to manage permissions for. Defaults to
0
.
Import
$ pulumi import grafana:index/dashboardPermission:DashboardPermission dashboard_name {{dashboard_uid}}
Package Details
- Repository
- grafana lbrlabs/pulumi-grafana
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
grafana
Terraform Provider.