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

databricks.getEntityTagAssignments

databricks logo
Databricks v1.78.0 published on Friday, Nov 7, 2025 by Pulumi
Schema (JSON)
pulumi/pulumi-databricks

    Public Preview

    This data source allows you to retrieve tag assignments that have been applied to a particular entity in Unity Catalog.

    Example Usage

    Get all tag assignments for a catalog

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

const catalogTags = databricks.getEntityTagAssignments({
    entityType: "catalogs",
    entityName: "production_catalog",
});
const schemaTags = databricks.getEntityTagAssignments({
    entityType: "schemas",
    entityName: "production_catalog.sales_data",
});
const tableTags = databricks.getEntityTagAssignments({
    entityType: "tables",
    entityName: "production_catalog.sales_data.customer_orders",
});
const columnTags = databricks.getEntityTagAssignments({
    entityType: "columns",
    entityName: "production_catalog.customer_data.users.email_address",
});
const volumeTags = databricks.getEntityTagAssignments({
    entityType: "volumes",
    entityName: "production_catalog.raw_data.landing_zone",
});

    import pulumi
import pulumi_databricks as databricks

catalog_tags = databricks.get_entity_tag_assignments(entity_type="catalogs",
    entity_name="production_catalog")
schema_tags = databricks.get_entity_tag_assignments(entity_type="schemas",
    entity_name="production_catalog.sales_data")
table_tags = databricks.get_entity_tag_assignments(entity_type="tables",
    entity_name="production_catalog.sales_data.customer_orders")
column_tags = databricks.get_entity_tag_assignments(entity_type="columns",
    entity_name="production_catalog.customer_data.users.email_address")
volume_tags = databricks.get_entity_tag_assignments(entity_type="volumes",
    entity_name="production_catalog.raw_data.landing_zone")

    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.GetEntityTagAssignments(ctx, &databricks.GetEntityTagAssignmentsArgs{
			EntityType: "catalogs",
			EntityName: "production_catalog",
		}, nil)
		if err != nil {
			return err
		}
		_, err = databricks.GetEntityTagAssignments(ctx, &databricks.GetEntityTagAssignmentsArgs{
			EntityType: "schemas",
			EntityName: "production_catalog.sales_data",
		}, nil)
		if err != nil {
			return err
		}
		_, err = databricks.GetEntityTagAssignments(ctx, &databricks.GetEntityTagAssignmentsArgs{
			EntityType: "tables",
			EntityName: "production_catalog.sales_data.customer_orders",
		}, nil)
		if err != nil {
			return err
		}
		_, err = databricks.GetEntityTagAssignments(ctx, &databricks.GetEntityTagAssignmentsArgs{
			EntityType: "columns",
			EntityName: "production_catalog.customer_data.users.email_address",
		}, nil)
		if err != nil {
			return err
		}
		_, err = databricks.GetEntityTagAssignments(ctx, &databricks.GetEntityTagAssignmentsArgs{
			EntityType: "volumes",
			EntityName: "production_catalog.raw_data.landing_zone",
		}, 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 catalogTags = Databricks.GetEntityTagAssignments.Invoke(new()
    {
        EntityType = "catalogs",
        EntityName = "production_catalog",
    });

    var schemaTags = Databricks.GetEntityTagAssignments.Invoke(new()
    {
        EntityType = "schemas",
        EntityName = "production_catalog.sales_data",
    });

    var tableTags = Databricks.GetEntityTagAssignments.Invoke(new()
    {
        EntityType = "tables",
        EntityName = "production_catalog.sales_data.customer_orders",
    });

    var columnTags = Databricks.GetEntityTagAssignments.Invoke(new()
    {
        EntityType = "columns",
        EntityName = "production_catalog.customer_data.users.email_address",
    });

    var volumeTags = Databricks.GetEntityTagAssignments.Invoke(new()
    {
        EntityType = "volumes",
        EntityName = "production_catalog.raw_data.landing_zone",
    });

});

    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.GetEntityTagAssignmentsArgs;
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 catalogTags = DatabricksFunctions.getEntityTagAssignments(GetEntityTagAssignmentsArgs.builder()
            .entityType("catalogs")
            .entityName("production_catalog")
            .build());

        final var schemaTags = DatabricksFunctions.getEntityTagAssignments(GetEntityTagAssignmentsArgs.builder()
            .entityType("schemas")
            .entityName("production_catalog.sales_data")
            .build());

        final var tableTags = DatabricksFunctions.getEntityTagAssignments(GetEntityTagAssignmentsArgs.builder()
            .entityType("tables")
            .entityName("production_catalog.sales_data.customer_orders")
            .build());

        final var columnTags = DatabricksFunctions.getEntityTagAssignments(GetEntityTagAssignmentsArgs.builder()
            .entityType("columns")
            .entityName("production_catalog.customer_data.users.email_address")
            .build());

        final var volumeTags = DatabricksFunctions.getEntityTagAssignments(GetEntityTagAssignmentsArgs.builder()
            .entityType("volumes")
            .entityName("production_catalog.raw_data.landing_zone")
            .build());

    }
}

    variables:
  catalogTags:
    fn::invoke:
      function: databricks:getEntityTagAssignments
      arguments:
        entityType: catalogs
        entityName: production_catalog
  schemaTags:
    fn::invoke:
      function: databricks:getEntityTagAssignments
      arguments:
        entityType: schemas
        entityName: production_catalog.sales_data
  tableTags:
    fn::invoke:
      function: databricks:getEntityTagAssignments
      arguments:
        entityType: tables
        entityName: production_catalog.sales_data.customer_orders
  columnTags:
    fn::invoke:
      function: databricks:getEntityTagAssignments
      arguments:
        entityType: columns
        entityName: production_catalog.customer_data.users.email_address
  volumeTags:
    fn::invoke:
      function: databricks:getEntityTagAssignments
      arguments:
        entityType: volumes
        entityName: production_catalog.raw_data.landing_zone

    Using getEntityTagAssignments

    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 getEntityTagAssignments(args: GetEntityTagAssignmentsArgs, opts?: InvokeOptions): Promise<GetEntityTagAssignmentsResult>
