1. Packages
  2. Databricks Provider
  3. API Docs
  4. EntityTagAssignment
Databricks v1.75.0 published on Thursday, Sep 11, 2025 by Pulumi

databricks.EntityTagAssignment

Explore with Pulumi AI

databricks logo
Databricks v1.75.0 published on Thursday, Sep 11, 2025 by Pulumi

    Import

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

    hcl

    import {

    id = “entity_type,entity_name,tag_key”

    to = databricks_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/entityTagAssignment:EntityTagAssignment databricks_entity_tag_assignment "entity_type,entity_name,tag_key"
    

    Create EntityTagAssignment Resource

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

    Constructor syntax

    new EntityTagAssignment(name: string, args: EntityTagAssignmentArgs, opts?: CustomResourceOptions);
    @overload
    def EntityTagAssignment(resource_name: str,
                            args: EntityTagAssignmentArgs,
                            opts: Optional[ResourceOptions] = None)
    
    @overload
    def EntityTagAssignment(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            entity_name: Optional[str] = None,
                            entity_type: Optional[str] = None,
                            tag_key: Optional[str] = None,
                            tag_value: Optional[str] = None,
                            workspace_id: Optional[str] = None)
    func NewEntityTagAssignment(ctx *Context, name string, args EntityTagAssignmentArgs, opts ...ResourceOption) (*EntityTagAssignment, error)
    public EntityTagAssignment(string name, EntityTagAssignmentArgs args, CustomResourceOptions? opts = null)
    public EntityTagAssignment(String name, EntityTagAssignmentArgs args)
    public EntityTagAssignment(String name, EntityTagAssignmentArgs args, CustomResourceOptions options)
    
    type: databricks:EntityTagAssignment
    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 EntityTagAssignmentArgs
    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 EntityTagAssignmentArgs
    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 EntityTagAssignmentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EntityTagAssignmentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EntityTagAssignmentArgs
    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 entityTagAssignmentResource = new Databricks.EntityTagAssignment("entityTagAssignmentResource", new()
    {
        EntityName = "string",
        EntityType = "string",
        TagKey = "string",
        TagValue = "string",
        WorkspaceId = "string",
    });
    
    example, err := databricks.NewEntityTagAssignment(ctx, "entityTagAssignmentResource", &databricks.EntityTagAssignmentArgs{
    	EntityName:  pulumi.String("string"),
    	EntityType:  pulumi.String("string"),
    	TagKey:      pulumi.String("string"),
    	TagValue:    pulumi.String("string"),
    	WorkspaceId: pulumi.String("string"),
    })
    
    var entityTagAssignmentResource = new EntityTagAssignment("entityTagAssignmentResource", EntityTagAssignmentArgs.builder()
        .entityName("string")
        .entityType("string")
        .tagKey("string")
        .tagValue("string")
        .workspaceId("string")
        .build());
    
    entity_tag_assignment_resource = databricks.EntityTagAssignment("entityTagAssignmentResource",
        entity_name="string",
        entity_type="string",
        tag_key="string",
        tag_value="string",
        workspace_id="string")
    
    const entityTagAssignmentResource = new databricks.EntityTagAssignment("entityTagAssignmentResource", {
        entityName: "string",
        entityType: "string",
        tagKey: "string",
        tagValue: "string",
        workspaceId: "string",
    });
    
    type: databricks:EntityTagAssignment
    properties:
        entityName: string
        entityType: string
        tagKey: string
        tagValue: string
        workspaceId: string
    

    EntityTagAssignment 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 EntityTagAssignment resource accepts the following input properties:

    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
    The key of the tag
    TagValue string
    The value of the tag
    WorkspaceId string
    Workspace ID of the resource
    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
    The key of the tag
    TagValue string
    The value of the tag
    WorkspaceId string
    Workspace ID of the resource
    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
    The key of the tag
    tagValue String
    The value of the tag
    workspaceId String
    Workspace ID of the resource
    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
    The key of the tag
    tagValue string
    The value of the tag
    workspaceId string
    Workspace ID of the resource
    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
    The key of the tag
    tag_value str
    The value of the tag
    workspace_id str
    Workspace ID of the resource
    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
    The key of the tag
    tagValue String
    The value of the tag
    workspaceId String
    Workspace ID of the resource

    Outputs

    All input properties are implicitly available as output properties. Additionally, the EntityTagAssignment 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 EntityTagAssignment Resource

    Get an existing EntityTagAssignment 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?: EntityTagAssignmentState, opts?: CustomResourceOptions): EntityTagAssignment
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            entity_name: Optional[str] = None,
            entity_type: Optional[str] = None,
            tag_key: Optional[str] = None,
            tag_value: Optional[str] = None,
            workspace_id: Optional[str] = None) -> EntityTagAssignment
    func GetEntityTagAssignment(ctx *Context, name string, id IDInput, state *EntityTagAssignmentState, opts ...ResourceOption) (*EntityTagAssignment, error)
    public static EntityTagAssignment Get(string name, Input<string> id, EntityTagAssignmentState? state, CustomResourceOptions? opts = null)
    public static EntityTagAssignment get(String name, Output<String> id, EntityTagAssignmentState state, CustomResourceOptions options)
    resources:  _:    type: databricks:EntityTagAssignment    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:
    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
    The key of the tag
    TagValue string
    The value of the tag
    WorkspaceId string
    Workspace ID of the resource
    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
    The key of the tag
    TagValue string
    The value of the tag
    WorkspaceId string
    Workspace ID of the resource
    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
    The key of the tag
    tagValue String
    The value of the tag
    workspaceId String
    Workspace ID of the resource
    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
    The key of the tag
    tagValue string
    The value of the tag
    workspaceId string
    Workspace ID of the resource
    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
    The key of the tag
    tag_value str
    The value of the tag
    workspace_id str
    Workspace ID of the resource
    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
    The key of the tag
    tagValue String
    The value of the tag
    workspaceId String
    Workspace ID of the resource

    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.75.0 published on Thursday, Sep 11, 2025 by Pulumi