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.

artefato

Define as configurações para criar um artefato.

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`	Mapa	Os arquivos de origem do artefato, definidos como artifact_file.
`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`.

artefatos

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.

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

Exemplo

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

arquivo_artefato

Define um arquivo de artefato em um pacote.

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

`bundle`

Os atributos do pacote. Veja o pacote.

Chave	Tipo	Descrição
`cluster_id`	String	O ID de um clustering a ser usado para executar o pacote. Veja clustering.
`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,Databricks consulte modos de implantação e ativo Bundle deployment.
`git`	Mapa	Os detalhes do controle de versão do Git que estão associados ao seu pacote. Para ver os atributos compatíveis, consulte git e git.
`name`	String	Obrigatório. O nome do pacote.

implantação

Define os atributos de 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 `true`, uma implantação em execução poderá ser interrompida.
`lock`	Mapa	Os atributos do bloqueio de implantação. Veja o cadeado.

experimental

Define os atributos do recurso experimental.

Chave	Tipo	Descrição
`python_wheel_wrapper`	Booleana	Se deve usar um wrapper Python wheel.
`scripts`	comando (strings)	O comando para a execução
`use_legacy_run_as`	Booleana	Se o comportamento de execução herdado deve ser usado.

git

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

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

conceder

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

Chave	Tipo	Descrição
`principal`	String	Obrigatório. O nome do diretor que receberá privilégios.
`privileges`	String	Obrigatório. Os privilégios a serem concedidos à entidade especificada.

Exemplo

O exemplo a seguir define um esquema do 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"

trancar

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

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

permissão

Define 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 `level`.
`level`	String	Obrigatório. 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 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 experimentos, trabalhos, pipelines e modelos definidos 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.

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 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 `PAUSED` ou `UNPAUSED`.

recurso

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.

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

Chave	Tipo	Descrição
`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. Ver 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 o esquema (Unity Catalog)
`volumes`	Mapa	As definições de volume do pacote, em que cada key é o nome do volume. Veja o volume (Unity Catalog )

execução

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

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.

alvo

Define metas de implantação para o pacote. Veja os 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 implantado nesse destino.
`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 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 as permissões.
`presets`	Mapa	As predefinições de implantação para o alvo. Veja as predefinições.
`resources`	Mapa	As definições de recurso para o alvo. Ver recurso.
`run_as`	Mapa	A identidade a ser usada para executar o pacote. Consulte execução e Especificar uma identidade de execução para um Databricks ativo Bundles fluxo de trabalho.
`sync`	Mapa	Os caminhos locais a serem sincronizados com o destino workspace quando um pacote é executado ou implantado. Consulte sincronização.
`variables`	Mapa	As definições de variáveis personalizadas para o alvo. Consulte Variáveis e Substituições e variáveis em Databricks ativo Bundles.
`workspace`	Mapa	O site Databricks workspace para o alvo. espaço de trabalho

variáveis

Um mapa que define as variáveis personalizadas do pacote, em que cada key é o nome da variável e o valor é um mapa que define a variável. Consulte Substituições e variáveis em Databricks ativo Bundles.

Chave	Tipo	Descrição
nome da variável	Mapa	A definição de uma variável. Veja variable-name.

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 objeto `alert`, `cluster_policy`, `cluster`, `dashboard`, `instance_pool`, `job`, `metastore`, `pipeline`, `query`, `service_principal` ou `warehouse` 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 endereço Databricks workspace para o pacote. Veja espaço de trabalho.

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	A ID do cliente do Azure.
`azure_environment`	String	O ambiente do Azure.
`azure_login_app_id`	String	A 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 para implantações e 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.