Impostazioni riferimento delle chiavi API

Questa pagina elenca le impostazioni disponibili tramite l'API pubblica Azure Databricks Settings, raggruppate per ambito. Ogni impostazione è identificata da un nome stabile ( chiave). Per scoprire come scoprire, leggere e aggiornare queste impostazioni, consulta Gestisci le impostazioni tramite l'API delle Impostazioni.

Le anteprime delle funzionalità sono gestite anche tramite l'API Settings ma non sono elencate qui, perché sono transitorie e alla fine raggiungono la fine della vita. Scopri le anteprime attualmente disponibili tramite l'endpoint delle impostazioni e dei metadati.

Impostazioni disponibili

Le seguenti impostazioni sono disponibili tramite l'API pubblica delle Impostazioni, raggruppate per ambito. Questa lista viene generata periodicamente; Per l'insieme autorevole e sempre attuale di impostazioni e i loro link alla documentazione, chiama l'endpoint Settings-Metadata, che restituisce i namedati di ciascuna impostazione , description, type, e docs_link.

Impostazioni dell'account

Impostazioni che si applicano a tutto l'account.

Setting Nome chiave Description
Disabilita le funzionalità legacy disable_legacy_features Disabilita le funzionalità legacy per i nuovi workspace Databricks. Per spazi di lavoro appena creati: 1. Disabilita l'uso delle radici e delle montature DBFS. 2. Il Metastore dell'alveare non sarà fornito. 3. Disabilita l'uso dei 'cluster senza isolamento'. 4. Disabilita Databricks Le versioni di runtime precedenti alla 13.3LTS.
Funzionalità di intelligenza artificiale in collaborazione con partner llm_proxy_partner_powered Determina se i modelli alimentati da partner sono abilitati o meno. Questa impostazione è disponibile sia a livello di account che di workspace
Imporre funzionalità di IA basate sui partner llm_proxy_partner_powered_enforce Determina se l'impostazione di applicazione del partner è attiva. Quando abilitato, il valore potenziato dal partner a livello di account prevale su qualsiasi override a livello di workspace.
Limita gli amministratori dello spazio di lavoro restrict_workspace_admins L'impostazione Limita amministratori area di lavoro consente di controllare le funzionalità degli amministratori dell'area di lavoro. Con lo stato impostato su ALLOW_ALL, gli amministratori dello spazio di lavoro possono creare token di accesso personali per il principale di servizio per conto di qualsiasi principale di servizio presente nel proprio spazio. Gli amministratori dell'area di lavoro possono anche assegnare un nuovo utente come proprietario dell'attività nella propria area di lavoro. E possono cambiare l'impostazione del lavoro run_as a qualsiasi utente nel loro workspace o a un principale di servizio su cui hanno il ruolo di Service Principal User. Con lo stato impostato su RESTRICT_TOKENS_AND_JOB_RUN_AS, gli amministratori dello spazio di lavoro possono creare token di accesso personali solo per conto dei principali del servizio su cui hanno il ruolo di Utente Principale del Servizio. Possono cambiare il proprietario di un lavoro solo in se stessi. E possono cambiare il ruolo run_as impostazione per sé stessi o per un principale di servizio su cui hanno il ruolo di Service Principal User.

Impostazioni dell'area di lavoro

Impostazioni che si applicano a un singolo spazio di lavoro.

