Referência de configuração

Este artigo fornece referência para a chave suportada por Databricks ativo Bundles configuration (YAML). Veja o que são Databricks ativo Bundles?

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

artefatos

Type: Map

Define os atributos para construir artefatos, em que cada key é o nome do artefato e o valor é um mapa que define as configurações de construção do artefato. Para obter informações sobre o mapeamento artifacts, consulte artefatos.

As configurações de artefato definidas no nível superior da configuração do pacote podem ser substituídas no mapeamento targets. Consulte Definir configurações de artefatos em Databricks ativo Bundles.

YAML

artifacts:
  <artifact-name>:
    <artifact-field-name>: <artifact-field-value>

Chave	Tipo	Descrição
build	String	Um conjunto opcional de comandos de compilação para execução local antes da implementação.
dynamic_version	Booleana	Se a versão da roda deve ser corrigida dinamicamente com base na data e hora do arquivo whl. Se isso for 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 está definido como whl. Veja artefatos.
executable	String	O tipo executável. Os valores válidos são bash, sh e cmd.
files	Sequência	O caminho relativo ou absoluto para os arquivos de artefatos criados. Veja artefatos. nome .files.
path	String	O caminho local do diretório para o artefato.
type	String	Obrigatório se o artefato for um Python wheel. O tipo do artefato. Os valores válidos são whl e jar.

Exemplo

YAML

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

artefatos. nome .files

Type: Sequence

O caminho relativo ou absoluto para os arquivos de artefatos criados.

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

pacote

Type: Map

Os atributos do pacote quando implantado nesse destino.

Chave	Tipo	Descrição
cluster_id	String	O ID de um clustering a ser usado para executar o pacote. Veja clustering.
compute_id	String	Obsoleto. O ID do site compute a ser usado para executar o pacote.
databricks_cli_version	String	A versão da CLI do Databricks a ser usada para o pacote. Veja CLI.
deployment	Mapa	A definição da implantação do pacote. Para conhecer os atributos compatíveis, consulte Databricks ativo Bundle deployment modes. Veja bundle.deployment.
git	Mapa	Os detalhes do controle de versão do Git que estão associados ao seu pacote. Para atributos compatíveis, consulte git. Veja bundle.git.
name	String	O nome do pacote.
uuid	String	Reservado. Um UUID (Universally Unique Identifier, identificador universal exclusivo) para o pacote que o identifica exclusivamente nos sistemas internos da Databricks. Isso é gerado quando um projeto de pacote é inicializado usando um padrão Databricks (usando o comando databricks bundle init).

pacote.implantação

Type: Map

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

Chave	Tipo	Descrição
fail_on_active_runs	Booleana	Se deve falhar na execução ativa. Se isso for definido como verdadeiro, uma implantação em execução poderá ser interrompida.
lock	Mapa	Os atributos do bloqueio de implantação. Veja bundle.deployment.lock.

bundle.deployment.lock

Type: Map

Os atributos do bloqueio de implantação.

Chave	Tipo	Descrição
enabled	Booleana	Se esse bloqueio está ativado.
force	Booleana	Se deve forçar esse bloqueio se ele estiver ativado.

pacote.git

Type: Map

Os detalhes do controle de versão do Git que estão associados ao seu pacote.

Chave	Tipo	Descrição
branch	String	O nome do ramo do Git. Veja git.
origin_url	String	O URL de origem do repositório. Veja git.

experimental

Type: Map

Define os atributos do recurso experimental.

Chave	Tipo	Descrição
python	Mapa	Configura o carregamento do código Python definido com o pacote 'databricks-bundles'. Veja experimental.Python.
python_wheel_wrapper	Booleana	Se deve usar um wrapper Python wheel.
scripts	Mapa	O comando para a execução.
use_legacy_run_as	Booleana	Se o comportamento de execução herdado deve ser usado.

experimental.Python

Type: Map

Configura o carregamento do código Python definido com o pacote 'databricks-bundles'.

Chave	Tipo	Descrição
mutators	Sequência	Mutators 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	recurso contém uma lista de caminhos de função totalmente qualificados para carregar o recurso definido no código Python, como ["my_project.resources:load_resources"]
venv_path	String	O VENVPath é o caminho para o ambiente virtual. Se ativado, o código Python será executado nesse ambiente. Se estiver desativado, o padrão será usar o interpretador Python disponível no site shell atual.

incluir

Type: Sequence

Especifica uma lista de globos 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 ao recurso definido no pacote, em que cada item da sequência é uma permissão para uma entidade específica.

