@pulumi/databricks
Version:
A Pulumi package for creating and managing databricks cloud resources.
119 lines (118 loc) • 3.27 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* > **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.
*
* This data source allows to export a notebook from Databricks Workspace.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as databricks from "@pulumi/databricks";
*
* const features = databricks.getNotebook({
* path: "/Production/Features",
* format: "SOURCE",
* });
* ```
*/
export declare function getNotebook(args: GetNotebookArgs, opts?: pulumi.InvokeOptions): Promise<GetNotebookResult>;
/**
* A collection of arguments for invoking getNotebook.
*/
export interface GetNotebookArgs {
/**
* Notebook format to export. Either `SOURCE`, `HTML`, `JUPYTER`, or `DBC`.
*/
format: string;
/**
* notebook language
*/
language?: string;
/**
* notebook object ID
*/
objectId?: number;
/**
* notebook object type
*/
objectType?: string;
/**
* Notebook path on the workspace
*/
path: string;
}
/**
* A collection of values returned by getNotebook.
*/
export interface GetNotebookResult {
/**
* notebook content in selected format
*/
readonly content: string;
readonly format: string;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
/**
* notebook language
*/
readonly language: string;
/**
* notebook object ID
*/
readonly objectId: number;
/**
* notebook object type
*/
readonly objectType: string;
readonly path: string;
/**
* path on Workspace File System (WSFS) in form of `/Workspace` + `path`
*/
readonly workspacePath: string;
}
/**
* > **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.
*
* This data source allows to export a notebook from Databricks Workspace.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as databricks from "@pulumi/databricks";
*
* const features = databricks.getNotebook({
* path: "/Production/Features",
* format: "SOURCE",
* });
* ```
*/
export declare function getNotebookOutput(args: GetNotebookOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetNotebookResult>;
/**
* A collection of arguments for invoking getNotebook.
*/
export interface GetNotebookOutputArgs {
/**
* Notebook format to export. Either `SOURCE`, `HTML`, `JUPYTER`, or `DBC`.
*/
format: pulumi.Input<string>;
/**
* notebook language
*/
language?: pulumi.Input<string>;
/**
* notebook object ID
*/
objectId?: pulumi.Input<number>;
/**
* notebook object type
*/
objectType?: pulumi.Input<string>;
/**
* Notebook path on the workspace
*/
path: pulumi.Input<string>;
}