Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Databricks Provider
  3. API Docs
  4. getDashboards
Databricks v1.63.0 published on Thursday, Mar 13, 2025 by Pulumi
pulumi/pulumi-databricks

databricks.getDashboards

Explore with Pulumi AI

databricks logo
Databricks v1.63.0 published on Thursday, Mar 13, 2025 by Pulumi
pulumi/pulumi-databricks

    This data source allows you to retrieve information about Databricks Dashboards.

    Example Usage

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    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,
                   opts: Optional[InvokeOptions] = None) -> GetDashboardsResult
def get_dashboards_output(dashboard_name_contains: Optional[pulumi.Input[str]] = 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.
    DashboardNameContains string
    A case-insensitive substring to filter Dashboards by their name.
    dashboardNameContains String
    A case-insensitive substring to filter Dashboards by their name.
    dashboardNameContains string
    A case-insensitive substring to filter Dashboards by their name.
    dashboard_name_contains str
    A case-insensitive substring to filter Dashboards by their name.
    dashboardNameContains String
    A case-insensitive substring to filter Dashboards by their name.

    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
    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
    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
    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
    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
    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

    Supporting Types

    GetDashboardsDashboard

    CreateTime string
    The timestamp of when the dashboard was created.
    DashboardId string
    The unique ID of the dashboard.
    Etag string
    LifecycleState string
    ParentPath string
    Path string
    UpdateTime string
    DisplayName string
    The display name of the dashboard.
    SerializedDashboard string
    WarehouseId string
    CreateTime string
    The timestamp of when the dashboard was created.
    DashboardId string
    The unique ID of the dashboard.
    Etag string
    LifecycleState string
    ParentPath string
    Path string
    UpdateTime string
    DisplayName string
    The display name of the dashboard.
    SerializedDashboard string
    WarehouseId string
    createTime String
    The timestamp of when the dashboard was created.
    dashboardId String
    The unique ID of the dashboard.
    etag String
    lifecycleState String
    parentPath String
    path String
    updateTime String
    displayName String
    The display name of the dashboard.
    serializedDashboard String
    warehouseId String
    createTime string
    The timestamp of when the dashboard was created.
    dashboardId string
    The unique ID of the dashboard.
    etag string
    lifecycleState string
    parentPath string
    path string
    updateTime string
    displayName string
    The display name of the dashboard.
    serializedDashboard string
    warehouseId 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
    createTime String
    The timestamp of when the dashboard was created.
    dashboardId String
    The unique ID of the dashboard.
    etag String
    lifecycleState String
    parentPath String
    path String
    updateTime String
    displayName String
    The display name of the dashboard.
    serializedDashboard String
    warehouseId String

    Package Details

    Repository
    databricks pulumi/pulumi-databricks
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the databricks Terraform Provider.
    databricks logo
    Databricks v1.63.0 published on Thursday, Mar 13, 2025 by Pulumi
    pulumi/pulumi-databricks