Consulte permissões e Definir permissões para recurso em Databricks ativo Bundles.

Chave	Tipo	Descrição
group_name	String	O nome do grupo que tem a permissão definida em nível.
level	String	A permissão permitida para o usuário, o grupo e a entidade de serviço definidos para essa permissão. Os valores válidos para esse key são diferentes, dependendo do fato de as permissões serem definidas no nível superior do pacote ou para um recurso específico. Consulte Definir permissões para recurso em Databricks ativo Bundles.
service_principal_name	String	O nome da entidade de serviço que tem a permissão definida no nível.
user_name	String	O nome do usuário que tem a permissão definida em nível.

Exemplo

YAML

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 as predefinições de implantação do pacote. Consulte Predefinições personalizadas.

Chave	Tipo	Descrição
jobs_max_concurrent_runs	Integer	A execução máxima concorrente para um trabalho.
name_prefix	String	O prefixo para execução do trabalho do pacote.
pipelines_development	Booleana	Se as implantações de pipeline devem ser bloqueadas no modo de desenvolvimento.
source_linked_deployment	Booleana	Se deve vincular a implantação à origem do pacote.
tags	Mapa	As tags para a implantação do pacote.
trigger_pause_status	String	Um status de pausa a ser aplicado a todos os acionadores e programas de trabalho. Os valores válidos são pausa ou UNPAUSED.

recurso

Type: Map

Um mapa que define o recurso para o pacote, em que cada key é o nome do recurso e o valor é um mapa que define o recurso. Para obter mais informações sobre Databricks ativo Bundles supported recurso, e referência de definição de recurso, consulte Databricks ativo Bundles recurso.

YAML

resources:
  <resource-type>:
    <resource-name>:
      <resource-field-name>: <resource-field-value>

Chave	Tipo	Descrição
apps	Mapa	As definições do aplicativo Databricks para o pacote, em que cada key é o nome do aplicativo. Veja o aplicativo.
clusters	Mapa	As definições de clustering para o pacote, em que cada key é o nome de um clustering. Veja clustering.
dashboards	Mapa	As definições do painel para o pacote, em que cada key é o nome do painel. Veja o painel.
experiments	Mapa	As definições de experimento para o pacote, em que cada key é o nome do experimento. Veja o experimento.
jobs	Mapa	As definições de trabalho para o pacote, em que cada key é o nome do trabalho. Ver trabalho.
model_serving_endpoints	Mapa	As definições do servindo modelo endpoint para o pacote, onde cada key é o nome do servindo modelo endpoint. Veja model_serving_endpoint.
models	Mapa	As definições de modelo para o pacote, em que cada key é o nome do modelo. Veja o modelo (legado).
pipelines	Mapa	As definições de pipeline para o pacote, em que cada key é o nome do pipeline. Veja o pipeline.
quality_monitors	Mapa	As definições do monitor de qualidade para o pacote, em que cada key é o nome do monitor de qualidade. Consulte quality_monitor (Unity Catalog).
registered_models	Mapa	As definições do modelo registrado para o pacote, em que cada key é o nome do modelo registrado Unity Catalog. Consulte registered_model (Unity Catalog).
schemas	Mapa	As definições de esquema do pacote, em que cada key é o nome do esquema. Veja schema (Unity Catalog).
secret_scopes	Mapa	As definições do escopo secreto do pacote, em que cada key é o nome do escopo secreto. Veja secret_scope.
volumes	Mapa	As definições de volume para o pacote, em que cada key é o nome do volume. Veja o volume (Unity Catalog).

execução

Type: Map

A identidade a ser usada ao executar Databricks ativo Bundles fluxo de trabalho. Consulte Especificar uma identidade de execução para um Databricks ativo Bundles fluxo de trabalho.

Chave	Tipo	Descrição
service_principal_name	String	O ID do aplicativo de uma entidade de serviço ativa. A configuração desse campo exige a função servicePrincipal/user.
user_name	String	O email de um usuário ativo do workspace. Os usuários não administradores só podem definir esse campo como seu próprio email.

sincronizar

Type: Map

Os arquivos e caminhos de arquivo a serem incluídos ou excluídos no pacote. Consulte sincronização.

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 da pasta local, que podem estar fora da raiz do pacote, para sincronizar com o site workspace quando o pacote for implantado.

alvos

Type: Map

Define metas de implantação para o pacote. Veja os alvos