Setting Nome chiave Description
Politica di Accesso Incorporato AI e BI Dashboard aibi_dash_embed_ws_acc_policy Controlla se l'embedding pubblicato da AI/BI è abilitato, abilitato condizionalmente o disabilitato a livello di workspace. Di default, questa impostazione è abilitata condizionalmente (ALLOW_APPROVED_DOMAINS).
Incorporamento di domini approvati da Dashboard AI/BI aibi_dash_embed_ws_apprvd_domains Controlla l'elenco dei domini approvati per ospitare i dashboard AI/BI incorporati. La lista dei domini approvati non può essere modificata quando la politica di accesso attuale non è impostata su ALLOW_APPROVED_DOMAINS.
Limita gli scope OAuth per le app a valori selezionati allowedAppsUserApiScopes Limitare quali ambiti OAuth gli sviluppatori di app possono richiedere quando agiscono per conto degli utenti. Specifica un elenco di ambiti consentiti, oppure usa "*" per consentire tutti i telescopi supportati. Una lista vuota disabilita di fatto l'autorizzazione utente per le app.
Aggiornamento automatico del cluster automatic_cluster_update L'aggiornamento automatico del cluster garantisce che tutti i cluster in un'area di lavoro vengano aggiornati periodicamente all'immagine del sistema operativo host e agli aggiornamenti della sicurezza più recenti. Gli amministratori dell'account possono pianificare la frequenza della finestra di manutenzione, la data di inizio e l'ora di inizio. Si applica al calcolo classico (cluster, pool, classic SQL warehouse, legacy Model Serving); Non si applica al calcolo serverless. Abilitare questa funzione aggiunge l'add-on Enhanced Security and Compliance e richiede la fascia di prezzo Premium.
Piattaforme di collaborazione consentite collaboration_platform_connectivity Controlla quali piattaforme di collaborazione esterne (Slack e/o Microsoft Teams) possono collegarsi a questo spazio di lavoro. Di default è ALLOW_ALL.
Consentire messaggi pubblici nelle piattaforme di collaborazione collaboration_platform_message_visibility Quando attivato, gli utenti possono scegliere se le risposte dall'app Databricks su Slack o Microsoft Teams sono visibili al canale. Quando disabilitate, tutte le risposte sono obbligate a rimanere private per l'utente richiedente.
Accesso allo spazio di lavoro per il personale Databricks customerApprovedWSLoginExpirationTime Un orario specifico dopo il quale il personale Databricks potrebbe non accedere più al tuo spazio di lavoro. Il tempo è formattato come YYYY-MM-DDTHH:MM:SSZ. Puoi disabilitare completamente l'accesso impostandolo su un timestamp nel passato, come 1998-01-01T00:00:00.000Zad esempio . Abilita l'accesso indefinitamente usando una stringa vuota o il valore indefinitespeciale .
Spazio dei nomi predefinito default_namespace_ws L'API predefinita per l'impostazione dello spazio dei nomi consente agli utenti di configurare lo spazio dei nomi predefinito per uno spazio di lavoro Databricks.
Disabilita l'accesso legacy disable_legacy_access 'Disabilitare l'accesso legacy' ha i seguenti impatti: 1. Disabilita l'accesso diretto agli Hive Metastore dallo spazio di lavoro (l'accesso tramite la federazione degli Hive Metastore non è influenzato). 2. Disabilita la modalità di fallback per l'accesso a posizioni esterne dallo spazio di lavoro. 3. Disabilita Databricks Le versioni di runtime precedenti alla 13.3LTS. Importante: questa impostazione non può essere abilitata mentre il catalogo predefinito dello spazio di lavoro è impostato su un catalogo legacy (hive_metastore o spark_catalog). Cambia prima il catalogo predefinito in un catalogo Unity Catalog.
Disabilitare la radice e i montaggi DBFS disable_legacy_dbfs Disabilitare il DBFS legacy ha le seguenti due implicazioni: 1. L'accesso alle montature root e DBFS DBFS è vietato (così come la creazione di nuove montature). 2. Disabilita Databricks Le versioni di runtime precedenti alla 13.3LTS. Quando l'impostazione è disattivata, tutte le funzionalità DBFS vengono abilitate e non vengono imposte restrizioni sulle versioni di esecuzione di Databricks. Questa impostazione può richiedere fino a 20 minuti per entrare in vigore e richiede un riavvio manuale di cluster di calcolo tuttofare e SQL warehouse.
Consentire solo le implementazioni di app da Git enforceGitAppDeployments Quando attivate, le app in questo workspace possono essere distribuite solo da Git.
Funzionalità di intelligenza artificiale in collaborazione con partner llm_proxy_partner_powered Determina se i modelli alimentati da partner sono abilitati o meno. Questa impostazione è disponibile sia a livello di account che di workspace
Missione Critica mission_critical Garantisce i più alti livelli di resilienza operativa e sicurezza per carichi di lavoro critici. Include il recupero in caso di disastri e un rafforzamento della sicurezza e conformità.
Consentire ai repository di esportare l'output IPYNB reposIpynbResultsExportPermissions Controlla se gli utenti possono effettuare commit degli output dei notebook .ipynb in repository Git remoti nello spazio di lavoro.
Limita gli amministratori dello spazio di lavoro restrict_workspace_admins L'impostazione Limita amministratori area di lavoro consente di controllare le funzionalità degli amministratori dell'area di lavoro. Con lo stato impostato su ALLOW_ALL, gli amministratori dello spazio di lavoro possono creare token di accesso personali per il principale di servizio per conto di qualsiasi principale di servizio presente nel proprio spazio. Gli amministratori dell'area di lavoro possono anche assegnare un nuovo utente come proprietario dell'attività nella propria area di lavoro. E possono cambiare l'impostazione del lavoro run_as a qualsiasi utente nel loro workspace o a un principale di servizio su cui hanno il ruolo di Service Principal User. Con lo stato impostato su RESTRICT_TOKENS_AND_JOB_RUN_AS, gli amministratori dello spazio di lavoro possono creare token di accesso personali solo per conto dei principali del servizio su cui hanno il ruolo di Utente Principale del Servizio. Possono cambiare il proprietario di un lavoro solo in se stessi. E possono cambiare il ruolo run_as impostazione per sé stessi o per un principale di servizio su cui hanno il ruolo di Service Principal User.
Profilo di sicurezza della conformità shield_csp_enablement_ws_db Controlla se il profilo di sicurezza di conformità è abilitato per questo spazio di lavoro. Il profilo di sicurezza di conformità fornisce una base altamente sicura (monitoraggio aggiuntivo, un'immagine di calcolo rafforzata, tipi di istanza imposti per la crittografia tra nodi e altri controlli) che facilita il rispetto e la gestione degli standard di conformità applicabili. Abilitandolo in modo permanente consente anche un monitoraggio della sicurezza migliorato e un aggiornamento automatico del cluster sull'area di lavoro, aggiungendo anche l'add-on Enhanced Security and Compliance.
Monitoraggio della sicurezza avanzato shield_esm_enablement_ws_db Controlla se il monitoraggio della sicurezza potenziato è abilitato per questo spazio di lavoro. Il monitoraggio della sicurezza potenziato fornisce un'immagine di calcolo rafforzata e agenti aggiuntivi di monitoraggio della sicurezza (monitoraggio dell'integrità dei file, antivirus e scansione delle vulnerabilità) che generano righe di log esaminabili. Si applica solo alle risorse classiche del piano di calcolo, non serverless. Se il profilo di sicurezza di conformità è abilitato sull'area di lavoro, questa impostazione viene applicata in modo permanente.
Etichetta dello spazio di lavoro workspace_label Un'etichetta personalizzata e un badge colorato sono mostrati accanto al nome dello spazio di lavoro nella navigazione superiore della console Databricks. Gli amministratori di spazi di lavoro possono utilizzare questa impostazione per distinguere visivamente gli spazi di lavoro tra gli ambienti. Il valore è un oggetto con un label campo (stringa di testo) e un color campo (uno di: coral, lemon, lime, turquoise, indigopurple, pink). Entrambi i campi sono stringhe vuote quando non è impostata alcuna etichetta.

