databricks.getDashboards

Start a Neo task

Explain and create a databricks.getDashboards resource

Databricks v1.77.0 published on Tuesday, Nov 4, 2025 by Pulumi

pulumi/pulumi-databricks

Example Usage

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

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 dictionary

The following arguments are supported:

DashboardNameContains string: A case-insensitive substring to filter Dashboards by their name.
ProviderConfig GetDashboardsProviderConfig

DashboardNameContains string: A case-insensitive substring to filter Dashboards by their name.
ProviderConfig GetDashboardsProviderConfig

dashboardNameContains String: A case-insensitive substring to filter Dashboards by their name.
providerConfig GetDashboardsProviderConfig

dashboardNameContains string: A case-insensitive substring to filter Dashboards by their name.
providerConfig GetDashboardsProviderConfig

dashboard_name_contains str: A case-insensitive substring to filter Dashboards by their name.
provider_config GetDashboardsProviderConfig

dashboardNameContains String: A case-insensitive substring to filter Dashboards by their name.
providerConfig Property Map

getDashboards Result

The following output properties are available:

Dashboards List<GetDashboardsDashboard>: 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.
DashboardNameContains string
ProviderConfig GetDashboardsProviderConfig

Dashboards []GetDashboardsDashboard: 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.
DashboardNameContains string
ProviderConfig GetDashboardsProviderConfig

dashboards List<GetDashboardsDashboard>: 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.
dashboardNameContains String
providerConfig GetDashboardsProviderConfig

dashboards GetDashboardsDashboard[]: 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.
dashboardNameContains string
providerConfig GetDashboardsProviderConfig

dashboards Sequence[GetDashboardsDashboard]: 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_contains str
provider_config GetDashboardsProviderConfig

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.
dashboardNameContains String
providerConfig Property Map