1. Packages
  2. Packages
  3. Databricks Provider
  4. API Docs
  5. getNotebook
Viewing docs for Databricks v0.4.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-databricks

databricks.getNotebook

databricks logo
Viewing docs for Databricks v0.4.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-databricks

    Example Usage

    using Pulumi;
using Databricks = Pulumi.Databricks;

class MyStack : Stack
{
    public MyStack()
    {
        var features = Output.Create(Databricks.GetNotebook.InvokeAsync(new Databricks.GetNotebookArgs
        {
            Format = "SOURCE",
            Path = "/Production/Features",
        }));
    }

}

    package main

import (
	"github.com/pulumi/pulumi-databricks/sdk/go/databricks"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := databricks.LookupNotebook(ctx, &GetNotebookArgs{
			Format: "SOURCE",
			Path:   "/Production/Features",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    Example coming soon!

    import * as pulumi from "@pulumi/pulumi";
import * as databricks from "@pulumi/databricks";

const features = pulumi.output(databricks.getNotebook({
    format: "SOURCE",
    path: "/Production/Features",
}));

    import pulumi
import pulumi_databricks as databricks

features = databricks.get_notebook(format="SOURCE",
    path="/Production/Features")

    Example coming soon!

    Using getNotebook

    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 getNotebook(args: GetNotebookArgs, opts?: InvokeOptions): Promise<GetNotebookResult>
function getNotebookOutput(args: GetNotebookOutputArgs, opts?: InvokeOptions): Output<GetNotebookResult>
    def get_notebook(format: Optional[str] = None,
                 language: Optional[str] = None,
                 object_id: Optional[int] = None,
                 object_type: Optional[str] = None,
                 path: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetNotebookResult
def get_notebook_output(format: Optional[pulumi.Input[str]] = None,
                 language: Optional[pulumi.Input[str]] = None,
                 object_id: Optional[pulumi.Input[int]] = None,
                 object_type: Optional[pulumi.Input[str]] = None,
                 path: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetNotebookResult]
    func LookupNotebook(ctx *Context, args *LookupNotebookArgs, opts ...InvokeOption) (*LookupNotebookResult, error)
func LookupNotebookOutput(ctx *Context, args *LookupNotebookOutputArgs, opts ...InvokeOption) LookupNotebookResultOutput

    > Note: This function is named LookupNotebook in the Go SDK.

    public static class GetNotebook 
{
    public static Task<GetNotebookResult> InvokeAsync(GetNotebookArgs args, InvokeOptions? opts = null)
    public static Output<GetNotebookResult> Invoke(GetNotebookInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetNotebookResult> getNotebook(GetNotebookArgs args, InvokeOptions options)
public static Output<GetNotebookResult> getNotebook(GetNotebookArgs args, InvokeOptions options)

    fn::invoke:
  function: databricks:index/getNotebook:getNotebook
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Format string
    Notebook format to export. Either SOURCE, HTML, JUPYTER, or DBC.
    Path string
    Notebook path on the workspace
    Language string
    notebook language
    ObjectId int
    notebook object ID
    ObjectType string
    notebook object type
    Format string
    Notebook format to export. Either SOURCE, HTML, JUPYTER, or DBC.
    Path string
    Notebook path on the workspace
    Language string
    notebook language
    ObjectId int
    notebook object ID
    ObjectType string
    notebook object type
    format String
    Notebook format to export. Either SOURCE, HTML, JUPYTER, or DBC.
    path String
    Notebook path on the workspace
    language String
    notebook language
    objectId Integer
    notebook object ID
    objectType String
    notebook object type
    format string
    Notebook format to export. Either SOURCE, HTML, JUPYTER, or DBC.
    path string
    Notebook path on the workspace
    language string
    notebook language
    objectId number
    notebook object ID
    objectType string
    notebook object type
    format str
    Notebook format to export. Either SOURCE, HTML, JUPYTER, or DBC.
    path str
    Notebook path on the workspace
    language str
    notebook language
    object_id int
    notebook object ID
    object_type str
    notebook object type
    format String
    Notebook format to export. Either SOURCE, HTML, JUPYTER, or DBC.
    path String
    Notebook path on the workspace
    language String
    notebook language
    objectId Number
    notebook object ID
    objectType String
    notebook object type

    getNotebook Result

    The following output properties are available:

    Content string
    notebook content in selected format
    Format string
    Id string
    The provider-assigned unique ID for this managed resource.
    Language string
    notebook language
    ObjectId int
    notebook object ID
    ObjectType string
    notebook object type
    Path string
    Content string
    notebook content in selected format
    Format string
    Id string
    The provider-assigned unique ID for this managed resource.
    Language string
    notebook language
    ObjectId int
    notebook object ID
    ObjectType string
    notebook object type
    Path string
    content String
    notebook content in selected format
    format String
    id String
    The provider-assigned unique ID for this managed resource.
    language String
    notebook language
    objectId Integer
    notebook object ID
    objectType String
    notebook object type
    path String
    content string
    notebook content in selected format
    format string
    id string
    The provider-assigned unique ID for this managed resource.
    language string
    notebook language
    objectId number
    notebook object ID
    objectType string
    notebook object type
    path string
    content str
    notebook content in selected format
    format str
    id str
    The provider-assigned unique ID for this managed resource.
    language str
    notebook language
    object_id int
    notebook object ID
    object_type str
    notebook object type
    path str
    content String
    notebook content in selected format
    format String
    id String
    The provider-assigned unique ID for this managed resource.
    language String
    notebook language
    objectId Number
    notebook object ID
    objectType String
    notebook object type
    path 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
    Viewing docs for Databricks v0.4.0 (Older version)
    published on Monday, Mar 9, 2026 by Pulumi
    Go to latest version
    Schema (JSON)
    pulumi/pulumi-databricks
      Try Pulumi Cloud free. Your team will thank you.