API-Schlüsselreferenz für Einstellungen

Diese Seite listet die Einstellungen auf, die über die öffentliche Azure Databricks Settings API verfügbar sind, gruppiert nach Scope. Jede Einstellung wird durch einen stabilen Setting-Namen (Schlüssel) identifiziert. Wie man diese Einstellungen entdeckt, liest und aktualisiert, siehe Einstellungen über die Settings API verwalten.

Feature-Vorschauen werden ebenfalls über die Settings API verwaltet, aber hier nicht aufgeführt, da sie vorübergehend sind und schließlich das Lebensende erreichen. Entdecken Sie die derzeit verfügbaren Vorschauen über den Endpunkt Settings und Metadata.

Verfügbare Einstellungen

Die folgenden Einstellungen sind über die öffentliche Settings API verfügbar, gruppiert nach Scope. Diese Liste wird regelmäßig erstellt; Für die autoritative, immer aktuelle Menge von Einstellungen und deren Dokumentationslinks rufen Sie den Endpunkt Einstellungen-Metadaten auf, der für jede Einstellung die name, description, type, und docs_linkzurückgibt.

Konteneinstellungen

Einstellungen, die im gesamten Konto gelten.

Setting Schlüsselname Description
Legacy-Funktionen deaktivieren disable_legacy_features Deaktiviere Altfunktionen für neue Databricks-Arbeitsbereiche. Für neu erstellte Arbeitsbereiche: 1. Deaktiviert die Nutzung von DBFS-Root und Mounts. 2. Hive Metastore wird nicht bereitgestellt. 3. Deaktiviert die Nutzung von 'No-Isolation-Clustern'. 4. Deaktiviert Databricks Laufzeitversionen vor 13.3LTS.
Enforce Unity Gateway enforce_ai_gateway_v3_only Kontrolliert, ob der gesamte Zugriff auf das Foundation-Modell über Unity Gateway erfolgen muss. Wenn aktiviert, werden Modellzugriffsberechtigungen, KI-Budgets und Sicherheitsrichtlinien zentral mit Unity Gateway verwaltet, und der gesamte Datenverkehr des Foundation-Modells muss hindurchlaufen. Legacy Foundation modelliert, die Endpunkte bedienen, die Unity Gateway umgehen, den Datenverkehr ablehnen.
Partnergestützte KI-Features llm_proxy_partner_powered Bestimmt, ob Partnermodelle aktiviert sind oder nicht. Diese Einstellung ist sowohl auf Konto- als auch auf Arbeitsplatzebene verfügbar
Erzwingen von Partner-gestützten KI-Funktionen llm_proxy_partner_powered_enforce Bestimmt, ob die Partner-gesteuerte Durchsetzungseinstellung aktiviert ist. Wenn aktiviert, überschreibt der auf Kontoebene gestützte Partner-gestützte Wert jede Überschreibung auf Arbeitsbereichsebene.
Arbeitsbereich-Administratoren einschränken restrict_workspace_admins Mit der Einstellung "Arbeitsbereichsadministratoren einschränken" können Sie die Funktionen von Arbeitsbereichsadministratoren steuern. Mit dem Einstellungsstatus auf ALLOW_ALL können Workspace-Administratoren Service Principal Personal Access Tokens für jeden Service Principal in ihrem Workspace erstellen. Arbeitsbereichsadministratoren können außerdem beliebige Benutzer in ihrem Arbeitsbereich zum Auftragseigentümer ernennen. Und sie können die Job-run_as-Einstellung auf jeden Benutzer in ihrem Arbeitsbereich oder auf einen Service Principal ändern, auf dem sie die Rolle Service Principal User haben. Mit dem Einstellungsstatus auf RESTRICT_TOKENS_AND_JOB_RUN_AS können Workspace-Administratoren nur persönliche Zugriffstoken im Namen von Service Principals erstellen, auf denen sie die Rolle Service Principal User haben. Zudem können Sie sich selbst zum Jobbesitzer machen. Und sie können den Job run_as Setting auf sich selbst oder auf einen Service Principal ändern, bei dem sie die Rolle Service Principal User haben.

