1. Packages
  2. Databricks Provider
  3. API Docs
  4. WorkspaceEntityTagAssignment
Databricks v1.83.0 published on Friday, Jan 23, 2026 by Pulumi
databricks logo
Databricks v1.83.0 published on Friday, Jan 23, 2026 by Pulumi

    Public Beta

    This resource allows you to create, update, list, and delete tag assignments for workspace scoped entities.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as databricks from "@pulumi/databricks";
    
    const dashboardTag = new databricks.WorkspaceEntityTagAssignment("dashboard_tag", {
        entityType: "dashboards",
        entityId: "2807324866692453",
        tagKey: "sensitivity_level",
        tagValue: "high",
    });
    const geniespaceTag = new databricks.WorkspaceEntityTagAssignment("geniespace_tag", {
        entityType: "geniespaces",
        entityId: "2807324866692453",
        tagKey: "sensitivity_level",
        tagValue: "high",
    });
    
    import pulumi
    import pulumi_databricks as databricks
    
    dashboard_tag = databricks.WorkspaceEntityTagAssignment("dashboard_tag",
        entity_type="dashboards",
        entity_id="2807324866692453",
        tag_key="sensitivity_level",
        tag_value="high")
    geniespace_tag = databricks.WorkspaceEntityTagAssignment("geniespace_tag",
        entity_type="geniespaces",
        entity_id="2807324866692453",
        tag_key="sensitivity_level",
        tag_value="high")
    
    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.NewWorkspaceEntityTagAssignment(ctx, "dashboard_tag", &databricks.WorkspaceEntityTagAssignmentArgs{
    			EntityType: pulumi.String("dashboards"),
    			EntityId:   pulumi.String("2807324866692453"),
    			TagKey:     pulumi.String("sensitivity_level"),
    			TagValue:   pulumi.String("high"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = databricks.NewWorkspaceEntityTagAssignment(ctx, "geniespace_tag", &databricks.WorkspaceEntityTagAssignmentArgs{
    			EntityType: pulumi.String("geniespaces"),
    			EntityId:   pulumi.String("2807324866692453"),
    			TagKey:     pulumi.String("sensitivity_level"),
    			TagValue:   pulumi.String("high"),
    		})
    		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 dashboardTag = new Databricks.WorkspaceEntityTagAssignment("dashboard_tag", new()
        {
            EntityType = "dashboards",
            EntityId = "2807324866692453",
            TagKey = "sensitivity_level",
            TagValue = "high",
        });
    
        var geniespaceTag = new Databricks.WorkspaceEntityTagAssignment("geniespace_tag", new()
        {
            EntityType = "geniespaces",
            EntityId = "2807324866692453",
            TagKey = "sensitivity_level",
            TagValue = "high",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.databricks.WorkspaceEntityTagAssignment;
    import com.pulumi.databricks.WorkspaceEntityTagAssignmentArgs;
    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) {
            var dashboardTag = new WorkspaceEntityTagAssignment("dashboardTag", WorkspaceEntityTagAssignmentArgs.builder()
                .entityType("dashboards")
                .entityId("2807324866692453")
                .tagKey("sensitivity_level")
                .tagValue("high")
                .build());
    
            var geniespaceTag = new WorkspaceEntityTagAssignment("geniespaceTag", WorkspaceEntityTagAssignmentArgs.builder()
                .entityType("geniespaces")
                .entityId("2807324866692453")
                .tagKey("sensitivity_level")
                .tagValue("high")
                .build());
    
        }
    }
    
    resources:
      dashboardTag:
        type: databricks:WorkspaceEntityTagAssignment
        name: dashboard_tag
        properties:
          entityType: dashboards
          entityId: '2807324866692453'
          tagKey: sensitivity_level
          tagValue: high
      geniespaceTag:
        type: databricks:WorkspaceEntityTagAssignment
        name: geniespace_tag
        properties:
          entityType: geniespaces
          entityId: '2807324866692453'
          tagKey: sensitivity_level
          tagValue: high
    

    Create WorkspaceEntityTagAssignment Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new WorkspaceEntityTagAssignment(name: string, args: WorkspaceEntityTagAssignmentArgs, opts?: CustomResourceOptions);
    @overload
    def WorkspaceEntityTagAssignment(resource_name: str,
                                     args: WorkspaceEntityTagAssignmentArgs,
                                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def WorkspaceEntityTagAssignment(resource_name: str,
                                     opts: Optional[ResourceOptions] = None,
                                     entity_id: Optional[str] = None,
                                     entity_type: Optional[str] = None,
                                     tag_key: Optional[str] = None,
                                     tag_value: Optional[str] = None)
    func NewWorkspaceEntityTagAssignment(ctx *Context, name string, args WorkspaceEntityTagAssignmentArgs, opts ...ResourceOption) (*WorkspaceEntityTagAssignment, error)
    public WorkspaceEntityTagAssignment(string name, WorkspaceEntityTagAssignmentArgs args, CustomResourceOptions? opts = null)
    public WorkspaceEntityTagAssignment(String name, WorkspaceEntityTagAssignmentArgs args)
    public WorkspaceEntityTagAssignment(String name, WorkspaceEntityTagAssignmentArgs args, CustomResourceOptions options)
    
    type: databricks:WorkspaceEntityTagAssignment
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args WorkspaceEntityTagAssignmentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args WorkspaceEntityTagAssignmentArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args WorkspaceEntityTagAssignmentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WorkspaceEntityTagAssignmentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WorkspaceEntityTagAssignmentArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var workspaceEntityTagAssignmentResource = new Databricks.WorkspaceEntityTagAssignment("workspaceEntityTagAssignmentResource", new()
    {
        EntityId = "string",
        EntityType = "string",
        TagKey = "string",
        TagValue = "string",
    });
    
    example, err := databricks.NewWorkspaceEntityTagAssignment(ctx, "workspaceEntityTagAssignmentResource", &databricks.WorkspaceEntityTagAssignmentArgs{
    	EntityId:   pulumi.String("string"),
    	EntityType: pulumi.String("string"),
    	TagKey:     pulumi.String("string"),
    	TagValue:   pulumi.String("string"),
    })
    
    var workspaceEntityTagAssignmentResource = new WorkspaceEntityTagAssignment("workspaceEntityTagAssignmentResource", WorkspaceEntityTagAssignmentArgs.builder()
        .entityId("string")
        .entityType("string")
        .tagKey("string")
        .tagValue("string")
        .build());
    
    workspace_entity_tag_assignment_resource = databricks.WorkspaceEntityTagAssignment("workspaceEntityTagAssignmentResource",
        entity_id="string",
        entity_type="string",
        tag_key="string",
        tag_value="string")
    
    const workspaceEntityTagAssignmentResource = new databricks.WorkspaceEntityTagAssignment("workspaceEntityTagAssignmentResource", {
        entityId: "string",
        entityType: "string",
        tagKey: "string",
        tagValue: "string",
    });
    
    type: databricks:WorkspaceEntityTagAssignment
    properties:
        entityId: string
        entityType: string
        tagKey: string
        tagValue: string
    

    WorkspaceEntityTagAssignment Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The WorkspaceEntityTagAssignment resource accepts the following input properties:

    EntityId string
    The identifier of the entity to which the tag is assigned
    EntityType string
    The type of entity to which the tag is assigned. Allowed values are dashboards, geniespaces
    TagKey string
    The key of the tag. The characters , . : / - = and leading/trailing spaces are not allowed
    TagValue string
    The value of the tag
    EntityId string
    The identifier of the entity to which the tag is assigned
    EntityType string
    The type of entity to which the tag is assigned. Allowed values are dashboards, geniespaces
    TagKey string
    The key of the tag. The characters , . : / - = and leading/trailing spaces are not allowed
    TagValue string
    The value of the tag
    entityId String
    The identifier of the entity to which the tag is assigned
    entityType String
    The type of entity to which the tag is assigned. Allowed values are dashboards, geniespaces
    tagKey String
    The key of the tag. The characters , . : / - = and leading/trailing spaces are not allowed
    tagValue String
    The value of the tag
    entityId string
    The identifier of the entity to which the tag is assigned
    entityType string
    The type of entity to which the tag is assigned. Allowed values are dashboards, geniespaces
    tagKey string
    The key of the tag. The characters , . : / - = and leading/trailing spaces are not allowed
    tagValue string
    The value of the tag
    entity_id str
    The identifier of the entity to which the tag is assigned
    entity_type str
    The type of entity to which the tag is assigned. Allowed values are dashboards, geniespaces
    tag_key str
    The key of the tag. The characters , . : / - = and leading/trailing spaces are not allowed
    tag_value str
    The value of the tag
    entityId String
    The identifier of the entity to which the tag is assigned
    entityType String
    The type of entity to which the tag is assigned. Allowed values are dashboards, geniespaces
    tagKey String
    The key of the tag. The characters , . : / - = and leading/trailing spaces are not allowed
    tagValue String
    The value of the tag

    Outputs

    All input properties are implicitly available as output properties. Additionally, the WorkspaceEntityTagAssignment resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing WorkspaceEntityTagAssignment Resource

    Get an existing WorkspaceEntityTagAssignment resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: WorkspaceEntityTagAssignmentState, opts?: CustomResourceOptions): WorkspaceEntityTagAssignment
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            entity_id: Optional[str] = None,
            entity_type: Optional[str] = None,
            tag_key: Optional[str] = None,
            tag_value: Optional[str] = None) -> WorkspaceEntityTagAssignment
    func GetWorkspaceEntityTagAssignment(ctx *Context, name string, id IDInput, state *WorkspaceEntityTagAssignmentState, opts ...ResourceOption) (*WorkspaceEntityTagAssignment, error)
    public static WorkspaceEntityTagAssignment Get(string name, Input<string> id, WorkspaceEntityTagAssignmentState? state, CustomResourceOptions? opts = null)
    public static WorkspaceEntityTagAssignment get(String name, Output<String> id, WorkspaceEntityTagAssignmentState state, CustomResourceOptions options)
    resources:  _:    type: databricks:WorkspaceEntityTagAssignment    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    EntityId string
    The identifier of the entity to which the tag is assigned
    EntityType string
    The type of entity to which the tag is assigned. Allowed values are dashboards, geniespaces
    TagKey string
    The key of the tag. The characters , . : / - = and leading/trailing spaces are not allowed
    TagValue string
    The value of the tag
    EntityId string
    The identifier of the entity to which the tag is assigned
    EntityType string
    The type of entity to which the tag is assigned. Allowed values are dashboards, geniespaces
    TagKey string
    The key of the tag. The characters , . : / - = and leading/trailing spaces are not allowed
    TagValue string
    The value of the tag
    entityId String
    The identifier of the entity to which the tag is assigned
    entityType String
    The type of entity to which the tag is assigned. Allowed values are dashboards, geniespaces
    tagKey String
    The key of the tag. The characters , . : / - = and leading/trailing spaces are not allowed
    tagValue String
    The value of the tag
    entityId string
    The identifier of the entity to which the tag is assigned
    entityType string
    The type of entity to which the tag is assigned. Allowed values are dashboards, geniespaces
    tagKey string
    The key of the tag. The characters , . : / - = and leading/trailing spaces are not allowed
    tagValue string
    The value of the tag
    entity_id str
    The identifier of the entity to which the tag is assigned
    entity_type str
    The type of entity to which the tag is assigned. Allowed values are dashboards, geniespaces
    tag_key str
    The key of the tag. The characters , . : / - = and leading/trailing spaces are not allowed
    tag_value str
    The value of the tag
    entityId String
    The identifier of the entity to which the tag is assigned
    entityType String
    The type of entity to which the tag is assigned. Allowed values are dashboards, geniespaces
    tagKey String
    The key of the tag. The characters , . : / - = and leading/trailing spaces are not allowed
    tagValue String
    The value of the tag

    Import

    As of Pulumi v1.5, resources can be imported through configuration.

    hcl

    import {

    id = “entity_type,entity_id,tag_key”

    to = databricks_workspace_entity_tag_assignment.this

    }

    If you are using an older version of Pulumi, import the resource using the pulumi import command as follows:

    $ pulumi import databricks:index/workspaceEntityTagAssignment:WorkspaceEntityTagAssignment this "entity_type,entity_id,tag_key"
    

    To learn more about importing existing cloud resources, see Importing resources.

    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.83.0 published on Friday, Jan 23, 2026 by Pulumi
      Meet Neo: Your AI Platform Teammate