YAML

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 os alvos. nome .artefatos.
bundle	Mapa	Os atributos do pacote quando implantado nesse destino. Veja os alvos. nome .bundle.
cluster_id	String	A ID do clustering a ser usado para esse destino.
compute_id	String	Obsoleto. O ID do site compute a ser usado para esse alvo.
default	Booleana	Se esse alvo é o alvo default.
git	Mapa	As configurações de controle de versão do Git para o destino. Veja os alvos. nome .git.
mode	String	O modo de implantação para o alvo. Os valores válidos são development ou production. Consulte Databricks ativo Bundle deployment modes.
permissions	Sequência	As permissões para implantar e executar o pacote no destino. Veja os alvos. nome .permissions.
presets	Mapa	As predefinições de implantação para o alvo. Veja os alvos. nome .presets.
resources	Mapa	As definições de recurso para o alvo. Consulte targets. namerecurso.
run_as	Mapa	A identidade a ser usada para executar o pacote, consulte Especificar uma identidade de execução para um Databricks ativo Bundles fluxo de trabalho. Consulte targets. nameexecução.
sync	Mapa	Os caminhos locais a serem sincronizados com o destino workspace quando um pacote é executado ou implantado. Veja os alvos. nome .sync.
variables	Mapa	As definições de variáveis personalizadas para o alvo. Veja os alvos. nome .variáveis.
workspace	Mapa	O site Databricks workspace para o alvo. Consulte targets. name .workspace.

alvos. nome .artefatos

Type: Map

Os artefatos a serem incluídos na implantação de destino.

YAML

artifacts:
  <artifact-name>:
    <artifact-field-name>: <artifact-field-value>

Chave	Tipo	Descrição
build	String	Um conjunto opcional de comandos de compilação nãodefault para execução local antes da implementação.
executable	String	O tipo executável. Os valores válidos são bash, sh e cmd.
files	Sequência	Os arquivos de origem do artefato. Veja os alvos. nome .artefatos. nome .files.
path	String	O local onde o artefato construído será salvo.
type	String	Obrigatório. O tipo do artefato. Os valores válidos são whl.

alvos. nome .artefatos. nome .files

Type: Sequence

Os arquivos de origem do artefato.

Chave	Tipo	Descrição
source	String	Obrigatório. O caminho dos arquivos usados para criar o artefato.

alvos. nome .bundle

Type: Map

Os atributos do pacote quando implantado nesse destino.

Chave	Tipo	Descrição
cluster_id	String	O ID de um clustering a ser usado para executar o pacote. Veja clustering.
compute_id	String	Obsoleto. O ID do site compute a ser usado para executar o pacote.
databricks_cli_version	String	A versão da CLI do Databricks a ser usada para o pacote. Veja CLI.
deployment	Mapa	A definição da implantação do pacote. Para conhecer os atributos compatíveis, consulte Databricks ativo Bundle deployment modes. Veja os alvos. nome .bundle.deployment.
git	Mapa	Os detalhes do controle de versão do Git que estão associados ao seu pacote. Para atributos compatíveis, consulte git. Veja os alvos. nome .bundle.git.
name	String	O nome do pacote.
uuid	String	Reservado. Um UUID (Universally Unique Identifier, identificador universal exclusivo) para o pacote que o identifica exclusivamente nos sistemas internos da Databricks. Isso é gerado quando um projeto de pacote é inicializado usando um padrão Databricks (usando o comando databricks bundle init).

alvos. nome .bundle.deployment

Type: Map

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

Chave	Tipo	Descrição
fail_on_active_runs	Booleana	Se deve falhar na execução ativa. Se isso for definido como verdadeiro, uma implantação em execução poderá ser interrompida.
lock	Mapa	Os atributos do bloqueio de implantação. Veja os alvos. nome .bundle.deployment.lock .

alvos. nome .bundle.deployment.lock

Type: Map

Os atributos do bloqueio de implantação.

Chave	Tipo	Descrição
enabled	Booleana	Se esse bloqueio está ativado.
force	Booleana	Se deve forçar esse bloqueio se ele estiver ativado.

alvos. nome .bundle.git

Type: Map

Os detalhes do controle de versão do Git que estão associados ao seu pacote.

Chave	Tipo	Descrição
branch	String	O nome do ramo do Git. Veja git.
origin_url	String	O URL de origem do repositório. Veja git.

alvos. nome .git

Type: Map

As configurações de controle de versão do Git para o destino.

Chave	Tipo	Descrição
branch	String	O nome do ramo do Git. Veja git.
origin_url	String	O URL de origem do repositório. Veja git.

alvos. nome .permissions

Type: Sequence

As permissões para implantar e executar o pacote no destino.

