Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Databricks Provider
  4. API Docs
  5. getDataClassificationCatalogConfig
Viewing docs for Databricks v1.118.1
published on Tuesday, Oct 27, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-databricks

databricks.getDataClassificationCatalogConfig

databricks logo databricks logo
Viewing docs for Databricks v1.118.1
published on Tuesday, Oct 27, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-databricks

    GA

    API Documentation

    This data source can be used to fetch the Data Classification configuration for a Unity Catalog catalog.

    To read the Data Classification configuration, you must have browse permissions on the catalog.

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

    Note The autoTagConfigs attribute is in Public Preview. All other attributes of this data source are generally available.

    Example Usage

    To get the Data Classification configuration for a catalog:

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

const prod = databricks.getCatalog({
    name: "prod_catalog",
});
const prodConfig = prod.then(prod => databricks.getDataClassificationCatalogConfig({
    name: `catalogs/${prod.name}/config`,
}));
export const includedSchemas = prodConfig.then(prodConfig => prodConfig.includedSchemas);

    import pulumi
import pulumi_databricks as databricks

prod = databricks.get_catalog(name="prod_catalog")
prod_config = databricks.get_data_classification_catalog_config(name=f"catalogs/{prod.name}/config")
pulumi.export("includedSchemas", prod_config.included_schemas)

    package main

