Databricks v1.63.0, Mar 13 25

Databricks v1.63.0 published on Thursday, Mar 13, 2025 by Pulumi

databricks.getRegisteredModelVersions

Explore with Pulumi AI

Databricks v1.63.0 published on Thursday, Mar 13, 2025 by Pulumi

Example Usage

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

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

import pulumi
import pulumi_databricks as databricks

this = databricks.get_registered_model_versions(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.GetRegisteredModelVersions(ctx, &databricks.GetRegisteredModelVersionsArgs{
			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.GetRegisteredModelVersions.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.GetRegisteredModelVersionsArgs;
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.getRegisteredModelVersions(GetRegisteredModelVersionsArgs.builder()
            .fullName("main.default.my_model")
            .build());

    }
}

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

The following resources are often used in the same context:

databricks.RegisteredModel data source to retrieve information about a model within Unity Catalog.
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 getRegisteredModelVersions

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 getRegisteredModelVersions(args: GetRegisteredModelVersionsArgs, opts?: InvokeOptions): Promise<GetRegisteredModelVersionsResult>
function getRegisteredModelVersionsOutput(args: GetRegisteredModelVersionsOutputArgs, opts?: InvokeOptions): Output<GetRegisteredModelVersionsResult>

def get_registered_model_versions(full_name: Optional[str] = None,
                                  model_versions: Optional[Sequence[GetRegisteredModelVersionsModelVersion]] = None,
                                  opts: Optional[InvokeOptions] = None) -> GetRegisteredModelVersionsResult
def get_registered_model_versions_output(full_name: Optional[pulumi.Input[str]] = None,
                                  model_versions: Optional[pulumi.Input[Sequence[pulumi.Input[GetRegisteredModelVersionsModelVersionArgs]]]] = None,
                                  opts: Optional[InvokeOptions] = None) -> Output[GetRegisteredModelVersionsResult]

func GetRegisteredModelVersions(ctx *Context, args *GetRegisteredModelVersionsArgs, opts ...InvokeOption) (*GetRegisteredModelVersionsResult, error)
func GetRegisteredModelVersionsOutput(ctx *Context, args *GetRegisteredModelVersionsOutputArgs, opts ...InvokeOption) GetRegisteredModelVersionsResultOutput

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

public static class GetRegisteredModelVersions 
{
    public static Task<GetRegisteredModelVersionsResult> InvokeAsync(GetRegisteredModelVersionsArgs args, InvokeOptions? opts = null)
    public static Output<GetRegisteredModelVersionsResult> Invoke(GetRegisteredModelVersionsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetRegisteredModelVersionsResult> getRegisteredModelVersions(GetRegisteredModelVersionsArgs args, InvokeOptions options)
public static Output<GetRegisteredModelVersionsResult> getRegisteredModelVersions(GetRegisteredModelVersionsArgs args, InvokeOptions options)

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

The following arguments are supported:

FullName string: The fully-qualified name of the registered model (catalog_name.schema_name.name).
ModelVersions List<GetRegisteredModelVersionsModelVersion>: list of objects describing the model versions. Each object consists of following attributes:

FullName string: The fully-qualified name of the registered model (catalog_name.schema_name.name).
ModelVersions []GetRegisteredModelVersionsModelVersion: list of objects describing the model versions. Each object consists of following attributes:

fullName String: The fully-qualified name of the registered model (catalog_name.schema_name.name).
modelVersions List<GetRegisteredModelVersionsModelVersion>: list of objects describing the model versions. Each object consists of following attributes:

fullName string: The fully-qualified name of the registered model (catalog_name.schema_name.name).
modelVersions GetRegisteredModelVersionsModelVersion[]: list of objects describing the model versions. Each object consists of following attributes:

full_name str: The fully-qualified name of the registered model (catalog_name.schema_name.name).
model_versions Sequence[GetRegisteredModelVersionsModelVersion]: list of objects describing the model versions. Each object consists of following attributes:

fullName String: The fully-qualified name of the registered model (catalog_name.schema_name.name).
modelVersions List<Property Map>: list of objects describing the model versions. Each object consists of following attributes:

getRegisteredModelVersions 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.
ModelVersions List<GetRegisteredModelVersionsModelVersion>: list of objects describing the model versions. Each object consists of following attributes:

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.
ModelVersions []GetRegisteredModelVersionsModelVersion: list of objects describing the model versions. Each object consists of following attributes:

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.
modelVersions List<GetRegisteredModelVersionsModelVersion>: list of objects describing the model versions. Each object consists of following attributes:

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.
modelVersions GetRegisteredModelVersionsModelVersion[]: list of objects describing the model versions. Each object consists of following attributes:

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_versions Sequence[GetRegisteredModelVersionsModelVersion]: list of objects describing the model versions. Each object consists of following attributes:

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.
modelVersions List<Property Map>: list of objects describing the model versions. Each object consists of following attributes:

Supporting Types

GetRegisteredModelVersionsModelVersion

Aliases List<GetRegisteredModelVersionsModelVersionAlias>: the list of aliases associated with this model. Each item is object consisting of following attributes:
BrowseOnly bool
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
Id string: The unique identifier of the model version
MetastoreId string: the unique identifier of the metastore
ModelName string
ModelVersionDependencies List<GetRegisteredModelVersionsModelVersionModelVersionDependency>: block describing model version dependencies, for feature-store packaged models. Consists of following attributes:
RunId string: MLflow run ID used when creating the model version, if source was generated by an experiment run stored in an MLflow tracking server
RunWorkspaceId int: ID of the Databricks workspace containing the MLflow run that generated this model version, if applicable
SchemaName string: The name of the schema where the registered model resides.
Source string: URI indicating the location of the source artifacts (files) for the model version.
Status string: Current status of the model version.
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
Version int: Integer model version number, used to reference the model version in API requests.

Aliases []GetRegisteredModelVersionsModelVersionAlias: the list of aliases associated with this model. Each item is object consisting of following attributes:
BrowseOnly bool
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
Id string: The unique identifier of the model version
MetastoreId string: the unique identifier of the metastore
ModelName string
ModelVersionDependencies []GetRegisteredModelVersionsModelVersionModelVersionDependency: block describing model version dependencies, for feature-store packaged models. Consists of following attributes:
RunId string: MLflow run ID used when creating the model version, if source was generated by an experiment run stored in an MLflow tracking server
RunWorkspaceId int: ID of the Databricks workspace containing the MLflow run that generated this model version, if applicable
SchemaName string: The name of the schema where the registered model resides.
Source string: URI indicating the location of the source artifacts (files) for the model version.
Status string: Current status of the model version.
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
Version int: Integer model version number, used to reference the model version in API requests.

aliases List<GetRegisteredModelVersionsModelVersionAlias>: the list of aliases associated with this model. Each item is object consisting of following attributes:
browseOnly Boolean
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
id String: The unique identifier of the model version
metastoreId String: the unique identifier of the metastore
modelName String
modelVersionDependencies List<GetRegisteredModelVersionsModelVersionModelVersionDependency>: block describing model version dependencies, for feature-store packaged models. Consists of following attributes:
runId String: MLflow run ID used when creating the model version, if source was generated by an experiment run stored in an MLflow tracking server
runWorkspaceId Integer: ID of the Databricks workspace containing the MLflow run that generated this model version, if applicable
schemaName String: The name of the schema where the registered model resides.
source String: URI indicating the location of the source artifacts (files) for the model version.
status String: Current status of the model version.
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
version Integer: Integer model version number, used to reference the model version in API requests.

aliases GetRegisteredModelVersionsModelVersionAlias[]: the list of aliases associated with this model. Each item is object consisting of following attributes:
browseOnly boolean
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
id string: The unique identifier of the model version
metastoreId string: the unique identifier of the metastore
modelName string
modelVersionDependencies GetRegisteredModelVersionsModelVersionModelVersionDependency[]: block describing model version dependencies, for feature-store packaged models. Consists of following attributes:
runId string: MLflow run ID used when creating the model version, if source was generated by an experiment run stored in an MLflow tracking server
runWorkspaceId number: ID of the Databricks workspace containing the MLflow run that generated this model version, if applicable
schemaName string: The name of the schema where the registered model resides.
source string: URI indicating the location of the source artifacts (files) for the model version.
status string: Current status of the model version.
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
version number: Integer model version number, used to reference the model version in API requests.

aliases Sequence[GetRegisteredModelVersionsModelVersionAlias]: the list of aliases associated with this model. Each item is object consisting of following attributes:
browse_only bool
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
id str: The unique identifier of the model version
metastore_id str: the unique identifier of the metastore
model_name str
model_version_dependencies Sequence[GetRegisteredModelVersionsModelVersionModelVersionDependency]: block describing model version dependencies, for feature-store packaged models. Consists of following attributes:
run_id str: MLflow run ID used when creating the model version, if source was generated by an experiment run stored in an MLflow tracking server
run_workspace_id int: ID of the Databricks workspace containing the MLflow run that generated this model version, if applicable
schema_name str: The name of the schema where the registered model resides.
source str: URI indicating the location of the source artifacts (files) for the model version.
status str: Current status of the model version.
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
version int: Integer model version number, used to reference the model version in API requests.

aliases List<Property Map>: the list of aliases associated with this model. Each item is object consisting of following attributes:
browseOnly Boolean
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
id String: The unique identifier of the model version
metastoreId String: the unique identifier of the metastore
modelName String
modelVersionDependencies List<Property Map>: block describing model version dependencies, for feature-store packaged models. Consists of following attributes:
runId String: MLflow run ID used when creating the model version, if source was generated by an experiment run stored in an MLflow tracking server
runWorkspaceId Number: ID of the Databricks workspace containing the MLflow run that generated this model version, if applicable
schemaName String: The name of the schema where the registered model resides.
source String: URI indicating the location of the source artifacts (files) for the model version.
status String: Current status of the model version.
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
version Number: Integer model version number, used to reference the model version in API requests.

GetRegisteredModelVersionsModelVersionAlias

AliasName string: string with the name of alias
VersionNum int: associated model version

AliasName string: string with the name of alias
VersionNum int: associated model version

aliasName String: string with the name of alias
versionNum Integer: associated model version

aliasName string: string with the name of alias
versionNum number: associated model version

alias_name str: string with the name of alias
version_num int: associated model version

aliasName String: string with the name of alias
versionNum Number: associated model version

GetRegisteredModelVersionsModelVersionModelVersionDependency

Dependencies List<GetRegisteredModelVersionsModelVersionModelVersionDependencyDependency>: list of dependencies consisting of following attributes:

Dependencies []GetRegisteredModelVersionsModelVersionModelVersionDependencyDependency: list of dependencies consisting of following attributes:

dependencies List<GetRegisteredModelVersionsModelVersionModelVersionDependencyDependency>: list of dependencies consisting of following attributes:

dependencies GetRegisteredModelVersionsModelVersionModelVersionDependencyDependency[]: list of dependencies consisting of following attributes:

dependencies Sequence[GetRegisteredModelVersionsModelVersionModelVersionDependencyDependency]: list of dependencies consisting of following attributes:

dependencies List<Property Map>: list of dependencies consisting of following attributes:

GetRegisteredModelVersionsModelVersionModelVersionDependencyDependency

Functions List<GetRegisteredModelVersionsModelVersionModelVersionDependencyDependencyFunction>: A function that is dependent on a SQL object:
Tables List<GetRegisteredModelVersionsModelVersionModelVersionDependencyDependencyTable>: A table that is dependent on a SQL object

Functions []GetRegisteredModelVersionsModelVersionModelVersionDependencyDependencyFunction: A function that is dependent on a SQL object:
Tables []GetRegisteredModelVersionsModelVersionModelVersionDependencyDependencyTable: A table that is dependent on a SQL object

functions List<GetRegisteredModelVersionsModelVersionModelVersionDependencyDependencyFunction>: A function that is dependent on a SQL object:
tables List<GetRegisteredModelVersionsModelVersionModelVersionDependencyDependencyTable>: A table that is dependent on a SQL object

functions GetRegisteredModelVersionsModelVersionModelVersionDependencyDependencyFunction[]: A function that is dependent on a SQL object:
tables GetRegisteredModelVersionsModelVersionModelVersionDependencyDependencyTable[]: A table that is dependent on a SQL object

functions Sequence[GetRegisteredModelVersionsModelVersionModelVersionDependencyDependencyFunction]: A function that is dependent on a SQL object:
tables Sequence[GetRegisteredModelVersionsModelVersionModelVersionDependencyDependencyTable]: A table that is dependent on a SQL object

functions List<Property Map>: A function that is dependent on a SQL object:
tables List<Property Map>: A table that is dependent on a SQL object

GetRegisteredModelVersionsModelVersionModelVersionDependencyDependencyFunction

FunctionFullName string: Full name of the dependent function

FunctionFullName string: Full name of the dependent function

functionFullName String: Full name of the dependent function

functionFullName string: Full name of the dependent function

function_full_name str: Full name of the dependent function

functionFullName String: Full name of the dependent function

GetRegisteredModelVersionsModelVersionModelVersionDependencyDependencyTable

TableFullName string: Full name of the dependent table

TableFullName string: Full name of the dependent table

tableFullName String: Full name of the dependent table

tableFullName string: Full name of the dependent table

table_full_name str: Full name of the dependent table

tableFullName String: Full name of the dependent table

Package Details

Repository: databricks pulumi/pulumi-databricks
License: Apache-2.0
Notes: This Pulumi package is based on the databricks Terraform Provider.

Databricks v1.63.0 published on Thursday, Mar 13, 2025 by Pulumi

pulumi/pulumi-databricks

databricks.getRegisteredModelVersions

On this page

On this page

Example Usage

Using getRegisteredModelVersions

getRegisteredModelVersions Result

Supporting Types

GetRegisteredModelVersionsModelVersion

GetRegisteredModelVersionsModelVersionAlias

GetRegisteredModelVersionsModelVersionModelVersionDependency

GetRegisteredModelVersionsModelVersionModelVersionDependencyDependency

GetRegisteredModelVersionsModelVersionModelVersionDependencyDependencyFunction

GetRegisteredModelVersionsModelVersionModelVersionDependencyDependencyTable

Package Details

On this page

On this page

databricks.getRegisteredModelVersions

On this page

On this page

Example Usage

Related Resources

Using getRegisteredModelVersions

getRegisteredModelVersions Result

Supporting Types

GetRegisteredModelVersionsModelVersion

GetRegisteredModelVersionsModelVersionAlias

GetRegisteredModelVersionsModelVersionModelVersionDependency

GetRegisteredModelVersionsModelVersionModelVersionDependencyDependency

GetRegisteredModelVersionsModelVersionModelVersionDependencyDependencyFunction

GetRegisteredModelVersionsModelVersionModelVersionDependencyDependencyTable

Package Details

On this page

On this page