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

databricks.getDataQualityRefresh

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

    Public Beta

    This data source can be used to fetch a data quality refresh on a Unity Catalog table.

    The caller must either:

    1. be an owner of the table’s parent catalog
    2. have USE_CATALOG on the table’s parent catalog and be an owner of the table’s parent schema.
    3. have the following permissions:
      • USE_CATALOG on the table’s parent catalog
      • USE_SCHEMA on the table’s parent schema
      • SELECT privilege on the table.

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

    Example Usage

    Getting a data quality refresh by Unity Catalog object type (currently supports table) and object id:

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

const _this = databricks.getTable({
    name: "my_catalog.my_schema.my_table",
});
const thisGetDataQualityRefresh = _this.then(_this => databricks.getDataQualityRefresh({
    objectType: "table",
    objectId: _this.id,
}));

    import pulumi
import pulumi_databricks as databricks

this = databricks.get_table(name="my_catalog.my_schema.my_table")
this_get_data_quality_refresh = databricks.get_data_quality_refresh(object_type="table",
    object_id=this.id)

    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.LookupTable(ctx, &databricks.LookupTableArgs{
			Name: "my_catalog.my_schema.my_table",
		}, nil)
		if err != nil {
			return err
		}
		_, err = databricks.LookupDataQualityRefresh(ctx, &databricks.LookupDataQualityRefreshArgs{
			ObjectType: "table",
			ObjectId:   this.Id,
		}, 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.GetTable.Invoke(new()
    {
        Name = "my_catalog.my_schema.my_table",
    });

    var thisGetDataQualityRefresh = Databricks.GetDataQualityRefresh.Invoke(new()
    {
        ObjectType = "table",
        ObjectId = @this.Apply(getTableResult => getTableResult.Id),
    });

});

    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.GetTableArgs;
import com.pulumi.databricks.inputs.GetDataQualityRefreshArgs;
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.getTable(GetTableArgs.builder()
            .name("my_catalog.my_schema.my_table")
            .build());

        final var thisGetDataQualityRefresh = DatabricksFunctions.getDataQualityRefresh(GetDataQualityRefreshArgs.builder()
            .objectType("table")
            .objectId(this_.id())
            .build());

    }
}

    variables:
  this:
    fn::invoke:
      function: databricks:getTable
      arguments:
        name: my_catalog.my_schema.my_table
  thisGetDataQualityRefresh:
    fn::invoke:
      function: databricks:getDataQualityRefresh
      arguments:
        objectType: table
        objectId: ${this.id}

    Using getDataQualityRefresh

    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 getDataQualityRefresh(args: GetDataQualityRefreshArgs, opts?: InvokeOptions): Promise<GetDataQualityRefreshResult>
function getDataQualityRefreshOutput(args: GetDataQualityRefreshOutputArgs, opts?: InvokeOptions): Output<GetDataQualityRefreshResult>
    def get_data_quality_refresh(object_id: Optional[str] = None,
                             object_type: Optional[str] = None,
                             refresh_id: Optional[int] = None,
                             opts: Optional[InvokeOptions] = None) -> GetDataQualityRefreshResult