function getEntityTagAssignmentsOutput(args: GetEntityTagAssignmentsOutputArgs, opts?: InvokeOptions): Output<GetEntityTagAssignmentsResult>
    def get_entity_tag_assignments(entity_name: Optional[str] = None,
                               entity_type: Optional[str] = None,
                               max_results: Optional[int] = None,
                               opts: Optional[InvokeOptions] = None) -> GetEntityTagAssignmentsResult
def get_entity_tag_assignments_output(entity_name: Optional[pulumi.Input[str]] = None,
                               entity_type: Optional[pulumi.Input[str]] = None,
                               max_results: Optional[pulumi.Input[int]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetEntityTagAssignmentsResult]
    func GetEntityTagAssignments(ctx *Context, args *GetEntityTagAssignmentsArgs, opts ...InvokeOption) (*GetEntityTagAssignmentsResult, error)
func GetEntityTagAssignmentsOutput(ctx *Context, args *GetEntityTagAssignmentsOutputArgs, opts ...InvokeOption) GetEntityTagAssignmentsResultOutput

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

    public static class GetEntityTagAssignments 
{
    public static Task<GetEntityTagAssignmentsResult> InvokeAsync(GetEntityTagAssignmentsArgs args, InvokeOptions? opts = null)
    public static Output<GetEntityTagAssignmentsResult> Invoke(GetEntityTagAssignmentsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetEntityTagAssignmentsResult> getEntityTagAssignments(GetEntityTagAssignmentsArgs args, InvokeOptions options)
public static Output<GetEntityTagAssignmentsResult> getEntityTagAssignments(GetEntityTagAssignmentsArgs args, InvokeOptions options)

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

    The following arguments are supported:

    EntityName string
    The fully qualified name of the entity to which the tag is assigned
    EntityType string
    The type of the entity to which the tag is assigned. Allowed values are: catalogs, schemas, tables, columns, volumes
    MaxResults int
    Optional. Maximum number of tag assignments to return in a single page
    EntityName string
    The fully qualified name of the entity to which the tag is assigned
    EntityType string
    The type of the entity to which the tag is assigned. Allowed values are: catalogs, schemas, tables, columns, volumes
    MaxResults int
    Optional. Maximum number of tag assignments to return in a single page
    entityName String
    The fully qualified name of the entity to which the tag is assigned
    entityType String
    The type of the entity to which the tag is assigned. Allowed values are: catalogs, schemas, tables, columns, volumes
    maxResults Integer
    Optional. Maximum number of tag assignments to return in a single page
    entityName string
    The fully qualified name of the entity to which the tag is assigned
    entityType string
    The type of the entity to which the tag is assigned. Allowed values are: catalogs, schemas, tables, columns, volumes
    maxResults number
    Optional. Maximum number of tag assignments to return in a single page
    entity_name str
    The fully qualified name of the entity to which the tag is assigned
    entity_type str
    The type of the entity to which the tag is assigned. Allowed values are: catalogs, schemas, tables, columns, volumes
    max_results int
    Optional. Maximum number of tag assignments to return in a single page
    entityName String
    The fully qualified name of the entity to which the tag is assigned
    entityType String
    The type of the entity to which the tag is assigned. Allowed values are: catalogs, schemas, tables, columns, volumes
    maxResults Number
    Optional. Maximum number of tag assignments to return in a single page

    getEntityTagAssignments Result

    The following output properties are available:

    EntityName string
    (string) - The fully qualified name of the entity to which the tag is assigned
    EntityType string
    (string) - The type of the entity to which the tag is assigned. Allowed values are: catalogs, schemas, tables, columns, volumes
    Id string
    The provider-assigned unique ID for this managed resource.
    TagAssignments List<GetEntityTagAssignmentsTagAssignment>
    MaxResults int
    EntityName string
    (string) - The fully qualified name of the entity to which the tag is assigned
    EntityType string
    (string) - The type of the entity to which the tag is assigned. Allowed values are: catalogs, schemas, tables, columns, volumes
    Id string
    The provider-assigned unique ID for this managed resource.
    TagAssignments []GetEntityTagAssignmentsTagAssignment
    MaxResults int
    entityName String
    (string) - The fully qualified name of the entity to which the tag is assigned
    entityType String
    (string) - The type of the entity to which the tag is assigned. Allowed values are: catalogs, schemas, tables, columns, volumes
    id String
    The provider-assigned unique ID for this managed resource.
    tagAssignments List<GetEntityTagAssignmentsTagAssignment>
    maxResults Integer
    entityName string
    (string) - The fully qualified name of the entity to which the tag is assigned
    entityType string
    (string) - The type of the entity to which the tag is assigned. Allowed values are: catalogs, schemas, tables, columns, volumes
    id string
    The provider-assigned unique ID for this managed resource.
    tagAssignments GetEntityTagAssignmentsTagAssignment[]
    maxResults number
    entity_name str
    (string) - The fully qualified name of the entity to which the tag is assigned
    entity_type str
    (string) - The type of the entity to which the tag is assigned. Allowed values are: catalogs, schemas, tables, columns, volumes
    id str
    The provider-assigned unique ID for this managed resource.
    tag_assignments Sequence[GetEntityTagAssignmentsTagAssignment]
    max_results int
    entityName String
    (string) - The fully qualified name of the entity to which the tag is assigned
    entityType String
    (string) - The type of the entity to which the tag is assigned. Allowed values are: catalogs, schemas, tables, columns, volumes
    id String
    The provider-assigned unique ID for this managed resource.
    tagAssignments List<Property Map>
    maxResults Number

    Supporting Types

    GetEntityTagAssignmentsTagAssignment

    EntityName string
    The fully qualified name of the entity to which the tag is assigned
    EntityType string
    The type of the entity to which the tag is assigned. Allowed values are: catalogs, schemas, tables, columns, volumes
    TagKey string
    (string) - The key of the tag
    TagValue string
    (string) - The value of the tag
    EntityName string
    The fully qualified name of the entity to which the tag is assigned
    EntityType string
    The type of the entity to which the tag is assigned. Allowed values are: catalogs, schemas, tables, columns, volumes
    TagKey string
    (string) - The key of the tag
    TagValue string
    (string) - The value of the tag
    entityName String
    The fully qualified name of the entity to which the tag is assigned
    entityType String
    The type of the entity to which the tag is assigned. Allowed values are: catalogs, schemas, tables, columns, volumes
    tagKey String
    (string) - The key of the tag
    tagValue String
    (string) - The value of the tag
    entityName string
    The fully qualified name of the entity to which the tag is assigned
    entityType string
    The type of the entity to which the tag is assigned. Allowed values are: catalogs, schemas, tables, columns, volumes
    tagKey string
    (string) - The key of the tag
    tagValue string
    (string) - The value of the tag
    entity_name str
    The fully qualified name of the entity to which the tag is assigned
    entity_type str
    The type of the entity to which the tag is assigned. Allowed values are: catalogs, schemas, tables, columns, volumes
    tag_key str
    (string) - The key of the tag
    tag_value str
    (string) - The value of the tag
    entityName String
    The fully qualified name of the entity to which the tag is assigned
    entityType String
    The type of the entity to which the tag is assigned. Allowed values are: catalogs, schemas, tables, columns, volumes
    tagKey String
    (string) - The key of the tag
    tagValue String
    (string) - The value of the tag

    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
    Schema (JSON)
    pulumi/pulumi-databricks
      Meet Neo: Your AI Platform Teammate