@pulumi/databricks
Version:
A Pulumi package for creating and managing databricks cloud resources.
100 lines (99 loc) • 3.32 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* > **Note** This data source can only be used with a workspace-level provider!
*
* > **Note** If you have a fully automated setup with workspaces created by databricks.MwsWorkspaces or azurerm_databricks_workspace, please make sure to add dependsOn attribute in order to prevent _default auth: cannot configure default credentials_ errors.
*
* Retrieves a list of databricks.Schema ids, that were created by Pulumi or manually, so that special handling could be applied.
*
* ## Example Usage
*
* Listing all schemas in a _sandbox_ databricks_catalog:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as databricks from "@pulumi/databricks";
*
* const sandbox = databricks.getSchemas({
* catalogName: "sandbox",
* });
* export const allSandboxSchemas = sandbox;
* ```
*
* ## Related Resources
*
* The following resources are used in the same context:
*
* * databricks.Schema to manage schemas within Unity Catalog.
* * databricks.Catalog to manage catalogs within Unity Catalog.
*/
export declare function getSchemas(args: GetSchemasArgs, opts?: pulumi.InvokeOptions): Promise<GetSchemasResult>;
/**
* A collection of arguments for invoking getSchemas.
*/
export interface GetSchemasArgs {
/**
* Name of databricks_catalog
*/
catalogName: string;
/**
* set of databricks.Schema full names: *`catalog`.`schema`*
*/
ids?: string[];
}
/**
* A collection of values returned by getSchemas.
*/
export interface GetSchemasResult {
readonly catalogName: string;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
/**
* set of databricks.Schema full names: *`catalog`.`schema`*
*/
readonly ids: string[];
}
/**
* > **Note** This data source can only be used with a workspace-level provider!
*
* > **Note** If you have a fully automated setup with workspaces created by databricks.MwsWorkspaces or azurerm_databricks_workspace, please make sure to add dependsOn attribute in order to prevent _default auth: cannot configure default credentials_ errors.
*
* Retrieves a list of databricks.Schema ids, that were created by Pulumi or manually, so that special handling could be applied.
*
* ## Example Usage
*
* Listing all schemas in a _sandbox_ databricks_catalog:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as databricks from "@pulumi/databricks";
*
* const sandbox = databricks.getSchemas({
* catalogName: "sandbox",
* });
* export const allSandboxSchemas = sandbox;
* ```
*
* ## Related Resources
*
* The following resources are used in the same context:
*
* * databricks.Schema to manage schemas within Unity Catalog.
* * databricks.Catalog to manage catalogs within Unity Catalog.
*/
export declare function getSchemasOutput(args: GetSchemasOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetSchemasResult>;
/**
* A collection of arguments for invoking getSchemas.
*/
export interface GetSchemasOutputArgs {
/**
* Name of databricks_catalog
*/
catalogName: pulumi.Input<string>;
/**
* set of databricks.Schema full names: *`catalog`.`schema`*
*/
ids?: pulumi.Input<pulumi.Input<string>[]>;
}