Referências de chaves API de definições

Esta página lista as definições disponíveis através da API pública Azure Databricks Settings, agrupadas por âmbito. Cada configuração é identificada por um nome de configuração estável (chave). Para saber como descobrir, ler e atualizar estas definições, consulte Gerir definições através da API de Definições.

As pré-visualizações de funcionalidades também são geridas através da API de Definições, mas não estão listadas aqui, porque são transitórias e eventualmente atingem o fim da vida útil. Descubra as pré-visualizações atualmente disponíveis através do endpoint de definições-metadados.

Configurações disponíveis

As seguintes definições estão disponíveis através da API pública de Definições, agrupadas por âmbito. Esta lista é gerada periodicamente; Para o conjunto autoritativo e sempre atual de definições e os seus links de documentação, chame ao endpoint de metadados de definições, que devolve os nameelementos de cada definição , description, type, e docs_link.

Configurações da conta

Definições que se aplicam a toda a conta.

Setting Nome da chave Description
Desativar funcionalidades legadas disable_legacy_features Desative funcionalidades legadas para novos espaços de trabalho Databricks. Para espaços de trabalho recém-criados: 1. Desativa o uso de raiz e montagens DBFS. 2. A Metastore da Colmeia 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 Controla se todo o acesso ao modelo de fundação deve passar pelo Unity Gateway. Quando ativadas, as permissões de acesso ao modelo, orçamentos de IA e políticas de segurança são geridas centralmente com o Unity Gateway, e todo o tráfego do modelo de fundação é obrigado a passar por ele. O modelo de fundação legado que serve endpoints que contornam o Unity Gateway rejeita o tráfego.
Recursos de IA impulsionados por parceiros llm_proxy_partner_powered Determina se os modelos alimentados por parceiros estão ativados ou não. Esta definição está disponível tanto ao nível da conta como do espaço de trabalho
Impor funcionalidades de IA impulsionadas por parceiros llm_proxy_partner_powered_enforce Determina se a configuração de imposição com forças de parceiro está ativada. Quando ativado, o valor potenciado pelo parceiro ao nível da conta sobrepõe-se a qualquer sobreposição ao nível do espaço de trabalho.
Restringir Administradores do Espaço de Trabalho restrict_workspace_admins A configuração Restringir administradores de espaço de trabalho permite controlar os recursos dos administradores de espaço de trabalho. Com o estado de definição definido para ALLOW_ALL, os administradores do espaço de trabalho podem criar tokens pessoais de acesso de principal de serviço em nome de qualquer principal de serviço no seu espaço de trabalho. Os administradores do espaço de trabalho também podem alterar o proprietário de um trabalho para qualquer usuário em seu espaço de trabalho. E podem alterar a função run_as definição para qualquer utilizador no seu espaço de trabalho ou para um principal de serviço onde tenham o papel de Utilizador Principal de Serviço. Com o estado de definição definido para RESTRICT_TOKENS_AND_JOB_RUN_AS, os administradores do espaço de trabalho só podem criar tokens de acesso pessoais em nome dos principais de serviço em que têm o papel de Utilizador Principal de Serviço. Eles também só podem mudar o responsável por um trabalho para eles próprios. E podem mudar a função run_as definição para si próprios ou para um principal de serviço no qual têm o papel de Utilizador Principal de Serviço.

Configurações de espaço de trabalho

