Referência de chaves da API de configurações
Esta página lista as configurações disponíveis por meio da API de configurações pública do Databricks, agrupadas por escopo. Cada configuração é identificada por um nome de configuração (key) estável. Para saber como descobrir, ler e atualizar essas configurações, consulte Gerenciar configurações por meio da API de configurações.
Os pré-lançamentos de recursos também são gerenciados por meio da API de configurações, mas não estão listados aqui, pois são transitórios e eventualmente atingem o fim da vida útil. Descubra os pré-lançamentos atualmente disponíveis para você por meio do endpoint settings-metadata.
Configurações disponíveis
As seguintes configurações estão disponíveis por meio da API de configurações pública, agrupadas por escopo. Esta lista é gerada periodicamente; para obter o conjunto oficial e sempre atualizado de configurações e seus links de documentação, chame o endpoint settings-metadata, que retorna name, description, type e docs_link de cada configuração.
Configurações da account
Configurações aplicadas a toda a conta.
Contexto | Nome da key | Descrição |
|---|---|---|
| Desativar recursos legados para novos workspaces do Databricks. Para workspaces recém-criados: 1. Desativa o uso do DBFS root e das montagens. 2. O Hive Metastore não será provisionado. 3. Desativa o uso de "clusters sem isolamento". 4. Desativa as versões do Databricks Runtime anteriores à 13.3LTS. | |
| Determina se os modelos desenvolvidos por parceiros estão ativados ou não. Esta configuração está disponível nos níveis de account e de workspace | |
| Determina se a configuração de imposição de recursos oferecidos por parceiros está ativada. Quando ativado, o valor de recursos oferecidos por parceiros em nível de account substitui qualquer substituição em nível de workspace. | |
| A configuração Restringir administradores do workspace permite controlar as capacidades dos administradores do workspace. Com o status da configuração definido como ALLOW_ALL, os administradores do workspace podem criar tokens de acesso pessoal de service principal em nome de qualquer service principal em seu workspace. Os administradores do workspace também podem alterar o proprietário de um job para qualquer usuário em seu workspace. E eles podem alterar a configuração run_as do Job para qualquer usuário em seu Workspace ou para um Service Principal no qual tenham a função de Usuário da Service Principal. Com o status da configuração definido como RESTRICT_TOKENS_AND_JOB_RUN_AS, os administradores do Workspace só podem criar tokens de acesso pessoal em nome de Service Principal nos quais tenham a função de Usuário da Service Principal. Eles também só podem alterar o proprietário de um job para si mesmos. E eles podem alterar a configuração run_as do job para si mesmos ou para um service principal no qual tenham a função de Usuário da entidade de serviço. | |
| Controla se o perfil de segurança de compliance está habilitado por default para novos workspaces criados na account. O perfil de segurança de compliance oferece uma base altamente segura (monitoramento adicional, uma imagem de compute protegida, tipos de instância forçados e outros controles) que facilita o atendimento e o gerenciamento dos padrões de compliance aplicáveis. Quando habilitado como um default de account, o monitoramento de segurança aprimorado e a atualização automática de clusters também são habilitados para novos workspaces. | |
| Controla se o monitoramento de segurança aprimorado é habilitado por default para novos workspaces criados na account. O monitoramento de segurança aprimorado fornece uma imagem de compute protegida e agentes de monitoramento de segurança adicionais que geram linhas de log revisáveis. Se o perfil de segurança de compliance estiver habilitado para novos workspaces, essa configuração será aplicada permanentemente. O monitoramento de segurança aprimorado em nível de account é suportado apenas na AWS e no GCP. |
Configurações do workspace
Configurações que se aplicam a um único workspace.
Contexto | Nome da key | Descrição |
|---|---|---|
| Controla se a incorporação de painéis publicados do AI/BI está habilitada, habilitada condicionalmente ou desabilitada no nível do workspace. Por default, essa configuração é habilitada condicionalmente (ALLOW_APPROVED_DOMAINS). | |
| Controla a lista de domínios aprovados para hospedar os dashboards de AI/BI incorporados. A lista de domínios aprovados não pode ser alterada quando a política de acesso atual não estiver definida como ALLOW_APPROVED_DOMAINS. | |
| Restrinja quais escopos OAuth os desenvolvedores de aplicativos podem solicitar ao agir em nome dos usuários. Especifique uma lista de escopos permitidos ou use "*" para permitir todos os escopos compatíveis. Uma lista vazia desativa efetivamente a autorização do usuário para aplicativos. | |
| A atualização automática de clusters garante que todos os clusters em um workspace sejam atualizados periodicamente para a imagem do sistema operacional host e as atualizações de segurança mais recentes. Os administradores de account podem programar a frequência da janela de manutenção, a data de começar e o horário de começar. Aplica-se ao compute clássico (clusters, Pools, SQL Warehouse clássicos, Model Serving legado); não se aplica ao compute Serverless. A habilitação desse recurso adiciona o complemento de Segurança e Compliance Aprimoradas e requer o nível de preços Premium. | |
| Controla quais plataformas de colaboração externas (Slack e/ou Microsoft Teams) podem se conectar a este workspace. default é ALLOW_ALL. | |
| Quando ativado, os usuários podem escolher se as respostas do aplicativo Databricks no Slack ficam visíveis para o canal. Quando desativado, todas as respostas são forçadas a ser privadas para o usuário solicitante. | |
| Um horário específico após o qual o pessoal da Databricks não poderá mais fazer login no seu workspace. A hora está formatada como | |
| A API de configuração de namespace default permite que os usuários configurem o namespace default para um workspace do Databricks. | |
| 'Desativar o acesso legado' tem os seguintes impactos: 1. Desativa o acesso direto aos Hive Metastores a partir do workspace (o acesso por meio da federação de Hive Metastore não é afetado). 2. Desativa o modo fallback no acesso a localizações externas a partir do workspace. 3. Desativa as versões do Databricks Runtime anteriores à 13.3LTS. Importante: esta configuração não pode ser habilitada enquanto o catálogo default do workspace estiver definido como um catálogo legado (hive_metastore ou spark_catalog). Altere primeiro o catálogo default para um catálogo do Unity Catalog. | |
| Desativar o DBFS legado tem as duas implicações a seguir: 1. O acesso à DBFS root e às montagens do DBFS não é permitido (bem como a criação de novas montagens). 2. Desativa as versões do Databricks Runtime anteriores à 13.3LTS. Quando a configuração está desativada, todas as funcionalidades do DBFS são ativadas e não são impostas restrições às versões do Databricks Runtime. Esta configuração pode levar até 20 minutos para ser efetivada e exige um reinício manual dos clusters de compute multiuso e SQL Warehouse. | |
| Quando habilitado, os aplicativos neste workspace só podem ser implantados a partir do Git. | |
| Determina se os modelos desenvolvidos por parceiros estão ativados ou não. Esta configuração está disponível nos níveis de account e de workspace | |
| Oferece os mais altos níveis de resiliência operacional e segurança para cargas de trabalho críticas. Inclui recuperação de desastres, segurança aprimorada e compliance. | |
| Destinatário adicional para os e-mails operacionais deste workspace. Quando definido, o Databricks envia esses emails tanto para os administradores do workspace quanto para este endereço. Disponível na AWS e no GCP. | |
| A configuração Restringir administradores do workspace permite controlar as capacidades dos administradores do workspace. Com o status da configuração definido como ALLOW_ALL, os administradores do workspace podem criar tokens de acesso pessoal de service principal em nome de qualquer service principal em seu workspace. Os administradores do workspace também podem alterar o proprietário de um job para qualquer usuário em seu workspace. E eles podem alterar a configuração run_as do Job para qualquer usuário em seu Workspace ou para um Service Principal no qual tenham a função de Usuário da Service Principal. Com o status da configuração definido como RESTRICT_TOKENS_AND_JOB_RUN_AS, os administradores do Workspace só podem criar tokens de acesso pessoal em nome de Service Principal nos quais tenham a função de Usuário da Service Principal. Eles também só podem alterar o proprietário de um job para si mesmos. E eles podem alterar a configuração run_as do job para si mesmos ou para um service principal no qual tenham a função de Usuário da entidade de serviço. | |
| Controla se o perfil de segurança de compliance está habilitado para este Workspace. O perfil de segurança de conformidade fornece uma base altamente segura (monitoramento adicional, uma imagem de compute protegida, tipos de instância forçados para criptografia entre nós e outros controles) que facilita o atendimento e o gerenciamento dos padrões de compliance aplicáveis. Habilitá-lo também ativa permanentemente o monitoramento de segurança aprimorado e a atualização automática de clusters no workspace, e adiciona o add-on de Segurança e compliance Aprimoradas. | |
| Controla se o monitoramento de segurança aprimorado está habilitado para este workspace. O monitoramento de segurança aprimorado fornece uma imagem de compute protegida e agentes adicionais de monitoramento de segurança (monitoramento de integridade de arquivos, antivírus e verificação de vulnerabilidades) que geram linhas de log revisáveis. Aplica-se apenas a recursos do plano de compute clássico, não ao serverless. Se o perfil de segurança de compliance estiver habilitado no Workspace, essa configuração será aplicada permanentemente. |
Preferências do usuário
Configurações que se aplicam a um usuário em uma conta.
Contexto | Nome da key | Descrição |
|---|---|---|
Criar automaticamente a sessão na interação com o editor |
| Controla se uma sessão é criada automaticamente ao interagir com o editor. |
Iniciar e anexar automaticamente |
| Controla se os notebooks iniciam e se anexam automaticamente a clusters. |
Confirmar exclusão do comando |
| Controla se a confirmação é necessária antes de excluir um comando. |
Criar novos ativos na pasta Rascunhos |
| Controla se novos ativos são criados na pasta Rascunhos. |
Preferência de criação e conversão de queries ao abrir no editor SQL unificado do Databricks |
| Controla o comportamento de criação e conversão de query no editor SQL unificado. |
Unidade Default de indentação Python |
| Controla a unidade de indentação default do Python. Valores permitidos: |
Tema escuro personalizado do editor |
| Controla o tema escuro personalizado para o editor. Valores permitidos: |
Tema claro personalizado do editor |
| Controla o tema claro personalizado para o editor. Valores permitidos: |
Tamanho da fonte do editor |
| Controla o tamanho da fonte no editor. Valores permitidos: intervalo de inteiros de 10 a 30. |
Ativar correção rápida inline automática |
| Controla se as correções rápidas em linha são sugeridas automaticamente. |
Ativar a opção de desativação da correção rápida inline automática |
| Controle de desativação para correções rápidas inline automáticas. |
Ativar diagnóstico de trigger automático |
| Controla se os diagnósticos são Trigger automaticamente. |
Ativar a opção de desativação do diagnóstico de trigger automático |
| Controle de cancelamento de participação para diagnósticos automáticos. |
Habilitar disposição centralizada |
| Controla se o editor usa uma disposição centralizada. |
Ativar atalhos clássicos |
| Controla o modo de atalhos de teclado. Valores permitidos: |
Ativar números dos comandos |
| Controla se os números de comando são exibidos nos notebooks. |
Ativar preenchimentos conforme você digita |
| Controla se as sugestões de preenchimento automático aparecem conforme você digita. |
Ativar a intermitência do cursor |
| Controla se o cursor pisca no editor. |
Ativar o Dark Mode |
| Controla o modo do tema. Valores permitidos: |
Habilitar Enter para aceitar sugestões |
| Controla se pressionar Enter aceita sugestões de preenchimento automático. |
Ativar foco para o editor |
| Controla se as dicas de ferramenta ao passar o mouse são mostradas no editor. |
Ativar a opção de desativação de sugestão inline conforme você digita |
| Controle de desativação para sugestões inline conforme você digita. |
Ativar números das linhas |
| Controla se os números de linha são exibidos no editor. |
Ativar números das linhas V2 |
| Controla se os números de linha são exibidos no editor (v2). |
Habilitar quebra de linha |
| Controla se o texto é quebrado para a próxima linha no editor. |
Ativar o Multi Cursor do Monaco |
| Controla a tecla modificadora de vários cursores. Valores permitidos: |
Habilitar a opção de desativação do Notebook Debugger |
| Controle de desativação para o depurador de notebook. |
Habilitar alternância de observabilidade Serverless |
| Opt-in do usuário para a Observabilidade Serverless Aprimorada em Jobs quando a visualização do workspace estiver habilitada. |
Habilitar a exibição de estatísticas de comando na nova UI de células |
| Controla se as estatísticas de comando são mostradas na nova UI de células. |
Ativar Mostrar títulos de células promovidas |
| Controla se os títulos de células promovidas são exibidos. |
Ativar aspas inteligentes |
| Controla se as aspas inteligentes estão ativadas no editor. |
Ativar Soft Tabs para notebooks e arquivos |
| Controla se as tabs são convertidas em espaços em notebooks e arquivos. |
Ativar destaque de erro de sintaxe SQL |
| Controla se os erros de sintaxe SQL são realçados. |
Habilitar alternância para o Mode de comando após a execução |
| Controla se o editor muda para o modo de comando após a execução da célula. |
Habilitar o Unified File Tree Explorer |
| Controla se o explorador de árvore de arquivos unificado está habilitado. |
Focar |
| Controla se o explorador de árvore do navegador de esquemas unificado está ativado. |
Habilitar o renderizador Vega Lite |
| Controla se o renderizador Vega-Lite está habilitado para visualizações. |
Habilitar a opção de cancelar a participação no renderizador Vega Lite |
| Controle de cancelamento (opt-out) para o renderizador Vega-Lite. |
Ativar tag de pré-visualização do renderizador Vega Lite |
| Controla se a tag de pré-visualização do renderizador Vega-Lite é mostrada. |
Painel inferior expandido |
| Controla se o painel inferior estendido é exibido. |
Nova IU de monitoramento de pipelines do Lakeflow |
| Controla se a nova interface do usuário de monitoramento de LakeFlow Pipelines está habilitada. |
Formato de exportação default do Notebook |
| Controla o formato de exportação default para notebooks. Valores permitidos: |
Option Arrow Shortcut Mode |
| Controla o comportamento dos atalhos de teclado Option+Seta. Valores permitidos: |
Autoria de múltiplos arquivos de pipelines |
| Controla se a autoria de múltiplos arquivos está ativada para pipelines. |
Enviar notificações de comentários por email |
| Controla se as notificações por email são enviadas para comentários. |
Mostrar minimapa de execução de células |
| Controla se o minimapa de execução de células é exibido. |
Mostrar prompt do painel Pip para o ambiente |
| Controla se o prompt do pip para o painel de ambiente deve ser exibido. |
Mostrar o Spark Advisor |
| Controla se as sugestões de otimização do Spark são exibidas. |
Mostrar dicas de erro do Spark |
| Controla se dicas úteis são mostradas para erros do Spark. |
O usuário ativa o destaque de erros de formatação do Python |
| Controla se os erros de formatação do Python são realçados. |
O usuário ativa a opção de desativação do destaque de erros de sintaxe do Python |
| Controle de desativação para o destaque de erros de sintaxe do Python. |
O usuário ativa a verificação de tipo do Python |
| Controla se a verificação de tipo do Python está ativada. |
Usuário ativa a restauração de Snapshot |
| Controla se a funcionalidade de restauração de Snapshot está habilitada. |
Limite default de 1000 para novas queries |
| Controla o limite automático default para queries SQL no editor. |