Partilhar via

Referência de configuração

Este artigo fornece referência para chaves suportadas pela configuração do Databricks Asset Bundles (YAML). Consulte O que são Databricks Asset Bundles?.

Para obter exemplos completos de pacotes, consulte Exemplos de configuração de pacotes e o repositório GitHub exemplos de pacotes.

artefatos

Type: Map

Define-se os atributos para construir artefactos, onde cada chave é o nome do artefacto, e o valor é um Mapa que define as configurações de construção do artefacto. Para mais informações sobre o mapeamento de artifacts, consulte artefactos.

As configurações de artefato definidas no nível superior da configuração do pacote podem ser substituídas no mapeamento de targets. Consulte Substituir com configurações de destino.

artifacts:
  <artifact-name>:
    <artifact-field-name>: <artifact-field-value>
Chave Tipo Descrição
build Cordão Um conjunto opcional de comandos de compilação para executar localmente antes da implantação.
dynamic_version booleano Se a versão do wheel deve ser ajustada dinamicamente com base no carimbo de data/hora do ficheiro whl. Se isso estiver definido como true, o novo código poderá ser implantado sem a necessidade de atualizar a versão em setup.py ou pyproject.toml. Essa configuração só é válida quando type definida como whl. Veja artefatos.
executable Cordão O tipo executável. Os valores válidos são bash, she cmd.
files Sequência O caminho relativo ou absoluto para os arquivos de artefato gerados. Veja artefactos.nome.ficheiros.
path Cordão O caminho local do diretório para o artefato.
type Cordão Necessário se o artefato for uma roda Python. O tipo do artefato. Os valores válidos são whl e jar.

Exemplo

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

artefactos.nome.arquivos

Type: Sequence

O caminho relativo ou absoluto para os arquivos de artefato gerados.

Chave Tipo Descrição
source Cordão Obrigatório. O arquivo de origem do artefato.

grupo

Type: Map

Os atributos do pacote quando se implanta neste destino.

Chave Tipo Descrição
cluster_id Cordão A ID de um cluster a ser usada para executar o pacote. Consulte cluster_id.
compute_id Cordão Preterido. O ID da computação a ser usado para executar o bundle.
databricks_cli_version Cordão A versão da CLI do Databricks a ser usada para o pacote. Consulte databricks_cli_version.
deployment Mapa A definição da implantação do pacote. Para obter os atributos suportados, consulte Modos de implantação do Databricks Asset Bundle. Consulte bundle.deployment.
git Mapa Os detalhes do controle de versão do Git associados ao seu pacote. Para obter os atributos suportados, consulte git. Veja git.
name Cordão O nome do pacote.
uuid Cordão Reservado. Um identificador universalmente exclusivo (UUID) para o pacote que identifica exclusivamente o pacote em sistemas internos do Databricks. Isso é gerado quando um projeto de pacote é inicializado usando um modelo Databricks (usando o comando databricks bundle init).

pacote.implementação

Type: Map

A definição da implantação do pacote

Chave Tipo Descrição
fail_on_active_runs booleano Se deve ocorrer falhas nas execuções ativas. Se isso for definido como true, uma implantação em execução poderá ser interrompida.
lock Mapa Os atributos de bloqueio de implementação. Consulte bundle.deployment.lock.

pacote.implementação.lock

Type: Map

Os atributos de bloqueio de implementação.

Chave Tipo Descrição
enabled booleano Se este bloqueio está ativado.
force booleano Se este bloqueio deve ser forçado se estiver ativado.

Experimentais

Type: Map

Define os atributos para funcionalidades experimentais.

Chave Tipo Descrição
python Mapa Preterido. Em vez disso, use o mapeamento python de nível superior.
python_wheel_wrapper booleano Se deve usar um invólucro de roda Python.
scripts Mapa Os comandos a serem executados.
use_legacy_run_as booleano Decidir se deve ser usado o comportamento herdado de run_as.

