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.
artifacts:
<artifact-name>:
<artifact-field-name>: <artifact-field-value>
Chave | Tipo | Descrição |
---|---|---|
| String | Um conjunto opcional de comandos de compilação para execução local antes da implementação. |
| 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 |
| String | O tipo executável. Os valores válidos são |
| Sequência | O caminho relativo ou absoluto para os arquivos de artefatos criados. Veja artefatos. nome .files. |
| String | O caminho local do diretório para o artefato. |
| String | Obrigatório se o artefato for um Python wheel. O tipo do artefato. Os valores válidos são |
Exemplo
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 |
---|---|---|
| String | Obrigatório. O arquivo de origem do artefato. |
pacote
Type: Map
Os atributos do pacote quando implantado nesse destino.
Chave | Tipo | Descrição |
---|---|---|
| String | O ID de um clustering a ser usado para executar o pacote. Veja clustering. |
| String | Obsoleto. O ID do site compute a ser usado para executar o pacote. |
| String | A versão da CLI do Databricks a ser usada para o pacote. Veja CLI. |
| Mapa | A definição da implantação do pacote. Para conhecer os atributos compatíveis, consulte Databricks ativo Bundle deployment modes. Veja bundle.deployment. |
| 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. |
| String | O nome do pacote. |
| 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 |
pacote.implantação
Type: Map
A definição da implantação do pacote
Chave | Tipo | Descrição |
---|---|---|
| Booleana | Se deve falhar na execução ativa. Se isso for definido como verdadeiro, uma implantação em execução poderá ser interrompida. |
| 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 |
---|---|---|
| Booleana | Se esse bloqueio está ativado. |
| 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 |
---|---|---|
| String | O nome do ramo do Git. Veja git. |
| String | O URL de origem do repositório. Veja git. |
experimental
Type: Map
Define os atributos do recurso experimental.
Chave | Tipo | Descrição |
---|---|---|
| Mapa | Configura o carregamento do código Python definido com o pacote 'databricks-bundles'. Veja experimental.Python. |
| Booleana | Se deve usar um wrapper Python wheel. |
| Mapa | O comando para a execução. |
| 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 |
---|---|---|
| Sequência | Mutators contém uma lista de caminhos de função totalmente qualificados para funções mutadoras, como |
| Sequência | recurso contém uma lista de caminhos de função totalmente qualificados para carregar o recurso definido no código Python, como |
| 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 |
---|---|---|
| String | O nome do grupo que tem a permissão definida em nível. |
| 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. |
| String | O nome da entidade de serviço que tem a permissão definida no nível. |
| String | O nome do usuário que tem a permissão definida em 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 as predefinições de implantação do pacote. Consulte Predefinições personalizadas.
Chave | Tipo | Descrição |
---|---|---|
| Integer | A execução máxima concorrente para um trabalho. |
| String | O prefixo para execução do trabalho do pacote. |
| Booleana | Se as implantações de pipeline devem ser bloqueadas no modo de desenvolvimento. |
| Booleana | Se deve vincular a implantação à origem do pacote. |
| Mapa | As tags para a implantação do pacote. |
| 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.
resources:
<resource-type>:
<resource-name>:
<resource-field-name>: <resource-field-value>
Chave | Tipo | Descrição |
---|---|---|
| Mapa | As definições do aplicativo Databricks para o pacote, em que cada key é o nome do aplicativo. Veja o aplicativo. |
| Mapa | As definições de clustering para o pacote, em que cada key é o nome de um clustering. Veja clustering. |
| Mapa | As definições do painel para o pacote, em que cada key é o nome do painel. Veja o painel. |
| Mapa | As definições de experimento para o pacote, em que cada key é o nome do experimento. Veja o experimento. |
| Mapa | As definições de trabalho para o pacote, em que cada key é o nome do trabalho. Ver trabalho. |
| Mapa | As definições do servindo modelo endpoint para o pacote, onde cada key é o nome do servindo modelo endpoint. Veja model_serving_endpoint. |
| Mapa | As definições de modelo para o pacote, em que cada key é o nome do modelo. Veja o modelo (legado). |
| Mapa | As definições de pipeline para o pacote, em que cada key é o nome do pipeline. Veja o pipeline. |
| 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). |
| 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). |
| Mapa | As definições de esquema do pacote, em que cada key é o nome do esquema. Veja schema (Unity Catalog). |
| Mapa | As definições do escopo secreto do pacote, em que cada key é o nome do escopo secreto. Veja secret_scope. |
| 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 |
---|---|---|
| String | O ID do aplicativo de uma entidade de serviço ativa. A configuração desse campo exige a função |
| 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 |
---|---|---|
| Sequência | Uma lista de arquivos ou pastas a serem excluídos do pacote. |
| Sequência | Uma lista de arquivos ou pastas a serem incluídos no pacote. |
| 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
targets:
<target-name>:
<target-field-name>: <target-field-value>
Chave | Tipo | Descrição |
---|---|---|
| Mapa | Os artefatos a serem incluídos na implantação de destino. Veja os alvos. nome .artefatos. |
| Mapa | Os atributos do pacote quando implantado nesse destino. Veja os alvos. nome .bundle. |
| String | A ID do clustering a ser usado para esse destino. |
| String | Obsoleto. O ID do site compute a ser usado para esse alvo. |
| Booleana | Se esse alvo é o alvo default. |
| Mapa | As configurações de controle de versão do Git para o destino. Veja os alvos. nome .git. |
| String | O modo de implantação para o alvo. Os valores válidos são |
| Sequência | As permissões para implantar e executar o pacote no destino. Veja os alvos. nome .permissions. |
| Mapa | As predefinições de implantação para o alvo. Veja os alvos. nome .presets. |
| Mapa | As definições de recurso para o alvo. Consulte targets. namerecurso. |
| 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. |
| Mapa | Os caminhos locais a serem sincronizados com o destino workspace quando um pacote é executado ou implantado. Veja os alvos. nome .sync. |
| Mapa | As definições de variáveis personalizadas para o alvo. Veja os alvos. nome .variáveis. |
| 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.
artifacts:
<artifact-name>:
<artifact-field-name>: <artifact-field-value>
Chave | Tipo | Descrição |
---|---|---|
| String | Um conjunto opcional de comandos de compilação nãodefault para execução local antes da implementação. |
| String | O tipo executável. Os valores válidos são |
| Sequência | Os arquivos de origem do artefato. Veja os alvos. nome .artefatos. nome .files. |
| String | O local onde o artefato construído será salvo. |
| String | Obrigatório. O tipo do artefato. Os valores válidos são |
alvos. nome .artefatos. nome .files
Type: Sequence
Os arquivos de origem do artefato.
Chave | Tipo | Descrição |
---|---|---|
| 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 |
---|---|---|
| String | O ID de um clustering a ser usado para executar o pacote. Veja clustering. |
| String | Obsoleto. O ID do site compute a ser usado para executar o pacote. |
| String | A versão da CLI do Databricks a ser usada para o pacote. Veja CLI. |
| 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. |
| 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. |
| String | O nome do pacote. |
| 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 |
alvos. nome .bundle.deployment
Type: Map
A definição da implantação do pacote
Chave | Tipo | Descrição |
---|---|---|
| Booleana | Se deve falhar na execução ativa. Se isso for definido como verdadeiro, uma implantação em execução poderá ser interrompida. |
| 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 |
---|---|---|
| Booleana | Se esse bloqueio está ativado. |
| 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 |
---|---|---|
| String | O nome do ramo do Git. Veja git. |
| 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 |
---|---|---|
| String | O nome do ramo do Git. Veja git. |
| 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 |
---|---|---|
| String | O nome do grupo que tem a permissão definida em nível. |
| String | A permissão permitida para o usuário, o grupo e a entidade de serviço definidos para essa permissão. |
| String | O nome da entidade de serviço que tem a permissão definida no nível. |
| 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 |
---|---|---|
| Integer | A execução máxima concorrente para um trabalho. |
| String | O prefixo para execução do trabalho do pacote. |
| Booleana | Se as implantações de pipeline devem ser bloqueadas no modo de desenvolvimento. |
| Booleana | Se deve vincular a implantação à origem do pacote. |
| Mapa | As tags para a implantação do pacote. |
| 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 |
---|---|---|
| Mapa | As definições do aplicativo Databricks para o pacote, em que cada key é o nome do aplicativo. Veja o aplicativo. |
| Mapa | As definições de clustering para o pacote, em que cada key é o nome de um clustering. Veja clustering. |
| Mapa | As definições do painel para o pacote, em que cada key é o nome do painel. Veja o painel. |
| Mapa | As definições de experimento para o pacote, em que cada key é o nome do experimento. Veja o experimento. |
| Mapa | As definições de trabalho para o pacote, em que cada key é o nome do trabalho. Ver trabalho. |
| Mapa | As definições do servindo modelo endpoint para o pacote, onde cada key é o nome do servindo modelo endpoint. Veja model_serving_endpoint. |
| Mapa | As definições de modelo para o pacote, em que cada key é o nome do modelo. Veja o modelo (legado). |
| Mapa | As definições de pipeline para o pacote, em que cada key é o nome do pipeline. Veja o pipeline. |
| 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). |
| 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). |
| Mapa | As definições de esquema do pacote, em que cada key é o nome do esquema. Veja schema (Unity Catalog). |
| 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 |
---|---|---|
| String | O ID do aplicativo de uma entidade de serviço ativa. A configuração desse campo exige a função |
| 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 |
---|---|---|
| Sequência | Uma lista de arquivos ou pastas a serem excluídos do pacote. |
| Sequência | Uma lista de arquivos ou pastas a serem incluídos no pacote. |
| 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.
variables:
<variable-name>:
<variable-field-name>: <variable-field-value>
Chave | Tipo | Descrição |
---|---|---|
| Qualquer um | O valor default da variável. Se isso não for especificado, |
| String | A descrição da variável. |
| 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. |
| 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 |
---|---|---|
| String | O nome do alerta para o qual se deseja recuperar uma ID. |
| String | O nome do clustering para o qual se deseja recuperar uma ID. |
| String | O nome do clustering para o qual se deseja recuperar uma ID. |
| String | O nome do painel para o qual recuperar uma ID. |
| String | O nome do instance_pool para o qual recuperar um ID. |
| String | O nome do trabalho para o qual se deseja recuperar uma ID. |
| String | O nome da metastore para a qual recuperar uma ID. |
| String | O nome do notification_destination para o qual recuperar uma ID. |
| String | O nome do pipeline para o qual se deseja recuperar uma ID. |
| String | O nome da consulta para a qual recuperar um ID. |
| String | O nome do serviço para o qual o senhor deseja recuperar um ID. |
| 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 |
---|---|---|
| String | O caminho do artefato a ser usado no site workspace para implantações e fluxo de trabalho de execução |
| String | O tipo de autenticação. |
| String | O ID do cliente do Azure |
| String | O ambiente do Azure |
| String | O ID do aplicativo de login do Azure |
| String | O Azure tenant ID |
| Booleana | Se deve usar o MSI para o Azure |
| String | O Azure workspace recurso ID |
| String | O ID do cliente para o workspace |
| String | O caminho do arquivo a ser usado no site workspace tanto para implantações quanto para a execução do fluxo de trabalho |
| String | O nome do serviço do Google account |
| String | O URL do host Databricks workspace |
| String | O nome do perfil Databricks workspace |
| String | O caminho do recurso workspace |
| String | O caminho da raiz Databricks workspace |
| String | O caminho do estado workspace |
variáveis
Type: Map
Define uma variável personalizada para o pacote. Veja as variáveis.
variables:
<variable-name>:
<variable-field-name>: <variable-field-value>
Chave | Tipo | Descrição |
---|---|---|
| Qualquer um | O valor default da variável. |
| String | A descrição da variável |
| Mapa | O nome do objeto |
| 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 |
---|---|---|
| String | O nome do alerta para o qual se deseja recuperar uma ID. |
| String | O nome do clustering para o qual se deseja recuperar uma ID. |
| String | O nome do clustering para o qual se deseja recuperar uma ID. |
| String | O nome do painel para o qual recuperar uma ID. |
| String | O nome do instance_pool para o qual recuperar um ID. |
| String | O nome do trabalho para o qual se deseja recuperar uma ID. |
| String | O nome da metastore para a qual recuperar uma ID. |
| String | O nome da notification_desination para a qual recuperar um ID. |
| String | O nome do pipeline para o qual se deseja recuperar uma ID. |
| String | O nome da consulta para a qual recuperar um ID. |
| String | O nome do serviço para o qual o senhor deseja recuperar um ID. |
| 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 |
---|---|---|
| String | O caminho do artefato a ser usado no site workspace para implantações e fluxo de trabalho de execução |
| String | O tipo de autenticação. |
| String | O ID do cliente do Azure |
| String | O ambiente do Azure |
| String | O ID do aplicativo de login do Azure |
| String | O Azure tenant ID |
| Booleana | Se deve usar o MSI para o Azure |
| String | O Azure workspace recurso ID |
| String | O ID do cliente para o workspace |
| String | O caminho do arquivo a ser usado no site workspace tanto para implantações quanto para a execução do fluxo de trabalho |
| String | O nome do serviço do Google account |
| String | O URL do host Databricks workspace |
| String | O nome do perfil Databricks workspace |
| String | O caminho do recurso workspace |
| String | O caminho da raiz Databricks workspace |
| String | O caminho do estado workspace |