Chave	Tipo	Descrição
group_name	String	O nome do grupo que tem a permissão definida em nível.
level	String	A permissão permitida para o usuário, o grupo e a entidade de serviço definidos para essa permissão.
service_principal_name	String	O nome da entidade de serviço que tem a permissão definida no nível.
user_name	String	O nome do usuário que tem a permissão definida em nível.

alvos. nome .presets

Type: Map

As predefinições de implantação para o alvo.

Chave	Tipo	Descrição
jobs_max_concurrent_runs	Integer	A execução máxima concorrente para um trabalho.
name_prefix	String	O prefixo para execução do trabalho do pacote.
pipelines_development	Booleana	Se as implantações de pipeline devem ser bloqueadas no modo de desenvolvimento.
source_linked_deployment	Booleana	Se deve vincular a implantação à origem do pacote.
tags	Mapa	As tags para a implantação do pacote.
trigger_pause_status	String	Um status de pausa a ser aplicado a todos os acionadores e programas de trabalho. Os valores válidos são pausa ou UNPAUSED.

targets .namerecurso

Type: Map

As definições de recurso para o alvo.

Chave	Tipo	Descrição
apps	Mapa	As definições do aplicativo Databricks para o pacote, em que cada key é o nome do aplicativo. Veja o aplicativo.
clusters	Mapa	As definições de clustering para o pacote, em que cada key é o nome de um clustering. Veja clustering.
dashboards	Mapa	As definições do painel para o pacote, em que cada key é o nome do painel. Veja o painel.
experiments	Mapa	As definições de experimento para o pacote, em que cada key é o nome do experimento. Veja o experimento.
jobs	Mapa	As definições de trabalho para o pacote, em que cada key é o nome do trabalho. Ver trabalho.
model_serving_endpoints	Mapa	As definições do servindo modelo endpoint para o pacote, onde cada key é o nome do servindo modelo endpoint. Veja model_serving_endpoint.
models	Mapa	As definições de modelo para o pacote, em que cada key é o nome do modelo. Veja o modelo (legado).
pipelines	Mapa	As definições de pipeline para o pacote, em que cada key é o nome do pipeline. Veja o pipeline.
quality_monitors	Mapa	As definições do monitor de qualidade para o pacote, em que cada key é o nome do monitor de qualidade. Consulte quality_monitor (Unity Catalog).
registered_models	Mapa	As definições do modelo registrado para o pacote, em que cada key é o nome do modelo registrado Unity Catalog. Consulte registered_model (Unity Catalog).
schemas	Mapa	As definições de esquema do pacote, em que cada key é o nome do esquema. Veja schema (Unity Catalog).
volumes	Mapa	As definições de volume para o pacote, em que cada key é o nome do volume. Veja o volume (Unity Catalog).

targets .nameexecução

Type: Map

A identidade a ser usada para executar o pacote.

Chave	Tipo	Descrição
service_principal_name	String	O ID do aplicativo de uma entidade de serviço ativa. A configuração desse campo exige a função servicePrincipal/user.
user_name	String	O email de um usuário ativo do workspace. Os usuários não administradores só podem definir esse campo como seu próprio email.

alvos. nome .sync

Type: Map

Os caminhos locais a serem sincronizados com o destino workspace quando um pacote é executado ou implantado.

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 da pasta local, que podem estar fora da raiz do pacote, para sincronizar com o site workspace quando o pacote for implantado.

alvos. nome .variáveis

Type: Map

As definições de variáveis personalizadas para o alvo.

YAML

variables:
  <variable-name>:
    <variable-field-name>: <variable-field-value>

Chave	Tipo	Descrição
default	Qualquer um	O valor default da variável. Se isso não for especificado,
description	String	A descrição da variável.
lookup	Mapa	O nome do objeto alerta, clustering, clustering, dashboard, instance_pool, Job, metastore, pipeline, query, serviço ou warehouse para o qual se deseja recuperar um ID. Veja os alvos. nome .variáveis. nome .lookup.
type	String	O tipo da variável.

alvos. nome .variáveis. nome .lookup

Type: Map

O nome do objeto alerta, clustering, clustering, dashboard, instance_pool, Job, metastore, pipeline, query, serviço ou warehouse para o qual se deseja recuperar um ID.