incluem

Type: Sequence

Especifica uma lista de globs de caminho que contêm arquivos de configuração a serem incluídos no pacote. Consulte incluir.

permissões

Type: Sequence

Uma Sequência que define as permissões a serem aplicadas aos recursos definidos no pacote, onde cada item na sequência é uma permissão para uma entidade específica.

Consulte permissões e Definir permissões para recursos em Databricks Asset Bundles.

Chave Tipo Descrição
group_name Cordão O nome do grupo que tem a permissão definida em nível.
level Cordão A permissão permitida para o utilizador, grupo ou principal de serviço é definida para esta permissão. Os valores válidos para essa chave são diferentes, dependendo se as permissões são definidas no nível superior do pacote ou para um recurso específico. Consulte Definir permissões para recursos em Databricks Asset Bundles.
service_principal_name Cordão O nome do principal de serviço que tem a permissão definida em nível.
user_name Cordão O nome do utilizador que tem a permissão definida ao nível.

Exemplo

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

predefinições

Type: Map

Define predefinições de implantação de pacote. Consulte Predefinições personalizadas.

Chave Tipo Descrição
jobs_max_concurrent_runs Inteiro O número máximo de execuções simultâneas para um trabalho.
name_prefix Cordão O prefixo para execuções de tarefas do pacote.
pipelines_development booleano Se as implantações de pipeline devem ser bloqueadas no modo de desenvolvimento.
source_linked_deployment booleano Se a implantação deve ser vinculada à origem do pacote.
tags Mapa As tags para a implantação do conjunto.
trigger_pause_status Cordão Um status de pausa para aplicar a todos os gatilhos e agendamentos de trabalho. Os valores válidos são PAUSED ou UNPAUSED.

píton

Type: Map

Configura o carregamento do código Python definido com o pacote databricks-bundles. Para obter mais informações, consulte Configuração do pacote em Python.

Chave Tipo Descrição
mutators Sequência Mutadores contém uma lista de caminhos de função totalmente qualificados para funções mutadoras, como [my_project.mutators:add_default_cluster].
resources Sequência Recursos contém uma lista de caminhos de função totalmente qualificados para carregar recursos definidos no código Python, como ["my_project.resources:load_resources"]
venv_path Cordão O caminho para o ambiente virtual. Se ativado, o código Python é executado dentro deste ambiente. Se desativado, o padrão é usar o interpretador Python disponível no shell atual.

Recursos

Type: Map

Um Mapa que define os recursos para o pacote, onde cada chave é o nome do recurso e o valor é um Mapa que define o recurso. Para obter mais informações sobre os recursos do Databricks Asset Bundles suportados e a referência de definição de recursos, consulte recursos do Databricks Asset Bundles.

resources:
  <resource-type>:
    <resource-name>:
      <resource-field-name>: <resource-field-value>