Definiçõ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 Controla se a incorporação de dashboards publicada por IA/BI está ativada, condicionalmente ativada ou desativada ao nível do espaço de trabalho. Por defeito, esta definição está condicionalmente ativada (ALLOW_APPROVED_DOMAINS).
Domínios Aprovados para Incorporar Painéis de Controle de IA/BI aibi_dash_embed_ws_apprvd_domains Controla a lista de domínios aprovados para alojar os dashboards de IA/BI embutidos. A lista de domínios aprovados não pode ser alterada quando a política de acesso atual não está definida para ALLOW_APPROVED_DOMAINS.
Restringa os escopos OAuth para aplicações a valores selecionados allowedAppsUserApiScopes Restringir quais os escopos OAuth que os desenvolvedores de aplicações podem solicitar quando atuam em nome dos utilizadores. Especifique uma lista de escopos permitidos, ou use "*" para permitir todos os escopos suportados. Uma lista vazia desativa efetivamente a autorização do utilizador para aplicações.
Atualização automática do painel de instrumentos automatic_cluster_update A atualização automática de cluster garante que todos os clusters em um espaço de trabalho sejam atualizados periodicamente para a imagem mais recente do sistema operacional host e as atualizações de segurança. Os administradores de 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, armazéns SQL clássicos, Servidor de Modelos legado); Não se aplica à computação serverless. Ativar esta funcionalidade adiciona o add-on Enhanced Security and Compliance e requer o escalão de preços Premium.
Plataformas de colaboração permitidas collaboration_platform_connectivity Controla quais plataformas de colaboração externas (Slack e/ou Microsoft Teams) podem ligar-se a este espaço de trabalho. Por defeito, é ALLOW_ALL.
Permitir mensagens públicas em plataformas de colaboração collaboration_platform_message_visibility Quando ativado, os utilizadores podem escolher se as respostas da aplicação Databricks no Slack ou do Microsoft Teams são visíveis para o canal. Quando desativado, todas as respostas são obrigadas a ser privadas para o utilizador que solicita.
Acesso ao espaço de trabalho para pessoal da Databricks customerApprovedWSLoginExpirationTime Um horário específico após o qual o pessoal da Databricks pode deixar de entrar no seu espaço de trabalho. O tempo é formatado como YYYY-MM-DDTHH:MM:SSZ. Pode desativar completamente o acesso definindo um carimbo temporal no passado, como 1998-01-01T00:00:00.000Z. Permita o acesso indefinidamente usando uma cadeia vazia ou o valor indefiniteespecial .
Namespace padrão default_namespace_ws A API de definição de namespace por defeito permite aos utilizadores configurar o namespace predefinido para um espaço de trabalho Databricks.
Desativar acesso legado disable_legacy_access 'Desativar 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 através da federação da Metastore da Colmeia não é afetado). 2. Desabilita o modo de fallback no acesso a locais externos a partir do espaço de trabalho. 3. Desativar Databricks Versões em tempo de execução anteriores à 13.3LTS. Importante: esta definiçã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). Muda primeiro o catálogo predefinido para um catálogo do Unity Catalog.
Desativar raiz e montagens DBFS disable_legacy_dbfs Desativar 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 definição está desligada, toda a funcionalidade do DBFS está ativada e não são impostas restrições às versões de Runtime do Databricks. Esta configuração pode demorar até 20 minutos a entrar em vigor e requer o reinício manual de clusters de computação multiusos e warehouses SQL.
Ativar tipos de nós auto-flexíveis enableAutoNodeTypeFlexibility Quando ativados, os clusters neste espaço de trabalho podem lançar automaticamente em tipos de nós alternativos quando o tipo de nó solicitado não estiver disponível, melhorando a fiabilidade do lançamento durante faltas de capacidade.
Impor o Unity Gateway enforce_ai_gateway_v3_only Controla se todo o acesso ao modelo de fundação deve passar pelo Unity Gateway. Quando ativadas, as permissões de acesso ao modelo, orçamentos de IA e políticas de segurança são geridas centralmente com o Unity Gateway, e todo o tráfego do modelo de fundação é obrigado a passar por ele. O modelo de fundação legado que serve endpoints que contornam o Unity Gateway rejeita o tráfego.
Só permitir implementações de aplicações a partir do Git enforceGitAppDeployments Quando ativadas, as aplicações neste espaço de trabalho só podem ser implementadas a partir do Git.
Recursos de IA impulsionados por parceiros llm_proxy_partner_powered Determina se os modelos alimentados por parceiros estão ativados ou não. Esta definição está disponível tanto ao nível da conta como do espaço de trabalho
Missão Crítica mission_critical Oferece os mais elevados 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 reforçadas.
Permitir que repositórios exportem saída IPYNB reposIpynbResultsExportPermissions Controla se os utilizadores podem comprometer as saídas do notebook .ipynb em repositórios Git remotos no espaço de trabalho.
Restringir Administradores do Espaço de Trabalho restrict_workspace_admins A configuração Restringir administradores de espaço de trabalho permite controlar os recursos dos administradores de espaço de trabalho. Com o estado de definição definido para ALLOW_ALL, os administradores do espaço de trabalho podem criar tokens pessoais de acesso de principal de serviço em nome de qualquer principal de serviço no seu espaço de trabalho. Os administradores do espaço de trabalho também podem alterar o proprietário de um trabalho para qualquer usuário em seu espaço de trabalho. E podem alterar a função run_as definição para qualquer utilizador no seu espaço de trabalho ou para um principal de serviço onde tenham o papel de Utilizador Principal de Serviço. Com o estado de definição definido para RESTRICT_TOKENS_AND_JOB_RUN_AS, os administradores do espaço de trabalho só podem criar tokens de acesso pessoais em nome dos principais de serviço em que têm o papel de Utilizador Principal de Serviço. Eles também só podem mudar o responsável por um trabalho para eles próprios. E podem mudar a função run_as definição para si próprios ou para um principal de serviço no qual têm o papel de Utilizador Principal de Serviço.
Perfil de segurança de conformidade shield_csp_enablement_ws_db Controla se o perfil de segurança de conformidade está ativado para este espaço de trabalho. O perfil de segurança de conformidade fornece uma linha de base altamente segura (monitorização adicional, uma imagem de computação reforçada, tipos de instância impostos para encriptação entre nós e outros controlos) que facilita o cumprimento e gestão das normas de conformidade aplicáveis. A sua habilitação também permite permanentemente monitorização de segurança reforçada e atualização automática do cluster no espaço de trabalho, além de adicionar o add-on Enhanced Security and Compliance.
Monitorização de segurança melhorada shield_esm_enablement_ws_db Controla se a monitorização de segurança reforçada está ativada para este espaço de trabalho. A monitorização de segurança reforçada fornece uma imagem de computação reforçada e agentes adicionais de monitorização de segurança (monitorização da integridade de ficheiros, antivírus e análise de vulnerabilidades) que geram linhas de registo revisíveis. Aplica-se apenas aos recursos clássicos do plano de computação, não ao serverless. Se o perfil de segurança de conformidade estiver ativado no espaço de trabalho, esta definição é permanentemente aplicada.
Rótulo do Espaço de Trabalho workspace_label Uma etiqueta personalizada e um crachá de cor são exibidos ao lado do nome do espaço de trabalho na navegação superior da consola Databricks. Os administradores de espaços de trabalho podem usar esta configuração para distinguir visualmente espaços de trabalho entre os ambientes. O valor é um objeto com um label campo (cadeia de texto) e um color campo (um dos: coral, lemon, lime, turquoiseindigo, purple, ). pink Ambos os campos são cadeias vazias quando não há rótulo definido.

