@pulumi/databricks/getDashboards.d.ts

A Pulumi package for creating and managing databricks cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
 * This data source allows you to retrieve information about Databricks [Dashboards](https://docs.databricks.com/en/dashboards/index.html).
 *
 * > This data source can only be used with a workspace-level provider!
 *
 * ## Example Usage
 *
 * ```typescript
 * 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",
 *             }],
 *         }));
 *     }
 * }
 * ```
 */
export declare function getDashboards(args?: GetDashboardsArgs, opts?: pulumi.InvokeOptions): Promise<GetDashboardsResult>;
/**
 * A collection of arguments for invoking getDashboards.
 */
export interface GetDashboardsArgs {
    /**
     * A **case-insensitive** substring to filter Dashboards by their name.
     */
    dashboardNameContains?: string;
    providerConfig?: inputs.GetDashboardsProviderConfig;
}
/**
 * A collection of values returned by getDashboards.
 */
export interface GetDashboardsResult {
    readonly dashboardNameContains?: string;
    /**
     * A list of dashboards matching the specified criteria. Each element contains the following attributes:
     */
    readonly dashboards: outputs.GetDashboardsDashboard[];
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    readonly providerConfig?: outputs.GetDashboardsProviderConfig;
}
/**
 * This data source allows you to retrieve information about Databricks [Dashboards](https://docs.databricks.com/en/dashboards/index.html).
 *
 * > This data source can only be used with a workspace-level provider!
 *
 * ## Example Usage
 *
 * ```typescript
 * 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",
 *             }],
 *         }));
 *     }
 * }
 * ```
 */
export declare function getDashboardsOutput(args?: GetDashboardsOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetDashboardsResult>;
/**
 * A collection of arguments for invoking getDashboards.
 */
export interface GetDashboardsOutputArgs {
    /**
     * A **case-insensitive** substring to filter Dashboards by their name.
     */
    dashboardNameContains?: pulumi.Input<string>;
    providerConfig?: pulumi.Input<inputs.GetDashboardsProviderConfigArgs>;
}