Chave Tipo Descrição
alerts Mapa As definições de alerta (v2) para o bundle, onde cada chave é o nome do alerta. Ver alerta.
apps Mapa As definições do aplicativo Databricks para o pacote, onde cada chave é o nome do aplicativo. Consulte aplicativo.
clusters Mapa As definições de cluster para o pacote, onde cada chave é o nome de um cluster. Consulte cluster.
dashboards Mapa As definições do dashboard para o pacote, onde cada chave é o nome do dashboard. Consulte painel de controle.
database_catalogs Mapa As definições de catálogo de banco de dados para o pacote, onde cada chave é o nome do catálogo de banco de dados. Veja database_catalog.
database-instances Mapa As definições de instância de banco de dados para o pacote, onde cada chave é o nome da instância de banco de dados. Ver database_instance.
experiments Mapa As definições do experimento para o pacote, onde cada chave é o nome do experimento. Ver experimento.
jobs Mapa As definições de trabalho para o pacote, sendo cada chave correspondente ao nome de um trabalho. Ver trabalho.
model_serving_endpoints Mapa O modelo que serve as definições de ponto de extremidade para o pacote, onde cada chave é o nome do modelo que serve o ponto de extremidade. Consulte model_serving_endpoint.
models Mapa As definições de modelo para o pacote, onde cada chave é o nome do modelo. Ver modelo (legado).
pipelines Mapa As definições de pipeline do pacote, em que cada chave corresponde ao nome do pipeline. Veja o pipeline.
quality_monitors Mapa As definições do monitor de qualidade para o pacote, em que cada chave representa o nome do monitor de qualidade. Consulte quality_monitor (Catálogo Unity).
registered_models Mapa As definições de modelo registrado para o pacote, onde cada chave é o nome do modelo registrado do Catálogo Unity. Consulte registered_model (Catálogo Unity).
schemas Mapa As definições de esquema para o pacote, onde cada chave é o nome do esquema. Consulte o esquema (Catálogo Unity).
secret_scopes Mapa As definições de escopo secreto para o pacote, onde cada chave é o nome do escopo secreto. Ver secret_scope.
sql_warehouses Mapa As definições do armazém de dados SQL para o conjunto, onde cada chave é o nome do armazém de dados SQL. Veja sql_warehouse.
synced_database_tables Mapa As definições de tabela de banco de dados sincronizado para o pacote, onde cada chave é o nome da tabela de banco de dados. Ver synced_database_table.
volumes Mapa As definições de volume para o conjunto, onde cada chave é o nome do volume. Consulte volume (Catálogo Unity).

executar como

Type: Map

A identidade a ser usada ao executar fluxos de trabalho do Databricks Asset Bundles. Consulte Especificar uma identidade de execução para um workflow de Databricks Asset Bundles.

Chave Tipo Descrição
service_principal_name Cordão O ID da aplicação de um principal de serviço ativo. A definição deste campo requer a função servicePrincipal/user.
user_name Cordão O e-mail de um usuário ativo do espaço de trabalho. Os utilizadores não administradores só podem definir este campo para o seu próprio e-mail.

roteiros

Type: Map

Os scripts que podem ser executados usando bundle run. Consulte Executar scripts.

scripts:
  <script-name>:
    <script-field-name>: <script-field-value>
Chave Tipo Descrição
content Cordão Os comandos a serem executados

sincronização

Type: Map

Os arquivos e caminhos de arquivo a serem incluídos ou excluídos no pacote. Veja sync.

Chave Tipo Descrição
exclude Sequência Uma lista de arquivos ou pastas a serem excluídos do pacote.
include Sequência Uma lista de arquivos ou pastas a serem incluídos no pacote.
paths Sequência Os caminhos das pastas locais, que podem estar fora da raiz do pacote, devem ser sincronizados com o espaço de trabalho quando o pacote for implantado.

Objetivos

Type: Map

Define metas de implantação para o pacote. Veja objetivos

targets:
  <target-name>:
    <target-field-name>: <target-field-value>
Chave Tipo Descrição
artifacts Mapa Os artefatos a serem incluídos na implantação de destino. Veja artefatos.
bundle Mapa Os atributos do pacote quando se implanta neste destino. Ver pacote.
cluster_id Cordão O ID do cluster a ser usado para este destino.
compute_id Cordão Preterido. O ID da computação a utilizar para este destino.
default booleano Se esse destino é o destino padrão.
git Mapa As definições de controlo de versão do Git para o alvo. Veja git.
mode Cordão O modo de implantação para o destino alvo. Os valores válidos são development ou production. Consulte os modos de implantação do Databricks Asset Bundle .
permissions Sequência As permissões para implantar e executar o pacote no destino. Consulte as permissões.
presets Mapa As predefinições de implantação para o alvo. Consulte predefinições.
resources Mapa As definições de recursos para o alvo. Consulte os recursos.
run_as Mapa A identidade a ser usada para executar o pacote, consulte Especificar uma identidade de execução para um fluxo de trabalho do Databricks Asset Bundles. Veja run_as.
sync Mapa Os percursos locais para sincronizar com o espaço de trabalho de destino quando um pacote é executado ou implantado. Veja sync.
variables Mapa As definições de variáveis personalizadas para o destino. Veja variáveis.
workspace Mapa O espaço de trabalho Databricks para o alvo. Veja o espaço de trabalho.