Arbeitsbereichseinstellungen

Einstellungen, die auf einen einzelnen Arbeitsbereich angewendet werden.

Setting Schlüsselname Description
AI/BI-Dashboard-Einbettungs-Zugriffsrichtlinie aibi_dash_embed_ws_acc_policy Kontrolliert, ob KI/BI-veröffentlichte Dashboard-Einbettung aktiviert, bedingt aktiviert oder auf Arbeitsbereichsebene deaktiviert ist. Standardmäßig ist diese Einstellung bedingt aktiviert (ALLOW_APPROVED_DOMAINS).
KI/BI-Dashboard: Einbettung genehmigter Domains aibi_dash_embed_ws_apprvd_domains Kontrolliert die Liste der Domains, die für das Hosting der eingebetteten KI/BI-Dashboards zugelassen wurden. Die Liste der genehmigten Domains kann nicht mutiert werden, wenn die aktuelle Zugriffsrichtlinie nicht auf ALLOW_APPROVED_DOMAINS gesetzt ist.
Beschränke OAuth-Scopes für Apps auf ausgewählte Werte allowedAppsUserApiScopes Beschränken Sie, welche OAuth-Scopes App-Entwickler anfordern können, wenn sie im Namen der Nutzer handeln. Geben Sie eine Liste der erlaubten Scopes an oder verwenden Sie "*", um alle unterstützten Scopes zuzulassen. Eine leere Liste deaktiviert effektiv die Benutzerautorisierung für Apps.
Automatische Clusteraktualisierung automatic_cluster_update Die automatische Clusteraktualisierung stellt sicher, dass alle Cluster in einem Arbeitsbereich regelmäßig auf die neuesten Host-Betriebssystemimages und Sicherheitsupdates aktualisiert werden. Kontoadministratoren können Häufigkeit, Startdatum und Startzeit eines Wartungsfensters planen. Gilt für klassische Rechenleistungen (Cluster, Pools, klassische SQL-Warehouses, Legacy Model Serving); Sie gilt nicht für serverlose Rechenleistungen. Die Aktivierung dieser Funktion fügt das Zusatz Enhanced Security and Compliance hinzu und erfordert die Premium-Preisklasse.
Erlaubte Kollaborationsplattformen collaboration_platform_connectivity Kontrolliert, welche externen Kollaborationsplattformen (Slack und/oder Microsoft Teams) sich mit diesem Arbeitsbereich verbinden können. Standardmäßig ALLOW_ALL.
Öffentliche Nachrichten in Kollaborationsplattformen erlauben collaboration_platform_message_visibility Wenn aktiviert, können Nutzer auswählen, ob Antworten aus der Databricks-App in Slack oder Microsoft Teams für den Kanal sichtbar sind. Wenn deaktiviert, müssen alle Antworten für den anfordernden Nutzer privat bleiben.
Arbeitsbereichszugriff für Databricks-Personal customerApprovedWSLoginExpirationTime Eine bestimmte Zeit, ab der sich Databricks-Mitarbeiter möglicherweise nicht mehr in Ihren Arbeitsbereich einloggen. Die Zeit ist wie folgt YYYY-MM-DDTHH:MM:SSZformatiert. Du kannst den Zugriff komplett deaktivieren, indem du ihn auf einen Zeitstempel in der Vergangenheit setzt, zum Beispiel 1998-01-01T00:00:00.000Z. Aktivieren Sie den Zugriff unbegrenzt, indem Sie eine leere Zeichenkette oder den speziellen Wert indefiniteverwenden.
Standardnamespace default_namespace_ws Die Standard-Namensraum-Einstellungs-API ermöglicht es Benutzern, den Standardnamensraum für einen Databricks-Arbeitsbereich zu konfigurieren.
Legacy-Zugriff deaktivieren disable_legacy_access "Legacy-Zugriff deaktivieren" hat folgende Auswirkungen: 1. Deaktiviert den direkten Zugriff auf Hive-Metastores aus dem Arbeitsbereich (der Zugriff über die Hive-Metastore-Föderation bleibt unbeeinträchtigt). 2. Deaktiviert den Fallbackmodus für den Zugriff auf externe Speicherorte aus dem Arbeitsbereich. 3. Deaktiviert Databricks Laufzeitversionen vor 13.3LTS. Wichtig: Diese Einstellung kann nicht aktiviert werden, solange der Standardkatalog des Arbeitsbereichs auf einen Legacy-Katalog (hive_metastore oder spark_catalog) gesetzt ist. Ändere zuerst den Standardkatalog zu einem Unity-Katalog.
Deaktivieren von DBFS-Stamm- und Einhängepunkten disable_legacy_dbfs Das Deaktivieren von Legacy-DBFS hat folgende zwei Implikationen: 1. Der Zugriff auf DBFS-Root- und DBFS-Mounts ist nicht erlaubt (ebenso wie die Erstellung neuer Mounts). 2. Deaktiviert Databricks Laufzeitversionen vor 13.3LTS. Wenn die Einstellung deaktiviert ist, sind alle DBFS-Funktionen aktiviert und es werden keine Einschränkungen für Databricks Runtime-Versionen auferlegt. Diese Einstellung kann bis zu 20 Minuten dauern, bis sie wirksam wird, und erfordert einen manuellen Neustart von Allzweck-Rechenclustern und SQL-Warehouses.
Auto-flexible Knotentypen aktivieren enableAutoNodeTypeFlexibility Wenn aktiviert, können Cluster in diesem Arbeitsbereich automatisch auf alternativen Knotentypen starten, wenn der angeforderte Knotentyp nicht verfügbar ist, was die Startzuverlässigkeit bei Kapazitätsengpässen verbessert.
Enforce Unity Gateway enforce_ai_gateway_v3_only Kontrolliert, ob der gesamte Zugriff auf das Foundation-Modell über Unity Gateway erfolgen muss. Wenn aktiviert, werden Modellzugriffsberechtigungen, KI-Budgets und Sicherheitsrichtlinien zentral mit Unity Gateway verwaltet, und der gesamte Datenverkehr des Foundation-Modells muss hindurchlaufen. Legacy Foundation modelliert, die Endpunkte bedienen, die Unity Gateway umgehen, den Datenverkehr ablehnen.
Erlauben nur App-Deployments aus Git enforceGitAppDeployments Wenn aktiviert, können Apps in diesem Arbeitsbereich nur von Git bereitgestellt werden.
Partnergestützte KI-Features llm_proxy_partner_powered Bestimmt, ob Partnermodelle aktiviert sind oder nicht. Diese Einstellung ist sowohl auf Konto- als auch auf Arbeitsplatzebene verfügbar
Missionskritisch mission_critical Bietet die höchsten Grade an operativer Resilienz und Sicherheit für kritische Arbeitslasten. Beinhaltet Katastrophenwiederherstellung sowie verbesserte Sicherheit und Compliance.
Erlauben Sie Repos zum Export von IPYNB-Ausgaben reposIpynbResultsExportPermissions Kontrolliert, ob Benutzer .ipynb-Notebook-Ausgaben in entfernte Git-Repositories im Arbeitsbereich übertragen können.
Arbeitsbereich-Administratoren einschränken restrict_workspace_admins Mit der Einstellung "Arbeitsbereichsadministratoren einschränken" können Sie die Funktionen von Arbeitsbereichsadministratoren steuern. Mit dem Einstellungsstatus auf ALLOW_ALL können Workspace-Administratoren Service Principal Personal Access Tokens für jeden Service Principal in ihrem Workspace erstellen. Arbeitsbereichsadministratoren können außerdem beliebige Benutzer in ihrem Arbeitsbereich zum Auftragseigentümer ernennen. Und sie können die Job-run_as-Einstellung auf jeden Benutzer in ihrem Arbeitsbereich oder auf einen Service Principal ändern, auf dem sie die Rolle Service Principal User haben. Mit dem Einstellungsstatus auf RESTRICT_TOKENS_AND_JOB_RUN_AS können Workspace-Administratoren nur persönliche Zugriffstoken im Namen von Service Principals erstellen, auf denen sie die Rolle Service Principal User haben. Zudem können Sie sich selbst zum Jobbesitzer machen. Und sie können den Job run_as Setting auf sich selbst oder auf einen Service Principal ändern, bei dem sie die Rolle Service Principal User haben.
Compliance-Sicherheitsprofil shield_csp_enablement_ws_db Kontrolliert, ob das Compliance-Sicherheitsprofil für diesen Arbeitsbereich aktiviert ist. Das Compliance-Sicherheitsprofil bietet eine hochsichere Basislinie (zusätzliche Überwachung, ein gehärtetes Compute-Bild, erzwungene Instanztypen für Inter-Knoten-Verschlüsselung und weitere Kontrollen), die es erleichtert, geltende Compliance-Standards zu erfüllen und zu verwalten. Die dauerhafte Aktivierung ermöglicht außerdem eine verbesserte Sicherheitsüberwachung und automatische Cluster-Aktualisierung im Arbeitsbereich und fügt das Zusatz Enhanced Security and Compliance hinzu.
Erweiterte Sicherheitsüberwachung shield_esm_enablement_ws_db Kontrolliert, ob für diesen Arbeitsbereich erweiterte Sicherheitsüberwachung aktiviert ist. Verbesserte Sicherheitsüberwachung bietet ein gehärtetes Compute-Image und zusätzliche Sicherheitsüberwachungsagenten (Dateiintegritätsüberwachung, Antiviren- und Schwachstellenscans), die überprüfbare Logzeilen generieren. Es gilt nur für klassische Compute-Plane-Ressourcen, nicht für serverlose. Wenn das Compliance-Sicherheitsprofil im Arbeitsbereich aktiviert ist, wird diese Einstellung dauerhaft durchgesetzt.
Arbeitsbereichsbeschriftung workspace_label Ein benutzerdefiniertes Label und ein Farbabzeichen werden neben dem Arbeitsbereichsnamen in der Top-Navigation der Databricks-Konsole angezeigt. Arbeitsbereichsadministratoren können diese Einstellung nutzen, um Arbeitsbereiche zwischen verschiedenen Umgebungen visuell zu unterscheiden. Der Wert ist ein Objekt mit einem label Feld (Textzeichenkette) und einem color Feld (eines von: coral, lemon, lime, turquoise, indigo, purple, , ). pink Beide Felder sind leere Zeichenketten, wenn kein Label gesetzt ist.

