Grupo de comandos entity-tag-assignments

Nota:

Esta información se aplica a las versiones 0.205 y posteriores de la CLI de Databricks. La CLI de Databricks está en versión preliminar pública.

El uso de la CLI de Databricks está sujeto a la licencia de Databricks y al aviso de privacidad de Databricks, incluidas las disposiciones de datos de uso.

El entity-tag-assignments grupo de comandos de la CLI de Databricks contiene comandos para crear, actualizar, eliminar y enumerar asignaciones de etiquetas en las entidades del catálogo de Unity. Las etiquetas son atributos que incluyen claves y valores opcionales que puede usar para organizar y clasificar entidades en el catálogo de Unity. Vea Aplicar etiquetas a objetos protegibles de Unity Catalog.

creación de entity-tag-assignments de databricks

Cree una asignación de etiquetas para una entidad de Catálogo de Unity.

Para agregar etiquetas a las entidades del catálogo de Unity, debe poseer la entidad o tener los siguientes privilegios:

  • APPLY TAG en la entidad
  • USE SCHEMA en el esquema primario de la entidad
  • USE CATALOG en el catálogo primario de la entidad

Para agregar una etiqueta regulada a las entidades de Catálogo de Unity, también debe tener el permiso ASSIGN o MANAGE en la directiva de etiquetas. Consulte Administración de permisos de directiva de etiquetas.

databricks entity-tag-assignments create ENTITY_NAME TAG_KEY ENTITY_TYPE [flags]

Argumentos

ENTITY_NAME

    Nombre completo de la entidad a la que se asigna la etiqueta.

TAG_KEY

    La clave de la etiqueta.

ENTITY_TYPE

    Tipo de la entidad a la que se asigna la etiqueta. Los valores permitidos son: catalogs, schemas, tables, columns, volumes.

Options

--json JSON

    La cadena JSON en línea o el archivo JSON @path con el cuerpo de la solicitud

--tag-value string

    El valor de la etiqueta.

Marcas globales

Examples

En el ejemplo siguiente se crea una asignación de etiquetas para una tabla:

databricks entity-tag-assignments create my_catalog.my_schema.my_table environment tables --tag-value production

En el ejemplo siguiente se crea una asignación de etiquetas mediante JSON:

databricks entity-tag-assignments create my_catalog.my_schema.my_table department tables --json '{"tag_value": "finance"}'

eliminación de entity-tag-assignments de databricks

Elimine una asignación de etiquetas para una entidad de Catálogo de Unity por su clave.

Para eliminar etiquetas de entidades del catálogo de Unity, debe poseer la entidad o tener los siguientes privilegios:

  • APPLY TAG en la entidad
  • USE_SCHEMA en el esquema primario de la entidad
  • USE_CATALOG en el catálogo primario de la entidad

Para eliminar una etiqueta regulada de entidades del catálogo de Unity, también debe tener el permiso ASSIGN o MANAGE en la directiva de etiquetas. Consulte Administración de permisos de directiva de etiquetas.

databricks entity-tag-assignments delete ENTITY_TYPE ENTITY_NAME TAG_KEY [flags]

Argumentos

ENTITY_TYPE

    Tipo de la entidad a la que se asigna la etiqueta. Los valores permitidos son: catalogs, schemas, tables, columns, volumes.

ENTITY_NAME

    Nombre completo de la entidad a la que se asigna la etiqueta.

TAG_KEY

    Clave de la etiqueta que se va a eliminar.

Options

Marcas globales

Examples

En el ejemplo siguiente se elimina una asignación de etiquetas de una tabla:

databricks entity-tag-assignments delete tables my_catalog.my_schema.my_table environment

databricks entity-tag-assignments get

Obtenga una asignación de etiquetas para una entidad de Catálogo de Unity por clave de etiqueta.

databricks entity-tag-assignments get ENTITY_TYPE ENTITY_NAME TAG_KEY [flags]

Argumentos

ENTITY_TYPE

    Tipo de la entidad a la que se asigna la etiqueta. Los valores permitidos son: catalogs, schemas, tables, columns, volumes.

ENTITY_NAME

    Nombre completo de la entidad a la que se asigna la etiqueta.

TAG_KEY

    La clave de la etiqueta.

Options

Marcas globales

Examples

En el ejemplo siguiente se obtiene una asignación de etiquetas para una tabla:

databricks entity-tag-assignments get tables my_catalog.my_schema.my_table environment

databricks entity-tag-assignments list

Enumera las asignaciones de etiquetas para una entidad de Catálogo de Unity.

Important

