Databricks v1.79.0 published on Saturday, Dec 20, 2025 by Pulumi
Databricks v1.79.0 published on Saturday, Dec 20, 2025 by Pulumi
This data source allows you to retrieve information about Databricks Dashboards.
This data source can only be used with a workspace-level provider!
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as databricks from "@pulumi/databricks";
export = async () => {
const all = await databricks.getDashboards({});
const dashboardsPermissions: databricks.Permissions[] = [];
for (const range of all.dashboards.map(__item => __item.dashboardId).map((v, k) => ({key: k, value: v}))) {
dashboardsPermissions.push(new databricks.Permissions(`dashboards_permissions-${range.key}`, {
depends: [all],
dashboardId: range.value,
accessControls: [{
groupName: "Example Group",
permissionLevel: "CAN_MANAGE",
}],
}));
}
}
import pulumi
import pulumi_databricks as databricks
all = databricks.get_dashboards()
dashboards_permissions = []
for range in [{"key": k, "value": v} for [k, v] in enumerate([__item.dashboard_id for __item in all.dashboards])]:
dashboards_permissions.append(databricks.Permissions(f"dashboards_permissions-{range['key']}",
depends=[all],
dashboard_id=range["value"],
access_controls=[{
"group_name": "Example Group",
"permission_level": "CAN_MANAGE",
}]))
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 {
all, err := databricks.GetDashboards(ctx, &databricks.GetDashboardsArgs{}, nil)
if err != nil {
return err
}
var splat0 []*string
for _, val0 := range all.Dashboards {
splat0 = append(splat0, val0.DashboardId)
}
var dashboardsPermissions []*databricks.Permissions
for key0, val0 := range splat0 {
__res, err := databricks.NewPermissions(ctx, fmt.Sprintf("dashboards_permissions-%v", key0), &databricks.PermissionsArgs{
Depends: []interface{}{
all,
},
DashboardId: pulumi.String(val0),
AccessControls: databricks.PermissionsAccessControlArray{
&databricks.PermissionsAccessControlArgs{
GroupName: pulumi.String("Example Group"),
PermissionLevel: pulumi.String("CAN_MANAGE"),
},
},
})
if err != nil {
return err
}
dashboardsPermissions = append(dashboardsPermissions, __res)
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Pulumi;
using Databricks = Pulumi.Databricks;
return await Deployment.RunAsync(async() =>
{
var all = await Databricks.GetDashboards.InvokeAsync();
var dashboardsPermissions = new List<Databricks.Permissions>();
foreach (var range in all.Dashboards.Select(__item => __item.DashboardId).ToList().Select((v, k) => new { Key = k, Value = v }))
{
dashboardsPermissions.Add(new Databricks.Permissions($"dashboards_permissions-{range.Key}", new()
{
Depends = new[]
{
all,
},
DashboardId = range.Value,
AccessControls = new[]
{
new Databricks.Inputs.PermissionsAccessControlArgs
{
GroupName = "Example Group",
PermissionLevel = "CAN_MANAGE",
},
},
}));
}
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.databricks.DatabricksFunctions;
import com.pulumi.databricks.inputs.GetDashboardsArgs;
import com.pulumi.databricks.Permissions;
import com.pulumi.databricks.PermissionsArgs;
import com.pulumi.databricks.inputs.PermissionsAccessControlArgs;
import com.pulumi.codegen.internal.KeyedValue;
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) {
final var all = DatabricksFunctions.getDashboards(GetDashboardsArgs.builder()
.build());
for (var range : KeyedValue.of(all.dashboards().stream().map(element -> element.dashboardId()).collect(toList()))) {
new Permissions("dashboardsPermissions-" + range.key(), PermissionsArgs.builder()
.depends(List.of(all))
.dashboardId(range.value())
.accessControls(PermissionsAccessControlArgs.builder()
.groupName("Example Group")
.permissionLevel("CAN_MANAGE")
.build())
.build());
}
}
}
resources:
dashboardsPermissions:
type: databricks:Permissions
name: dashboards_permissions
properties:
depends:
- ${all}
dashboardId: ${range.value}
accessControls:
- groupName: Example Group
permissionLevel: CAN_MANAGE
options: {}
variables:
all:
fn::invoke:
function: databricks:getDashboards
arguments: {}
Using getDashboards
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getDashboards(args: GetDashboardsArgs, opts?: InvokeOptions): Promise<GetDashboardsResult>
function getDashboardsOutput(args: GetDashboardsOutputArgs, opts?: InvokeOptions): Output<GetDashboardsResult>def get_dashboards(dashboard_name_contains: Optional[str] = None,
provider_config: Optional[GetDashboardsProviderConfig] = None,
opts: Optional[InvokeOptions] = None) -> GetDashboardsResult
def get_dashboards_output(dashboard_name_contains: Optional[pulumi.Input[str]] = None,
provider_config: Optional[pulumi.Input[GetDashboardsProviderConfigArgs]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetDashboardsResult]func GetDashboards(ctx *Context, args *GetDashboardsArgs, opts ...InvokeOption) (*GetDashboardsResult, error)
func GetDashboardsOutput(ctx *Context, args *GetDashboardsOutputArgs, opts ...InvokeOption) GetDashboardsResultOutput> Note: This function is named GetDashboards in the Go SDK.
public static class GetDashboards
{
public static Task<GetDashboardsResult> InvokeAsync(GetDashboardsArgs args, InvokeOptions? opts = null)
public static Output<GetDashboardsResult> Invoke(GetDashboardsInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetDashboardsResult> getDashboards(GetDashboardsArgs args, InvokeOptions options)
public static Output<GetDashboardsResult> getDashboards(GetDashboardsArgs args, InvokeOptions options)
fn::invoke:
function: databricks:index/getDashboards:getDashboards
arguments:
# arguments dictionaryThe following arguments are supported:
- Dashboard
Name stringContains - A case-insensitive substring to filter Dashboards by their name.
- Provider
Config GetDashboards Provider Config
- Dashboard
Name stringContains - A case-insensitive substring to filter Dashboards by their name.
- Provider
Config GetDashboards Provider Config
- dashboard
Name StringContains - A case-insensitive substring to filter Dashboards by their name.
- provider
Config GetDashboards Provider Config
- dashboard
Name stringContains - A case-insensitive substring to filter Dashboards by their name.
- provider
Config GetDashboards Provider Config
- dashboard_
name_ strcontains - A case-insensitive substring to filter Dashboards by their name.
- provider_
config GetDashboards Provider Config
- dashboard
Name StringContains - A case-insensitive substring to filter Dashboards by their name.
- provider
Config Property Map
getDashboards Result
The following output properties are available:
- Dashboards
List<Get
Dashboards Dashboard> - A list of dashboards matching the specified criteria. Each element contains the following attributes:
- Id string
- The provider-assigned unique ID for this managed resource.
- Dashboard
Name stringContains - Provider
Config GetDashboards Provider Config
- Dashboards
[]Get
Dashboards Dashboard - A list of dashboards matching the specified criteria. Each element contains the following attributes:
- Id string
- The provider-assigned unique ID for this managed resource.
- Dashboard
Name stringContains - Provider
Config GetDashboards Provider Config
- dashboards
List<Get
Dashboards Dashboard> - A list of dashboards matching the specified criteria. Each element contains the following attributes:
- id String
- The provider-assigned unique ID for this managed resource.
- dashboard
Name StringContains - provider
Config GetDashboards Provider Config
- dashboards
Get
Dashboards Dashboard[] - A list of dashboards matching the specified criteria. Each element contains the following attributes:
- id string
- The provider-assigned unique ID for this managed resource.
- dashboard
Name stringContains - provider
Config GetDashboards Provider Config
- dashboards
Sequence[Get
Dashboards Dashboard] - A list of dashboards matching the specified criteria. Each element contains the following attributes:
- id str
- The provider-assigned unique ID for this managed resource.
- dashboard_
name_ strcontains - provider_
config GetDashboards Provider Config
- dashboards List<Property Map>
- A list of dashboards matching the specified criteria. Each element contains the following attributes:
- id String
- The provider-assigned unique ID for this managed resource.
- dashboard
Name StringContains - provider
Config Property Map
Supporting Types
GetDashboardsDashboard
- Create
Time string - The timestamp of when the dashboard was created.
- Dashboard
Id string - The unique ID of the dashboard.
- Etag string
- Lifecycle
State string - Parent
Path string - Path string
- Update
Time string - Display
Name string - The display name of the dashboard.
- Serialized
Dashboard string - Warehouse
Id string
- Create
Time string - The timestamp of when the dashboard was created.
- Dashboard
Id string - The unique ID of the dashboard.
- Etag string
- Lifecycle
State string - Parent
Path string - Path string
- Update
Time string - Display
Name string - The display name of the dashboard.
- Serialized
Dashboard string - Warehouse
Id string
- create
Time String - The timestamp of when the dashboard was created.
- dashboard
Id String - The unique ID of the dashboard.
- etag String
- lifecycle
State String - parent
Path String - path String
- update
Time String - display
Name String - The display name of the dashboard.
- serialized
Dashboard String - warehouse
Id String
- create
Time string - The timestamp of when the dashboard was created.
- dashboard
Id string - The unique ID of the dashboard.
- etag string
- lifecycle
State string - parent
Path string - path string
- update
Time string - display
Name string - The display name of the dashboard.
- serialized
Dashboard string - warehouse
Id string
- create_
time str - The timestamp of when the dashboard was created.
- dashboard_
id str - The unique ID of the dashboard.
- etag str
- lifecycle_
state str - parent_
path str - path str
- update_
time str - display_
name str - The display name of the dashboard.
- serialized_
dashboard str - warehouse_
id str
- create
Time String - The timestamp of when the dashboard was created.
- dashboard
Id String - The unique ID of the dashboard.
- etag String
- lifecycle
State String - parent
Path String - path String
- update
Time String - display
Name String - The display name of the dashboard.
- serialized
Dashboard String - warehouse
Id String
GetDashboardsProviderConfig
- Workspace
Id string
- Workspace
Id string
- workspace
Id String
- workspace
Id string
- workspace_
id str
- workspace
Id String
Package Details
- Repository
- databricks pulumi/pulumi-databricks
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
databricksTerraform Provider.
Databricks v1.79.0 published on Saturday, Dec 20, 2025 by Pulumi
