Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Databricks Provider
  3. API Docs
  4. getExternalMetadata
Databricks v1.74.0 published on Thursday, Aug 14, 2025 by Pulumi
pulumi/pulumi-databricks

databricks.getExternalMetadata

Explore with Pulumi AI

databricks logo
Databricks v1.74.0 published on Thursday, Aug 14, 2025 by Pulumi
pulumi/pulumi-databricks

    This data source can be used to get a single external metadata object.

    Note This resource can only be used with an workspace-level provider!

    Example Usage

    Referring to an external metadata object by name:

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

const _this = databricks.getExternalMetadata({
    name: "security_events_stream",
});

    import pulumi
import pulumi_databricks as databricks

this = databricks.get_external_metadata(name="security_events_stream")

    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.LookupExternalMetadata(ctx, &databricks.LookupExternalMetadataArgs{
			Name: "security_events_stream",
		}, 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.GetExternalMetadata.Invoke(new()
    {
        Name = "security_events_stream",
    });

});

    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.GetExternalMetadataArgs;
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.getExternalMetadata(GetExternalMetadataArgs.builder()
            .name("security_events_stream")
            .build());

    }
}

    variables:
  this:
    fn::invoke:
      function: databricks:getExternalMetadata
      arguments:
        name: security_events_stream

    Using getExternalMetadata

    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 getExternalMetadata(args: GetExternalMetadataArgs, opts?: InvokeOptions): Promise<GetExternalMetadataResult>
function getExternalMetadataOutput(args: GetExternalMetadataOutputArgs, opts?: InvokeOptions): Output<GetExternalMetadataResult>
    def get_external_metadata(columns: Optional[Sequence[str]] = None,
                          description: Optional[str] = None,
                          entity_type: Optional[str] = None,
                          name: Optional[str] = None,
                          owner: Optional[str] = None,
                          properties: Optional[Mapping[str, str]] = None,
                          system_type: Optional[str] = None,
                          url: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetExternalMetadataResult
def get_external_metadata_output(columns: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                          description: Optional[pulumi.Input[str]] = None,
                          entity_type: Optional[pulumi.Input[str]] = None,
                          name: Optional[pulumi.Input[str]] = None,
                          owner: Optional[pulumi.Input[str]] = None,
                          properties: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                          system_type: Optional[pulumi.Input[str]] = None,
                          url: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetExternalMetadataResult]
    func LookupExternalMetadata(ctx *Context, args *LookupExternalMetadataArgs, opts ...InvokeOption) (*LookupExternalMetadataResult, error)
func LookupExternalMetadataOutput(ctx *Context, args *LookupExternalMetadataOutputArgs, opts ...InvokeOption) LookupExternalMetadataResultOutput

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

    public static class GetExternalMetadata 
{
    public static Task<GetExternalMetadataResult> InvokeAsync(GetExternalMetadataArgs args, InvokeOptions? opts = null)
    public static Output<GetExternalMetadataResult> Invoke(GetExternalMetadataInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetExternalMetadataResult> getExternalMetadata(GetExternalMetadataArgs args, InvokeOptions options)
public static Output<GetExternalMetadataResult> getExternalMetadata(GetExternalMetadataArgs args, InvokeOptions options)

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

    The following arguments are supported:

    EntityType string
    (string) - Type of entity within the external system
    Name string
    Name of the external metadata object
    SystemType string
    (string) - Type of external system. Possible values are: AMAZON_REDSHIFT, AZURE_SYNAPSE, CONFLUENT, DATABRICKS, GOOGLE_BIGQUERY, KAFKA, LOOKER, MICROSOFT_FABRIC, MICROSOFT_SQL_SERVER, MONGODB, MYSQL, ORACLE, OTHER, POSTGRESQL, POWER_BI, SALESFORCE, SAP, SERVICENOW, SNOWFLAKE, TABLEAU, TERADATA, WORKDAY
    Columns List<string>
    (list of string) - List of columns associated with the external metadata object
    Description string
    (string) - User-provided free-form text description
    Owner string
    (string) - Owner of the external metadata object
    Properties Dictionary<string, string>
    (object) - A map of key-value properties attached to the external metadata object
    Url string
    (string) - URL associated with the external metadata object
    EntityType string
    (string) - Type of entity within the external system
    Name string
    Name of the external metadata object
    SystemType string
    (string) - Type of external system. Possible values are: AMAZON_REDSHIFT, AZURE_SYNAPSE, CONFLUENT, DATABRICKS, GOOGLE_BIGQUERY, KAFKA, LOOKER, MICROSOFT_FABRIC, MICROSOFT_SQL_SERVER, MONGODB, MYSQL, ORACLE, OTHER, POSTGRESQL, POWER_BI, SALESFORCE, SAP, SERVICENOW, SNOWFLAKE, TABLEAU, TERADATA, WORKDAY
    Columns []string
    (list of string) - List of columns associated with the external metadata object
    Description string
    (string) - User-provided free-form text description
    Owner string
    (string) - Owner of the external metadata object
    Properties map[string]string
    (object) - A map of key-value properties attached to the external metadata object
    Url string
    (string) - URL associated with the external metadata object
    entityType String
    (string) - Type of entity within the external system
    name String
    Name of the external metadata object
    systemType String
    (string) - Type of external system. Possible values are: AMAZON_REDSHIFT, AZURE_SYNAPSE, CONFLUENT, DATABRICKS, GOOGLE_BIGQUERY, KAFKA, LOOKER, MICROSOFT_FABRIC, MICROSOFT_SQL_SERVER, MONGODB, MYSQL, ORACLE, OTHER, POSTGRESQL, POWER_BI, SALESFORCE, SAP, SERVICENOW, SNOWFLAKE, TABLEAU, TERADATA, WORKDAY
    columns List<String>
    (list of string) - List of columns associated with the external metadata object
    description String
    (string) - User-provided free-form text description
    owner String
    (string) - Owner of the external metadata object
    properties Map<String,String>
    (object) - A map of key-value properties attached to the external metadata object
    url String
    (string) - URL associated with the external metadata object
    entityType string
    (string) - Type of entity within the external system
    name string
    Name of the external metadata object
    systemType string
    (string) - Type of external system. Possible values are: AMAZON_REDSHIFT, AZURE_SYNAPSE, CONFLUENT, DATABRICKS, GOOGLE_BIGQUERY, KAFKA, LOOKER, MICROSOFT_FABRIC, MICROSOFT_SQL_SERVER, MONGODB, MYSQL, ORACLE, OTHER, POSTGRESQL, POWER_BI, SALESFORCE, SAP, SERVICENOW, SNOWFLAKE, TABLEAU, TERADATA, WORKDAY
    columns string[]
    (list of string) - List of columns associated with the external metadata object
    description string
    (string) - User-provided free-form text description
    owner string
    (string) - Owner of the external metadata object
    properties {[key: string]: string}
    (object) - A map of key-value properties attached to the external metadata object
    url string
    (string) - URL associated with the external metadata object
    entity_type str
    (string) - Type of entity within the external system
    name str
    Name of the external metadata object
    system_type str
    (string) - Type of external system. Possible values are: AMAZON_REDSHIFT, AZURE_SYNAPSE, CONFLUENT, DATABRICKS, GOOGLE_BIGQUERY, KAFKA, LOOKER, MICROSOFT_FABRIC, MICROSOFT_SQL_SERVER, MONGODB, MYSQL, ORACLE, OTHER, POSTGRESQL, POWER_BI, SALESFORCE, SAP, SERVICENOW, SNOWFLAKE, TABLEAU, TERADATA, WORKDAY
    columns Sequence[str]
    (list of string) - List of columns associated with the external metadata object
    description str
    (string) - User-provided free-form text description
    owner str
    (string) - Owner of the external metadata object
    properties Mapping[str, str]
    (object) - A map of key-value properties attached to the external metadata object
    url str
    (string) - URL associated with the external metadata object
    entityType String
    (string) - Type of entity within the external system
    name String
    Name of the external metadata object
    systemType String
    (string) - Type of external system. Possible values are: AMAZON_REDSHIFT, AZURE_SYNAPSE, CONFLUENT, DATABRICKS, GOOGLE_BIGQUERY, KAFKA, LOOKER, MICROSOFT_FABRIC, MICROSOFT_SQL_SERVER, MONGODB, MYSQL, ORACLE, OTHER, POSTGRESQL, POWER_BI, SALESFORCE, SAP, SERVICENOW, SNOWFLAKE, TABLEAU, TERADATA, WORKDAY
    columns List<String>
    (list of string) - List of columns associated with the external metadata object
    description String
    (string) - User-provided free-form text description
    owner String
    (string) - Owner of the external metadata object
    properties Map<String>
    (object) - A map of key-value properties attached to the external metadata object
    url String
    (string) - URL associated with the external metadata object

    getExternalMetadata Result

    The following output properties are available:

    CreateTime string
    (string) - Time at which this external metadata object was created
    CreatedBy string
    (string) - Username of external metadata object creator
    EntityType string
    (string) - Type of entity within the external system
    Id string
    (string) - Unique identifier of the external metadata object
    MetastoreId string
    (string) - Unique identifier of parent metastore
    Name string
    (string) - Name of the external metadata object
    SystemType string
    (string) - Type of external system. Possible values are: AMAZON_REDSHIFT, AZURE_SYNAPSE, CONFLUENT, DATABRICKS, GOOGLE_BIGQUERY, KAFKA, LOOKER, MICROSOFT_FABRIC, MICROSOFT_SQL_SERVER, MONGODB, MYSQL, ORACLE, OTHER, POSTGRESQL, POWER_BI, SALESFORCE, SAP, SERVICENOW, SNOWFLAKE, TABLEAU, TERADATA, WORKDAY
    UpdateTime string
    (string) - Time at which this external metadata object was last modified
    UpdatedBy string
    (string) - Username of user who last modified external metadata object
    Columns List<string>
    (list of string) - List of columns associated with the external metadata object
    Description string
    (string) - User-provided free-form text description
    Owner string
    (string) - Owner of the external metadata object
    Properties Dictionary<string, string>
    (object) - A map of key-value properties attached to the external metadata object
    Url string
    (string) - URL associated with the external metadata object
    CreateTime string
    (string) - Time at which this external metadata object was created
    CreatedBy string
    (string) - Username of external metadata object creator
    EntityType string
    (string) - Type of entity within the external system
    Id string
    (string) - Unique identifier of the external metadata object
    MetastoreId string
    (string) - Unique identifier of parent metastore
    Name string
    (string) - Name of the external metadata object
    SystemType string
    (string) - Type of external system. Possible values are: AMAZON_REDSHIFT, AZURE_SYNAPSE, CONFLUENT, DATABRICKS, GOOGLE_BIGQUERY, KAFKA, LOOKER, MICROSOFT_FABRIC, MICROSOFT_SQL_SERVER, MONGODB, MYSQL, ORACLE, OTHER, POSTGRESQL, POWER_BI, SALESFORCE, SAP, SERVICENOW, SNOWFLAKE, TABLEAU, TERADATA, WORKDAY
    UpdateTime string
    (string) - Time at which this external metadata object was last modified
    UpdatedBy string
    (string) - Username of user who last modified external metadata object
    Columns []string
    (list of string) - List of columns associated with the external metadata object
    Description string
    (string) - User-provided free-form text description
    Owner string
    (string) - Owner of the external metadata object
    Properties map[string]string
    (object) - A map of key-value properties attached to the external metadata object
    Url string
    (string) - URL associated with the external metadata object
    createTime String
    (string) - Time at which this external metadata object was created
    createdBy String
    (string) - Username of external metadata object creator
    entityType String
    (string) - Type of entity within the external system
    id String
    (string) - Unique identifier of the external metadata object
    metastoreId String
    (string) - Unique identifier of parent metastore
    name String
    (string) - Name of the external metadata object
    systemType String
    (string) - Type of external system. Possible values are: AMAZON_REDSHIFT, AZURE_SYNAPSE, CONFLUENT, DATABRICKS, GOOGLE_BIGQUERY, KAFKA, LOOKER, MICROSOFT_FABRIC, MICROSOFT_SQL_SERVER, MONGODB, MYSQL, ORACLE, OTHER, POSTGRESQL, POWER_BI, SALESFORCE, SAP, SERVICENOW, SNOWFLAKE, TABLEAU, TERADATA, WORKDAY
    updateTime String
    (string) - Time at which this external metadata object was last modified
    updatedBy String
    (string) - Username of user who last modified external metadata object
    columns List<String>
    (list of string) - List of columns associated with the external metadata object
    description String
    (string) - User-provided free-form text description
    owner String
    (string) - Owner of the external metadata object
    properties Map<String,String>
    (object) - A map of key-value properties attached to the external metadata object
    url String
    (string) - URL associated with the external metadata object
    createTime string
    (string) - Time at which this external metadata object was created
    createdBy string
    (string) - Username of external metadata object creator
    entityType string
    (string) - Type of entity within the external system
    id string
    (string) - Unique identifier of the external metadata object
    metastoreId string
    (string) - Unique identifier of parent metastore
    name string
    (string) - Name of the external metadata object
    systemType string
    (string) - Type of external system. Possible values are: AMAZON_REDSHIFT, AZURE_SYNAPSE, CONFLUENT, DATABRICKS, GOOGLE_BIGQUERY, KAFKA, LOOKER, MICROSOFT_FABRIC, MICROSOFT_SQL_SERVER, MONGODB, MYSQL, ORACLE, OTHER, POSTGRESQL, POWER_BI, SALESFORCE, SAP, SERVICENOW, SNOWFLAKE, TABLEAU, TERADATA, WORKDAY
    updateTime string
    (string) - Time at which this external metadata object was last modified
    updatedBy string
    (string) - Username of user who last modified external metadata object
    columns string[]
    (list of string) - List of columns associated with the external metadata object
    description string
    (string) - User-provided free-form text description
    owner string
    (string) - Owner of the external metadata object
    properties {[key: string]: string}
    (object) - A map of key-value properties attached to the external metadata object
    url string
    (string) - URL associated with the external metadata object
    create_time str
    (string) - Time at which this external metadata object was created
    created_by str
    (string) - Username of external metadata object creator
    entity_type str
    (string) - Type of entity within the external system
    id str
    (string) - Unique identifier of the external metadata object
    metastore_id str
    (string) - Unique identifier of parent metastore
    name str
    (string) - Name of the external metadata object
    system_type str
    (string) - Type of external system. Possible values are: AMAZON_REDSHIFT, AZURE_SYNAPSE, CONFLUENT, DATABRICKS, GOOGLE_BIGQUERY, KAFKA, LOOKER, MICROSOFT_FABRIC, MICROSOFT_SQL_SERVER, MONGODB, MYSQL, ORACLE, OTHER, POSTGRESQL, POWER_BI, SALESFORCE, SAP, SERVICENOW, SNOWFLAKE, TABLEAU, TERADATA, WORKDAY
    update_time str
    (string) - Time at which this external metadata object was last modified
    updated_by str
    (string) - Username of user who last modified external metadata object
    columns Sequence[str]
    (list of string) - List of columns associated with the external metadata object
    description str
    (string) - User-provided free-form text description
    owner str
    (string) - Owner of the external metadata object
    properties Mapping[str, str]
    (object) - A map of key-value properties attached to the external metadata object
    url str
    (string) - URL associated with the external metadata object
    createTime String
    (string) - Time at which this external metadata object was created
    createdBy String
    (string) - Username of external metadata object creator
    entityType String
    (string) - Type of entity within the external system
    id String
    (string) - Unique identifier of the external metadata object
    metastoreId String
    (string) - Unique identifier of parent metastore
    name String
    (string) - Name of the external metadata object
    systemType String
    (string) - Type of external system. Possible values are: AMAZON_REDSHIFT, AZURE_SYNAPSE, CONFLUENT, DATABRICKS, GOOGLE_BIGQUERY, KAFKA, LOOKER, MICROSOFT_FABRIC, MICROSOFT_SQL_SERVER, MONGODB, MYSQL, ORACLE, OTHER, POSTGRESQL, POWER_BI, SALESFORCE, SAP, SERVICENOW, SNOWFLAKE, TABLEAU, TERADATA, WORKDAY
    updateTime String
    (string) - Time at which this external metadata object was last modified
    updatedBy String
    (string) - Username of user who last modified external metadata object
    columns List<String>
    (list of string) - List of columns associated with the external metadata object
    description String
    (string) - User-provided free-form text description
    owner String
    (string) - Owner of the external metadata object
    properties Map<String>
    (object) - A map of key-value properties attached to the external metadata object
    url String
    (string) - URL associated with the external metadata object

    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.74.0 published on Thursday, Aug 14, 2025 by Pulumi
    pulumi/pulumi-databricks