Compartir a través de

Referencia de configuración

En este artículo se proporciona referencia a las claves compatibles con la configuración de Conjuntos de recursos de Databricks (YAML). Consulte ¿Qué son las conjuntos de recursos de Databricks?.

Para obtener ejemplos completos de paquetes, consulte los ejemplos de configuración de paquetes y el repositorio de GitHub de ejemplos de paquetes .

artifacts

Type: Map

Define los atributos para compilar artefactos, donde cada clave es el nombre del artefacto y el valor es un mapa que define la configuración de compilación del artefacto. Para obtener información sobre la asignación artifacts, consulte artefactos.

La configuración del artefacto definida en el nivel superior de la configuración de agrupación se puede invalidar en la asignación targets. Consulte Invalidación con la configuración de destino.

artifacts:
  <artifact-name>:
    <artifact-field-name>: <artifact-field-value>
Clave Tipo Descripción
build Cadena Conjunto opcional de comandos de compilación que se ejecutarán localmente antes de la implementación.
dynamic_version Boolean Si se va a actualizar dinámicamente la versión del paquete wheel en función de la marca de tiempo del archivo .whl. Si se establece en true, se puede implementar código nuevo sin tener que actualizar la versión en setup.py o pyproject.toml. Esta configuración solo es válida cuando type se establece en whl. Consulte artefactos.
executable Cadena Tipo ejecutable. Valores válidos son bash, sh y cmd.
files Secuencia Ruta de acceso relativa o absoluta a los archivos de artefacto compilado. Consulte artifacts.name.files.
path Cadena Ruta de acceso local del directorio para el artefacto.
type Cadena Obligatorio si el artefacto es una rueda de Python. Tipo del artefacto. Los valores válidos son whl y jar.

Ejemplo

artifacts:
  default:
    type: whl
    build: poetry build
    path: .

artifacts.name.files

Type: Sequence

Ruta de acceso relativa o absoluta a los archivos de artefacto compilado.

Clave Tipo Descripción
source Cadena Necesario. El archivo de origen del artefacto.

agrupación

Type: Map

Atributos de agrupación al implementar en este destino.

Clave Tipo Descripción
cluster_id Cadena Identificador de un clúster que se va a usar para ejecutar el paquete. Consulte el identificador del clúster .
compute_id Cadena En desuso. ID del recurso de computación a utilizar para ejecutar el paquete.
databricks_cli_version Cadena La versión de la CLI de Databricks para usar con el paquete. Consulte databricks_cli_version.
deployment Map Definición de la implementación de agrupación. Para los atributos admitidos, consulte modos de implementación de Asset Bundle de Databricks. Consulte bundle.deployment.
git Map Detalles del control de versiones de Git asociados a tu paquete. Para ver los atributos admitidos, consulte Git. Consulte Git.
name Cadena Nombre del lote.
uuid Cadena Reservado. Identificador único universal (UUID) para el lote que identifica de forma única el lote en sistemas internos de Databricks. Esto se genera cuando se inicializa un proyecto de agrupación mediante una plantilla de Databricks (mediante el comando databricks bundle init).

bundle.deployment

Type: Map

Definición de la implementación del paquete

Clave Tipo Descripción
fail_on_active_runs Boolean Si se produce un error en las ejecuciones activas. Si se establece en true, se puede interrumpir una implementación que se está ejecutando.
lock Map Atributos de bloqueo de la implementación. Consulte bundle.deployment.lock.

bundle.deployment.lock

Type: Map

Atributos de bloqueo de la implementación.

Clave Tipo Descripción
enabled Boolean Si este bloqueo está habilitado.
force Boolean Si se va a forzar este bloqueo si está habilitado.

experimental

Type: Map

Define atributos para las características experimentales.

Clave Tipo Descripción
python Map En desuso. Utilice la asignación de python de nivel superior en su lugar.
python_wheel_wrapper Boolean Si se va a usar un contenedor de paquete wheel de Python.
scripts Map Los comandos que se ejecutarán.
use_legacy_run_as Boolean Indica si se debe usar el comportamiento del run_as heredado.

include

Type: Sequence

