1. Packages
  2. Packages
  3. Databricks Provider
  4. API Docs
  5. SqlDashboard
Viewing docs for Databricks v0.4.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-databricks

databricks.SqlDashboard

databricks logo
Viewing docs for Databricks v0.4.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-databricks

    This resource is used to manage Databricks SQL Dashboards. To manage SQLA resources you must have databricks_sql_access on your databricks.Group or databricks_user.

    Note: documentation for this resource is a work in progress.

    A dashboard may have one or more widgets.

    The following resources are often used in the same context:

    • End to end workspace management guide.
    • databricks.SqlEndpoint to manage Databricks SQL Endpoints.
    • databricks.SqlGlobalConfig to configure the security policy, databricks_instance_profile, and data access properties for all databricks.SqlEndpoint of workspace.
    • databricks.SqlPermissions to manage data object access control lists in Databricks workspaces for things like tables, views, databases, and more.

    Example Usage

    using Pulumi;
using Databricks = Pulumi.Databricks;

class MyStack : Stack
{
    public MyStack()
    {
        var d1 = new Databricks.SqlDashboard("d1", new Databricks.SqlDashboardArgs
        {
            Tags = 
            {
                "some-tag",
                "another-tag",
            },
        });
    }

}

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := databricks.NewSqlDashboard(ctx, "d1", &databricks.SqlDashboardArgs{
			Tags: pulumi.StringArray{
				pulumi.String("some-tag"),
				pulumi.String("another-tag"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    Example coming soon!

    import * as pulumi from "@pulumi/pulumi";
import * as databricks from "@pulumi/databricks";

const d1 = new databricks.SqlDashboard("d1", {
    tags: [
        "some-tag",
        "another-tag",
    ],
});

    import pulumi
import pulumi_databricks as databricks

d1 = databricks.SqlDashboard("d1", tags=[
    "some-tag",
    "another-tag",
])

    Example coming soon!

    Example permission to share dashboard with all users

    using Pulumi;
using Databricks = Pulumi.Databricks;

class MyStack : Stack
{
    public MyStack()
    {
        var d1 = new Databricks.Permissions("d1", new Databricks.PermissionsArgs
        {
            SqlDashboardId = databricks_sql_dashboard.D1.Id,
            AccessControls = 
            {
                new Databricks.Inputs.PermissionsAccessControlArgs
                {
                    GroupName = data.Databricks_group.Users.Display_name,
                    PermissionLevel = "CAN_RUN",
                },
            },
        });
    }

}

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := databricks.NewPermissions(ctx, "d1", &databricks.PermissionsArgs{
			SqlDashboardId: pulumi.Any(databricks_sql_dashboard.D1.Id),
			AccessControls: PermissionsAccessControlArray{
				&PermissionsAccessControlArgs{
					GroupName:       pulumi.Any(data.Databricks_group.Users.Display_name),
					PermissionLevel: pulumi.String("CAN_RUN"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    Example coming soon!

    import * as pulumi from "@pulumi/pulumi";
import * as databricks from "@pulumi/databricks";

const d1 = new databricks.Permissions("d1", {
    sqlDashboardId: databricks_sql_dashboard.d1.id,
    accessControls: [{
        groupName: data.databricks_group.users.display_name,
        permissionLevel: "CAN_RUN",
    }],
});

    import pulumi
import pulumi_databricks as databricks

d1 = databricks.Permissions("d1",
    sql_dashboard_id=databricks_sql_dashboard["d1"]["id"],
    access_controls=[databricks.PermissionsAccessControlArgs(
        group_name=data["databricks_group"]["users"]["display_name"],
        permission_level="CAN_RUN",
    )])

    Example coming soon!

    Create SqlDashboard Resource

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

    Constructor syntax

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

@overload
def SqlDashboard(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 name: Optional[str] = None,
                 tags: Optional[Sequence[str]] = None)
    func NewSqlDashboard(ctx *Context, name string, args *SqlDashboardArgs, opts ...ResourceOption) (*SqlDashboard, error)
    public SqlDashboard(string name, SqlDashboardArgs? args = null, CustomResourceOptions? opts = null)
    public SqlDashboard(String name, SqlDashboardArgs args)
public SqlDashboard(String name, SqlDashboardArgs args, CustomResourceOptions options)

    type: databricks:SqlDashboard
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 SqlDashboardArgs
    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 SqlDashboardArgs
    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 SqlDashboardArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SqlDashboardArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SqlDashboardArgs
    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 sqlDashboardResource = new Databricks.SqlDashboard("sqlDashboardResource", new()
{
    Name = "string",
    Tags = new[]
    {
        "string",
    },
});

    example, err := databricks.NewSqlDashboard(ctx, "sqlDashboardResource", &databricks.SqlDashboardArgs{
	Name: pulumi.String("string"),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var sqlDashboardResource = new SqlDashboard("sqlDashboardResource", SqlDashboardArgs.builder()
    .name("string")
    .tags("string")
    .build());

    sql_dashboard_resource = databricks.SqlDashboard("sqlDashboardResource",
    name="string",
    tags=["string"])

    const sqlDashboardResource = new databricks.SqlDashboard("sqlDashboardResource", {
    name: "string",
    tags: ["string"],
});

    type: databricks:SqlDashboard
properties:
    name: string
    tags:
        - string

    SqlDashboard Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The SqlDashboard resource accepts the following input properties:

    Name string
    Tags List<string>
    Name string
    Tags []string
    name String
    tags List<String>
    name string
    tags string[]
    name str
    tags Sequence[str]
    name String
    tags List<String>

    Outputs

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

    Get an existing SqlDashboard 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?: SqlDashboardState, opts?: CustomResourceOptions): SqlDashboard
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        name: Optional[str] = None,
        tags: Optional[Sequence[str]] = None) -> SqlDashboard
    func GetSqlDashboard(ctx *Context, name string, id IDInput, state *SqlDashboardState, opts ...ResourceOption) (*SqlDashboard, error)
    public static SqlDashboard Get(string name, Input<string> id, SqlDashboardState? state, CustomResourceOptions? opts = null)
    public static SqlDashboard get(String name, Output<String> id, SqlDashboardState state, CustomResourceOptions options)
    resources:  _:    type: databricks:SqlDashboard    get:      id: ${id}
    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:
    Name string
    Tags List<string>
    Name string
    Tags []string
    name String
    tags List<String>
    name string
    tags string[]
    name str
    tags Sequence[str]
    name String
    tags List<String>

    Import

    -> Note Importing this resource is not currently supported.

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

    Package Details

    Repository
    databricks pulumi/pulumi-databricks
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the databricks Terraform Provider.
    databricks logo
    Viewing docs for Databricks v0.4.0 (Older version)
    published on Monday, Mar 9, 2026 by Pulumi
    Go to latest version
    Schema (JSON)
    pulumi/pulumi-databricks
      Try Pulumi Cloud free. Your team will thank you.