@pulumi/databricks/getSqlWarehouses.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";
/**
 * Retrieves a list of databricks.SqlEndpoint ids, that were created by Pulumi or manually.
 *
 * > This data source can only be used with a workspace-level provider!
 *
 * ## Example Usage
 *
 * Retrieve IDs for all SQL warehouses:
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as databricks from "@pulumi/databricks";
 *
 * const all = databricks.getSqlWarehouses({});
 * ```
 *
 * Retrieve IDs for all clusters having "Shared" in the warehouse name:
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as databricks from "@pulumi/databricks";
 *
 * const allShared = databricks.getSqlWarehouses({
 *     warehouseNameContains: "shared",
 * });
 * ```
 *
 * ## Related Resources
 *
 * The following resources are often used in the same context:
 *
 * * End to end workspace management guide.
 * * databricks.InstanceProfile to manage AWS EC2 instance profiles that users can launch databricks.Cluster and access data, like databricks_mount.
 * * databricks.SqlDashboard to manage Databricks SQL [Dashboards](https://docs.databricks.com/sql/user/dashboards/index.html).
 * * databricks.SqlGlobalConfig to configure the security policy, databricks_instance_profile, and [data access properties](https://docs.databricks.com/sql/admin/data-access-configuration.html) for all databricks.getSqlWarehouse of workspace.
 * * databricks.Grants to manage data access in Unity Catalog.
 */
export declare function getSqlWarehouses(args?: GetSqlWarehousesArgs, opts?: pulumi.InvokeOptions): Promise<GetSqlWarehousesResult>;
/**
 * A collection of arguments for invoking getSqlWarehouses.
 */
export interface GetSqlWarehousesArgs {
    /**
     * list of databricks.SqlEndpoint ids
     */
    ids?: string[];
    /**
     * Configure the provider for management through account provider. This block consists of the following fields:
     */
    providerConfig?: inputs.GetSqlWarehousesProviderConfig;
    /**
     * Only return databricks.SqlEndpoint ids that match the given name string.
     */
    warehouseNameContains?: string;
}
/**
 * A collection of values returned by getSqlWarehouses.
 */
export interface GetSqlWarehousesResult {
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    /**
     * list of databricks.SqlEndpoint ids
     */
    readonly ids: string[];
    readonly providerConfig?: outputs.GetSqlWarehousesProviderConfig;
    readonly warehouseNameContains?: string;
}
/**
 * Retrieves a list of databricks.SqlEndpoint ids, that were created by Pulumi or manually.
 *
 * > This data source can only be used with a workspace-level provider!
 *
 * ## Example Usage
 *
 * Retrieve IDs for all SQL warehouses:
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as databricks from "@pulumi/databricks";
 *
 * const all = databricks.getSqlWarehouses({});
 * ```
 *
 * Retrieve IDs for all clusters having "Shared" in the warehouse name:
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as databricks from "@pulumi/databricks";
 *
 * const allShared = databricks.getSqlWarehouses({
 *     warehouseNameContains: "shared",
 * });
 * ```
 *
 * ## Related Resources
 *
 * The following resources are often used in the same context:
 *
 * * End to end workspace management guide.
 * * databricks.InstanceProfile to manage AWS EC2 instance profiles that users can launch databricks.Cluster and access data, like databricks_mount.
 * * databricks.SqlDashboard to manage Databricks SQL [Dashboards](https://docs.databricks.com/sql/user/dashboards/index.html).
 * * databricks.SqlGlobalConfig to configure the security policy, databricks_instance_profile, and [data access properties](https://docs.databricks.com/sql/admin/data-access-configuration.html) for all databricks.getSqlWarehouse of workspace.
 * * databricks.Grants to manage data access in Unity Catalog.
 */
export declare function getSqlWarehousesOutput(args?: GetSqlWarehousesOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetSqlWarehousesResult>;
/**
 * A collection of arguments for invoking getSqlWarehouses.
 */
export interface GetSqlWarehousesOutputArgs {
    /**
     * list of databricks.SqlEndpoint ids
     */
    ids?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * Configure the provider for management through account provider. This block consists of the following fields:
     */
    providerConfig?: pulumi.Input<inputs.GetSqlWarehousesProviderConfigArgs>;
    /**
     * Only return databricks.SqlEndpoint ids that match the given name string.
     */
    warehouseNameContains?: pulumi.Input<string>;
}