Referência de chaves API de configurações

Esta página lista as configurações disponíveis pela API pública de Configurações do Azure Databricks, agrupadas por escopo. Cada configuração é identificada por um nome estável (chave). Para saber como descobrir, ler e atualizar essas configurações, veja Gerenciar configurações através da API de Configurações.

Prévias de recursos também são gerenciadas pela API de Configurações, mas não estão listadas aqui, pois são transitórias e eventualmente chegam ao fim da vida útil. Descubra as prévias atualmente disponíveis para você através do endpoint de configurações e metadados.

Configurações disponíveis

As seguintes configurações estão disponíveis pela API pública de Configurações, agrupadas por escopo. Essa lista é gerada periodicamente; Para o conjunto autoritativo e sempre atual de configurações e seus links de documentação, chame o endpoint de metadados de configurações, que retorna os namedados de cada configuração , description, type, e docs_link.

Configurações de conta

Configurações que se aplicam em toda a conta.

Setting Nome da chave Description
Desativar recursos legados disable_legacy_features Desative recursos legados para novos espaços de trabalho do Databricks. Para espaços de trabalho recém-criados: 1. Desativa o uso de root e montagens do DBFS. 2. A Metastore Hive não será provisionada. 3. Desabilita o uso de 'clusters sem isolamento'. 4 Desativar Databricks Versões em tempo de execução anteriores à 13.3LTS.
Impor o Unity Gateway enforce_ai_gateway_v3_only Determina se todo acesso ao modelo de fundação deve passar pelo Unity Gateway. Quando ativados, permissões de acesso ao modelo, orçamentos de IA e políticas de segurança são gerenciados centralmente pelo Unity Gateway, e todo o tráfego do modelo de fundação precisa passar por ele. Modelo legado de fundação que serve endpoints que contornam o Unity Gateway rejeita tráfego.
Recursos de IA impulsionados por parceiros llm_proxy_partner_powered Determina se modelos alimentados por parceiros são habilitados ou não. Essa configuração está disponível tanto no nível da conta quanto do workspace
Impor recursos de IA impulsionados por parceiros llm_proxy_partner_powered_enforce Determina se a configuração de aplicação de aplicação com base de parceiros está ativada. Quando ativado, o valor potenciado pelo parceiro em nível de conta prevalece sobre qualquer override em nível de workspace.
Restringa administradores de espaço de trabalho restrict_workspace_admins A configuração Restringir Administradores do Workspace permite controlar os recursos dos administradores do workspace. Com o status de configuração definido como ALLOW_ALL, administradores de workspace podem criar tokens pessoais de acesso de principal de serviço em nome de qualquer principal de serviço em seu espaço de trabalho. Os administradores do espaço de trabalho também podem alterar o responsável pelo trabalho para qualquer usuário em seu espaço de trabalho. E eles podem mudar a configuração run_as do trabalho para qualquer usuário em seu espaço de trabalho ou para um principal de serviço no qual possuem o papel de Usuário Principal de Serviço. Com o status de configuração definido como RESTRICT_TOKENS_AND_JOB_RUN_AS, administradores de workspace só podem criar tokens de acesso pessoais em nome dos principais de serviço que têm o papel de Usuário Principal de Serviço. Eles também só podem mudar um proprietário de trabalho para si mesmos. E eles podem mudar a função run_as configuração para si mesmos ou para um principal de serviço no qual tenham o papel de Usuário Principal de Serviço.

Configurações do workspace

Configurações que se aplicam a um único espaço de trabalho.

