Grafana v0.4.2 published on Monday, Apr 15, 2024 by pulumiverse
grafana.DashboardPermission
Explore with Pulumi AI
Create DashboardPermission Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new DashboardPermission(name: string, args?: DashboardPermissionArgs, opts?: CustomResourceOptions);
@overload
def DashboardPermission(resource_name: str,
args: Optional[DashboardPermissionArgs] = None,
opts: Optional[ResourceOptions] = None)
@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)
func NewDashboardPermission(ctx *Context, name string, args *DashboardPermissionArgs, opts ...ResourceOption) (*DashboardPermission, error)
public DashboardPermission(string name, DashboardPermissionArgs? args = null, 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.
Parameters
- 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.
Example
The following reference example uses placeholder values for all input properties.
var dashboardPermissionResource = new Grafana.DashboardPermission("dashboardPermissionResource", new()
{
DashboardUid = "string",
OrgId = "string",
Permissions = new[]
{
new Grafana.Inputs.DashboardPermissionPermissionArgs
{
Permission = "string",
Role = "string",
TeamId = "string",
UserId = "string",
},
},
});
example, err := grafana.NewDashboardPermission(ctx, "dashboardPermissionResource", &grafana.DashboardPermissionArgs{
DashboardUid: pulumi.String("string"),
OrgId: pulumi.String("string"),
Permissions: grafana.DashboardPermissionPermissionArray{
&grafana.DashboardPermissionPermissionArgs{
Permission: pulumi.String("string"),
Role: pulumi.String("string"),
TeamId: pulumi.String("string"),
UserId: pulumi.String("string"),
},
},
})
var dashboardPermissionResource = new DashboardPermission("dashboardPermissionResource", DashboardPermissionArgs.builder()
.dashboardUid("string")
.orgId("string")
.permissions(DashboardPermissionPermissionArgs.builder()
.permission("string")
.role("string")
.teamId("string")
.userId("string")
.build())
.build());
dashboard_permission_resource = grafana.DashboardPermission("dashboardPermissionResource",
dashboard_uid="string",
org_id="string",
permissions=[grafana.DashboardPermissionPermissionArgs(
permission="string",
role="string",
team_id="string",
user_id="string",
)])
const dashboardPermissionResource = new grafana.DashboardPermission("dashboardPermissionResource", {
dashboardUid: "string",
orgId: "string",
permissions: [{
permission: "string",
role: "string",
teamId: "string",
userId: "string",
}],
});
type: grafana:DashboardPermission
properties:
dashboardUid: string
orgId: string
permissions:
- permission: string
role: string
teamId: string
userId: string
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:
- Dashboard
Id int - ID of the dashboard to apply permissions to. Deprecated: 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<Pulumiverse.
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. - 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. - 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. - 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. - 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. - 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.
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. - 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<Pulumiverse.
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. - 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. - 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. - 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. - 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. - 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.
- User
Id string - ID of the user or service account to manage permissions for.
- 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.
- User
Id string - ID of the user or service account to manage permissions for.
- 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.
- user
Id String - ID of the user or service account to manage permissions for.
- 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.
- user
Id string - ID of the user or service account to manage permissions for.
- 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.
- user_
id str - ID of the user or service account to manage permissions for.
- 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.
- user
Id String - ID of the user or service account to manage permissions for.
Package Details
- Repository
- grafana pulumiverse/pulumi-grafana
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
grafana
Terraform Provider.