import (
	"fmt"

	"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 {
		prod, err := databricks.GetCatalog(ctx, &databricks.LookupCatalogArgs{
			Name: "prod_catalog",
		}, nil)
		if err != nil {
			return err
		}
		prodConfig, err := databricks.GetDataClassificationCatalogConfig(ctx, &databricks.LookupDataClassificationCatalogConfigArgs{
			Name: fmt.Sprintf("catalogs/%v/config", prod.Name),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("includedSchemas", prodConfig.IncludedSchemas)
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Databricks = Pulumi.Databricks;

return await Deployment.RunAsync(() => 
{
    var prod = Databricks.GetCatalog.Invoke(new()
    {
        Name = "prod_catalog",
    });

    var prodConfig = Databricks.GetDataClassificationCatalogConfig.Invoke(new()
    {
        Name = $"catalogs/{prod.Apply(getCatalogResult => getCatalogResult.Name)}/config",
    });

    return new Dictionary<string, object?>
    {
        ["includedSchemas"] = prodConfig.Apply(getDataClassificationCatalogConfigResult => getDataClassificationCatalogConfigResult.IncludedSchemas),
    };
});

    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.GetCatalogArgs;
import com.pulumi.databricks.inputs.GetDataClassificationCatalogConfigArgs;
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 prod = DatabricksFunctions.getCatalog(GetCatalogArgs.builder()
            .name("prod_catalog")
            .build());

        final var prodConfig = DatabricksFunctions.getDataClassificationCatalogConfig(GetDataClassificationCatalogConfigArgs.builder()
            .name(String.format("catalogs/%s/config", prod.name()))
            .build());

        ctx.export("includedSchemas", prodConfig.includedSchemas());
    }
}

    variables:
  prod:
    fn::invoke:
      function: databricks:getCatalog
      arguments:
        name: prod_catalog
  prodConfig:
    fn::invoke:
      function: databricks:getDataClassificationCatalogConfig
      arguments:
        name: catalogs/${prod.name}/config
outputs:
  # Use the fetched configuration
  includedSchemas: ${prodConfig.includedSchemas}

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

data "databricks_catalog" "prod" {
  name = "prod_catalog"
}
data "databricks_data_classification_catalog_config" "prodConfig" {
  name ="catalogs/${data.databricks_catalog.prod.name}/config"
}

# Use the fetched configuration
output "includedSchemas" {
  value = data.databricks_data_classification_catalog_config.prodConfig.included_schemas
}

    Using getDataClassificationCatalogConfig

    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 getDataClassificationCatalogConfig(args: GetDataClassificationCatalogConfigArgs, opts?: InvokeOptions): Promise<GetDataClassificationCatalogConfigResult>
function getDataClassificationCatalogConfigOutput(args: GetDataClassificationCatalogConfigOutputArgs, opts?: InvokeOutputOptions): Output<GetDataClassificationCatalogConfigResult>
    def get_data_classification_catalog_config(name: Optional[str] = None,
                                           provider_config: Optional[GetDataClassificationCatalogConfigProviderConfig] = None,
                                           opts: Optional[InvokeOptions] = None) -> GetDataClassificationCatalogConfigResult
def get_data_classification_catalog_config_output(name: pulumi.Input[Optional[str]] = None,
                                           provider_config: pulumi.Input[Optional[GetDataClassificationCatalogConfigProviderConfigArgs]] = None,
                                           opts: Optional[InvokeOutputOptions] = None) -> Output[GetDataClassificationCatalogConfigResult]
    func LookupDataClassificationCatalogConfig(ctx *Context, args *LookupDataClassificationCatalogConfigArgs, opts ...InvokeOption) (*LookupDataClassificationCatalogConfigResult, error)
func LookupDataClassificationCatalogConfigOutput(ctx *Context, args *LookupDataClassificationCatalogConfigOutputArgs, opts ...InvokeOption) LookupDataClassificationCatalogConfigResultOutput

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

    public static class GetDataClassificationCatalogConfig 
{
    public static Task<GetDataClassificationCatalogConfigResult> InvokeAsync(GetDataClassificationCatalogConfigArgs args, InvokeOptions? opts = null)
    public static Output<GetDataClassificationCatalogConfigResult> Invoke(GetDataClassificationCatalogConfigInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetDataClassificationCatalogConfigResult> Invoke(GetDataClassificationCatalogConfigInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetDataClassificationCatalogConfigResult> getDataClassificationCatalogConfig(GetDataClassificationCatalogConfigArgs args, InvokeOptions options)
public static Output<GetDataClassificationCatalogConfigResult> getDataClassificationCatalogConfig(GetDataClassificationCatalogConfigArgs args, InvokeOptions options)
public static Output<GetDataClassificationCatalogConfigResult> getDataClassificationCatalogConfig(GetDataClassificationCatalogConfigArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: databricks:index/getDataClassificationCatalogConfig:getDataClassificationCatalogConfig
  arguments:
    # arguments dictionary
    data "databricks_get_data_classification_catalog_config" "name" {
    # arguments
}

    The following arguments are supported:

    Name string
    Resource name in the format: catalogs/{catalog_name}/config
    ProviderConfig GetDataClassificationCatalogConfigProviderConfig
    Configure the provider for management through account provider.
    Name string
    Resource name in the format: catalogs/{catalog_name}/config
    ProviderConfig GetDataClassificationCatalogConfigProviderConfig
    Configure the provider for management through account provider.
    name string
    Resource name in the format: catalogs/{catalog_name}/config
    provider_config object
    Configure the provider for management through account provider.
    name String
    Resource name in the format: catalogs/{catalog_name}/config
    providerConfig GetDataClassificationCatalogConfigProviderConfig
    Configure the provider for management through account provider.
    name string
    Resource name in the format: catalogs/{catalog_name}/config
    providerConfig GetDataClassificationCatalogConfigProviderConfig
    Configure the provider for management through account provider.
    name str
    Resource name in the format: catalogs/{catalog_name}/config
    provider_config GetDataClassificationCatalogConfigProviderConfig
    Configure the provider for management through account provider.
    name String
    Resource name in the format: catalogs/{catalog_name}/config
    providerConfig Property Map
    Configure the provider for management through account provider.

    getDataClassificationCatalogConfig Result

    The following output properties are available:

    AutoTagConfigs List<GetDataClassificationCatalogConfigAutoTagConfig>
    (list of AutoTaggingConfig) - List of auto-tagging configurations for this catalog. Empty list means no auto-tagging is enabled
    ExcludedSchemas GetDataClassificationCatalogConfigExcludedSchemas
    (CatalogConfigSchemaNames) - Schemas to exclude from the scan, each named relative to the parent catalog. If specified, all schemas except the specified ones will be scanned. Mutually exclusive with includedSchemas: only one may be set per request. If neither includedSchemas nor excludedSchemas is set, all schemas are scanned
    IncludedSchemas GetDataClassificationCatalogConfigIncludedSchemas
    (CatalogConfigSchemaNames) - Schemas to include in the scan, each named relative to the parent catalog. If specified, only listed schemas will be scanned. Mutually exclusive with excludedSchemas: only one may be set per request. If neither includedSchemas nor excludedSchemas is set, all schemas are scanned
    Name string
    (string) - Resource name in the format: catalogs/{catalog_name}/config
    ProviderConfig GetDataClassificationCatalogConfigProviderConfig
    AutoTagConfigs []GetDataClassificationCatalogConfigAutoTagConfig
    (list of AutoTaggingConfig) - List of auto-tagging configurations for this catalog. Empty list means no auto-tagging is enabled
    ExcludedSchemas GetDataClassificationCatalogConfigExcludedSchemas
    (CatalogConfigSchemaNames) - Schemas to exclude from the scan, each named relative to the parent catalog. If specified, all schemas except the specified ones will be scanned. Mutually exclusive with includedSchemas: only one may be set per request. If neither includedSchemas nor excludedSchemas is set, all schemas are scanned
    IncludedSchemas GetDataClassificationCatalogConfigIncludedSchemas
    (CatalogConfigSchemaNames) - Schemas to include in the scan, each named relative to the parent catalog. If specified, only listed schemas will be scanned. Mutually exclusive with excludedSchemas: only one may be set per request. If neither includedSchemas nor excludedSchemas is set, all schemas are scanned
    Name string
    (string) - Resource name in the format: catalogs/{catalog_name}/config
    ProviderConfig GetDataClassificationCatalogConfigProviderConfig
    auto_tag_configs list(object)
    (list of AutoTaggingConfig) - List of auto-tagging configurations for this catalog. Empty list means no auto-tagging is enabled
    excluded_schemas object
    (CatalogConfigSchemaNames) - Schemas to exclude from the scan, each named relative to the parent catalog. If specified, all schemas except the specified ones will be scanned. Mutually exclusive with includedSchemas: only one may be set per request. If neither includedSchemas nor excludedSchemas is set, all schemas are scanned
    included_schemas object
    (CatalogConfigSchemaNames) - Schemas to include in the scan, each named relative to the parent catalog. If specified, only listed schemas will be scanned. Mutually exclusive with excludedSchemas: only one may be set per request. If neither includedSchemas nor excludedSchemas is set, all schemas are scanned
    name string
    (string) - Resource name in the format: catalogs/{catalog_name}/config
    provider_config object
    autoTagConfigs List<GetDataClassificationCatalogConfigAutoTagConfig>
    (list of AutoTaggingConfig) - List of auto-tagging configurations for this catalog. Empty list means no auto-tagging is enabled
    excludedSchemas GetDataClassificationCatalogConfigExcludedSchemas
    (CatalogConfigSchemaNames) - Schemas to exclude from the scan, each named relative to the parent catalog. If specified, all schemas except the specified ones will be scanned. Mutually exclusive with includedSchemas: only one may be set per request. If neither includedSchemas nor excludedSchemas is set, all schemas are scanned
    includedSchemas GetDataClassificationCatalogConfigIncludedSchemas
    (CatalogConfigSchemaNames) - Schemas to include in the scan, each named relative to the parent catalog. If specified, only listed schemas will be scanned. Mutually exclusive with excludedSchemas: only one may be set per request. If neither includedSchemas nor excludedSchemas is set, all schemas are scanned
    name String
    (string) - Resource name in the format: catalogs/{catalog_name}/config
    providerConfig GetDataClassificationCatalogConfigProviderConfig
    autoTagConfigs GetDataClassificationCatalogConfigAutoTagConfig[]
    (list of AutoTaggingConfig) - List of auto-tagging configurations for this catalog. Empty list means no auto-tagging is enabled
    excludedSchemas GetDataClassificationCatalogConfigExcludedSchemas
    (CatalogConfigSchemaNames) - Schemas to exclude from the scan, each named relative to the parent catalog. If specified, all schemas except the specified ones will be scanned. Mutually exclusive with includedSchemas: only one may be set per request. If neither includedSchemas nor excludedSchemas is set, all schemas are scanned
    includedSchemas GetDataClassificationCatalogConfigIncludedSchemas
    (CatalogConfigSchemaNames) - Schemas to include in the scan, each named relative to the parent catalog. If specified, only listed schemas will be scanned. Mutually exclusive with excludedSchemas: only one may be set per request. If neither includedSchemas nor excludedSchemas is set, all schemas are scanned
    name string
    (string) - Resource name in the format: catalogs/{catalog_name}/config
    providerConfig GetDataClassificationCatalogConfigProviderConfig
    auto_tag_configs Sequence[GetDataClassificationCatalogConfigAutoTagConfig]
    (list of AutoTaggingConfig) - List of auto-tagging configurations for this catalog. Empty list means no auto-tagging is enabled
    excluded_schemas GetDataClassificationCatalogConfigExcludedSchemas
    (CatalogConfigSchemaNames) - Schemas to exclude from the scan, each named relative to the parent catalog. If specified, all schemas except the specified ones will be scanned. Mutually exclusive with includedSchemas: only one may be set per request. If neither includedSchemas nor excludedSchemas is set, all schemas are scanned
    included_schemas GetDataClassificationCatalogConfigIncludedSchemas
    (CatalogConfigSchemaNames) - Schemas to include in the scan, each named relative to the parent catalog. If specified, only listed schemas will be scanned. Mutually exclusive with excludedSchemas: only one may be set per request. If neither includedSchemas nor excludedSchemas is set, all schemas are scanned
    name str
    (string) - Resource name in the format: catalogs/{catalog_name}/config
    provider_config GetDataClassificationCatalogConfigProviderConfig
    autoTagConfigs List<Property Map>
    (list of AutoTaggingConfig) - List of auto-tagging configurations for this catalog. Empty list means no auto-tagging is enabled
    excludedSchemas Property Map
    (CatalogConfigSchemaNames) - Schemas to exclude from the scan, each named relative to the parent catalog. If specified, all schemas except the specified ones will be scanned. Mutually exclusive with includedSchemas: only one may be set per request. If neither includedSchemas nor excludedSchemas is set, all schemas are scanned
    includedSchemas Property Map
    (CatalogConfigSchemaNames) - Schemas to include in the scan, each named relative to the parent catalog. If specified, only listed schemas will be scanned. Mutually exclusive with excludedSchemas: only one may be set per request. If neither includedSchemas nor excludedSchemas is set, all schemas are scanned
    name String
    (string) - Resource name in the format: catalogs/{catalog_name}/config
    providerConfig Property Map

    Supporting Types

    GetDataClassificationCatalogConfigAutoTagConfig

    AutoTaggingMode string
    (string) - Whether auto-tagging is enabled or disabled for this classification tag. Possible values are: AUTO_TAGGING_DISABLED, AUTO_TAGGING_ENABLED
    ClassificationTag string
    (string) - The Classification Tag. For built-in classes this is a system tag (e.g., "class.name", "class.location"); for custom classes it is a user-defined governance tag key
    AutoTaggingMode string
    (string) - Whether auto-tagging is enabled or disabled for this classification tag. Possible values are: AUTO_TAGGING_DISABLED, AUTO_TAGGING_ENABLED
    ClassificationTag string
    (string) - The Classification Tag. For built-in classes this is a system tag (e.g., "class.name", "class.location"); for custom classes it is a user-defined governance tag key
    auto_tagging_mode string
    (string) - Whether auto-tagging is enabled or disabled for this classification tag. Possible values are: AUTO_TAGGING_DISABLED, AUTO_TAGGING_ENABLED
    classification_tag string
    (string) - The Classification Tag. For built-in classes this is a system tag (e.g., "class.name", "class.location"); for custom classes it is a user-defined governance tag key
    autoTaggingMode String
    (string) - Whether auto-tagging is enabled or disabled for this classification tag. Possible values are: AUTO_TAGGING_DISABLED, AUTO_TAGGING_ENABLED
    classificationTag String
    (string) - The Classification Tag. For built-in classes this is a system tag (e.g., "class.name", "class.location"); for custom classes it is a user-defined governance tag key
    autoTaggingMode string
    (string) - Whether auto-tagging is enabled or disabled for this classification tag. Possible values are: AUTO_TAGGING_DISABLED, AUTO_TAGGING_ENABLED
    classificationTag string
    (string) - The Classification Tag. For built-in classes this is a system tag (e.g., "class.name", "class.location"); for custom classes it is a user-defined governance tag key
    auto_tagging_mode str
    (string) - Whether auto-tagging is enabled or disabled for this classification tag. Possible values are: AUTO_TAGGING_DISABLED, AUTO_TAGGING_ENABLED
    classification_tag str
    (string) - The Classification Tag. For built-in classes this is a system tag (e.g., "class.name", "class.location"); for custom classes it is a user-defined governance tag key
    autoTaggingMode String
    (string) - Whether auto-tagging is enabled or disabled for this classification tag. Possible values are: AUTO_TAGGING_DISABLED, AUTO_TAGGING_ENABLED
    classificationTag String
    (string) - The Classification Tag. For built-in classes this is a system tag (e.g., "class.name", "class.location"); for custom classes it is a user-defined governance tag key

    GetDataClassificationCatalogConfigExcludedSchemas

    Names List<string>
    (list of string) - Schema names, each relative to the parent catalog. Must not be empty
    Names []string
    (list of string) - Schema names, each relative to the parent catalog. Must not be empty
    names list(string)
    (list of string) - Schema names, each relative to the parent catalog. Must not be empty
    names List<String>
    (list of string) - Schema names, each relative to the parent catalog. Must not be empty
    names string[]
    (list of string) - Schema names, each relative to the parent catalog. Must not be empty
    names Sequence[str]
    (list of string) - Schema names, each relative to the parent catalog. Must not be empty
    names List<String>
    (list of string) - Schema names, each relative to the parent catalog. Must not be empty

    GetDataClassificationCatalogConfigIncludedSchemas

    Names List<string>
    (list of string) - Schema names, each relative to the parent catalog. Must not be empty
    Names []string
    (list of string) - Schema names, each relative to the parent catalog. Must not be empty
    names list(string)
    (list of string) - Schema names, each relative to the parent catalog. Must not be empty
    names List<String>
    (list of string) - Schema names, each relative to the parent catalog. Must not be empty
    names string[]
    (list of string) - Schema names, each relative to the parent catalog. Must not be empty
    names Sequence[str]
    (list of string) - Schema names, each relative to the parent catalog. Must not be empty
    names List<String>
    (list of string) - Schema names, each relative to the parent catalog. Must not be empty

    GetDataClassificationCatalogConfigProviderConfig

    WorkspaceId string
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    WorkspaceId string
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspace_id string
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspaceId String
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspaceId string
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspace_id str
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspaceId String
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.

    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 logo
    Viewing docs for Databricks v1.118.1
    published on Tuesday, Oct 27, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-databricks

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial