1. Packages
  2. Databricks Provider
  3. API Docs
  4. getExternalMetadatas
Databricks v1.78.0 published on Friday, Nov 7, 2025 by Pulumi
pulumi/pulumi-databricks

databricks.getExternalMetadatas

Start a Neo task
Explain and create a databricks.getExternalMetadatas resource
databricks logo
Databricks v1.78.0 published on Friday, Nov 7, 2025 by Pulumi
pulumi/pulumi-databricks

    Public Preview

    This data source can be used to fetch the list of external metadata objects.

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

    Example Usage

    Getting a list of all external metadata objects:

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

const all = databricks.getExternalMetadatas({});

    import pulumi
import pulumi_databricks as databricks

all = databricks.get_external_metadatas()

    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.GetExternalMetadatas(ctx, &databricks.GetExternalMetadatasArgs{}, 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 all = Databricks.GetExternalMetadatas.Invoke();

});

    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.GetExternalMetadatasArgs;
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 all = DatabricksFunctions.getExternalMetadatas(GetExternalMetadatasArgs.builder()
            .build());

    }
}

    variables:
  all:
    fn::invoke:
      function: databricks:getExternalMetadatas
      arguments: {}

    Using getExternalMetadatas

    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 getExternalMetadatas(args: GetExternalMetadatasArgs, opts?: InvokeOptions): Promise<GetExternalMetadatasResult>
function getExternalMetadatasOutput(args: GetExternalMetadatasOutputArgs, opts?: InvokeOptions): Output<GetExternalMetadatasResult>
    def get_external_metadatas(page_size: Optional[int] = None,
                           opts: Optional[InvokeOptions] = None) -> GetExternalMetadatasResult
def get_external_metadatas_output(page_size: Optional[pulumi.Input[int]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetExternalMetadatasResult]
    func GetExternalMetadatas(ctx *Context, args *GetExternalMetadatasArgs, opts ...InvokeOption) (*GetExternalMetadatasResult, error)
func GetExternalMetadatasOutput(ctx *Context, args *GetExternalMetadatasOutputArgs, opts ...InvokeOption) GetExternalMetadatasResultOutput

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

    public static class GetExternalMetadatas 
{
    public static Task<GetExternalMetadatasResult> InvokeAsync(GetExternalMetadatasArgs args, InvokeOptions? opts = null)
    public static Output<GetExternalMetadatasResult> Invoke(GetExternalMetadatasInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetExternalMetadatasResult> getExternalMetadatas(GetExternalMetadatasArgs args, InvokeOptions options)
public static Output<GetExternalMetadatasResult> getExternalMetadatas(GetExternalMetadatasArgs args, InvokeOptions options)

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

    The following arguments are supported:

    PageSize int
    Specifies the maximum number of external metadata objects to return in a single response. The value must be less than or equal to 1000
    PageSize int
    Specifies the maximum number of external metadata objects to return in a single response. The value must be less than or equal to 1000
    pageSize Integer
    Specifies the maximum number of external metadata objects to return in a single response. The value must be less than or equal to 1000
    pageSize number
    Specifies the maximum number of external metadata objects to return in a single response. The value must be less than or equal to 1000
    page_size int
    Specifies the maximum number of external metadata objects to return in a single response. The value must be less than or equal to 1000
    pageSize Number
    Specifies the maximum number of external metadata objects to return in a single response. The value must be less than or equal to 1000

    getExternalMetadatas Result

    The following output properties are available:

    ExternalMetadatas List<GetExternalMetadatasExternalMetadata>
    Id string
    The provider-assigned unique ID for this managed resource.
    PageSize int
    ExternalMetadatas []GetExternalMetadatasExternalMetadata
    Id string
    The provider-assigned unique ID for this managed resource.
    PageSize int
    externalMetadatas List<GetExternalMetadatasExternalMetadata>
    id String
    The provider-assigned unique ID for this managed resource.
    pageSize Integer
    externalMetadatas GetExternalMetadatasExternalMetadata[]
    id string
    The provider-assigned unique ID for this managed resource.
    pageSize number
    external_metadatas Sequence[GetExternalMetadatasExternalMetadata]
    id str
    The provider-assigned unique ID for this managed resource.
    page_size int
    externalMetadatas List<Property Map>
    id String
    The provider-assigned unique ID for this managed resource.
    pageSize Number

    Supporting Types

    GetExternalMetadatasExternalMetadata

    Columns List<string>
    (list of string) - List of columns 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
    Description string
    (string) - User-provided free-form text description
    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
    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
    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, STREAM_NATIVE, 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
    Url string
    (string) - URL associated with the external metadata object
    Columns []string
    (list of string) - List of columns 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
    Description string
    (string) - User-provided free-form text description
    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
    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
    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, STREAM_NATIVE, 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
    Url string
    (string) - URL associated with the external metadata object
    columns List<String>
    (list of string) - List of columns 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
    description String
    (string) - User-provided free-form text description
    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
    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
    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, STREAM_NATIVE, 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
    url String
    (string) - URL associated with the external metadata object
    columns string[]
    (list of string) - List of columns 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
    description string
    (string) - User-provided free-form text description
    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
    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
    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, STREAM_NATIVE, 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
    url string
    (string) - URL associated with the external metadata object
    columns Sequence[str]
    (list of string) - List of columns 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
    description str
    (string) - User-provided free-form text description
    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
    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
    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, STREAM_NATIVE, 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
    url str
    (string) - URL associated with the external metadata object
    columns List<String>
    (list of string) - List of columns 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
    description String
    (string) - User-provided free-form text description
    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
    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
    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, STREAM_NATIVE, 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
    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.78.0 published on Friday, Nov 7, 2025 by Pulumi
    pulumi/pulumi-databricks
      Meet Neo: Your AI Platform Teammate