Databricks v1.67.0, Apr 17 25

Databricks v1.67.0 published on Thursday, Apr 17, 2025 by Pulumi

databricks.getVolume

Explore with Pulumi AI

Databricks v1.67.0 published on Thursday, Apr 17, 2025 by Pulumi

Retrieves details about databricks.Volume that was created by Pulumi or manually. A volume can be identified by its three-level (fully qualified) name (in the form of: catalog_name.schema_name.volume_name) as input. This can be retrieved programmatically using databricks.getVolumes data source.

Example Usage

Retrieve details of all volumes in in a things databricks.Schema of a sandbox databricks_catalog:

TypeScript
Python
Go
C#
Java
YAML

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

const all = databricks.getVolumes({
    catalogName: "sandbox",
    schemaName: "things",
});
const _this = all.then(all => .reduce((__obj, [__key, __value]) => ({ ...__obj, [__key]: databricks.getVolume({
    name: __value,
}) })));

import pulumi
import pulumi_databricks as databricks

all = databricks.get_volumes(catalog_name="sandbox",
    schema_name="things")
this = {__key: databricks.get_volume(name=__value) for __key, __value in all.ids}

Coming soon!

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Databricks = Pulumi.Databricks;

return await Deployment.RunAsync(() => 
{
    var all = Databricks.GetVolumes.Invoke(new()
    {
        CatalogName = "sandbox",
        SchemaName = "things",
    });

    var @this = ;

});

Coming soon!

Coming soon!

Search for a specific volume by its fully qualified name

TypeScript
Python
Go
C#
Java
YAML

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

const _this = databricks.getVolume({
    name: "catalog.schema.volume",
});

import pulumi
import pulumi_databricks as databricks

this = databricks.get_volume(name="catalog.schema.volume")

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.LookupVolume(ctx, &databricks.LookupVolumeArgs{
			Name: "catalog.schema.volume",
		}, 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 @this = Databricks.GetVolume.Invoke(new()
    {
        Name = "catalog.schema.volume",
    });

});

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.GetVolumeArgs;
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 this = DatabricksFunctions.getVolume(GetVolumeArgs.builder()
            .name("catalog.schema.volume")
            .build());

    }
}

variables:
  this:
    fn::invoke:
      function: databricks:getVolume
      arguments:
        name: catalog.schema.volume

The following resources are used in the same context:

databricks.Volume to manage volumes within Unity Catalog.
databricks.Schema to manage schemas within Unity Catalog.
databricks.Catalog to manage catalogs within Unity Catalog.

Using getVolume

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.

TypeScript
Python
Go
C#
Java
YAML

function getVolume(args: GetVolumeArgs, opts?: InvokeOptions): Promise<GetVolumeResult>
function getVolumeOutput(args: GetVolumeOutputArgs, opts?: InvokeOptions): Output<GetVolumeResult>

def get_volume(id: Optional[str] = None,
               name: Optional[str] = None,
               volume_info: Optional[GetVolumeVolumeInfo] = None,
               opts: Optional[InvokeOptions] = None) -> GetVolumeResult
