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.

artefato

Define as configurações para criar um artefato.

Chave	Tipo	Descrição
build	String	Um conjunto opcional de comandos de compilação para executar localmente antes da implantação.
executable	String	O tipo executável. Os valores válidos são bash, she cmd.
files	Mapa	O caminho relativo ou absoluto para os arquivos de artefato construídos, definido como artifact_file.
path	String	O caminho local do diretório para o artefato.
type	String	Necessário se o artefato for uma roda Python. O tipo do artefato. Os valores válidos são whl e jar.

artefatos

Define os atributos para construir artefatos, onde cada chave é o nome do artefato, e o valor é um Mapa que define as configurações de compilação de artefato . 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. Ver Definir configurações de artefato nos "Databricks Asset Bundles".

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

Exemplo

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

ficheiro_de_artefacto

Define um ficheiro de artefacto num pacote.

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

pacote

Os atributos do pacote. Consulte o pacote .

Chave	Tipo	Descrição
cluster_id	String	A ID de um cluster a ser usada para executar o pacote. Consulte cluster_id.
databricks_cli_version	String	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 implantação e modos de implantação do Databricks Asset Bundle.
git	Mapa	Os detalhes do controle de versão do Git associados ao seu pacote. Para obter os atributos suportados, consulte git e git.
name	String	Necessário. O nome do pacote.
uuid	String	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).

implantação

Define atributos de distribuição de pacotes.

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

Experimentais

Define os atributos para funcionalidades experimentais.

Chave	Tipo	Descrição
python_wheel_wrapper	Booleano	Se deve usar um invólucro de roda Python.
scripts	Comando (String)	Os comandos a serem executados
use_legacy_run_as	Booleano	Decidir se deve ser usado o comportamento herdado de run_as.

Git

Define os detalhes do controle de versão do Git associados ao pacote. Veja git.

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

subvenção

Define o acesso aos objetos do Unity Catalog. Para obter mais informações, consulte Conectar-se ao armazenamento e serviços de objetos na nuvem usando o Unity Catalog.

Chave	Tipo	Descrição
principal	String	Necessário. O nome do principal ao qual serão concedidos privilégios.
privileges	String	Necessário. Os privilégios a conceder à entidade especificada.

Exemplo

O exemplo a seguir define um esquema Unity Catalog com concessões:

resources:
  schemas:
    my_schema:
      name: test-schema
      grants:
        - principal: users
          privileges:
            - CAN_MANAGE
        - principal: my_team
          privileges:
            - CAN_READ
      catalog_name: main
      comment: "my schema with grants"

bloqueio

Define os atributos de bloqueio de implantação do pacote.

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

permissão

Define 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	String	O nome do grupo que tem a permissão definida em level.
level	String	Necessário. A permissão permitida para o utilizador, grupo ou principal de serviço é definida para esta permissão.
service_principal_name	String	O nome da entidade de serviço que tem a permissão configurada em level.
user_name	String	O nome do usuário que tem a permissão definida em level.

Permissões

Uma sequência que define as permissões a serem aplicadas a experiências, tarefas, pipelines e modelos 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.

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

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	String	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	String	Um status de pausa para aplicar a todos os gatilhos e agendamentos de trabalho. Os valores válidos são PAUSED ou UNPAUSED.

Recursos

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>s:
    <resource-name>:
      <resource-field-name>: <resource-field-value>

Chave	Tipo	Descrição
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. Veja o painel
experiments	Mapa	As definições do experimento para o pacote, onde cada chave é o nome do experimento. Veja o 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. Visualizar model_serving_endpoint
models	Mapa	As definições de modelo para o pacote, onde cada chave é o nome do modelo. Veja o modelo (legado)
pipelines	Mapa	As definições de pipeline do pacote, em que cada chave corresponde ao nome do pipeline. Veja processo
quality_monitors	Mapa	As definições do monitor de qualidade para o pacote, em que cada chave representa o nome do monitor de qualidade. Ver 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. Ver 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)
volumes	Mapa	As definições de volume para o conjunto, onde cada chave é o nome do volume. Ver volume (Catálogo Unity)

run_as

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

Chave	Tipo	Descrição
service_principal_name	String	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	String	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.

sincronização

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 da pasta local, que podem estar fora da raiz do pacote, para sincronizar com o espaço de trabalho quando o pacote é implantado.

público-alvo

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

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.
cluster_id	String	O ID do cluster a ser usado para este destino.
compute_id	String	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	String	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 permissões.
presets	Mapa	As predefinições de implantação para o alvo. Veja as predefinições .
resources	Mapa	As definições de recursos para o alvo. Veja os recursos.
run_as	Mapa	A identidade a ser usada para executar o pacote. Veja run_as e Especifique uma identidade de execução para um fluxo de trabalho do Databricks Asset Bundles.
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 e Substituições e variáveis em Databricks Asset Bundles.
workspace	Mapa	O espaço de trabalho Databricks para o alvo. espaço de trabalho

variáveis

Um Mapa que define as variáveis personalizadas para o pacote, onde cada chave é o nome da variável e o valor é um Mapa que define a variável. Consulte Substituições e variáveis em Databricks Asset Bundles.

Chave	Tipo	Descrição
nome da variável	Mapa	A definição de uma variável. Consulte a variável denominada.

nome da variável

Cada definição de variável tem os seguintes atributos:

Chave	Tipo	Descrição
description	String	A descrição da variável.
lookup	String	O nome do alert, cluster_policy, cluster, dashboard, instance_pool, job, metastore, pipeline, query, service_principalou warehouse objeto para o qual recuperar uma ID.
type	String	O tipo da variável. Os valores válidos são complex.

espaço de trabalho

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

Chave	Tipo	Descrição
artifact_path	String	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	String	O tipo de autenticação.
azure_client_id	String	A ID do cliente do Azure.
azure_environment	String	O ambiente do Azure.
azure_login_app_id	String	A ID do aplicativo de logon do Azure.
azure_tenant_id	String	O ID de inquilino do Azure.
azure_use_msi	Booleano	Utilizar MSI para o Azure.
azure_workspace_resource_id	String	O ID do recurso do espaço de trabalho do Azure.
client_id	String	O ID do cliente para o espaço de trabalho.
file_path	String	O caminho do ficheiro a ser utilizado no espaço de trabalho tanto para implantações como para execuções de fluxos de trabalho.
google_service_account	String	O nome da conta de serviço do Google.
host	String	A URL do host do espaço de trabalho Databricks.
profile	String	O nome do perfil do espaço de trabalho Databricks.
resource_path	String	O caminho do recurso do espaço de trabalho.
root_path	String	O caminho raiz do espaço de trabalho Databricks.
state_path	String	O caminho do estado do espaço de trabalho.