Benutzereinstellungen

Einstellungen, die für einen Benutzer in einem Konto gelten.

Setting Schlüsselname Description
Automatisch eine Sitzung bei der Interaktion des Editors erstellen autoCreateSessionOnEditorInteraction Kontrolliert, ob eine Sitzung automatisch erstellt wird, wenn sie mit dem Editor interagiert.
Auto-Launch und Anhängen autoLaunchAndAttach Kontrolliert, ob Notebooks automatisch Cluster starten und anhängen.
Befehl Delete bestätigen confirmCommandDelete Kontrolliert, ob eine Bestätigung vor dem Löschen eines Befehls erforderlich ist.
Neue Assets im Entwurfsordner erstellen createNewAssetsInDraftsFolder Kontrolliert, ob neue Assets im Entwurfsordner erstellt werden.
Databricks Unified SQL Editor erstellt und konvertiert Abfragen auf Open Pref databricks-unified-sql-editor-create-and-convert-queries-on-open-pref Steuert die Erstellung und das Umwandlungsverhalten von Abfragen im einheitlichen SQL-Editor.
Standard-Python-Einzug defaultPythonIndentUnit Steuert die Standard-Python-Einrückungseinheit. Erlaubte Werte: 2, , 4oder '' (leere Zeichenkette für Standard).
Editor Custom Dark Theme editorCustomDarkTheme Kontrolliert das benutzerdefinierte dunkle Thema für den Editor. Erlaubte Werte: defaultTheme, Atom-One-Dark, Ayu-Dark, Blackboard, Dracula, GitHub-DarkMonokaiOne-Dark-Pro. Winter-is-Coming-Dark
Editor Benutzerdefiniertes Lichtthema editorCustomLightTheme Steuert das benutzerdefinierte Lichtthema für den Editor. Zulässige Werte: defaultTheme, , Active4D, Atom-One-Light, Ayu-LightGitHub-Light, , . TomorrowWinter-is-Coming-Light
Schriftgröße des Editors editorFontSize Kontrolliert die Schriftgröße im Editor. Erlaubte Werte: ganzzahlige Werte reichen von 10 bis 30.
Auto-Inline-Schnelllösung aktivieren enableAutoInlineQuickFix Kontrolliert, ob Inline-Schnelllösungen automatisch vorgeschlagen werden.
Aktiviere automatische Inline-Schnellkorrektur-Opt-out enableAutoInlineQuickFixOptOut Opt-out-Steuerung für automatische Inline-Schnelllösungen.
Auto-Trigger-Diagnose aktivieren enableAutoTriggerDiagnose Kontrolliert, ob Diagnosen automatisch ausgelöst werden.
Auto-Trigger-Diagnose aktivieren – Abmelden enableAutoTriggerDiagnoseOptOut Opt-out-Steuerung für automatische Diagnosen.
Zentriertes Layout aktivieren enableCenteredLayout Kontrolliert, ob der Editor ein zentriertes Layout verwendet.
Aktiviere klassische Verknüpfungen enableClassicShortcuts Kontrolliert den Tastenkombinationsmodus. Zulässige Werte: default, classic.
Befehlsnummern aktivieren enableCommandNumbers Kontrolliert, ob Befehlsnummern in Notizbüchern angezeigt werden.
Aktivieren Sie Abschlüsse, während Sie tippen enableCompletionsAsYouType Kontrolliert, ob Autovervollständigungsvorschläge angezeigt werden, während du tippst.
Cursor Blink aktivieren enableCursorBlink Kontrolliert, ob der Cursor im Editor blinkt.
Dunkelmodus aktivieren enableDarkMode Kontrolliert den Themenmodus. Zulässige Werte: light, dark und system.
Aktivieren von Eingaben akzeptiert Vorschläge enableEnterAcceptsSuggestions Kontrolliert, ob das Drücken von Enter Autocomplete-Vorschläge akzeptiert.
Hover für den Editor aktivieren enableHoverForEditor Kontrolliert, ob Hover-Tooltips im Editor angezeigt werden.
Aktivieren Sie Inline-Vorschläge, während Sie "Abmelden" tippen enableInlineSuggestionAsYouTypeOptOut Opt-out-Control für Inline-Vorschläge beim Tippen.
Zeilennummern aktivieren enableLineNumbers Kontrolliert, ob Zeilennummern im Editor angezeigt werden.
Zeilennummern V2 aktivieren enableLineNumbersV2 Kontrolliert, ob Zeilennummern im Editor (v2) angezeigt werden.
Line-Wrap aktivieren enableLineWrap Kontrolliert, ob der Text in die nächste Zeile im Editor übergeht.
Monaco-Multicursor aktivieren enableMonacoMultiCursor Kontrolliert die Mehrheitscursor-Modifikatortaste. Zulässige Werte: alt, ctrlCmd.
Notebook-Debugger Opt-out aktivieren enableNotebookDebuggerOptOut Opt-out-Steuerung für den Notebook-Debugger.
Aktivieren Sie den Serverless Observability Toggle enableServerlessObservabilityToggle Der Nutzer wählt die verbesserte Serverless Observability in Jobs an, wenn die Arbeitsbereichsvorschau aktiviert ist.
Aktivieren Sie die Anzeigen von Befehlsstatistiken in der neuen Zell-Benutzeroberfläche enableShowCommandStatsInNewCellUi Kontrolliert, ob Befehlsstatistiken in der neuen Zellen-UI angezeigt werden.
Aktivieren Sie promovierte Zelltitel enableShowPromotedCellTitles Kontrolliert, ob beförderte Zellentitel angezeigt werden.
Aktivieren Sie Smart Quotes enableSmartQuotes Kontrolliert, ob intelligente Zitate im Editor aktiviert sind.
Aktiviere weiche Tabs für Notizbücher und Dateien enableSoftTabsForNotebooksAndFiles Kontrolliert, ob Tabs in Leerzeichen und Dateien in Leerzeichen umgewandelt werden.
Aktivieren Sie die Fehlerhervorhebung der SQL-Syntax enableSqlSyntaxErrorHighlighting Kontrolliert, ob SQL-Syntaxfehler hervorgehoben werden.
Aktivieren Sie den Wechsel zum Befehlsmodus nach der Ausführung enableSwitchToCommandModeAfterExecution Kontrolliert, ob der Editor nach der Zellausführung in den Befehlsmodus wechselt.
Aktivieren Sie den einheitlichen Dateibaum-Explorer enableUnifiedFileTreeExplorer Kontrolliert, ob der einheitliche Dateibaum-Explorer aktiviert ist.
Fokus enableUnifiedSchemaBrowserTreeExplorer Kontrolliert, ob der einheitliche Schema-Browser-Baum-Explorer aktiviert ist.
Aktivieren Sie den Vega Lite Renderer enableVegaLiteRenderer Kontrolliert, ob der Vega-Lite Renderer für Visualisierungen aktiviert ist.
Vega Lite Renderer Opt-out aktivieren enableVegaLiteRendererOptOut Opt-out-Control für den Vega-Lite Renderer.
Vega Lite Renderer Vorschau-Tag aktivieren enableVegaLiteRendererPreviewTag Kontrolliert, ob das Vorschau-Tag des Vega-Lite Renderers angezeigt wird.
Verlängerte Unterplatte extendedBottomPanel Kontrolliert, ob das erweiterte untere Panel angezeigt wird.
Lakeflow New Pipelines Monitoring Ui lakeflowNewPipelinesMonitoringUi Kontrolliert, ob die neue Lakeflow-Pipeline-Überwachungs-UI aktiviert ist.
Notebook-Standard-Exportformat notebookDefaultExportFormat Kontrolliert das Standard-Exportformat für Notizbücher. Zulässige Werte: SOURCE, JUPYTER.
Option Pfeil-Shortcut-Modus optionArrowShortcutMode Steuert das Verhalten der Tastenkürzel Option+Pfeil. Zulässige Werte: navigate, move.
Pipelines Multifile-Autoring pipelinesMultifileAuthoring Kontrolliert, ob Multifile Authoring für Pipelines aktiviert ist.
Kommentar-E-Mail-Benachrichtigungen senden sendCommentEmailNotifications Kontrolliert, ob E-Mail-Benachrichtigungen für Kommentare gesendet werden.
Zeige Zellenausführungs-Minimap showCellExecutionMinimap Kontrolliert, ob die Zellausführungs-Minimap angezeigt wird.
Display-Pip-an-Umwelt-Panel-Prompt showPipToEnvironmentPanelPrompt Kontrolliert, ob ein Pip im Umgebungspanel angezeigt wird.
Show Spark Berater showSparkAdvisor Kontrolliert, ob Spark-Optimierungsvorschläge angezeigt werden.
Fehlertipps zu Show Spark showSparkErrorTips Kontrolliert, ob hilfreiche Tipps für Spark-Fehler angezeigt werden.
User Activates Python Format Fehlerhervorhebung userActivatesPythonFormatErrorHighlighting Kontrolliert, ob Python-Formatierungsfehler hervorgehoben werden.
Benutzer aktiviert Python-Syntaxfehler hervorheben Opt-out userActivatesPythonSyntaxErrorHighlightingOptOut Opt-out-Steuerung für die Fehlerhervorhebung der Python-Syntax.
Benutzer aktiviert Python-Typprüfung userActivatesPythonTypeChecking Kontrolliert, ob die Python-Typprüfung aktiviert ist.
Der Benutzer aktiviert Snapshot-Wiederherstellung userActivatesSnapshotRestore Kontrolliert, ob die Funktion zur Snapshot-Wiederherstellung aktiviert ist.
Standardlimit 1000 für neue Abfragen usqleDefaultQueryAutoLimit Kontrolliert das Standard-Autolimit für SQL-Abfragen im Editor.

Weitere Ressourcen