Setting Nome da chave Description
Política de Acesso de Incorporação de Dashboards de IA/BI aibi_dash_embed_ws_acc_policy Determina se a incorporação de dashboards publicada por IA/BI está ativada, condicionalmente habilitada ou desativada no nível do workspace. Por padrão, essa configuração é condicionalmente habilitada (ALLOW_APPROVED_DOMAINS).
Painel de IA/BI Incorporando Domínios Aprovados aibi_dash_embed_ws_apprvd_domains Controla a lista de domínios aprovados para hospedar os dashboards de IA/BI embarcados. A lista de domínios aprovados não pode ser alterada quando a política de acesso atual não está configurada para ALLOW_APPROVED_DOMAINS.
Restringa os escopos OAuth para aplicativos a valores selecionados allowedAppsUserApiScopes Restringir 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 suportados. Uma lista vazia efetivamente desativa a autorização do usuário para aplicativos.
Atualização automática do cluster automatic_cluster_update A atualização automática do cluster garante que todos os clusters de um workspace sejam atualizados periodicamente para a imagem mais recente do sistema operacional host e as atualizações de segurança. Os administradores da conta podem agendar a frequência da janela de manutenção, a data de início e a hora de início. Aplica-se à computação clássica (clusters, pools, warehouses SQL clássicos, Model Serving legado); Isso não se aplica à computação serverless. Ativar esse recurso adiciona o add-on Enhanced Security and Compliance e requer o segmento de preços Premium.
Plataformas de colaboração permitidas collaboration_platform_connectivity Determina quais plataformas externas de colaboração (Slack e/ou Microsoft Teams) podem se conectar a esse espaço de trabalho. O padrão é ALLOW_ALL.
Permitir mensagens públicas em plataformas de colaboração collaboration_platform_message_visibility Quando ativado, os usuários podem escolher se as respostas do aplicativo Databricks no Slack ou do Microsoft Teams são visíveis para o canal. Quando desativadas, todas as respostas são forçadas a serem privadas para o usuário solicitante.
Acesso ao espaço de trabalho para pessoal do Databricks customerApprovedWSLoginExpirationTime Um horário específico após o qual o pessoal do Databricks pode não mais fazer login no seu espaço de trabalho. O tempo é formatado como YYYY-MM-DDTHH:MM:SSZ. Você pode desabilitar completamente o acesso definindo para um carimbo de tempo no passado, como 1998-01-01T00:00:00.000Z. Ative o acesso indefinidamente usando uma string vazia ou o valor indefiniteespecial .
Namespace padrão default_namespace_ws A API padrão de configuração de namespace permite que os usuários configurem o namespace padrão para um workspace Databricks.
Desabilite o acesso legado disable_legacy_access 'Desabilitar o acesso legado' tem os seguintes impactos: 1. Desativa o acesso direto às Metastores da Colmeia a partir do espaço de trabalho (o acesso pela federação da Metastore da Colmeia não é afetado). 2. Desabilita o modo de fallback no acesso à localização externa do ambiente de trabalho. 3. Desativar Databricks Versões em tempo de execução anteriores à 13.3LTS. Importante: essa configuração não pode ser ativada enquanto o catálogo padrão do workspace estiver definido como catálogo legado (hive_metastore ou spark_catalog). Mude o catálogo padrão para um catálogo do Unity primeiro.
Desabilitar raiz e montagens do DBFS disable_legacy_dbfs Desabilitar o DBFS legado tem as seguintes duas implicações: 1. O acesso às montagens raiz e DBFS é proibido (assim como a criação de novas montagens). 2. Desativar Databricks Versões em tempo de execução anteriores à 13.3LTS. Quando a configuração está desativada, toda a funcionalidade do DBFS é ativada e nenhuma restrição é imposta às versões de Runtime do Databricks. Essa configuração pode levar até 20 minutos para entrar em vigor e requer a reinicialização manual de clusters de computação multiuso e warehouses SQL.
Habilitar tipos de nós auto-flexíveis enableAutoNodeTypeFlexibility Quando ativados, clusters nesse espaço de trabalho podem ser lançados automaticamente em tipos de nós alternativos quando o tipo solicitado não estiver disponível, melhorando a confiabilidade do lançamento durante a falta de capacidade.
Impor o Unity Gateway enforce_ai_gateway_v3_only Determina se todo acesso ao modelo de fundação deve passar pelo Unity Gateway. Quando ativados, permissões de acesso ao modelo, orçamentos de IA e políticas de segurança são gerenciados centralmente pelo Unity Gateway, e todo o tráfego do modelo de fundação precisa passar por ele. Modelo legado de fundação que serve endpoints que contornam o Unity Gateway rejeita tráfego.
Permitir implantações de aplicativos apenas pelo Git enforceGitAppDeployments Quando ativados, os aplicativos nesse espaço de trabalho só podem ser implantados a partir do Git.
Recursos de IA impulsionados por parceiros llm_proxy_partner_powered Determina se modelos alimentados por parceiros são habilitados ou não. Essa configuração está disponível tanto no nível da conta quanto do workspace
Missão Crítica mission_critical Oferece os mais altos níveis de resiliência operacional e segurança para cargas de trabalho críticas. Inclui recuperação de desastres e segurança e conformidade aprimoradas.
Permitir que repositórios exportem saída IPYNB reposIpynbResultsExportPermissions Controle se os usuários podem comprometer as saídas do notebook .ipynb em repositórios Git remotos no espaço de trabalho.
Restringa administradores de espaço de trabalho restrict_workspace_admins A configuração Restringir Administradores do Workspace permite controlar os recursos dos administradores do workspace. Com o status de configuração definido como ALLOW_ALL, administradores de workspace podem criar tokens pessoais de acesso de principal de serviço em nome de qualquer principal de serviço em seu espaço de trabalho. Os administradores do espaço de trabalho também podem alterar o responsável pelo trabalho para qualquer usuário em seu espaço de trabalho. E eles podem mudar a configuração run_as do trabalho para qualquer usuário em seu espaço de trabalho ou para um principal de serviço no qual possuem o papel de Usuário Principal de Serviço. Com o status de configuração definido como RESTRICT_TOKENS_AND_JOB_RUN_AS, administradores de workspace só podem criar tokens de acesso pessoais em nome dos principais de serviço que têm o papel de Usuário Principal de Serviço. Eles também só podem mudar um proprietário de trabalho para si mesmos. E eles podem mudar a função run_as configuração para si mesmos ou para um principal de serviço no qual tenham o papel de Usuário Principal de Serviço.
Perfil de segurança de conformidade shield_csp_enablement_ws_db Determina se o perfil de segurança de conformidade está ativado para esse espaço de trabalho. O perfil de segurança de conformidade fornece uma linha de base altamente segura (monitoramento adicional, uma imagem de computação reforçada, tipos de instância impostos para criptografia entre nós e outros controles) que facilita o cumprimento e o gerenciamento dos padrões de conformidade aplicáveis. Habilitá-lo também permite permanentemente monitoramento de segurança aprimorado e atualização automática do cluster no workspace, além de adicionar o add-on Enhanced Security and Compliance.
Monitoramento de segurança aprimorado shield_esm_enablement_ws_db Determina se o monitoramento de segurança aprimorado está ativado para esse espaço de trabalho. O monitoramento de segurança aprimorado fornece uma imagem computacional reforçada e agentes adicionais de monitoramento de segurança (monitoramento de integridade de arquivos, antivírus e varredura de vulnerabilidades) que geram linhas de logs revisáveis. Isso se aplica apenas aos recursos clássicos do plano de computação, não a serverless. Se o perfil de segurança de conformidade estiver ativado no workspace, essa configuração é permanentemente aplicada.
Rótulo do Workspace workspace_label Uma etiqueta personalizada e um crachá de cor exibidos ao lado do nome do espaço de trabalho na navegação superior do console Databricks. Administradores de espaços de trabalho podem usar essa configuração para distinguir visualmente espaços de trabalho entre ambientes. O valor é um objeto com um label campo (string de texto) e um color campo (um de: coral, lemon, lime, turquoiseindigo, purple, , ). pink Ambos os campos são cadeias vazias quando nenhum rótulo é definido.

