@pulumi/databricks/getEntityTagAssignments.d.ts

A Pulumi package for creating and managing databricks cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "./types/output";
/**
 * [![Public Preview](https://img.shields.io/badge/Release_Stage-Public_Preview-yellowgreen)](https://docs.databricks.com/aws/en/release-notes/release-types)
 *
 * 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
 *
 * ```typescript
 * 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",
 * });
 * ```
 */
export declare function getEntityTagAssignments(args: GetEntityTagAssignmentsArgs, opts?: pulumi.InvokeOptions): Promise<GetEntityTagAssignmentsResult>;
/**
 * A collection of arguments for invoking getEntityTagAssignments.
 */
export interface GetEntityTagAssignmentsArgs {
    /**
     * The fully qualified name of the entity to which the tag is assigned
     */
    entityName: string;
    /**
     * The type of the entity to which the tag is assigned. Allowed values are: catalogs, schemas, tables, columns, volumes
     */
    entityType: string;
    /**
     * Optional. Maximum number of tag assignments to return in a single page
     */
    maxResults?: number;
}
/**
 * A collection of values returned by getEntityTagAssignments.
 */
export interface GetEntityTagAssignmentsResult {
    /**
     * (string) - The fully qualified name of the entity to which the tag is assigned
     */
    readonly entityName: string;
    /**
     * (string) - The type of the entity to which the tag is assigned. Allowed values are: catalogs, schemas, tables, columns, volumes
     */
    readonly entityType: string;
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    readonly maxResults?: number;
    readonly tagAssignments: outputs.GetEntityTagAssignmentsTagAssignment[];
}
/**
 * [![Public Preview](https://img.shields.io/badge/Release_Stage-Public_Preview-yellowgreen)](https://docs.databricks.com/aws/en/release-notes/release-types)
 *
 * 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
 *
 * ```typescript
 * 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",
 * });
 * ```
 */
export declare function getEntityTagAssignmentsOutput(args: GetEntityTagAssignmentsOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetEntityTagAssignmentsResult>;
/**
 * A collection of arguments for invoking getEntityTagAssignments.
 */
export interface GetEntityTagAssignmentsOutputArgs {
    /**
     * The fully qualified name of the entity to which the tag is assigned
     */
    entityName: pulumi.Input<string>;
    /**
     * The type of the entity to which the tag is assigned. Allowed values are: catalogs, schemas, tables, columns, volumes
     */
    entityType: pulumi.Input<string>;
    /**
     * Optional. Maximum number of tag assignments to return in a single page
     */
    maxResults?: pulumi.Input<number>;
}