Especifica una lista de patrones de ruta que contienen archivos de configuración para incluir en el paquete. Consulte incluir.

permisos

Type: Sequence

Secuencia que define los permisos para aplicar a los recursos definidos en la agrupación, donde cada elemento de la secuencia es un permiso para una entidad específica.

Consulte permisos y Establecimiento de permisos para recursos en agrupaciones de recursos de Databricks.

Clave Tipo Descripción
group_name Cadena Nombre del grupo que tiene el permiso establecido en el nivel.
level Cadena El permiso permitido para usuario, grupo, o entidad de servicio está definido por este permiso. Los valores válidos para esta clave son diferentes en función de si los permisos se definen en el nivel superior de la agrupación o para un recurso específico. Ver Establecer permisos para recursos en paquetes de activos de Databricks.
service_principal_name Cadena Nombre de la entidad de servicio que tiene el permiso establecido en el nivel.
user_name Cadena Nombre del usuario que tiene el permiso establecido en el nivel.

Ejemplo

permissions:
  - level: CAN_VIEW
    group_name: test-group
  - level: CAN_MANAGE
    user_name: someone@example.com
  - level: CAN_RUN
    service_principal_name: 123456-abcdef

de optimización

Type: Map

Define los valores preestablecidos de implementación de agrupación. Consulte Valores preestablecidos personalizados.

Clave Tipo Descripción
jobs_max_concurrent_runs Entero Número máximo de ejecuciones simultáneas para un trabajo.
name_prefix Cadena Prefijo para ejecuciones de trabajo de la agrupación.
pipelines_development Boolean Si las implementaciones de canalización deben bloquearse en modo de desarrollo.
source_linked_deployment Boolean Si se va a vincular la implementación al origen de la agrupación.
tags Map Etiquetas para la implementación de la agrupación.
trigger_pause_status Cadena Estado de pausa que se aplicará a todos los desencadenadores y programaciones del trabajo. Los valores válidos son PAUSED o UNPAUSED.

Python

Type: Map

Configura la carga del código de Python definido con el paquete databricks-bundles. Para obtener más información, consulte Configuración de agrupación en Python.

Clave Tipo Descripción
mutators Secuencia Los mutadores contienen una lista de rutas de acceso de funciones completas a funciones mutadoras, como [my_project.mutators:add_default_cluster].
resources Secuencia Los recursos contienen una lista de rutas completas de funciones para cargar los recursos definidos en el código de Python, como ["my_project.resources:load_resources"].
venv_path Cadena Ruta de acceso al entorno virtual. Si está habilitado, el código de Python se ejecuta en este entorno. Si está deshabilitado, el valor predeterminado es usar el intérprete de Python disponible en el shell actual.

resources

Type: Map

Mapa que define los recursos de la agrupación, donde cada clave es el nombre del recurso y el valor es un mapa que define el recurso. Para obtener más información sobre los recursos admitidos de agrupación de recursos de Databricks y la referencia de definición de recursos, consulte Recursos de agrupaciones de recursos de Databricks.

resources:
  <resource-type>:
    <resource-name>:
      <resource-field-name>: <resource-field-value>
