Databricks v1.70.0 published on Friday, May 9, 2025 by Pulumi
databricks.getNotebookPaths
Explore with Pulumi AI
This data source allows to list notebooks in the Databricks Workspace.
This data source can only be used with a workspace-level provider!
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as databricks from "@pulumi/databricks";
const prod = databricks.getNotebookPaths({
path: "/Production",
recursive: true,
});
import pulumi
import pulumi_databricks as databricks
prod = databricks.get_notebook_paths(path="/Production",
recursive=True)
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.GetNotebookPaths(ctx, &databricks.GetNotebookPathsArgs{
Path: "/Production",
Recursive: true,
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Databricks = Pulumi.Databricks;
return await Deployment.RunAsync(() =>
{
var prod = Databricks.GetNotebookPaths.Invoke(new()
{
Path = "/Production",
Recursive = true,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.databricks.DatabricksFunctions;
import com.pulumi.databricks.inputs.GetNotebookPathsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var prod = DatabricksFunctions.getNotebookPaths(GetNotebookPathsArgs.builder()
.path("/Production")
.recursive(true)
.build());
}
}
variables:
prod:
fn::invoke:
function: databricks:getNotebookPaths
arguments:
path: /Production
recursive: true
Using getNotebookPaths
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 getNotebookPaths(args: GetNotebookPathsArgs, opts?: InvokeOptions): Promise<GetNotebookPathsResult>
function getNotebookPathsOutput(args: GetNotebookPathsOutputArgs, opts?: InvokeOptions): Output<GetNotebookPathsResult>
def get_notebook_paths(path: Optional[str] = None,
recursive: Optional[bool] = None,
opts: Optional[InvokeOptions] = None) -> GetNotebookPathsResult
def get_notebook_paths_output(path: Optional[pulumi.Input[str]] = None,
recursive: Optional[pulumi.Input[bool]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetNotebookPathsResult]
func GetNotebookPaths(ctx *Context, args *GetNotebookPathsArgs, opts ...InvokeOption) (*GetNotebookPathsResult, error)
func GetNotebookPathsOutput(ctx *Context, args *GetNotebookPathsOutputArgs, opts ...InvokeOption) GetNotebookPathsResultOutput
> Note: This function is named GetNotebookPaths
in the Go SDK.
public static class GetNotebookPaths
{
public static Task<GetNotebookPathsResult> InvokeAsync(GetNotebookPathsArgs args, InvokeOptions? opts = null)
public static Output<GetNotebookPathsResult> Invoke(GetNotebookPathsInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetNotebookPathsResult> getNotebookPaths(GetNotebookPathsArgs args, InvokeOptions options)
public static Output<GetNotebookPathsResult> getNotebookPaths(GetNotebookPathsArgs args, InvokeOptions options)
fn::invoke:
function: databricks:index/getNotebookPaths:getNotebookPaths
arguments:
# arguments dictionary
The following arguments are supported:
getNotebookPaths Result
The following output properties are available:
- Id string
- The provider-assigned unique ID for this managed resource.
- Notebook
Path List<GetLists Notebook Paths Notebook Path List> - list of objects with
path
andlanguage
attributes - Path string
- Recursive bool
- Id string
- The provider-assigned unique ID for this managed resource.
- Notebook
Path []GetLists Notebook Paths Notebook Path List - list of objects with
path
andlanguage
attributes - Path string
- Recursive bool
- id String
- The provider-assigned unique ID for this managed resource.
- notebook
Path List<GetLists Notebook Paths Notebook Path List> - list of objects with
path
andlanguage
attributes - path String
- recursive Boolean
- id string
- The provider-assigned unique ID for this managed resource.
- notebook
Path GetLists Notebook Paths Notebook Path List[] - list of objects with
path
andlanguage
attributes - path string
- recursive boolean
- id str
- The provider-assigned unique ID for this managed resource.
- notebook_
path_ Sequence[Getlists Notebook Paths Notebook Path List] - list of objects with
path
andlanguage
attributes - path str
- recursive bool
- id String
- The provider-assigned unique ID for this managed resource.
- notebook
Path List<Property Map>Lists - list of objects with
path
andlanguage
attributes - path String
- recursive Boolean
Supporting Types
GetNotebookPathsNotebookPathList
Package Details
- Repository
- databricks pulumi/pulumi-databricks
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
databricks
Terraform Provider.