def get_volume_output(id: Optional[pulumi.Input[str]] = None,
               name: Optional[pulumi.Input[str]] = None,
               volume_info: Optional[pulumi.Input[GetVolumeVolumeInfoArgs]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetVolumeResult]

func LookupVolume(ctx *Context, args *LookupVolumeArgs, opts ...InvokeOption) (*LookupVolumeResult, error)
func LookupVolumeOutput(ctx *Context, args *LookupVolumeOutputArgs, opts ...InvokeOption) LookupVolumeResultOutput

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

public static class GetVolume 
{
    public static Task<GetVolumeResult> InvokeAsync(GetVolumeArgs args, InvokeOptions? opts = null)
    public static Output<GetVolumeResult> Invoke(GetVolumeInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetVolumeResult> getVolume(GetVolumeArgs args, InvokeOptions options)
public static Output<GetVolumeResult> getVolume(GetVolumeArgs args, InvokeOptions options)

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

The following arguments are supported:

Name string: a fully qualified name of databricks_volume: catalog.schema.volume
Id string: ID of this Unity Catalog Volume in form of <catalog>.<schema>.<name>.
VolumeInfo GetVolumeVolumeInfo: VolumeInfo object for a Unity Catalog volume. This contains the following attributes:

Name string: a fully qualified name of databricks_volume: catalog.schema.volume
Id string: ID of this Unity Catalog Volume in form of <catalog>.<schema>.<name>.
VolumeInfo GetVolumeVolumeInfo: VolumeInfo object for a Unity Catalog volume. This contains the following attributes:

name String: a fully qualified name of databricks_volume: catalog.schema.volume
id String: ID of this Unity Catalog Volume in form of <catalog>.<schema>.<name>.
volumeInfo GetVolumeVolumeInfo: VolumeInfo object for a Unity Catalog volume. This contains the following attributes:

name string: a fully qualified name of databricks_volume: catalog.schema.volume
id string: ID of this Unity Catalog Volume in form of <catalog>.<schema>.<name>.
volumeInfo GetVolumeVolumeInfo: VolumeInfo object for a Unity Catalog volume. This contains the following attributes:

name str: a fully qualified name of databricks_volume: catalog.schema.volume
id str: ID of this Unity Catalog Volume in form of <catalog>.<schema>.<name>.
volume_info GetVolumeVolumeInfo: VolumeInfo object for a Unity Catalog volume. This contains the following attributes:

name String: a fully qualified name of databricks_volume: catalog.schema.volume
id String: ID of this Unity Catalog Volume in form of <catalog>.<schema>.<name>.
volumeInfo Property Map: VolumeInfo object for a Unity Catalog volume. This contains the following attributes:

getVolume Result

The following output properties are available:

Id string: ID of this Unity Catalog Volume in form of <catalog>.<schema>.<name>.
Name string: the name of the volume
VolumeInfo GetVolumeVolumeInfo: VolumeInfo object for a Unity Catalog volume. This contains the following attributes:

Id string: ID of this Unity Catalog Volume in form of <catalog>.<schema>.<name>.
Name string: the name of the volume
VolumeInfo GetVolumeVolumeInfo: VolumeInfo object for a Unity Catalog volume. This contains the following attributes:

id String: ID of this Unity Catalog Volume in form of <catalog>.<schema>.<name>.
name String: the name of the volume
volumeInfo GetVolumeVolumeInfo: VolumeInfo object for a Unity Catalog volume. This contains the following attributes:

id string: ID of this Unity Catalog Volume in form of <catalog>.<schema>.<name>.
name string: the name of the volume
volumeInfo GetVolumeVolumeInfo: VolumeInfo object for a Unity Catalog volume. This contains the following attributes:

id str: ID of this Unity Catalog Volume in form of <catalog>.<schema>.<name>.
name str: the name of the volume
volume_info GetVolumeVolumeInfo: VolumeInfo object for a Unity Catalog volume. This contains the following attributes:

id String: ID of this Unity Catalog Volume in form of <catalog>.<schema>.<name>.
name String: the name of the volume
volumeInfo Property Map: VolumeInfo object for a Unity Catalog volume. This contains the following attributes:

Supporting Types

GetVolumeVolumeInfo

AccessPoint string: the AWS access point to use when accessing s3 bucket for this volume's external location
BrowseOnly bool: indicates whether the principal is limited to retrieving metadata for the volume through the BROWSE privilege when include_browse is enabled in the request.
CatalogName string: the name of the catalog where the schema and the volume are
Comment string: the comment attached to the volume
CreatedAt int: the Unix timestamp at the volume's creation
CreatedBy string: the identifier of the user who created the volume
EncryptionDetails GetVolumeVolumeInfoEncryptionDetails: encryption options that apply to clients connecting to cloud storage
FullName string: the three-level (fully qualified) name of the volume
MetastoreId string: the unique identifier of the metastore
Name string: a fully qualified name of databricks_volume: catalog.schema.volume
Owner string: the identifier of the user who owns the volume
SchemaName string: the name of the schema where the volume is
StorageLocation string: the storage location on the cloud
UpdatedAt int: the timestamp of the last time changes were made to the volume
UpdatedBy string: the identifier of the user who updated the volume last time
VolumeId string: the unique identifier of the volume
VolumeType string: whether the volume is MANAGED or EXTERNAL

AccessPoint string: the AWS access point to use when accessing s3 bucket for this volume's external location
BrowseOnly bool: indicates whether the principal is limited to retrieving metadata for the volume through the BROWSE privilege when include_browse is enabled in the request.
CatalogName string: the name of the catalog where the schema and the volume are
Comment string: the comment attached to the volume
CreatedAt int: the Unix timestamp at the volume's creation
CreatedBy string: the identifier of the user who created the volume
EncryptionDetails GetVolumeVolumeInfoEncryptionDetails: encryption options that apply to clients connecting to cloud storage
FullName string: the three-level (fully qualified) name of the volume
MetastoreId string: the unique identifier of the metastore
Name string: a fully qualified name of databricks_volume: catalog.schema.volume
Owner string: the identifier of the user who owns the volume
SchemaName string: the name of the schema where the volume is
StorageLocation string: the storage location on the cloud
UpdatedAt int: the timestamp of the last time changes were made to the volume
UpdatedBy string: the identifier of the user who updated the volume last time
VolumeId string: the unique identifier of the volume
VolumeType string: whether the volume is MANAGED or EXTERNAL

accessPoint String: the AWS access point to use when accessing s3 bucket for this volume's external location
browseOnly Boolean: indicates whether the principal is limited to retrieving metadata for the volume through the BROWSE privilege when include_browse is enabled in the request.
catalogName String: the name of the catalog where the schema and the volume are
comment String: the comment attached to the volume
createdAt Integer: the Unix timestamp at the volume's creation
createdBy String: the identifier of the user who created the volume
encryptionDetails GetVolumeVolumeInfoEncryptionDetails: encryption options that apply to clients connecting to cloud storage
fullName String: the three-level (fully qualified) name of the volume
metastoreId String: the unique identifier of the metastore
name String: a fully qualified name of databricks_volume: catalog.schema.volume
owner String: the identifier of the user who owns the volume
schemaName String: the name of the schema where the volume is
storageLocation String: the storage location on the cloud
updatedAt Integer: the timestamp of the last time changes were made to the volume
updatedBy String: the identifier of the user who updated the volume last time
volumeId String: the unique identifier of the volume
volumeType String: whether the volume is MANAGED or EXTERNAL

accessPoint string: the AWS access point to use when accessing s3 bucket for this volume's external location
browseOnly boolean: indicates whether the principal is limited to retrieving metadata for the volume through the BROWSE privilege when include_browse is enabled in the request.
catalogName string: the name of the catalog where the schema and the volume are
comment string: the comment attached to the volume
createdAt number: the Unix timestamp at the volume's creation
createdBy string: the identifier of the user who created the volume
encryptionDetails GetVolumeVolumeInfoEncryptionDetails: encryption options that apply to clients connecting to cloud storage
fullName string: the three-level (fully qualified) name of the volume
metastoreId string: the unique identifier of the metastore
name string: a fully qualified name of databricks_volume: catalog.schema.volume
owner string: the identifier of the user who owns the volume
schemaName string: the name of the schema where the volume is
storageLocation string: the storage location on the cloud
updatedAt number: the timestamp of the last time changes were made to the volume
updatedBy string: the identifier of the user who updated the volume last time
volumeId string: the unique identifier of the volume
volumeType string: whether the volume is MANAGED or EXTERNAL

access_point str: the AWS access point to use when accessing s3 bucket for this volume's external location
browse_only bool: indicates whether the principal is limited to retrieving metadata for the volume through the BROWSE privilege when include_browse is enabled in the request.
catalog_name str: the name of the catalog where the schema and the volume are
comment str: the comment attached to the volume
created_at int: the Unix timestamp at the volume's creation
created_by str: the identifier of the user who created the volume
encryption_details GetVolumeVolumeInfoEncryptionDetails: encryption options that apply to clients connecting to cloud storage
full_name str: the three-level (fully qualified) name of the volume
metastore_id str: the unique identifier of the metastore
name str: a fully qualified name of databricks_volume: catalog.schema.volume
owner str: the identifier of the user who owns the volume
schema_name str: the name of the schema where the volume is
storage_location str: the storage location on the cloud
updated_at int: the timestamp of the last time changes were made to the volume
updated_by str: the identifier of the user who updated the volume last time
volume_id str: the unique identifier of the volume
volume_type str: whether the volume is MANAGED or EXTERNAL

accessPoint String: the AWS access point to use when accessing s3 bucket for this volume's external location
browseOnly Boolean: indicates whether the principal is limited to retrieving metadata for the volume through the BROWSE privilege when include_browse is enabled in the request.
catalogName String: the name of the catalog where the schema and the volume are
comment String: the comment attached to the volume
createdAt Number: the Unix timestamp at the volume's creation
createdBy String: the identifier of the user who created the volume
encryptionDetails Property Map: encryption options that apply to clients connecting to cloud storage
fullName String: the three-level (fully qualified) name of the volume
metastoreId String: the unique identifier of the metastore
name String: a fully qualified name of databricks_volume: catalog.schema.volume
owner String: the identifier of the user who owns the volume
schemaName String: the name of the schema where the volume is
storageLocation String: the storage location on the cloud
updatedAt Number: the timestamp of the last time changes were made to the volume
updatedBy String: the identifier of the user who updated the volume last time
volumeId String: the unique identifier of the volume
volumeType String: whether the volume is MANAGED or EXTERNAL