Preferências do utilizador

Definições que se aplicam a um utilizador numa conta.

Setting Nome da chave Description
Criar automaticamente a interação da sessão com o editor autoCreateSessionOnEditorInteraction Controla se uma sessão é criada automaticamente ao interagir com o editor.
Lançamento e Acoplamento Automáticos autoLaunchAndAttach Controla se os notebooks são automaticamente iniciados e ligados a clusters.
Confirmar Comando Eliminar confirmCommandDelete Controla se é necessária confirmação antes de eliminar um comando.
Criar novos recursos na pasta Rascunhos createNewAssetsInDraftsFolder Controla 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 Controla a criação de consultas e o comportamento de conversão no editor SQL unificado.
Unidade de Indentação Python Padrão defaultPythonIndentUnit Controla a unidade de indentação padrão em Python. Valores permitidos: 2, 4, ou '' (cadeia vazia por defeito).
Tema Escuro Personalizado do Editor editorCustomDarkTheme Controla 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 Controla o tema de luzes personalizado para o 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: números inteiros variam de 10 a 30.
Ativar Correção Rápida Automática Inline enableAutoInlineQuickFix Controla se as soluções rápidas inline são automaticamente sugeridas.
Ativar Correção Rápida Automática Inline Optar por Sair enableAutoInlineQuickFixOptOut Controlo de exclusão para soluções rápidas automáticas em linha.
Ativar Diagnóstico Automático de Gatilhos enableAutoTriggerDiagnose Controla se os diagnósticos são automaticamente acionados.
Ativar o Diagnóstico Automático de Gatilhos Optar por Excluir enableAutoTriggerDiagnoseOptOut Controlo de desistência para diagnósticos automáticos.
Ativar Disposição Centrada enableCenteredLayout Controla se o editor utiliza um layout centralizado.
Ativar Atalhos Clássicos enableClassicShortcuts Controla o modo de atalhos de teclado. Valores permitidos: default, classic.
Ativar Números de Comando enableCommandNumbers Controla se os números de comando são exibidos nos cadernos.
Ative as Conclusãos Enquanto Escreve enableCompletionsAsYouType Controla se as sugestões de autocompletar aparecem enquanto escreves.
Ativar o Piscar do Cursor enableCursorBlink Controla 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 Controla se pressionar Enter aceita sugestões de autocompletamento.
Ativar Passagem do Cursor para o Editor enableHoverForEditor Controla se as descrições de hover são mostradas no editor.
Ative a Sugestão Inline ao Escrever Optar por Sair enableInlineSuggestionAsYouTypeOptOut Desative o controlo para sugestões inline enquanto escreve.
Ativar Números de Linha enableLineNumbers Controla se os números das linhas são exibidos no editor.
Ativar Números de Linha V2 enableLineNumbersV2 Controla se os números das linhas são exibidos no editor (v2).
Ativar Line Wrap enableLineWrap Controla se o texto passa para a linha seguinte no editor.
Ativar o Cursor Multi do Mónaco enableMonacoMultiCursor Controla a tecla modificadora multicursor. Valores permitidos: alt, ctrlCmd.
Ativar Desativação do Depurador do Notebook enableNotebookDebuggerOptOut Controlo de opt-out para o depurador do notebook.
Ativar Toggle de Observabilidade Serverless enableServerlessObservabilityToggle O utilizador opta por Observabilidade Melhorada Serverless em Jobs quando a pré-visualização do espaço de trabalho está ativada.
Ativar Mostrar Estatísticas de Comando na Nova Interface da Célula enableShowCommandStatsInNewCellUi Controla se as estatísticas de comandos são apresentadas na nova interface da célula.
Ativar Títulos de Células Promovidas para Mostrar enableShowPromotedCellTitles Controla se os títulos das células promovidas são exibidos.
Ative Cotações Inteligentes enableSmartQuotes Controla se as citações inteligentes estão ativadas no editor.
Ativar separadores suaves para cadernos e ficheiros enableSoftTabsForNotebooksAndFiles Controla se os separadores são convertidos em espaços em cadernos e ficheiros.
Ativar o Realce de Erros da Sintaxe SQL enableSqlSyntaxErrorHighlighting Controla se os erros de sintaxe SQL são destacados.
Ativar a Mudança para o Modo de Comando Após a Execução enableSwitchToCommandModeAfterExecution Controla se o editor muda para o modo de comando após a execução da célula.
Ativar o Explorador Unificado de Árvore de Ficheiros enableUnifiedFileTreeExplorer Controla se o explorador unificado de ficheiros está ativado.
Foco enableUnifiedSchemaBrowserTreeExplorer Controla se o explorador unificado de árvore do navegador de esquemas está ativado.
Ativar Vega Lite Renderer enableVegaLiteRenderer Controla se o renderizador Vega-Lite está ativado para visualizações.
Ativar a opção de desativação do renderizador Vega Lite enableVegaLiteRendererOptOut Controlo de opt-out para o renderizador Vega-Lite.
Ativar a Etiqueta de Pré-visualização do Vega Lite Renderer enableVegaLiteRendererPreviewTag Controla se a etiqueta de pré-visualização do Vega-Lite renderer é mostrada.
Painel inferior estendido extendedBottomPanel Controla se o painel inferior estendido é exibido.
Fluxo de Lagos Novos Oleodutos a Monitorizar a Interface lakeflowNewPipelinesMonitoringUi Controla se a nova interface de monitorização dos pipelines Lakeflow está ativada.
Formato de Exportação Predefinido do Notebook notebookDefaultExportFormat Controla o formato de exportação predefinido para cadernos. Valores permitidos: SOURCE, JUPYTER.
Modo de Atalho de Seta de Opção optionArrowShortcutMode Controla o comportamento dos atalhos de teclado Opção+Seta. Valores permitidos: navigate, move.
Autoria Multificheiro em Pipelines pipelinesMultifileAuthoring Controla se a autoria multificheiro está ativada para pipelines.
Enviar Notificações por Email de Enviar Comentário sendCommentEmailNotifications Controla se são enviadas notificações por email para comentários.
Mostrar minimapa de execução da célula showCellExecutionMinimap Controla se o minimapa de execução da célula é exibido.
Prompt de Mostrar Pip para o Painel de Ambiente showPipToEnvironmentPanelPrompt Controla se deve mostrar pip ao painel de ambiente.
Conselheiro Show Spark showSparkAdvisor Controla se as sugestões de otimização do Spark são exibidas.
Dicas de Erro de Mostrar Faísca showSparkErrorTips Controla se são mostradas dicas úteis para erros do Spark.
Utilizador Ativa Realce de Erros no Formato Python userActivatesPythonFormatErrorHighlighting Controla se os erros de formatação em Python são destacados.
Utilizador Ativa Erro de Sintaxe em Python Destacando Optar por Sair userActivatesPythonSyntaxErrorHighlightingOptOut Controlo de opt-out para o realce de erro de sintaxe em Python.
O utilizador ativa a verificação de tipos em Python userActivatesPythonTypeChecking Controla se a verificação de tipos em Python está ativada.
Utilizador Ativa a Restauração de Snapshots userActivatesSnapshotRestore Controla se a funcionalidade de restauro de snapshots está ativada.
Limite padrão 1000 para novas consultas usqleDefaultQueryAutoLimit Controla o limite automático predefinido para consultas SQL no editor.

Recursos adicionais

  • Última atualização a