Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Databricks Provider
  3. API Docs
  4. getExternalLocation
Databricks v1.71.0 published on Monday, Jun 9, 2025 by Pulumi
pulumi/pulumi-databricks

databricks.getExternalLocation

Explore with Pulumi AI

databricks logo
Databricks v1.71.0 published on Monday, Jun 9, 2025 by Pulumi
pulumi/pulumi-databricks

    Retrieves details about a databricks.ExternalLocation that were created by Pulumi or manually.

    This data source can only be used with a workspace-level provider!

    Example Usage

    Getting details of an existing external location in the metastore

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

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

    import pulumi
import pulumi_databricks as databricks

this = databricks.get_external_location(name="this")
pulumi.export("createdBy", this.external_location_info.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.LookupExternalLocation(ctx, &databricks.LookupExternalLocationArgs{
			Name: "this",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("createdBy", this.ExternalLocationInfo.CreatedBy)
		return nil
	})
}

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

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

    return new Dictionary<string, object?>
    {
        ["createdBy"] = @this.Apply(@this => @this.Apply(getExternalLocationResult => getExternalLocationResult.ExternalLocationInfo?.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.GetExternalLocationArgs;
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.getExternalLocation(GetExternalLocationArgs.builder()
            .name("this")
            .build());

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

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

    The following resources are used in the same context:

    • databricks.getExternalLocations to get names of all external locations
    • databricks.ExternalLocation to manage external locations within Unity Catalog.

    Using getExternalLocation

    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 getExternalLocation(args: GetExternalLocationArgs, opts?: InvokeOptions): Promise<GetExternalLocationResult>
function getExternalLocationOutput(args: GetExternalLocationOutputArgs, opts?: InvokeOptions): Output<GetExternalLocationResult>
    def get_external_location(external_location_info: Optional[GetExternalLocationExternalLocationInfo] = None,
                          id: Optional[str] = None,
                          name: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetExternalLocationResult
def get_external_location_output(external_location_info: Optional[pulumi.Input[GetExternalLocationExternalLocationInfoArgs]] = None,
                          id: Optional[pulumi.Input[str]] = None,
                          name: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetExternalLocationResult]
    func LookupExternalLocation(ctx *Context, args *LookupExternalLocationArgs, opts ...InvokeOption) (*LookupExternalLocationResult, error)
func LookupExternalLocationOutput(ctx *Context, args *LookupExternalLocationOutputArgs, opts ...InvokeOption) LookupExternalLocationResultOutput

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

    public static class GetExternalLocation 
{
    public static Task<GetExternalLocationResult> InvokeAsync(GetExternalLocationArgs args, InvokeOptions? opts = null)
    public static Output<GetExternalLocationResult> Invoke(GetExternalLocationInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetExternalLocationResult> getExternalLocation(GetExternalLocationArgs args, InvokeOptions options)
public static Output<GetExternalLocationResult> getExternalLocation(GetExternalLocationArgs args, InvokeOptions options)

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

    The following arguments are supported:

    Name string
    The name of the external location
    ExternalLocationInfo GetExternalLocationExternalLocationInfo
    array of objects with information about external location:
    Id string
    external location ID - same as name.
    Name string
    The name of the external location
    ExternalLocationInfo GetExternalLocationExternalLocationInfo
    array of objects with information about external location:
    Id string
    external location ID - same as name.
    name String
    The name of the external location
    externalLocationInfo GetExternalLocationExternalLocationInfo
    array of objects with information about external location:
    id String
    external location ID - same as name.
    name string
    The name of the external location
    externalLocationInfo GetExternalLocationExternalLocationInfo
    array of objects with information about external location:
    id string
    external location ID - same as name.
    name str
    The name of the external location
    external_location_info GetExternalLocationExternalLocationInfo
    array of objects with information about external location:
    id str
    external location ID - same as name.
    name String
    The name of the external location
    externalLocationInfo Property Map
    array of objects with information about external location:
    id String
    external location ID - same as name.

    getExternalLocation Result

    The following output properties are available:

    ExternalLocationInfo GetExternalLocationExternalLocationInfo
    array of objects with information about external location:
    Id string
    external location ID - same as name.
    Name string
    ExternalLocationInfo GetExternalLocationExternalLocationInfo
    array of objects with information about external location:
    Id string
    external location ID - same as name.
    Name string
    externalLocationInfo GetExternalLocationExternalLocationInfo
    array of objects with information about external location:
    id String
    external location ID - same as name.
    name String
    externalLocationInfo GetExternalLocationExternalLocationInfo
    array of objects with information about external location:
    id string
    external location ID - same as name.
    name string
    external_location_info GetExternalLocationExternalLocationInfo
    array of objects with information about external location:
    id str
    external location ID - same as name.
    name str
    externalLocationInfo Property Map
    array of objects with information about external location:
    id String
    external location ID - same as name.
    name String

    Supporting Types

    GetExternalLocationExternalLocationInfo

    BrowseOnly bool
    Comment string
    User-supplied comment.
    CreatedAt int
    Time at which this catalog was created, in epoch milliseconds.
    CreatedBy string
    Username of catalog creator.
    CredentialId string
    Unique ID of storage credential.
    CredentialName string
    Name of the databricks.StorageCredential to use with this external location.
    EnableFileEvents bool
    EncryptionDetails GetExternalLocationExternalLocationInfoEncryptionDetails
    The options for Server-Side Encryption to be used by each Databricks s3 client when connecting to S3 cloud storage (AWS).
    Fallback bool
    FileEventQueue GetExternalLocationExternalLocationInfoFileEventQueue
    IsolationMode string
    MetastoreId string
    Unique identifier of the parent Metastore.
    Name string
    The name of the external location
    Owner string
    Username/groupname/sp application_id of the external location owner.
    ReadOnly bool
    Indicates whether the external location is read-only.
    UpdatedAt int
    Time at which this catalog was last modified, in epoch milliseconds.
    UpdatedBy string
    Username of user who last modified catalog.
    Url string
    Path URL in cloud storage, of the form: s3://[bucket-host]/[bucket-dir] (AWS), abfss://[user]@[host]/[path] (Azure), gs://[bucket-host]/[bucket-dir] (GCP).
    BrowseOnly bool
    Comment string
    User-supplied comment.
    CreatedAt int
    Time at which this catalog was created, in epoch milliseconds.
    CreatedBy string
    Username of catalog creator.
    CredentialId string
    Unique ID of storage credential.
    CredentialName string
    Name of the databricks.StorageCredential to use with this external location.
    EnableFileEvents bool
    EncryptionDetails GetExternalLocationExternalLocationInfoEncryptionDetails
    The options for Server-Side Encryption to be used by each Databricks s3 client when connecting to S3 cloud storage (AWS).
    Fallback bool
    FileEventQueue GetExternalLocationExternalLocationInfoFileEventQueue
    IsolationMode string
    MetastoreId string
    Unique identifier of the parent Metastore.
    Name string
    The name of the external location
    Owner string
    Username/groupname/sp application_id of the external location owner.
    ReadOnly bool
    Indicates whether the external location is read-only.
    UpdatedAt int
    Time at which this catalog was last modified, in epoch milliseconds.
    UpdatedBy string
    Username of user who last modified catalog.
    Url string
    Path URL in cloud storage, of the form: s3://[bucket-host]/[bucket-dir] (AWS), abfss://[user]@[host]/[path] (Azure), gs://[bucket-host]/[bucket-dir] (GCP).
    browseOnly Boolean
    comment String
    User-supplied comment.
    createdAt Integer
    Time at which this catalog was created, in epoch milliseconds.
    createdBy String
    Username of catalog creator.
    credentialId String
    Unique ID of storage credential.
    credentialName String
    Name of the databricks.StorageCredential to use with this external location.
    enableFileEvents Boolean
    encryptionDetails GetExternalLocationExternalLocationInfoEncryptionDetails
    The options for Server-Side Encryption to be used by each Databricks s3 client when connecting to S3 cloud storage (AWS).
    fallback Boolean
    fileEventQueue GetExternalLocationExternalLocationInfoFileEventQueue
    isolationMode String
    metastoreId String
    Unique identifier of the parent Metastore.
    name String
    The name of the external location
    owner String
    Username/groupname/sp application_id of the external location owner.
    readOnly Boolean
    Indicates whether the external location is read-only.
    updatedAt Integer
    Time at which this catalog was last modified, in epoch milliseconds.
    updatedBy String
    Username of user who last modified catalog.
    url String
    Path URL in cloud storage, of the form: s3://[bucket-host]/[bucket-dir] (AWS), abfss://[user]@[host]/[path] (Azure), gs://[bucket-host]/[bucket-dir] (GCP).
    browseOnly boolean
    comment string
    User-supplied comment.
    createdAt number
    Time at which this catalog was created, in epoch milliseconds.
    createdBy string
    Username of catalog creator.
    credentialId string
    Unique ID of storage credential.
    credentialName string
    Name of the databricks.StorageCredential to use with this external location.
    enableFileEvents boolean
    encryptionDetails GetExternalLocationExternalLocationInfoEncryptionDetails
    The options for Server-Side Encryption to be used by each Databricks s3 client when connecting to S3 cloud storage (AWS).
    fallback boolean
    fileEventQueue GetExternalLocationExternalLocationInfoFileEventQueue
    isolationMode string
    metastoreId string
    Unique identifier of the parent Metastore.
    name string
    The name of the external location
    owner string
    Username/groupname/sp application_id of the external location owner.
    readOnly boolean
    Indicates whether the external location is read-only.
    updatedAt number
    Time at which this catalog was last modified, in epoch milliseconds.
    updatedBy string
    Username of user who last modified catalog.
    url string
    Path URL in cloud storage, of the form: s3://[bucket-host]/[bucket-dir] (AWS), abfss://[user]@[host]/[path] (Azure), gs://[bucket-host]/[bucket-dir] (GCP).
    browse_only bool
    comment str
    User-supplied comment.
    created_at int
    Time at which this catalog was created, in epoch milliseconds.
    created_by str
    Username of catalog creator.
    credential_id str
    Unique ID of storage credential.
    credential_name str
    Name of the databricks.StorageCredential to use with this external location.
    enable_file_events bool
    encryption_details GetExternalLocationExternalLocationInfoEncryptionDetails
    The options for Server-Side Encryption to be used by each Databricks s3 client when connecting to S3 cloud storage (AWS).
    fallback bool
    file_event_queue GetExternalLocationExternalLocationInfoFileEventQueue
    isolation_mode str
    metastore_id str
    Unique identifier of the parent Metastore.
    name str
    The name of the external location
    owner str
    Username/groupname/sp application_id of the external location owner.
    read_only bool
    Indicates whether the external location is read-only.
    updated_at int
    Time at which this catalog was last modified, in epoch milliseconds.
    updated_by str
    Username of user who last modified catalog.
    url str
    Path URL in cloud storage, of the form: s3://[bucket-host]/[bucket-dir] (AWS), abfss://[user]@[host]/[path] (Azure), gs://[bucket-host]/[bucket-dir] (GCP).
    browseOnly Boolean
    comment String
    User-supplied comment.
    createdAt Number
    Time at which this catalog was created, in epoch milliseconds.
    createdBy String
    Username of catalog creator.
    credentialId String
    Unique ID of storage credential.
    credentialName String
    Name of the databricks.StorageCredential to use with this external location.
    enableFileEvents Boolean
    encryptionDetails Property Map
    The options for Server-Side Encryption to be used by each Databricks s3 client when connecting to S3 cloud storage (AWS).
    fallback Boolean
    fileEventQueue Property Map
    isolationMode String
    metastoreId String
    Unique identifier of the parent Metastore.
    name String
    The name of the external location
    owner String
    Username/groupname/sp application_id of the external location owner.
    readOnly Boolean
    Indicates whether the external location is read-only.
    updatedAt Number
    Time at which this catalog was last modified, in epoch milliseconds.
    updatedBy String
    Username of user who last modified catalog.
    url String
    Path URL in cloud storage, of the form: s3://[bucket-host]/[bucket-dir] (AWS), abfss://[user]@[host]/[path] (Azure), gs://[bucket-host]/[bucket-dir] (GCP).

    GetExternalLocationExternalLocationInfoEncryptionDetails

    GetExternalLocationExternalLocationInfoEncryptionDetailsSseEncryptionDetails

    Algorithm string
    AwsKmsKeyArn string
    Algorithm string
    AwsKmsKeyArn string
    algorithm String
    awsKmsKeyArn String
    algorithm string
    awsKmsKeyArn string
    algorithm String
    awsKmsKeyArn String

    GetExternalLocationExternalLocationInfoFileEventQueue

    GetExternalLocationExternalLocationInfoFileEventQueueManagedAqs

    GetExternalLocationExternalLocationInfoFileEventQueueManagedPubsub

    GetExternalLocationExternalLocationInfoFileEventQueueManagedSqs

    GetExternalLocationExternalLocationInfoFileEventQueueProvidedAqs

    GetExternalLocationExternalLocationInfoFileEventQueueProvidedPubsub

    GetExternalLocationExternalLocationInfoFileEventQueueProvidedSqs

    Package Details

    Repository
    databricks pulumi/pulumi-databricks
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the databricks Terraform Provider.
    databricks logo
    Databricks v1.71.0 published on Monday, Jun 9, 2025 by Pulumi
    pulumi/pulumi-databricks