databricks.getRegisteredModel

Databricks v1.100.0, Jul 21 26

Viewing docs for Databricks v1.100.0
published on Tuesday, Jul 21, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-databricks

Viewing docs for Databricks v1.100.0
published on Tuesday, Jul 21, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-databricks

Example Usage

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

const _this = databricks.getRegisteredModel({
    fullName: "main.default.my_model",
});

import pulumi
import pulumi_databricks as databricks

this = databricks.get_registered_model(full_name="main.default.my_model")

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.GetRegisteredModel(ctx, &databricks.LookupRegisteredModelArgs{
			FullName: "main.default.my_model",
		}, 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.GetRegisteredModel.Invoke(new()
    {
        FullName = "main.default.my_model",
    });

});

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.GetRegisteredModelArgs;
import java.util.ArrayList;
import java.util.Arrays;
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.getRegisteredModel(GetRegisteredModelArgs.builder()
            .fullName("main.default.my_model")
            .build());

    }
}

variables:
  this:
    fn::invoke:
      function: databricks:getRegisteredModel
      arguments:
        fullName: main.default.my_model

pulumi {
  required_providers {
    databricks = {
      source = "pulumi/databricks"
    }
  }
}

data "databricks_getregisteredmodel" "this" {
  full_name = "main.default.my_model"
}

The following resources are often used in the same context:

databricks.RegisteredModel resource to manage models within Unity Catalog.
databricks.ModelServing to serve this model on a Databricks serving endpoint.
databricks.MlflowExperiment to manage MLflow experiments in Databricks.

Using getRegisteredModel

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 getRegisteredModel(args: GetRegisteredModelArgs, opts?: InvokeOptions): Promise<GetRegisteredModelResult>
function getRegisteredModelOutput(args: GetRegisteredModelOutputArgs, opts?: InvokeOptions): Output<GetRegisteredModelResult>

def get_registered_model(full_name: Optional[str] = None,
                         include_aliases: Optional[bool] = None,
                         include_browse: Optional[bool] = None,
                         model_infos: Optional[Sequence[GetRegisteredModelModelInfo]] = None,
                         provider_config: Optional[GetRegisteredModelProviderConfig] = None,
                         opts: Optional[InvokeOptions] = None) -> GetRegisteredModelResult