La API está paginada de forma predeterminada, una página puede contener cero resultados mientras se proporciona un next_page_token. Los clientes deben seguir leyendo páginas hasta que next_page_token esté ausente, que es la única indicación de que se ha alcanzado el final de los resultados.

databricks entity-tag-assignments list ENTITY_TYPE ENTITY_NAME [flags]

Argumentos

ENTITY_TYPE

    Tipo de la entidad a la que se asigna la etiqueta. Los valores permitidos son: catalogs, schemas, tables, columns, volumes.

ENTITY_NAME

    Nombre completo de la entidad a la que se asigna la etiqueta.

Options

--max-results int

    Número máximo de resultados que se van a devolver.

--page-token string

    Token para recuperar la página siguiente de resultados.

Marcas globales

Examples

En el ejemplo siguiente se enumeran todas las asignaciones de etiquetas de una tabla:

databricks entity-tag-assignments list tables my_catalog.my_schema.my_table

En el ejemplo siguiente se enumeran las asignaciones de etiquetas con paginación:

databricks entity-tag-assignments list tables my_catalog.my_schema.my_table --max-results 10

actualización de entity-tag-assignments de databricks

Actualice una asignación de etiquetas existente para una entidad de Catálogo de Unity.

Para actualizar las etiquetas a las entidades del catálogo de Unity, debe poseer la entidad o tener los privilegios siguientes:

  • APPLY TAG en la entidad
  • USE SCHEMA en el esquema primario de la entidad
  • USE CATALOG en el catálogo primario de la entidad

Para actualizar una etiqueta regulada a las entidades del catálogo de Unity, también debe tener el permiso ASSIGN o MANAGE en la directiva de etiquetas. Consulte Administración de permisos de directiva de etiquetas.

databricks entity-tag-assignments update ENTITY_TYPE ENTITY_NAME TAG_KEY UPDATE_MASK [flags]

Argumentos

ENTITY_TYPE

    Tipo de la entidad a la que se asigna la etiqueta. Los valores permitidos son: catalogs, schemas, tables, columns, volumes.

ENTITY_NAME

    Nombre completo de la entidad a la que se asigna la etiqueta.

TAG_KEY

    La clave de la etiqueta.

UPDATE_MASK

    La máscara de campo debe ser una sola cadena, con varios campos separados por comas (sin espacios). La ruta de acceso del campo es relativa al objeto de recurso, mediante un punto (.) para navegar por los subcampos (por ejemplo, author.given_name). No se permite la especificación de elementos en campos de secuencia o mapa, ya que solo se puede especificar todo el campo de colección. Los nombres de campo deben coincidir exactamente con los nombres de campo de recursos.

    Una máscara de campo asterisco (*) indica un reemplazo completo. Se recomienda enumerar siempre explícitamente los campos que se actualizan y evitar el uso de caracteres comodín, ya que puede provocar resultados no deseados si la API cambia en el futuro.

Options

--json JSON

    La cadena JSON en línea o el archivo JSON @path con el cuerpo de la solicitud

--tag-value string

    El valor de la etiqueta.

Marcas globales

Examples

En el ejemplo siguiente se actualiza una asignación de etiquetas para una tabla:

databricks entity-tag-assignments update tables my_catalog.my_schema.my_table environment "tag_value" --tag-value staging

En el ejemplo siguiente se actualiza una asignación de etiquetas mediante JSON:

databricks entity-tag-assignments update tables my_catalog.my_schema.my_table environment "tag_value" --json '{"tag_value": "development"}'

Marcas globales

--debug

  Indica si se va a habilitar el registro de depuración.

-h o --help

    Mostrar ayuda para la CLI de Databricks o el grupo de comandos relacionado o el comando relacionado.

--log-file cadena

    Cadena que representa el archivo en el que se van a escribir registros de salida. Si no se especifica esta marca, el valor predeterminado es escribir registros de salida en stderr.

--log-format formato

    Tipo de formato de registro: text o json. El valor predeterminado es text.

--log-level cadena

    Cadena que representa el nivel de formato de registro. Si no se especifica, el nivel de formato de registro está deshabilitado.

-o, --output tipo

    Tipo de salida del comando, text o json. El valor predeterminado es text.

-p, --profile cadena

    Nombre del perfil en el archivo ~/.databrickscfg que se usará para ejecutar el comando. Si no se especifica esta marca, si existe, se usa el perfil denominado DEFAULT .

--progress-format formato

    Formato para mostrar los registros de progreso: default, append, inplaceo json

-t, --target cadena

    Si procede, el destino del paquete que se va a usar