databricks.getShare

Start a Neo task

Explain and create a databricks.getShare resource

Databricks v1.77.0 published on Tuesday, Nov 4, 2025 by Pulumi

pulumi/pulumi-databricks

Example Usage

Getting details of an existing share in the metastore

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

const _this = databricks.getShare({
    name: "this",
});
export const createdBy = _this.then(_this => _this.createdBy);

import pulumi
import pulumi_databricks as databricks

this = databricks.get_share(name="this")
pulumi.export("createdBy", this.created_by)

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 {
		this, err := databricks.LookupShare(ctx, &databricks.LookupShareArgs{
			Name: pulumi.StringRef("this"),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("createdBy", this.CreatedBy)
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var @this = Databricks.GetShare.Invoke(new()
    {
        Name = "this",
    });

    return new Dictionary<string, object?>
    {
        ["createdBy"] = @this.Apply(@this => @this.Apply(getShareResult => getShareResult.CreatedBy)),
    };
});

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.GetShareArgs;
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.getShare(GetShareArgs.builder()
            .name("this")
            .build());

        ctx.export("createdBy", this_.createdBy());
    }
}

variables:
  this:
    fn::invoke:
      function: databricks:getShare
      arguments:
        name: this
outputs:
  createdBy: ${this.createdBy}

The following resources are used in the same context:

* databricks.Share to create Delta Sharing shares. * databricks.Recipient to create Delta Sharing recipients. * databricks.Grants to manage Delta Sharing permissions.

Using getShare

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 getShare(args: GetShareArgs, opts?: InvokeOptions): Promise<GetShareResult>
function getShareOutput(args: GetShareOutputArgs, opts?: InvokeOptions): Output<GetShareResult>

def get_share(comment: Optional[str] = None,
              name: Optional[str] = None,
              objects: Optional[Sequence[GetShareObject]] = None,
              owner: Optional[str] = None,
              provider_config: Optional[GetShareProviderConfig] = None,
              storage_root: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetShareResult
def get_share_output(comment: Optional[pulumi.Input[str]] = None,
              name: Optional[pulumi.Input[str]] = None,
              objects: Optional[pulumi.Input[Sequence[pulumi.Input[GetShareObjectArgs]]]] = None,
              owner: Optional[pulumi.Input[str]] = None,
              provider_config: Optional[pulumi.Input[GetShareProviderConfigArgs]] = None,
              storage_root: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetShareResult]

func LookupShare(ctx *Context, args *LookupShareArgs, opts ...InvokeOption) (*LookupShareResult, error)
func LookupShareOutput(ctx *Context, args *LookupShareOutputArgs, opts ...InvokeOption) LookupShareResultOutput

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

public static class GetShare 
{
    public static Task<GetShareResult> InvokeAsync(GetShareArgs args, InvokeOptions? opts = null)
    public static Output<GetShareResult> Invoke(GetShareInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetShareResult> getShare(GetShareArgs args, InvokeOptions options)
public static Output<GetShareResult> getShare(GetShareArgs args, InvokeOptions options)

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

The following arguments are supported:

Comment string: Description about the object.
Name string: The name of the share
Objects List<GetShareObject>: arrays containing details of each object in the share.
Owner string
ProviderConfig GetShareProviderConfig: Configure the provider for management through account provider. This block consists of the following fields:
StorageRoot string

Comment string: Description about the object.
Name string: The name of the share
Objects []GetShareObject: arrays containing details of each object in the share.
Owner string
ProviderConfig GetShareProviderConfig: Configure the provider for management through account provider. This block consists of the following fields:
StorageRoot string

comment String: Description about the object.
name String: The name of the share
objects List<GetShareObject>: arrays containing details of each object in the share.
owner String
providerConfig GetShareProviderConfig: Configure the provider for management through account provider. This block consists of the following fields:
storageRoot String

comment string: Description about the object.
name string: The name of the share
objects GetShareObject[]: arrays containing details of each object in the share.
owner string
providerConfig GetShareProviderConfig: Configure the provider for management through account provider. This block consists of the following fields:
storageRoot string

comment str: Description about the object.
name str: The name of the share
objects Sequence[GetShareObject]: arrays containing details of each object in the share.
owner str
provider_config GetShareProviderConfig: Configure the provider for management through account provider. This block consists of the following fields:
storage_root str

comment String: Description about the object.
name String: The name of the share
objects List<Property Map>: arrays containing details of each object in the share.
owner String
providerConfig Property Map: Configure the provider for management through account provider. This block consists of the following fields:
storageRoot String

getShare Result

The following output properties are available:

CreatedAt int: Time when the share was created.
CreatedBy string: The principal that created the share.
EffectiveOwner string
Id string: The provider-assigned unique ID for this managed resource.
StorageLocation string
UpdatedAt int
UpdatedBy string
Comment string: Description about the object.
Name string: Full name of the object being shared.
Objects List<GetShareObject>: arrays containing details of each object in the share.
Owner string
ProviderConfig GetShareProviderConfig
StorageRoot string

CreatedAt int: Time when the share was created.
CreatedBy string: The principal that created the share.
EffectiveOwner string
Id string: The provider-assigned unique ID for this managed resource.
StorageLocation string
UpdatedAt int
UpdatedBy string
Comment string: Description about the object.
Name string: Full name of the object being shared.
Objects []GetShareObject: arrays containing details of each object in the share.
Owner string
ProviderConfig GetShareProviderConfig
StorageRoot string

createdAt Integer: Time when the share was created.
createdBy String: The principal that created the share.
effectiveOwner String
id String: The provider-assigned unique ID for this managed resource.
storageLocation String
updatedAt Integer
updatedBy String
comment String: Description about the object.
name String: Full name of the object being shared.
objects List<GetShareObject>: arrays containing details of each object in the share.
owner String
providerConfig GetShareProviderConfig
storageRoot String

createdAt number: Time when the share was created.
createdBy string: The principal that created the share.
effectiveOwner string
id string: The provider-assigned unique ID for this managed resource.
storageLocation string
updatedAt number
updatedBy string
comment string: Description about the object.
name string: Full name of the object being shared.
objects GetShareObject[]: arrays containing details of each object in the share.
owner string
providerConfig GetShareProviderConfig
storageRoot string

created_at int: Time when the share was created.
created_by str: The principal that created the share.
effective_owner str
id str: The provider-assigned unique ID for this managed resource.
storage_location str
updated_at int
updated_by str
comment str: Description about the object.
name str: Full name of the object being shared.
objects Sequence[GetShareObject]: arrays containing details of each object in the share.
owner str
provider_config GetShareProviderConfig
storage_root str

createdAt Number: Time when the share was created.
createdBy String: The principal that created the share.
effectiveOwner String
id String: The provider-assigned unique ID for this managed resource.
storageLocation String
updatedAt Number
updatedBy String
comment String: Description about the object.
name String: Full name of the object being shared.
objects List<Property Map>: arrays containing details of each object in the share.
owner String
providerConfig Property Map
storageRoot String