Clave Tipo Descripción
alerts Map Las definiciones de alerta (v2) para el paquete, donde cada clave es el nombre del conjunto de alertas. Consulte alerta.
apps Map Las definiciones de aplicaciones de Databricks para el paquete, donde cada clave es el nombre de la aplicación. Consulte aplicación.
clusters Map Las definiciones de clúster para la agrupación, donde cada clave es el nombre de un clúster. Consulte el clúster
dashboards Map Las definiciones del tablero de control para el paquete, donde cada clave es el nombre del tablero de control. Consulte el panel.
database_catalogs Map Las definiciones del catálogo de bases de datos para la agrupación, donde cada clave es el nombre del catálogo de bases de datos. Consulte database_catalog.
database-instances Map Las definiciones de instancia de base de datos para la agrupación, donde cada clave es el nombre de la instancia de base de datos. Consulte database_instance.
experiments Map Las definiciones del experimento para la agrupación, donde cada clave es el nombre del experimento. Consulte experimento.
jobs Map Las definiciones de tareas para el paquete, donde cada clave es el nombre del trabajo. Ver trabajo.
model_serving_endpoints Map El modelo que atiende las definiciones de punto de conexión para la agrupación, donde cada clave es el nombre del punto de conexión de servicio del modelo. Consulte model_serving_endpoint.
models Map Las definiciones de modelo para la agrupación, donde cada clave es el nombre del modelo. Consulte el modelo (heredado).
pipelines Map Las definiciones de canalización para la agrupación, donde cada clave es el nombre de la canalización. Consulte pipeline.
quality_monitors Map Las definiciones del monitor de calidad para la agrupación, donde cada clave es el nombre del monitor de calidad. Consulte quality_monitor (Catálogo de Unity).
registered_models Map Las definiciones de modelo registradas para la agrupación, donde cada clave es el nombre del modelo registrado del catálogo de Unity. Consulte registered_model (Catálogo de Unity).
schemas Map Las definiciones de esquema para la agrupación, donde cada clave es el nombre del esquema. Consulte esquema (Unity Catalog).
secret_scopes Map Las definiciones de ámbito de secreto para la agrupación, donde cada clave es el nombre del ámbito del secreto. Consulte secret_scope.
sql_warehouses Map Las definiciones del almacén de SQL para el paquete, donde cada clave es el nombre del almacén de SQL. Consulte sql_warehouse.
synced_database_tables Map Definiciones de tabla de base de datos sincronizadas para la agrupación, donde cada clave es el nombre de la tabla de base de datos. Consulte synced_database_table.
volumes Map Las definiciones de volumen para la agrupación, donde cada clave es el nombre del volumen. Consulta volumen (Unity Catalog).

run_as

Type: Map

Identidad que se va a usar al ejecutar flujos de trabajo de agrupaciones de recursos de Databricks. Consulte Especificación de una identidad de ejecución para un flujo de trabajo de agrupaciones de recursos de Databricks.

Clave Tipo Descripción
service_principal_name Cadena Identificador de aplicación de una entidad de servicio activa. Establecer este campo requiere el rol servicePrincipal/user.
user_name Cadena Correo electrónico de un usuario de área de trabajo activa. Los usuarios que no son administradores solo pueden establecer este campo en su propio correo electrónico.

scripts

Type: Map

Los scripts que se pueden ejecutar mediante bundle run. Consulte Ejecución de scripts.

scripts:
  <script-name>:
    <script-field-name>: <script-field-value>
Clave Tipo Descripción
content Cadena Los comandos para ejecutar

sincronizar

Type: Map

Los archivos y rutas de archivo a incluir o excluir en el paquete. Consulte sync.

Clave Tipo Descripción
exclude Secuencia Lista de archivos o carpetas que se van a excluir de la agrupación.
include Secuencia Lista de archivos o carpetas que se van a incluir en la agrupación.
paths Secuencia Las rutas de acceso a carpetas locales, que pueden ubicarse fuera de la raíz del paquete, para sincronizarlas en el área de trabajo cuando se implementa el paquete.

destinos

Type: Map

Define los destinos de implementación para la agrupación. Consulte targets

targets:
  <target-name>:
    <target-field-name>: <target-field-value>
Clave Tipo Descripción
artifacts Map Artefactos que se van a incluir en la implementación de destino. Consulte artefactos.
bundle Map Atributos de agrupación al implementar en este destino. Consulte paquete.
cluster_id Cadena Identificador del clúster que se va a usar para este destino.
compute_id Cadena En desuso. Identificador del proceso que se va a usar para este destino.
default Boolean Si este destino es el destino predeterminado.
git Map Configuración del control de versiones de Git para el destino. Consulte Git.
mode Cadena Modo de implementación del destino. Los valores válidos son development o production. Consulte modos de implementación de Asset Bundle de Databricks.
permissions Secuencia Permisos para implementar y ejecutar el paquete en el destino objetivo. Consulte los permisos.
presets Map Valores preestablecidos de implementación para el destino. Consulte ajustes predefinidos.
resources Map Definiciones de recursos para el objetivo. Consulte recursos.
run_as Map La identidad que se va a usar para ejecutar la agrupación, consulte Especificación de una identidad de ejecución para un flujo de trabajo de Conjuntos de recursos de Databricks. Consulte run_as.
sync Map Las rutas de acceso locales que se van a sincronizar con el área de trabajo de destino cuando se ejecuta o se implementa una agrupación. Consulte sync.
variables Map Definiciones de variables personalizadas para el destino. Consulte variables.
workspace Map Área de trabajo de Databricks para el destino. Consulte workspace.