Preferências do usuário

Configurações que se aplicam a um usuário em uma conta.

Setting Nome da chave Description
Criar automaticamente a interação da sessão com o editor autoCreateSessionOnEditorInteraction Controle se uma sessão é criada automaticamente ao interagir com o editor.
Lançamento e Acoplamento Automáticos autoLaunchAndAttach Controle se notebooks são iniciados e conectados automaticamente a clusters.
Confirmar Comando Excluir confirmCommandDelete Determina se a confirmação é necessária antes de excluir um comando.
Criar novos recursos na pasta Rascunhos createNewAssetsInDraftsFolder Controle se novos recursos são criados na pasta de rascunhos.
Databricks Unified SQL Editor Cria e Converte Consultas no Open Pref databricks-unified-sql-editor-create-and-convert-queries-on-open-pref Controle a criação de consultas e o comportamento de conversão no editor SQL unificado.
Unidade de Recuo padrão em Python defaultPythonIndentUnit Controla a unidade padrão de indentação em Python. Valores permitidos: 2, 4, ou '' (string vazia para padrão).
Tema Escuro Personalizado do Editor editorCustomDarkTheme Controle o tema escuro personalizado do editor. Valores permitidos: defaultTheme, Atom-One-Dark, Ayu-DarkBlackboard, Dracula, , GitHub-Dark, Monokai, One-Dark-Pro, . Winter-is-Coming-Dark
Tema de Luz Personalizado do Editor editorCustomLightTheme Controle o tema de luzes personalizadas do editor. Valores permitidos: defaultTheme, , Active4D, Atom-One-Light, Ayu-Light, GitHub-Light, , Tomorrow. Winter-is-Coming-Light
Tamanho da fonte do editor editorFontSize Controla o tamanho da fonte no editor. Valores permitidos: faixa inteira de 10 a 30.
Ativar Correção Rápida Automática Inline enableAutoInlineQuickFix Os controles são automaticamente sugeridos se soluções rápidas inline.
Ativar Correção Rápida Automática Inline Optar por Sair enableAutoInlineQuickFixOptOut Controle de desistência para correções rápidas automáticas em linha.
Ative o Diagnóstico Automático de Gatilhos enableAutoTriggerDiagnose Determina se os diagnósticos são acionados automaticamente.
Ativar o Diagnóstico Automático de Gatilhos Optar por Sair enableAutoTriggerDiagnoseOptOut Controle de opt-out para diagnósticos automáticos.
Habilitar o Layout Centralizado enableCenteredLayout Determina se o editor usa um layout centralizado.
Ativar Atalhos Clássicos enableClassicShortcuts Controla o modo atalhos de teclado. Valores permitidos: default, classic.
Habilitar Números de Comando enableCommandNumbers Controle se os números de comando são exibidos em cadernos.
Ative as Conclusãos Enquanto Digita enableCompletionsAsYouType Controle se as sugestões de autocompletar aparecem enquanto você digita.
Ativar o Cursor Blink enableCursorBlink Determina se o cursor pisca no editor.
Ativar o Modo Escuro enableDarkMode Controla o modo tema. Valores permitidos: light, dark, system.
Ativar Enter aceita sugestões enableEnterAcceptsSuggestions Determina se pressionar Enter aceita sugestões de autocompletamento.
Ativar o Passe do Mouse para o Editor enableHoverForEditor Controle se as dicas de hover são exibidas no editor.
Ative a Sugestão Inline ao digitar Optar por Sair enableInlineSuggestionAsYouTypeOptOut Desative o controle para sugestões inline enquanto você digita.
Ativar Números de Linha enableLineNumbers Controle se os números das linhas são exibidos no editor.
Habilitar Números de Linha V2 enableLineNumbersV2 Controle se os números das linhas são exibidos no editor (v2).
Ativar Enrolamento de Linha enableLineWrap Controla se o texto é enrolado para a próxima linha no editor.
Ativar o cursor múltiplo de Mônaco enableMonacoMultiCursor Controla a tecla modificadora multicursor. Valores permitidos: alt, ctrlCmd.
Ativar a opção de desativação do depurador de notebooks enableNotebookDebuggerOptOut Controle de opt-out para o depurador de notebooks.
Ativar a opção de Observabilidade Serverless enableServerlessObservabilityToggle O usuário opta por Observabilidade Aprimorada Serverless em Jobs quando a pré-visualização do workspace está ativada.
Ativar Mostrar Estatísticas de Comando na Nova Interface da Célula enableShowCommandStatsInNewCellUi Controla se as estatísticas de comandos são exibidas na nova interface da célula.
Ativar Títulos de Células Promovidas para Mostrar enableShowPromotedCellTitles Controle se títulos de células promovidos são exibidos.
Ative Cotações Inteligentes enableSmartQuotes Ele controla se as cotações inteligentes estão ativadas no editor.
Habilitar abas suaves para cadernos e arquivos enableSoftTabsForNotebooksAndFiles Controle se as tabulações são convertidas em espaços em cadernos e arquivos.
Ativar o Realce de Erros da Sintaxe SQL enableSqlSyntaxErrorHighlighting Controle se erros de sintaxe SQL são destacados.
Habilitar a Mudança para o Modo Comando Após a Execução enableSwitchToCommandModeAfterExecution Determina se o editor muda para o modo de comando após a execução da célula.
Ativar o Explorador Unificado de Árvore de Arquivos enableUnifiedFileTreeExplorer Determina se o explorador unificado de árvore de arquivos está ativado.
Foco enableUnifiedSchemaBrowserTreeExplorer Determina se o explorador unificado de árvores do navegador de esquemas está ativado.
Habilitar o Vega Lite Renderer enableVegaLiteRenderer Controle se o renderizador Vega-Lite está ativado para visualizações.
Ativar o Vega Lite Renderer Opt Out enableVegaLiteRendererOptOut Controle de opt-out para o renderizador Vega-Lite.
Ativar a Tag de Visualização do Vega Lite Renderer enableVegaLiteRendererPreviewTag Determina se a tag de visualização do Vega-Lite renderer é mostrada.
Painel inferior estendido extendedBottomPanel Controle se o painel inferior estendido é exibido.
Fluxo do Lago Monitorando Novos Dutos de Interface lakeflowNewPipelinesMonitoringUi Ele controla se a nova interface de monitoramento dos pipelines Lakeflow está ativada.
Formato padrão de exportação do notebook notebookDefaultExportFormat Controla o formato padrão de exportação para notebooks. Valores permitidos: SOURCE, JUPYTER.
Modo Atalho de Opção Seta optionArrowShortcutMode Controla o comportamento dos atalhos de teclado Opção+Seta. Valores permitidos: navigate, move.
Autoria Multifile em Pipelines pipelinesMultifileAuthoring Determina se a autoria multiarquivo está ativada para pipelines.
Enviar Notificações de Comentário por E-mail sendCommentEmailNotifications Controle se notificações por e-mail são enviadas para comentários.
Mostrar o minimapa de execução da célula showCellExecutionMinimap Determina se o minimapa de execução da célula é exibido.
Indicação de Mostrar Pip para o Painel de Ambiente showPipToEnvironmentPanelPrompt Controle se mostrar pip para o comando do painel de ambiente.
Conselheiro Show Spark showSparkAdvisor Controle se sugestões de otimização do Spark são exibidas.
Dicas de erro de faísca para mostrar showSparkErrorTips Determina se dicas úteis são mostradas para erros do Spark.
Usuário Ativa o Realce de Erros no Formato Python userActivatesPythonFormatErrorHighlighting Controle se erros de formatação em Python são destacados.
Usuário ativa erro de sintaxe em Python Destacando Optar por não userActivatesPythonSyntaxErrorHighlightingOptOut Controle de opt-out para o realce de erro de sintaxe em Python.
Usuário ativa a verificação de tipos em Python userActivatesPythonTypeChecking Ele controla se a verificação de tipos em Python está ativada.
Usuário Ativa Restauração de Snapshots userActivatesSnapshotRestore Determina se a funcionalidade de restauração de snapshots está ativada.
Limite padrão 1000 para novas consultas usqleDefaultQueryAutoLimit Ele controla o limite automático padrão para consultas SQL no editor.

Recursos adicionais

  • Última atualização em