def get_data_quality_refresh_output(object_id: Optional[pulumi.Input[str]] = None,
                             object_type: Optional[pulumi.Input[str]] = None,
                             refresh_id: Optional[pulumi.Input[int]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetDataQualityRefreshResult]
    func LookupDataQualityRefresh(ctx *Context, args *LookupDataQualityRefreshArgs, opts ...InvokeOption) (*LookupDataQualityRefreshResult, error)
func LookupDataQualityRefreshOutput(ctx *Context, args *LookupDataQualityRefreshOutputArgs, opts ...InvokeOption) LookupDataQualityRefreshResultOutput

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

    public static class GetDataQualityRefresh 
{
    public static Task<GetDataQualityRefreshResult> InvokeAsync(GetDataQualityRefreshArgs args, InvokeOptions? opts = null)
    public static Output<GetDataQualityRefreshResult> Invoke(GetDataQualityRefreshInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetDataQualityRefreshResult> getDataQualityRefresh(GetDataQualityRefreshArgs args, InvokeOptions options)
public static Output<GetDataQualityRefreshResult> getDataQualityRefresh(GetDataQualityRefreshArgs args, InvokeOptions options)

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

    The following arguments are supported:

    ObjectId string

    The UUID of the request object. It is schema_id for schema, and table_id for table.

    Find the schema_id from either:

    1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the Schemas resource.
    2. In Catalog Explorer > select the schema > go to the Details tab > the Schema ID field.

    Find the table_id from either:

    1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the Tables resource.
    2. In Catalog Explorer > select the table > go to the Details tab > the Table ID field
    ObjectType string
    The type of the monitored object. Can be one of the following: schemaor table
    RefreshId int
    Unique id of the refresh operation
    ObjectId string

    The UUID of the request object. It is schema_id for schema, and table_id for table.

    Find the schema_id from either:

    1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the Schemas resource.
    2. In Catalog Explorer > select the schema > go to the Details tab > the Schema ID field.

    Find the table_id from either:

    1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the Tables resource.
    2. In Catalog Explorer > select the table > go to the Details tab > the Table ID field
    ObjectType string
    The type of the monitored object. Can be one of the following: schemaor table
    RefreshId int
    Unique id of the refresh operation
    objectId String

    The UUID of the request object. It is schema_id for schema, and table_id for table.

    Find the schema_id from either:

    1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the Schemas resource.
    2. In Catalog Explorer > select the schema > go to the Details tab > the Schema ID field.

    Find the table_id from either:

    1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the Tables resource.
    2. In Catalog Explorer > select the table > go to the Details tab > the Table ID field
    objectType String
    The type of the monitored object. Can be one of the following: schemaor table
    refreshId Integer
    Unique id of the refresh operation
    objectId string

    The UUID of the request object. It is schema_id for schema, and table_id for table.

    Find the schema_id from either:

    1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the Schemas resource.
    2. In Catalog Explorer > select the schema > go to the Details tab > the Schema ID field.

    Find the table_id from either:

    1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the Tables resource.
    2. In Catalog Explorer > select the table > go to the Details tab > the Table ID field
    objectType string
    The type of the monitored object. Can be one of the following: schemaor table
    refreshId number
    Unique id of the refresh operation
    object_id str

    The UUID of the request object. It is schema_id for schema, and table_id for table.

    Find the schema_id from either:

    1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the Schemas resource.
    2. In Catalog Explorer > select the schema > go to the Details tab > the Schema ID field.

    Find the table_id from either:

    1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the Tables resource.
    2. In Catalog Explorer > select the table > go to the Details tab > the Table ID field
    object_type str
    The type of the monitored object. Can be one of the following: schemaor table
    refresh_id int
    Unique id of the refresh operation
    objectId String

    The UUID of the request object. It is schema_id for schema, and table_id for table.

    Find the schema_id from either:

    1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the Schemas resource.
    2. In Catalog Explorer > select the schema > go to the Details tab > the Schema ID field.

    Find the table_id from either:

    1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the Tables resource.
    2. In Catalog Explorer > select the table > go to the Details tab > the Table ID field
    objectType String
    The type of the monitored object. Can be one of the following: schemaor table
    refreshId Number
    Unique id of the refresh operation

    getDataQualityRefresh Result

    The following output properties are available:

    EndTimeMs int
    (integer) - Time when the refresh ended (milliseconds since 1/1/1970 UTC)
    Id string
    The provider-assigned unique ID for this managed resource.
    Message string
    (string) - An optional message to give insight into the current state of the refresh (e.g. FAILURE messages)
    ObjectId string
    (string) - The UUID of the request object. It is schema_id for schema, and table_id for table.
    ObjectType string
    (string) - The type of the monitored object. Can be one of the following: schemaor table
    RefreshId int
    (integer) - Unique id of the refresh operation
    StartTimeMs int
    (integer) - Time when the refresh started (milliseconds since 1/1/1970 UTC)
    State string
    (string) - The current state of the refresh. Possible values are: MONITOR_REFRESH_STATE_CANCELED, MONITOR_REFRESH_STATE_FAILED, MONITOR_REFRESH_STATE_PENDING, MONITOR_REFRESH_STATE_RUNNING, MONITOR_REFRESH_STATE_SUCCESS, MONITOR_REFRESH_STATE_UNKNOWN
    Trigger string
    (string) - What triggered the refresh. Possible values are: MONITOR_REFRESH_TRIGGER_DATA_CHANGE, MONITOR_REFRESH_TRIGGER_MANUAL, MONITOR_REFRESH_TRIGGER_SCHEDULE, MONITOR_REFRESH_TRIGGER_UNKNOWN
    EndTimeMs int
    (integer) - Time when the refresh ended (milliseconds since 1/1/1970 UTC)
    Id string
    The provider-assigned unique ID for this managed resource.
    Message string
    (string) - An optional message to give insight into the current state of the refresh (e.g. FAILURE messages)
    ObjectId string
    (string) - The UUID of the request object. It is schema_id for schema, and table_id for table.
    ObjectType string
    (string) - The type of the monitored object. Can be one of the following: schemaor table
    RefreshId int
    (integer) - Unique id of the refresh operation
    StartTimeMs int
    (integer) - Time when the refresh started (milliseconds since 1/1/1970 UTC)
    State string
    (string) - The current state of the refresh. Possible values are: MONITOR_REFRESH_STATE_CANCELED, MONITOR_REFRESH_STATE_FAILED, MONITOR_REFRESH_STATE_PENDING, MONITOR_REFRESH_STATE_RUNNING, MONITOR_REFRESH_STATE_SUCCESS, MONITOR_REFRESH_STATE_UNKNOWN
    Trigger string
    (string) - What triggered the refresh. Possible values are: MONITOR_REFRESH_TRIGGER_DATA_CHANGE, MONITOR_REFRESH_TRIGGER_MANUAL, MONITOR_REFRESH_TRIGGER_SCHEDULE, MONITOR_REFRESH_TRIGGER_UNKNOWN
    endTimeMs Integer
    (integer) - Time when the refresh ended (milliseconds since 1/1/1970 UTC)
    id String
    The provider-assigned unique ID for this managed resource.
    message String
    (string) - An optional message to give insight into the current state of the refresh (e.g. FAILURE messages)
    objectId String
    (string) - The UUID of the request object. It is schema_id for schema, and table_id for table.
    objectType String
    (string) - The type of the monitored object. Can be one of the following: schemaor table
    refreshId Integer
    (integer) - Unique id of the refresh operation
    startTimeMs Integer
    (integer) - Time when the refresh started (milliseconds since 1/1/1970 UTC)
    state String
    (string) - The current state of the refresh. Possible values are: MONITOR_REFRESH_STATE_CANCELED, MONITOR_REFRESH_STATE_FAILED, MONITOR_REFRESH_STATE_PENDING, MONITOR_REFRESH_STATE_RUNNING, MONITOR_REFRESH_STATE_SUCCESS, MONITOR_REFRESH_STATE_UNKNOWN
    trigger String
    (string) - What triggered the refresh. Possible values are: MONITOR_REFRESH_TRIGGER_DATA_CHANGE, MONITOR_REFRESH_TRIGGER_MANUAL, MONITOR_REFRESH_TRIGGER_SCHEDULE, MONITOR_REFRESH_TRIGGER_UNKNOWN
    endTimeMs number
    (integer) - Time when the refresh ended (milliseconds since 1/1/1970 UTC)
    id string
    The provider-assigned unique ID for this managed resource.
    message string
    (string) - An optional message to give insight into the current state of the refresh (e.g. FAILURE messages)
    objectId string
    (string) - The UUID of the request object. It is schema_id for schema, and table_id for table.
    objectType string
    (string) - The type of the monitored object. Can be one of the following: schemaor table
    refreshId number
    (integer) - Unique id of the refresh operation
    startTimeMs number
    (integer) - Time when the refresh started (milliseconds since 1/1/1970 UTC)
    state string
    (string) - The current state of the refresh. Possible values are: MONITOR_REFRESH_STATE_CANCELED, MONITOR_REFRESH_STATE_FAILED, MONITOR_REFRESH_STATE_PENDING, MONITOR_REFRESH_STATE_RUNNING, MONITOR_REFRESH_STATE_SUCCESS, MONITOR_REFRESH_STATE_UNKNOWN
    trigger string
    (string) - What triggered the refresh. Possible values are: MONITOR_REFRESH_TRIGGER_DATA_CHANGE, MONITOR_REFRESH_TRIGGER_MANUAL, MONITOR_REFRESH_TRIGGER_SCHEDULE, MONITOR_REFRESH_TRIGGER_UNKNOWN
    end_time_ms int
    (integer) - Time when the refresh ended (milliseconds since 1/1/1970 UTC)
    id str
    The provider-assigned unique ID for this managed resource.
    message str
    (string) - An optional message to give insight into the current state of the refresh (e.g. FAILURE messages)
    object_id str
    (string) - The UUID of the request object. It is schema_id for schema, and table_id for table.
    object_type str
    (string) - The type of the monitored object. Can be one of the following: schemaor table
    refresh_id int
    (integer) - Unique id of the refresh operation
    start_time_ms int
    (integer) - Time when the refresh started (milliseconds since 1/1/1970 UTC)
    state str
    (string) - The current state of the refresh. Possible values are: MONITOR_REFRESH_STATE_CANCELED, MONITOR_REFRESH_STATE_FAILED, MONITOR_REFRESH_STATE_PENDING, MONITOR_REFRESH_STATE_RUNNING, MONITOR_REFRESH_STATE_SUCCESS, MONITOR_REFRESH_STATE_UNKNOWN
    trigger str
    (string) - What triggered the refresh. Possible values are: MONITOR_REFRESH_TRIGGER_DATA_CHANGE, MONITOR_REFRESH_TRIGGER_MANUAL, MONITOR_REFRESH_TRIGGER_SCHEDULE, MONITOR_REFRESH_TRIGGER_UNKNOWN
    endTimeMs Number
    (integer) - Time when the refresh ended (milliseconds since 1/1/1970 UTC)
    id String
    The provider-assigned unique ID for this managed resource.
    message String
    (string) - An optional message to give insight into the current state of the refresh (e.g. FAILURE messages)
    objectId String
    (string) - The UUID of the request object. It is schema_id for schema, and table_id for table.
    objectType String
    (string) - The type of the monitored object. Can be one of the following: schemaor table
    refreshId Number
    (integer) - Unique id of the refresh operation
    startTimeMs Number
    (integer) - Time when the refresh started (milliseconds since 1/1/1970 UTC)
    state String
    (string) - The current state of the refresh. Possible values are: MONITOR_REFRESH_STATE_CANCELED, MONITOR_REFRESH_STATE_FAILED, MONITOR_REFRESH_STATE_PENDING, MONITOR_REFRESH_STATE_RUNNING, MONITOR_REFRESH_STATE_SUCCESS, MONITOR_REFRESH_STATE_UNKNOWN
    trigger String
    (string) - What triggered the refresh. Possible values are: MONITOR_REFRESH_TRIGGER_DATA_CHANGE, MONITOR_REFRESH_TRIGGER_MANUAL, MONITOR_REFRESH_TRIGGER_SCHEDULE, MONITOR_REFRESH_TRIGGER_UNKNOWN

    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