def get_registered_model_output(full_name: pulumi.Input[Optional[str]] = None,
                         include_aliases: pulumi.Input[Optional[bool]] = None,
                         include_browse: pulumi.Input[Optional[bool]] = None,
                         model_infos: pulumi.Input[Optional[Sequence[pulumi.Input[GetRegisteredModelModelInfoArgs]]]] = None,
                         provider_config: pulumi.Input[Optional[GetRegisteredModelProviderConfigArgs]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetRegisteredModelResult]

func LookupRegisteredModel(ctx *Context, args *LookupRegisteredModelArgs, opts ...InvokeOption) (*LookupRegisteredModelResult, error)
func LookupRegisteredModelOutput(ctx *Context, args *LookupRegisteredModelOutputArgs, opts ...InvokeOption) LookupRegisteredModelResultOutput

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

public static class GetRegisteredModel 
{
    public static Task<GetRegisteredModelResult> InvokeAsync(GetRegisteredModelArgs args, InvokeOptions? opts = null)
    public static Output<GetRegisteredModelResult> Invoke(GetRegisteredModelInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetRegisteredModelResult> getRegisteredModel(GetRegisteredModelArgs args, InvokeOptions options)
public static Output<GetRegisteredModelResult> getRegisteredModel(GetRegisteredModelArgs args, InvokeOptions options)

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

data "databricks_get_registered_model" "name" {
    # arguments
}

The following arguments are supported:

FullName string: The fully-qualified name of the registered model (catalog_name.schema_name.name).
IncludeAliases bool: flag to specify if list of aliases should be included into output.
IncludeBrowse bool: flag to specify if include registered models in the response for which the principal can only access selective metadata for.
ModelInfos List<GetRegisteredModelModelInfo>: block with information about the model in Unity Catalog:
ProviderConfig GetRegisteredModelProviderConfig

FullName string: The fully-qualified name of the registered model (catalog_name.schema_name.name).
IncludeAliases bool: flag to specify if list of aliases should be included into output.
IncludeBrowse bool: flag to specify if include registered models in the response for which the principal can only access selective metadata for.
ModelInfos []GetRegisteredModelModelInfo: block with information about the model in Unity Catalog:
ProviderConfig GetRegisteredModelProviderConfig

full_name string: The fully-qualified name of the registered model (catalog_name.schema_name.name).
include_aliases bool: flag to specify if list of aliases should be included into output.
include_browse bool: flag to specify if include registered models in the response for which the principal can only access selective metadata for.
model_infos list(object): block with information about the model in Unity Catalog:
provider_config object

fullName String: The fully-qualified name of the registered model (catalog_name.schema_name.name).
includeAliases Boolean: flag to specify if list of aliases should be included into output.
includeBrowse Boolean: flag to specify if include registered models in the response for which the principal can only access selective metadata for.
modelInfos List<GetRegisteredModelModelInfo>: block with information about the model in Unity Catalog:
providerConfig GetRegisteredModelProviderConfig

fullName string: The fully-qualified name of the registered model (catalog_name.schema_name.name).
includeAliases boolean: flag to specify if list of aliases should be included into output.
includeBrowse boolean: flag to specify if include registered models in the response for which the principal can only access selective metadata for.
modelInfos GetRegisteredModelModelInfo[]: block with information about the model in Unity Catalog:
providerConfig GetRegisteredModelProviderConfig

full_name str: The fully-qualified name of the registered model (catalog_name.schema_name.name).
include_aliases bool: flag to specify if list of aliases should be included into output.
include_browse bool: flag to specify if include registered models in the response for which the principal can only access selective metadata for.
model_infos Sequence[GetRegisteredModelModelInfo]: block with information about the model in Unity Catalog:
provider_config GetRegisteredModelProviderConfig

fullName String: The fully-qualified name of the registered model (catalog_name.schema_name.name).
includeAliases Boolean: flag to specify if list of aliases should be included into output.
includeBrowse Boolean: flag to specify if include registered models in the response for which the principal can only access selective metadata for.
modelInfos List<Property Map>: block with information about the model in Unity Catalog:
providerConfig Property Map

getRegisteredModel Result

The following output properties are available:

FullName string: The fully-qualified name of the registered model (catalog_name.schema_name.name).
Id string: The provider-assigned unique ID for this managed resource.
ModelInfos List<GetRegisteredModelModelInfo>: block with information about the model in Unity Catalog:
IncludeAliases bool
IncludeBrowse bool
ProviderConfig GetRegisteredModelProviderConfig

FullName string: The fully-qualified name of the registered model (catalog_name.schema_name.name).
Id string: The provider-assigned unique ID for this managed resource.
ModelInfos []GetRegisteredModelModelInfo: block with information about the model in Unity Catalog:
IncludeAliases bool
IncludeBrowse bool
ProviderConfig GetRegisteredModelProviderConfig

full_name string: The fully-qualified name of the registered model (catalog_name.schema_name.name).
id string: The provider-assigned unique ID for this managed resource.
model_infos list(object): block with information about the model in Unity Catalog:
include_aliases bool
include_browse bool
provider_config object

fullName String: The fully-qualified name of the registered model (catalog_name.schema_name.name).
id String: The provider-assigned unique ID for this managed resource.
modelInfos List<GetRegisteredModelModelInfo>: block with information about the model in Unity Catalog:
includeAliases Boolean
includeBrowse Boolean
providerConfig GetRegisteredModelProviderConfig

fullName string: The fully-qualified name of the registered model (catalog_name.schema_name.name).
id string: The provider-assigned unique ID for this managed resource.
modelInfos GetRegisteredModelModelInfo[]: block with information about the model in Unity Catalog:
includeAliases boolean
includeBrowse boolean
providerConfig GetRegisteredModelProviderConfig

full_name str: The fully-qualified name of the registered model (catalog_name.schema_name.name).
id str: The provider-assigned unique ID for this managed resource.
model_infos Sequence[GetRegisteredModelModelInfo]: block with information about the model in Unity Catalog:
include_aliases bool
include_browse bool
provider_config GetRegisteredModelProviderConfig

fullName String: The fully-qualified name of the registered model (catalog_name.schema_name.name).
id String: The provider-assigned unique ID for this managed resource.
modelInfos List<Property Map>: block with information about the model in Unity Catalog:
includeAliases Boolean
includeBrowse Boolean
providerConfig Property Map

Supporting Types

GetRegisteredModelModelInfo

BrowseOnly bool
Aliases List<GetRegisteredModelModelInfoAlias>: the list of aliases associated with this model. Each item is object consisting of following attributes:
CatalogName string: The name of the catalog where the schema and the registered model reside.
Comment string: The comment attached to the registered model.
CreatedAt int: the Unix timestamp at the model's creation
CreatedBy string: the identifier of the user who created the model
FullName string: The fully-qualified name of the registered model (catalog_name.schema_name.name).
MetastoreId string: the unique identifier of the metastore
Name string: The name of the registered model.
Owner string: Name of the registered model owner.
SchemaName string: The name of the schema where the registered model resides.
StorageLocation string: The storage location under which model version data files are stored.
UpdatedAt int: the timestamp of the last time changes were made to the model
UpdatedBy string: the identifier of the user who updated the model last time

BrowseOnly bool
Aliases []GetRegisteredModelModelInfoAlias: the list of aliases associated with this model. Each item is object consisting of following attributes:
CatalogName string: The name of the catalog where the schema and the registered model reside.
Comment string: The comment attached to the registered model.
CreatedAt int: the Unix timestamp at the model's creation
CreatedBy string: the identifier of the user who created the model
FullName string: The fully-qualified name of the registered model (catalog_name.schema_name.name).
MetastoreId string: the unique identifier of the metastore
Name string: The name of the registered model.
Owner string: Name of the registered model owner.
SchemaName string: The name of the schema where the registered model resides.
StorageLocation string: The storage location under which model version data files are stored.
UpdatedAt int: the timestamp of the last time changes were made to the model
UpdatedBy string: the identifier of the user who updated the model last time

browse_only bool
aliases list(object): the list of aliases associated with this model. Each item is object consisting of following attributes:
catalog_name string: The name of the catalog where the schema and the registered model reside.
comment string: The comment attached to the registered model.
created_at number: the Unix timestamp at the model's creation
created_by string: the identifier of the user who created the model
full_name string: The fully-qualified name of the registered model (catalog_name.schema_name.name).
metastore_id string: the unique identifier of the metastore
name string: The name of the registered model.
owner string: Name of the registered model owner.
schema_name string: The name of the schema where the registered model resides.
storage_location string: The storage location under which model version data files are stored.
updated_at number: the timestamp of the last time changes were made to the model
updated_by string: the identifier of the user who updated the model last time

browseOnly Boolean
aliases List<GetRegisteredModelModelInfoAlias>: the list of aliases associated with this model. Each item is object consisting of following attributes:
catalogName String: The name of the catalog where the schema and the registered model reside.
comment String: The comment attached to the registered model.
createdAt Integer: the Unix timestamp at the model's creation
createdBy String: the identifier of the user who created the model
fullName String: The fully-qualified name of the registered model (catalog_name.schema_name.name).
metastoreId String: the unique identifier of the metastore
name String: The name of the registered model.
owner String: Name of the registered model owner.
schemaName String: The name of the schema where the registered model resides.
storageLocation String: The storage location under which model version data files are stored.
updatedAt Integer: the timestamp of the last time changes were made to the model
updatedBy String: the identifier of the user who updated the model last time

browseOnly boolean
aliases GetRegisteredModelModelInfoAlias[]: the list of aliases associated with this model. Each item is object consisting of following attributes:
catalogName string: The name of the catalog where the schema and the registered model reside.
comment string: The comment attached to the registered model.
createdAt number: the Unix timestamp at the model's creation
createdBy string: the identifier of the user who created the model
fullName string: The fully-qualified name of the registered model (catalog_name.schema_name.name).
metastoreId string: the unique identifier of the metastore
name string: The name of the registered model.
owner string: Name of the registered model owner.
schemaName string: The name of the schema where the registered model resides.
storageLocation string: The storage location under which model version data files are stored.
updatedAt number: the timestamp of the last time changes were made to the model
updatedBy string: the identifier of the user who updated the model last time

browse_only bool
aliases Sequence[GetRegisteredModelModelInfoAlias]: the list of aliases associated with this model. Each item is object consisting of following attributes:
catalog_name str: The name of the catalog where the schema and the registered model reside.
comment str: The comment attached to the registered model.
created_at int: the Unix timestamp at the model's creation
created_by str: the identifier of the user who created the model
full_name str: The fully-qualified name of the registered model (catalog_name.schema_name.name).
metastore_id str: the unique identifier of the metastore
name str: The name of the registered model.
owner str: Name of the registered model owner.
schema_name str: The name of the schema where the registered model resides.
storage_location str: The storage location under which model version data files are stored.
updated_at int: the timestamp of the last time changes were made to the model
updated_by str: the identifier of the user who updated the model last time

browseOnly Boolean
aliases List<Property Map>: the list of aliases associated with this model. Each item is object consisting of following attributes:
catalogName String: The name of the catalog where the schema and the registered model reside.
comment String: The comment attached to the registered model.
createdAt Number: the Unix timestamp at the model's creation
createdBy String: the identifier of the user who created the model
fullName String: The fully-qualified name of the registered model (catalog_name.schema_name.name).
metastoreId String: the unique identifier of the metastore
name String: The name of the registered model.
owner String: Name of the registered model owner.
schemaName String: The name of the schema where the registered model resides.
storageLocation String: The storage location under which model version data files are stored.
updatedAt Number: the timestamp of the last time changes were made to the model
updatedBy String: the identifier of the user who updated the model last time

GetRegisteredModelModelInfoAlias

AliasName string: string with the name of alias
CatalogName string: The name of the catalog where the schema and the registered model reside.
Id string
ModelName string
SchemaName string: The name of the schema where the registered model resides.
VersionNum int: associated model version

AliasName string: string with the name of alias
CatalogName string: The name of the catalog where the schema and the registered model reside.
Id string
ModelName string
SchemaName string: The name of the schema where the registered model resides.
VersionNum int: associated model version

alias_name string: string with the name of alias
catalog_name string: The name of the catalog where the schema and the registered model reside.
id string
model_name string
schema_name string: The name of the schema where the registered model resides.
version_num number: associated model version

aliasName String: string with the name of alias
catalogName String: The name of the catalog where the schema and the registered model reside.
id String
modelName String
schemaName String: The name of the schema where the registered model resides.
versionNum Integer: associated model version

aliasName string: string with the name of alias
catalogName string: The name of the catalog where the schema and the registered model reside.
id string
modelName string
schemaName string: The name of the schema where the registered model resides.
versionNum number: associated model version

alias_name str: string with the name of alias
catalog_name str: The name of the catalog where the schema and the registered model reside.
id str
model_name str
schema_name str: The name of the schema where the registered model resides.
version_num int: associated model version

aliasName String: string with the name of alias
catalogName String: The name of the catalog where the schema and the registered model reside.
id String
modelName String
schemaName String: The name of the schema where the registered model resides.
versionNum Number: associated model version