1. Packages
  2. Packages
  3. Databricks Provider
  4. API Docs
  5. getDbfsFile
Viewing docs for Databricks v0.4.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
databricks logo
Viewing docs for Databricks v0.4.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

    The following resources are used in the same context:

    Example Usage

    using Pulumi;
    using Databricks = Pulumi.Databricks;
    
    class MyStack : Stack
    {
        public MyStack()
        {
            var report = Output.Create(Databricks.GetDbfsFile.InvokeAsync(new Databricks.GetDbfsFileArgs
            {
                LimitFileSize = 10240,
                Path = "dbfs:/reports/some.csv",
            }));
        }
    
    }
    
    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.LookupDbfsFile(ctx, &GetDbfsFileArgs{
    			LimitFileSize: 10240,
    			Path:          "dbfs:/reports/some.csv",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    

    Example coming soon!

    import * as pulumi from "@pulumi/pulumi";
    import * as databricks from "@pulumi/databricks";
    
    const report = pulumi.output(databricks.getDbfsFile({
        limitFileSize: 10240,
        path: "dbfs:/reports/some.csv",
    }));
    
    import pulumi
    import pulumi_databricks as databricks
    
    report = databricks.get_dbfs_file(limit_file_size=10240,
        path="dbfs:/reports/some.csv")
    

    Example coming soon!

    Using getDbfsFile

    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 getDbfsFile(args: GetDbfsFileArgs, opts?: InvokeOptions): Promise<GetDbfsFileResult>
    function getDbfsFileOutput(args: GetDbfsFileOutputArgs, opts?: InvokeOptions): Output<GetDbfsFileResult>
    def get_dbfs_file(limit_file_size: Optional[bool] = None,
                      path: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetDbfsFileResult
    def get_dbfs_file_output(limit_file_size: Optional[pulumi.Input[bool]] = None,
                      path: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetDbfsFileResult]
    func LookupDbfsFile(ctx *Context, args *LookupDbfsFileArgs, opts ...InvokeOption) (*LookupDbfsFileResult, error)
    func LookupDbfsFileOutput(ctx *Context, args *LookupDbfsFileOutputArgs, opts ...InvokeOption) LookupDbfsFileResultOutput

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

    public static class GetDbfsFile 
    {
        public static Task<GetDbfsFileResult> InvokeAsync(GetDbfsFileArgs args, InvokeOptions? opts = null)
        public static Output<GetDbfsFileResult> Invoke(GetDbfsFileInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetDbfsFileResult> getDbfsFile(GetDbfsFileArgs args, InvokeOptions options)
    public static Output<GetDbfsFileResult> getDbfsFile(GetDbfsFileArgs args, InvokeOptions options)
    
    fn::invoke:
      function: databricks:index/getDbfsFile:getDbfsFile
      arguments:
        # arguments dictionary

    The following arguments are supported:

    LimitFileSize bool
    Do lot load content for files smaller than this in bytes
    Path string
    Path on DBFS for the file to get content of
    LimitFileSize bool
    Do lot load content for files smaller than this in bytes
    Path string
    Path on DBFS for the file to get content of
    limitFileSize Boolean
    Do lot load content for files smaller than this in bytes
    path String
    Path on DBFS for the file to get content of
    limitFileSize boolean
    Do lot load content for files smaller than this in bytes
    path string
    Path on DBFS for the file to get content of
    limit_file_size bool
    Do lot load content for files smaller than this in bytes
    path str
    Path on DBFS for the file to get content of
    limitFileSize Boolean
    Do lot load content for files smaller than this in bytes
    path String
    Path on DBFS for the file to get content of

    getDbfsFile Result

    The following output properties are available:

    Content string
    base64-encoded file contents
    FileSize int
    size of the file in bytes
    Id string
    The provider-assigned unique ID for this managed resource.
    LimitFileSize bool
    Path string
    Content string
    base64-encoded file contents
    FileSize int
    size of the file in bytes
    Id string
    The provider-assigned unique ID for this managed resource.
    LimitFileSize bool
    Path string
    content String
    base64-encoded file contents
    fileSize Integer
    size of the file in bytes
    id String
    The provider-assigned unique ID for this managed resource.
    limitFileSize Boolean
    path String
    content string
    base64-encoded file contents
    fileSize number
    size of the file in bytes
    id string
    The provider-assigned unique ID for this managed resource.
    limitFileSize boolean
    path string
    content str
    base64-encoded file contents
    file_size int
    size of the file in bytes
    id str
    The provider-assigned unique ID for this managed resource.
    limit_file_size bool
    path str
    content String
    base64-encoded file contents
    fileSize Number
    size of the file in bytes
    id String
    The provider-assigned unique ID for this managed resource.
    limitFileSize Boolean
    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
      Try Pulumi Cloud free. Your team will thank you.