variables

Type: Map

Define una variable personalizada para la agrupación. Consulte variables.

variables:
  <variable-name>:
    <variable-field-name>: <variable-field-value>
Clave Tipo Descripción
default Cualquiera Valor predeterminado de la variable.
description Cadena Descripción de la variable.
lookup Map Nombre del alert, cluster_policy, cluster, dashboard, instance_pool, job, metastore, pipeline, query, service_principal, o warehouse objeto para el que se va a recuperar un identificador. Consulte variables.name.lookup.
type Cadena Tipo de la variable, simple o compleja. Establezca esta clave solo si la variable es compleja. Valores válidos: complex.

variables.name.lookup

Type: Map

Nombre de la alerta, política_de_clúster, clúster, panel, grupo_de_instancias, trabajo, metastore, canalización, consulta, servicio_principal o almacén para el cual se recuperará un identificador. Para obtener información sobre el uso de la búsqueda, vea Recuperar el valor de identificador de un objeto.

Clave Tipo Descripción
alert Cadena Nombre de la alerta de la que se va a recuperar un identificador.
cluster Cadena Nombre del clúster para el que se va a recuperar un identificador.
cluster_policy Cadena El nombre del "cluster_policy" del que se va a recuperar un identificador.
dashboard Cadena Nombre del panel del que se va a recuperar un identificador
instance_pool Cadena Nombre del instance_pool para el que se va a recuperar un identificador.
job Cadena Nombre del trabajo del que se va a recuperar un identificador.
metastore Cadena Nombre del metastore del que se va a recuperar un identificador.
notification_destination Cadena El nombre de notification_destination del que se va a recuperar un identificador.
pipeline Cadena Nombre de la canalización de la que se va a recuperar un identificador.
query Cadena Nombre de la consulta para la que se va a recuperar un identificador.
service_principal Cadena Nombre del service_principal para el que se va a recuperar un identificador.
warehouse Cadena Nombre del almacén para el que se va a recuperar un identificador.

Área de trabajo

Type: Map

Define el área de trabajo de Databricks para la agrupación. Consulte workspace.

Clave Tipo Descripción
artifact_path Cadena Ruta de acceso del artefacto que se va a usar en el área de trabajo para las implementaciones y ejecuciones de flujo de trabajo.
auth_type Cadena El tipo de autenticación.
azure_client_id Cadena Identificador de cliente de Azure
azure_environment Cadena Entorno de Azure
azure_login_app_id Cadena Identificador de la aplicación de inicio de sesión de Azure
azure_tenant_id Cadena Identificador de inquilino de Azure
azure_use_msi Boolean Si se va a usar MSI para Azure
azure_workspace_resource_id Cadena Identificador de recurso del área de trabajo de Azure
client_id Cadena ID de cliente del área de trabajo
file_path Cadena Ruta de acceso del archivo que se va a usar en el área de trabajo para las implementaciones y ejecuciones de flujo de trabajo.
google_service_account Cadena El nombre de la cuenta de servicio de Google
host Cadena Dirección URL del host del área de trabajo de Databricks
profile Cadena El nombre del perfil de área de trabajo de Databricks
resource_path Cadena Ruta de acceso del recurso del área de trabajo
root_path Cadena Ruta de acceso raíz del área de trabajo de Databricks
state_path Cadena Ruta de acceso del estado del área de trabajo

Objetos comunes

Git (sistema de control de versiones)

Type: Map

Define los detalles del control de versiones de Git.

Clave Tipo Descripción
branch Cadena Nombre de la rama de Git. Consulte Git.
origin_url Cadena Dirección URL de origen del repositorio. Consulte Git.
  • Last updated on