Docs Packages
  1. Packages
  2. Grafana Cloud
  3. API Docs
  4. RoleAssignmentItem
Grafana v0.5.1 published on Wednesday, Jun 12, 2024 by pulumiverse
pulumiverse/pulumi-grafana

grafana.RoleAssignmentItem

Explore with Pulumi AI

grafana logo
Grafana v0.5.1 published on Wednesday, Jun 12, 2024 by pulumiverse
pulumiverse/pulumi-grafana

    Manages a single assignment for a role. Conflicts with the “grafana.RoleAssignment” resource which manages the entire set of assignments for a role.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as grafana from "@pulumiverse/grafana";

const testRole = new grafana.Role("testRole", {
    uid: "testrole",
    version: 1,
    global: true,
    permissions: [{
        action: "org.users:add",
        scope: "users:*",
    }],
});
const testTeam = new grafana.Team("testTeam", {});
const testUser = new grafana.User("testUser", {
    email: "terraform_user@test.com",
    login: "terraform_user@test.com",
    password: "password",
});
const testSa = new grafana.ServiceAccount("testSa", {role: "Viewer"});
const user = new grafana.RoleAssignmentItem("user", {
    roleUid: testRole.uid,
    userId: testUser.id,
});
const team = new grafana.RoleAssignmentItem("team", {
    roleUid: testRole.uid,
    teamId: testTeam.id,
});
const serviceAccount = new grafana.RoleAssignmentItem("serviceAccount", {
    roleUid: testRole.uid,
    serviceAccountId: testSa.id,
});

    import pulumi
import pulumiverse_grafana as grafana

test_role = grafana.Role("testRole",
    uid="testrole",
    version=1,
    global_=True,
    permissions=[grafana.RolePermissionArgs(
        action="org.users:add",
        scope="users:*",
    )])
test_team = grafana.Team("testTeam")
test_user = grafana.User("testUser",
    email="terraform_user@test.com",
    login="terraform_user@test.com",
    password="password")
test_sa = grafana.ServiceAccount("testSa", role="Viewer")
user = grafana.RoleAssignmentItem("user",
    role_uid=test_role.uid,
    user_id=test_user.id)
team = grafana.RoleAssignmentItem("team",
    role_uid=test_role.uid,
    team_id=test_team.id)