Preferenze utente

Impostazioni che si applicano a un utente in un account.

Setting Nome chiave Description
Creare automaticamente la sessione all'interazione con l'editor autoCreateSessionOnEditorInteraction Controlla se una sessione viene creata automaticamente durante l'interazione con l'editor.
Avvio e attacco automatico autoLaunchAndAttach Controlla se i notebook si avviano e si collegano automaticamente ai cluster.
Conferma Comando Cancella confirmCommandDelete Controlla se è necessaria una conferma prima di eliminare un comando.
Crea nuovi asset nella cartella Bozze createNewAssetsInDraftsFolder Controlla se vengono creati nuovi asset nella cartella bozze.
Databricks Unified SQL Editor crea e converte query su Open Pref databricks-unified-sql-editor-create-and-convert-queries-on-open-pref Controlla la creazione delle query e il comportamento di conversione nell'editor SQL unificato.
Unità di rientro predefinita di Python defaultPythonIndentUnit Controlla l'unità di rientro predefinita di Python. Valori consentiti: 2, 4, o '' (stringa vuota per impostazione predefinita).
Tema Oscuro personalizzato dell'editor editorCustomDarkTheme Controlla il tema scuro personalizzato per l'editor. Valori consentiti: defaultTheme, Atom-One-Dark, Ayu-Dark, Blackboard, Dracula, GitHub-Dark, MonokaiOne-Dark-Pro. Winter-is-Coming-Dark
Tema di luce personalizzato per editor editorCustomLightTheme Controlla il tema delle luci personalizzate per l'editor. Valori consentiti: defaultTheme, Active4D, Atom-One-LightAyu-Light, GitHub-Light, Tomorrow. Winter-is-Coming-Light
Dimensione del font dell'editor editorFontSize Controlla la dimensione del font nell'editor. Valori consentiti: intervallo intero da 10 a 30.
Attiva la Soluzione Automatica Inline Quick Fix enableAutoInlineQuickFix Controlla se vengono suggerite automaticamente soluzioni rapide inline.
Abilita la soluzione automatica inline Quick Release enableAutoInlineQuickFixOptOut Controllo di disattivazione per soluzioni rapide automatiche in linea.
Abilita la diagnosi automatica dei trigger enableAutoTriggerDiagnose Controlla se le diagnostiche vengono attivate automaticamente.
Attiva la diagnosi automatica dei trigger Opt out enableAutoTriggerDiagnoseOptOut Controllo di esclusione per diagnostica automatica.
Abilita la disposizione centrata enableCenteredLayout Controlla se l'editor utilizza un layout centrato.
Abilita scorciatoie classiche enableClassicShortcuts Controlla la modalità scorciatoie da tastiera. Valori consentiti: default, classic.
Abilita i numeri di comando enableCommandNumbers Controlla se i numeri di comando vengono visualizzati nei quaderni.
Abilita i completamenti mentre digiti enableCompletionsAsYouType Controlla se appaiono i suggerimenti di autocompletamento mentre scrivi.
Abilita il Cursor Blink enableCursorBlink Controlla se il cursore lampeggia nell'editor.
Abilita la modalità Dark enableDarkMode Controlla la modalità tema. Valori consentiti: light, dark, system.
Abilita Invia accetta suggerimenti enableEnterAcceptsSuggestions Controlla se premendo Invio accetta suggerimenti di autocompletamento.
Abilita il passaggio del mouse per l'editor enableHoverForEditor Controlla se il passaggio degli tooltip viene mostrato nell'editor.
Abilita il suggerimento inline mentre scrivi 'disattiva 'rinuncia' enableInlineSuggestionAsYouTypeOptOut Rinuncia al controllo per i suggerimenti inline mentre scrivi.
Abilita i numeri di linea enableLineNumbers Controlla se i numeri delle righe vengono visualizzati nell'editor.
Abilita i numeri di linea v2 enableLineNumbersV2 Controlla se i numeri delle righe vengono visualizzati nell'editor (v2).
Abilita il Line Wrap enableLineWrap Controlla se il testo passa alla riga successiva nell'editor.
Abilita il cursore multiplo di Monaco enableMonacoMultiCursor Controlla il tasto modificatore multicursore. Valori consentiti: alt, ctrlCmd.
Abilita l'Opzione di Riattivazione del Debugger del Notebook enableNotebookDebuggerOptOut Controllo di disattivazione per il debugger del notebook.
Abilita l'interruttore di osservabilità serverless enableServerlessObservabilityToggle L'utente opta per Improved Serverless Observability nei Job quando l'anteprima dello spazio di lavoro è abilitata.
Abilita Mostra le statistiche del comando nella nuova interfaccia di cella enableShowCommandStatsInNewCellUi Controlla se le statistiche dei comandi vengono mostrate nella nuova interfaccia della cella.
Abilita i titoli delle celle promosse per mostrare enableShowPromotedCellTitles Controlla se i titoli delle celle promosse vengono visualizzati.
Abilita preventivi intelligenti enableSmartQuotes Controlla se le virgolette intelligenti sono attivate nell'editor.
Abilita le schede soft per quaderni e file enableSoftTabsForNotebooksAndFiles Controlla se le tabulazioni vengono convertite in spazi in quaderni e file.
Abilita l'evidenziazione degli errori della sintassi SQL enableSqlSyntaxErrorHighlighting Controlla se gli errori di sintassi SQL vengono evidenziati.
Abilita il passaggio alla modalità comando dopo l'esecuzione enableSwitchToCommandModeAfterExecution Controlla se l'editor passa alla modalità comando dopo l'esecuzione della cella.
Abilita Archivi Esploratore Unificato enableUnifiedFileTreeExplorer Controlla se l'esploratore file unificato è abilitato.
Concentrazione (or Messa a fuoco) enableUnifiedSchemaBrowserTreeExplorer Controlla se l'esploratore unificato del browser di schemi è abilitato.
Abilita il renderer Vega Lite enableVegaLiteRenderer Controlla se il renderer Vega-Lite è abilitato per le visualizzazioni.
Abilita la riattiva del renderer Vega Lite enableVegaLiteRendererOptOut Rinuncia al controllo per il renderer Vega-Lite.
Abilita il tag Anteprima del renderer di Vega Lite enableVegaLiteRendererPreviewTag Controlla se viene mostrato il tag di anteprima del renderer Vega-Lite.
Pannello inferiore esteso extendedBottomPanel Controlla se il pannello inferiore esteso viene visualizzato.
Floodflow Nuovi Condotti Monitoraggio UI lakeflowNewPipelinesMonitoringUi Controlla se la nuova interfaccia di monitoraggio delle pipeline Lakeflow è abilitata.
Formato di esportazione predefinito del notebook notebookDefaultExportFormat Controlla il formato di esportazione predefinito per i notebook. Valori consentiti: SOURCE, JUPYTER.
Modalità scorciatoia con freccia opzionale optionArrowShortcutMode Controlla il comportamento delle scorciatoie da tastiera Option+Arrow. Valori consentiti: navigate, move.
Authoring multifile su pipeline pipelinesMultifileAuthoring Controlla se la creazione multifile è abilitata per le pipeline.
Invia notifiche email di commento sendCommentEmailNotifications Controlla se vengono inviate notifiche via email per i commenti.
Minimappa di esecuzione della cella mostra showCellExecutionMinimap Controlla se la minimappa di esecuzione della cella viene visualizzata.
Prompt del pannello Mostra Pip all'Ambiente showPipToEnvironmentPanelPrompt Controlla se mostrare pip al prompt del pannello ambiente.
Consulente Show Spark showSparkAdvisor Controlla se vengono visualizzate le proposte di ottimizzazione di Spark.
Consigli per l'errore di spark show showSparkErrorTips Controlla se vengono mostrati consigli utili per gli errori di Spark.
L'utente attiva l'evidenziazione degli errori del formato Python userActivatesPythonFormatErrorHighlighting Controlla se gli errori di formattazione Python vengono evidenziati.
L'utente attiva errore di sintassi Python, evidenziando la rinuncia userActivatesPythonSyntaxErrorHighlightingOptOut Controllo di disattivazione per l'evidenziazione degli errori della sintassi Python.
L'utente attiva il controllo dei tipi Python userActivatesPythonTypeChecking Controlla se il controllo dei tipi Python è abilitato.
L'utente attiva il ripristino istantaneo userActivatesSnapshotRestore Controlla se la funzionalità di ripristino istantaneo è attivata.
Limite predefinito 1000 per le nuove query usqleDefaultQueryAutoLimit Controlla il limite automatico predefinito per le query SQL nell'editor.

Risorse aggiuntive