variáveis

Type: Map

Define uma variável personalizada para o pacote. Veja variáveis.

variables:
  <variable-name>:
    <variable-field-name>: <variable-field-value>
Chave Tipo Descrição
default Qualquer O valor padrão para a variável.
description Cordão A descrição da variável.
lookup Mapa O nome do alert, cluster_policy, cluster, dashboard, instance_pool, job, metastore, pipeline, query, service_principalou warehouse objeto para o qual recuperar uma ID. Veja variáveis.nome.pesquisa.
type Cordão O tipo da variável, simples ou complexa. Defina essa chave somente se a variável for complexa. Valores válidos: complex.

variáveis. nome.lookup

Type: Map

O nome do alerta, cluster_policy, cluster, dashboard, instance_pool, tarefa, metastore, pipeline, consulta, principal de serviço, ou objeto de armazém para o qual recuperar um ID. Para obter informações sobre como usar a pesquisa, consulte Recuperar o valor de ID de um objeto.

Chave Tipo Descrição
alert Cordão O nome do alerta para o qual se deve recuperar o ID.
cluster Cordão O nome do cluster para o qual obter uma ID.
cluster_policy Cordão O nome do cluster_policy para o qual recuperar uma ID.
dashboard Cordão O nome do painel para o qual recuperar uma ID.
instance_pool Cordão O nome do grupo_de_instâncias para o qual recuperar um identificador.
job Cordão O nome da função para a qual recuperar um identificador.
metastore Cordão O nome do metastore para o qual recuperar uma ID.
notification_destination Cordão O nome do notification_destination para o qual recuperar uma ID.
pipeline Cordão O nome do pipeline para o qual recuperar uma ID.
query Cordão O nome da consulta para a qual recuperar uma ID.
service_principal Cordão O nome do service_principal para o qual recuperar uma ID.
warehouse Cordão O nome do depósito para o qual recuperar um ID.

área de trabalho

Type: Map

Define o espaço de trabalho Databricks para o pacote. Veja o espaço de trabalho.

Chave Tipo Descrição
artifact_path Cordão O caminho do artefato a ser utilizado no espaço de trabalho tanto para as implementações como para as execuções dos fluxos de trabalho.
auth_type Cordão O tipo de autenticação.
azure_client_id Cordão A ID do cliente do Azure
azure_environment Cordão O ambiente do Azure
azure_login_app_id Cordão A ID do aplicativo de logon do Azure
azure_tenant_id Cordão A ID do locatário do Azure
azure_use_msi booleano Se o MSI para Azure deve ser usado
azure_workspace_resource_id Cordão A ID do recurso do espaço de trabalho do Azure
client_id Cordão A ID do cliente para o espaço de trabalho
file_path Cordão O caminho do ficheiro para usar no espaço de trabalho tanto para desdobramentos como para a execução de fluxos de trabalho
google_service_account Cordão O nome da conta de serviço do Google
host Cordão O URL do anfitrião do espaço de trabalho Databricks
profile Cordão O nome do perfil do espaço de trabalho Databricks
resource_path Cordão O caminho do recurso do espaço de trabalho
root_path Cordão O caminho raiz do Databricks workspace
state_path Cordão O caminho do estado do espaço de trabalho

Objetos comuns

Git

Type: Map

Define os detalhes do controle de versão do git.

Chave Tipo Descrição
branch Cordão O nome do ramo Git. Veja git.
origin_url Cordão A URL de origem do repositório. Veja git.
  • Last updated on