service_account = grafana.RoleAssignmentItem("serviceAccount",
    role_uid=test_role.uid,
    service_account_id=test_sa.id)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		testRole, err := grafana.NewRole(ctx, "testRole", &grafana.RoleArgs{
			Uid:     pulumi.String("testrole"),
			Version: pulumi.Int(1),
			Global:  pulumi.Bool(true),
			Permissions: grafana.RolePermissionArray{
				&grafana.RolePermissionArgs{
					Action: pulumi.String("org.users:add"),
					Scope:  pulumi.String("users:*"),
				},
			},
		})
		if err != nil {
			return err
		}
		testTeam, err := grafana.NewTeam(ctx, "testTeam", nil)
		if err != nil {
			return err
		}
		testUser, err := grafana.NewUser(ctx, "testUser", &grafana.UserArgs{
			Email:    pulumi.String("terraform_user@test.com"),
			Login:    pulumi.String("terraform_user@test.com"),
			Password: pulumi.String("password"),
		})
		if err != nil {
			return err
		}
		testSa, err := grafana.NewServiceAccount(ctx, "testSa", &grafana.ServiceAccountArgs{
			Role: pulumi.String("Viewer"),
		})
		if err != nil {
			return err
		}
		_, err = grafana.NewRoleAssignmentItem(ctx, "user", &grafana.RoleAssignmentItemArgs{
			RoleUid: testRole.Uid,
			UserId:  testUser.ID(),
		})
		if err != nil {
			return err
		}
		_, err = grafana.NewRoleAssignmentItem(ctx, "team", &grafana.RoleAssignmentItemArgs{
			RoleUid: testRole.Uid,
			TeamId:  testTeam.ID(),
		})
		if err != nil {
			return err
		}
		_, err = grafana.NewRoleAssignmentItem(ctx, "serviceAccount", &grafana.RoleAssignmentItemArgs{
			RoleUid:          testRole.Uid,
			ServiceAccountId: testSa.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var testRole = new Grafana.Role("testRole", new()
    {
        Uid = "testrole",
        Version = 1,
        Global = true,
        Permissions = new[]
        {
            new Grafana.Inputs.RolePermissionArgs
            {
                Action = "org.users:add",
                Scope = "users:*",
            },
        },
    });

    var testTeam = new Grafana.Team("testTeam");

    var testUser = new Grafana.User("testUser", new()
    {
        Email = "terraform_user@test.com",
        Login = "terraform_user@test.com",
        Password = "password",
    });

    var testSa = new Grafana.ServiceAccount("testSa", new()
    {
        Role = "Viewer",
    });

    var user = new Grafana.RoleAssignmentItem("user", new()
    {
        RoleUid = testRole.Uid,
        UserId = testUser.Id,
    });

    var team = new Grafana.RoleAssignmentItem("team", new()
    {
        RoleUid = testRole.Uid,
        TeamId = testTeam.Id,
    });

    var serviceAccount = new Grafana.RoleAssignmentItem("serviceAccount", new()
    {
        RoleUid = testRole.Uid,
        ServiceAccountId = testSa.Id,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.grafana.Role;
import com.pulumi.grafana.RoleArgs;
import com.pulumi.grafana.inputs.RolePermissionArgs;
import com.pulumi.grafana.Team;
import com.pulumi.grafana.User;
import com.pulumi.grafana.UserArgs;
import com.pulumi.grafana.ServiceAccount;
import com.pulumi.grafana.ServiceAccountArgs;
import com.pulumi.grafana.RoleAssignmentItem;
import com.pulumi.grafana.RoleAssignmentItemArgs;
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 testRole = new Role("testRole", RoleArgs.builder()        
            .uid("testrole")
            .version(1)
            .global(true)
            .permissions(RolePermissionArgs.builder()
                .action("org.users:add")
                .scope("users:*")
                .build())
            .build());

        var testTeam = new Team("testTeam");

        var testUser = new User("testUser", UserArgs.builder()        
            .email("terraform_user@test.com")
            .login("terraform_user@test.com")
            .password("password")
            .build());

        var testSa = new ServiceAccount("testSa", ServiceAccountArgs.builder()        
            .role("Viewer")
            .build());

        var user = new RoleAssignmentItem("user", RoleAssignmentItemArgs.builder()        
            .roleUid(testRole.uid())
            .userId(testUser.id())
            .build());

        var team = new RoleAssignmentItem("team", RoleAssignmentItemArgs.builder()        
            .roleUid(testRole.uid())
            .teamId(testTeam.id())
            .build());

        var serviceAccount = new RoleAssignmentItem("serviceAccount", RoleAssignmentItemArgs.builder()        
            .roleUid(testRole.uid())
            .serviceAccountId(testSa.id())
            .build());

    }
}

    resources:
  testRole:
    type: grafana:Role
    properties:
      uid: testrole
      version: 1
      global: true
      permissions:
        - action: org.users:add
          scope: users:*
  testTeam:
    type: grafana:Team
  testUser:
    type: grafana:User
    properties:
      email: terraform_user@test.com
      login: terraform_user@test.com
      password: password
  testSa:
    type: grafana:ServiceAccount
    properties:
      role: Viewer
  user:
    type: grafana:RoleAssignmentItem
    properties:
      roleUid: ${testRole.uid}
      userId: ${testUser.id}
  team:
    type: grafana:RoleAssignmentItem
    properties:
      roleUid: ${testRole.uid}
      teamId: ${testTeam.id}
  serviceAccount:
    type: grafana:RoleAssignmentItem
    properties:
      roleUid: ${testRole.uid}
      serviceAccountId: ${testSa.id}

    Create RoleAssignmentItem Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new RoleAssignmentItem(name: string, args: RoleAssignmentItemArgs, opts?: CustomResourceOptions);
    @overload
def RoleAssignmentItem(resource_name: str,
                       args: RoleAssignmentItemArgs,
                       opts: Optional[ResourceOptions] = None)

@overload
def RoleAssignmentItem(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       role_uid: Optional[str] = None,
                       org_id: Optional[str] = None,
                       service_account_id: Optional[str] = None,
                       team_id: Optional[str] = None,
                       user_id: Optional[str] = None)
    func NewRoleAssignmentItem(ctx *Context, name string, args RoleAssignmentItemArgs, opts ...ResourceOption) (*RoleAssignmentItem, error)
    public RoleAssignmentItem(string name, RoleAssignmentItemArgs args, CustomResourceOptions? opts = null)
    public RoleAssignmentItem(String name, RoleAssignmentItemArgs args)
public RoleAssignmentItem(String name, RoleAssignmentItemArgs args, CustomResourceOptions options)

    type: grafana:RoleAssignmentItem
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args RoleAssignmentItemArgs
    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 RoleAssignmentItemArgs
    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 RoleAssignmentItemArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RoleAssignmentItemArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RoleAssignmentItemArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var roleAssignmentItemResource = new Grafana.RoleAssignmentItem("roleAssignmentItemResource", new()
{
    RoleUid = "string",
    OrgId = "string",
    ServiceAccountId = "string",
    TeamId = "string",
    UserId = "string",
});

    example, err := grafana.NewRoleAssignmentItem(ctx, "roleAssignmentItemResource", &grafana.RoleAssignmentItemArgs{
	RoleUid:          pulumi.String("string"),
	OrgId:            pulumi.String("string"),
	ServiceAccountId: pulumi.String("string"),
	TeamId:           pulumi.String("string"),
	UserId:           pulumi.String("string"),
})

    var roleAssignmentItemResource = new RoleAssignmentItem("roleAssignmentItemResource", RoleAssignmentItemArgs.builder()
    .roleUid("string")
    .orgId("string")
    .serviceAccountId("string")
    .teamId("string")
    .userId("string")
    .build());

    role_assignment_item_resource = grafana.RoleAssignmentItem("roleAssignmentItemResource",
    role_uid="string",
    org_id="string",
    service_account_id="string",
    team_id="string",
    user_id="string")

    const roleAssignmentItemResource = new grafana.RoleAssignmentItem("roleAssignmentItemResource", {
    roleUid: "string",
    orgId: "string",
    serviceAccountId: "string",
    teamId: "string",
    userId: "string",
});

    type: grafana:RoleAssignmentItem
properties:
    orgId: string
    roleUid: string
    serviceAccountId: string
    teamId: string
    userId: string

    RoleAssignmentItem 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 RoleAssignmentItem resource accepts the following input properties:

    RoleUid string
    the role UID onto which to assign an actor
    OrgId string
    The Organization ID. If not set, the Org ID defined in the provider block will be used.
    ServiceAccountId string
    the service account onto which the role is to be assigned
    TeamId string
    the team onto which the role is to be assigned
    UserId string
    the user onto which the role is to be assigned
    RoleUid string
    the role UID onto which to assign an actor
    OrgId string
    The Organization ID. If not set, the Org ID defined in the provider block will be used.
    ServiceAccountId string
    the service account onto which the role is to be assigned
    TeamId string
    the team onto which the role is to be assigned
    UserId string
    the user onto which the role is to be assigned
    roleUid String
    the role UID onto which to assign an actor
    orgId String
    The Organization ID. If not set, the Org ID defined in the provider block will be used.
    serviceAccountId String
    the service account onto which the role is to be assigned
    teamId String
    the team onto which the role is to be assigned
    userId String
    the user onto which the role is to be assigned
    roleUid string
    the role UID onto which to assign an actor
    orgId string
    The Organization ID. If not set, the Org ID defined in the provider block will be used.
    serviceAccountId string
    the service account onto which the role is to be assigned
    teamId string
    the team onto which the role is to be assigned
    userId string
    the user onto which the role is to be assigned
    role_uid str
    the role UID onto which to assign an actor
    org_id str
    The Organization ID. If not set, the Org ID defined in the provider block will be used.
    service_account_id str
    the service account onto which the role is to be assigned
    team_id str
    the team onto which the role is to be assigned
    user_id str
    the user onto which the role is to be assigned
    roleUid String
    the role UID onto which to assign an actor
    orgId String
    The Organization ID. If not set, the Org ID defined in the provider block will be used.
    serviceAccountId String
    the service account onto which the role is to be assigned
    teamId String
    the team onto which the role is to be assigned
    userId String
    the user onto which the role is to be assigned

    Outputs

    All input properties are implicitly available as output properties. Additionally, the RoleAssignmentItem 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 RoleAssignmentItem Resource

    Get an existing RoleAssignmentItem 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?: RoleAssignmentItemState, opts?: CustomResourceOptions): RoleAssignmentItem
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        org_id: Optional[str] = None,
        role_uid: Optional[str] = None,
        service_account_id: Optional[str] = None,
        team_id: Optional[str] = None,
        user_id: Optional[str] = None) -> RoleAssignmentItem
    func GetRoleAssignmentItem(ctx *Context, name string, id IDInput, state *RoleAssignmentItemState, opts ...ResourceOption) (*RoleAssignmentItem, error)
    public static RoleAssignmentItem Get(string name, Input<string> id, RoleAssignmentItemState? state, CustomResourceOptions? opts = null)
    public static RoleAssignmentItem get(String name, Output<String> id, RoleAssignmentItemState 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:
    OrgId string
    The Organization ID. If not set, the Org ID defined in the provider block will be used.
    RoleUid string
    the role UID onto which to assign an actor
    ServiceAccountId string
    the service account onto which the role is to be assigned
    TeamId string
    the team onto which the role is to be assigned
    UserId string
    the user onto which the role is to be assigned
    OrgId string
    The Organization ID. If not set, the Org ID defined in the provider block will be used.
    RoleUid string
    the role UID onto which to assign an actor
    ServiceAccountId string
    the service account onto which the role is to be assigned
    TeamId string
    the team onto which the role is to be assigned
    UserId string
    the user onto which the role is to be assigned
    orgId String
    The Organization ID. If not set, the Org ID defined in the provider block will be used.
    roleUid String
    the role UID onto which to assign an actor
    serviceAccountId String
    the service account onto which the role is to be assigned
    teamId String
    the team onto which the role is to be assigned
    userId String
    the user onto which the role is to be assigned
    orgId string
    The Organization ID. If not set, the Org ID defined in the provider block will be used.
    roleUid string
    the role UID onto which to assign an actor
    serviceAccountId string
    the service account onto which the role is to be assigned
    teamId string
    the team onto which the role is to be assigned
    userId string
    the user onto which the role is to be assigned
    org_id str
    The Organization ID. If not set, the Org ID defined in the provider block will be used.
    role_uid str
    the role UID onto which to assign an actor
    service_account_id str
    the service account onto which the role is to be assigned
    team_id str
    the team onto which the role is to be assigned
    user_id str
    the user onto which the role is to be assigned
    orgId String
    The Organization ID. If not set, the Org ID defined in the provider block will be used.
    roleUid String
    the role UID onto which to assign an actor
    serviceAccountId String
    the service account onto which the role is to be assigned
    teamId String
    the team onto which the role is to be assigned
    userId String
    the user onto which the role is to be assigned

    Import

    $ pulumi import grafana:index/roleAssignmentItem:RoleAssignmentItem name "{{ roleUID }}:{{ type (user, team or service_account) }}:{{ identifier }}"

    $ pulumi import grafana:index/roleAssignmentItem:RoleAssignmentItem name "{{ orgID }}:{{ roleUID }}:{{ type (user, team or service_account) }}:{{ identifier }}"

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    grafana pulumiverse/pulumi-grafana
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the grafana Terraform Provider.
    grafana logo
    Grafana v0.5.1 published on Wednesday, Jun 12, 2024 by pulumiverse
    pulumiverse/pulumi-grafana