Chave	Tipo	Descrição
alert	String	O nome do alerta para o qual se deseja recuperar uma ID.
cluster	String	O nome do clustering para o qual se deseja recuperar uma ID.
cluster_policy	String	O nome do clustering para o qual se deseja recuperar uma ID.
dashboard	String	O nome do painel para o qual recuperar uma ID.
instance_pool	String	O nome do instance_pool para o qual recuperar um ID.
job	String	O nome do trabalho para o qual se deseja recuperar uma ID.
metastore	String	O nome da metastore para a qual recuperar uma ID.
notification_destination	String	O nome do notification_destination para o qual recuperar uma ID.
pipeline	String	O nome do pipeline para o qual se deseja recuperar uma ID.
query	String	O nome da consulta para a qual recuperar um ID.
service_principal	String	O nome do serviço para o qual o senhor deseja recuperar um ID.
warehouse	String	O nome do depósito para o qual recuperar uma ID.

targets .name .workspace

Type: Map

O site Databricks workspace para o alvo.

Chave	Tipo	Descrição
artifact_path	String	O caminho do artefato a ser usado no site workspace para implantações e fluxo de trabalho de execução
auth_type	String	O tipo de autenticação.
azure_client_id	String	O ID do cliente do Azure
azure_environment	String	O ambiente do Azure
azure_login_app_id	String	O ID do aplicativo de login do Azure
azure_tenant_id	String	O Azure tenant ID
azure_use_msi	Booleana	Se deve usar o MSI para o Azure
azure_workspace_resource_id	String	O Azure workspace recurso ID
client_id	String	O ID do cliente para o workspace
file_path	String	O caminho do arquivo a ser usado no site workspace tanto para implantações quanto para a execução do fluxo de trabalho
google_service_account	String	O nome do serviço do Google account
host	String	O URL do host Databricks workspace
profile	String	O nome do perfil Databricks workspace
resource_path	String	O caminho do recurso workspace
root_path	String	O caminho da raiz Databricks workspace
state_path	String	O caminho do estado workspace

variáveis

Type: Map

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

YAML

variables:
  <variable-name>:
    <variable-field-name>: <variable-field-value>

Chave	Tipo	Descrição
default	Qualquer um	O valor default da variável.
description	String	A descrição da variável
lookup	Mapa	O nome do objeto alert, cluster_policy, cluster, dashboard, instance_pool, job, metastore, pipeline, query, service_principal ou warehouse para o qual recuperar uma ID. Veja as variáveis. nome .lookup.
type	String	O tipo da variável.

variáveis. nome .lookup

Type: Map

O nome do objeto alerta, clustering, clustering, dashboard, instance_pool, Job, metastore, pipeline, query, serviço ou warehouse para o qual se deseja recuperar um ID.

Chave	Tipo	Descrição
alert	String	O nome do alerta para o qual se deseja recuperar uma ID.
cluster	String	O nome do clustering para o qual se deseja recuperar uma ID.
cluster_policy	String	O nome do clustering para o qual se deseja recuperar uma ID.
dashboard	String	O nome do painel para o qual recuperar uma ID.
instance_pool	String	O nome do instance_pool para o qual recuperar um ID.
job	String	O nome do trabalho para o qual se deseja recuperar uma ID.
metastore	String	O nome da metastore para a qual recuperar uma ID.
notification_destination	String	O nome da notification_desination para a qual recuperar um ID.
pipeline	String	O nome do pipeline para o qual se deseja recuperar uma ID.
query	String	O nome da consulta para a qual recuperar um ID.
service_principal	String	O nome do serviço para o qual o senhor deseja recuperar um ID.
warehouse	String	O nome do depósito para o qual recuperar uma ID.

workspace

Type: Map

Define o endereço Databricks workspace para o pacote. Veja workspace.

Chave	Tipo	Descrição
artifact_path	String	O caminho do artefato a ser usado no site workspace para implantações e fluxo de trabalho de execução
auth_type	String	O tipo de autenticação.
azure_client_id	String	O ID do cliente do Azure
azure_environment	String	O ambiente do Azure
azure_login_app_id	String	O ID do aplicativo de login do Azure
azure_tenant_id	String	O Azure tenant ID
azure_use_msi	Booleana	Se deve usar o MSI para o Azure
azure_workspace_resource_id	String	O Azure workspace recurso ID
client_id	String	O ID do cliente para o workspace
file_path	String	O caminho do arquivo a ser usado no site workspace tanto para implantações quanto para a execução do fluxo de trabalho
google_service_account	String	O nome do serviço do Google account
host	String	O URL do host Databricks workspace
profile	String	O nome do perfil Databricks workspace
resource_path	String	O caminho do recurso workspace
root_path	String	O caminho da raiz Databricks workspace
state_path	String	O caminho do estado workspace