Instellingen API-sleutelreferentie

Deze pagina geeft een overzicht van de instellingen die beschikbaar zijn via de openbare Azure Databricks Settings API, gegroepeerd op scope. Elke instelling wordt geïdentificeerd door een stabiele instelling (sleutel). Voor hoe je deze instellingen ontdekt, leest en bijwerkt, zie Instellingen beheren via de Settings API.

Feature-previews worden ook beheerd via de Settings API, maar worden hier niet vermeld, omdat ze tijdelijk zijn en uiteindelijk het einde van de levensduur bereiken. Ontdek de previews die momenteel beschikbaar zijn via het instellingen-metadata-eindpunt.

Beschikbare instellingen

De volgende instellingen zijn beschikbaar via de publieke Settings API, gegroepeerd per scope. Deze lijst wordt periodiek gegenereerd; Voor de gezaghebbende, altijd-actuele set instellingen en hun documentatielinks, roep het Settings-Metadata eindpunt aan, dat voor elke instelling de name, description, type, en docs_link.

Accountinstellingen

Instellingen die gelden voor het hele account.

Setting Sleutelnaam Beschrijving
Schakel legacy-functies uit disable_legacy_features Schakel legacy-functies uit voor nieuwe Databricks-werkruimtes. Voor nieuw aangemaakte werkruimtes: 1. Schakelt het gebruik van DBFS-root en mounts uit. 2. Hive Metastore wordt niet geprovisioneerd. 3. Schakelt het gebruik van 'No-isolation clusters' uit. 4. Schakelt Databricks uit Runtime-versies vóór 13.3LTS.
Enforce Unity Gateway enforce_ai_gateway_v3_only Bepaalt of alle toegang tot het foundation model via Unity Gateway moet gaan. Wanneer ingeschakeld, worden modeltoegangsrechten, AI-budgetten en beveiligingsbeleid centraal beheerd met Unity Gateway, en moet al het verkeer van de foundation model erdoorheen gaan. Legacy Foundation model bedient eindpunten die Unity Gateway omzeilen en verkeer afwijzen.
Door partners aangedreven AI-functies llm_proxy_partner_powered Bepaalt of door partners aangedreven modellen zijn ingeschakeld of niet. Deze instelling is beschikbaar op zowel account- als werkruimteniveau
Handhaaf partnergestuurde AI-functies llm_proxy_partner_powered_enforce Bepaalt of de partner-gestuurde handhavingsinstelling aan staat. Wanneer ingeschakeld, overschrijft de account-level partner-powered value elke override op werkruimteniveau.
Beperk Workspace-beheerders restrict_workspace_admins Met de instelling Werkruimtebeheerders beperken kunt u de mogelijkheden van werkruimtebeheerders beheren. Met de instelling op ALLOW_ALL kunnen workspace-beheerders service principal persoonlijke toegangstokens aanmaken namens elke service principal in hun workspace. Werkruimtebeheerders kunnen de eigenaar van een klus ook wijzigen naar een andere gebruiker in hun werkruimte. En ze kunnen de functie run_as instelling wijzigen naar elke gebruiker in hun werkruimte of naar een serviceprincipal waarop ze de rol Service Principal User hebben. Met de instelling ingesteld op RESTRICT_TOKENS_AND_JOB_RUN_AS kunnen workspacebeheerders alleen persoonlijke toegangstokens aanmaken namens servicehoofden waarop zij de rol Service Principal User hebben. Ze kunnen ook alleen de eigenaar van een functie zelf wijzigen. En ze kunnen de functie run_as instelling aanpassen naar zichzelf of naar een serviceprincipe waarop zij de rol Service Principal User hebben.

Werkruimte-instellingen

Instellingen die van toepassing zijn op één enkele werkruimte.

Setting Sleutelnaam Beschrijving
AI/BI dashboard inbedding toegangsbeleid aibi_dash_embed_ws_acc_policy Bepaalt of AI/BI-gepubliceerde dashboard-embedding op werkruimteniveau is ingeschakeld, voorwaardelijk ingeschakeld of uitgeschakeld. Standaard is deze instelling voorwaardelijk ingeschakeld (ALLOW_APPROVED_DOMAINS).
AI/BI-dashboard met goedgekeurde domeinen inbedden aibi_dash_embed_ws_apprvd_domains Beheert de lijst van domeinen die zijn goedgekeurd om de embedded AI/BI-dashboards te hosten. De lijst met goedgekeurde domeinen kan niet worden gemuteerd als het huidige toegangsbeleid niet op ALLOW_APPROVED_DOMAINS is ingesteld.
Beperk OAuth-scopes voor apps tot geselecteerde waarden allowedAppsUserApiScopes Beperk welke OAuth-scopes app-ontwikkelaars kunnen aanvragen wanneer ze namens gebruikers handelen. Specificeer een lijst van toegestane scopes, of gebruik "*" om alle ondersteunde scopes toe te staan. Een lege lijst schakelt effectief de autorisatie van gebruikers voor apps uit.
Automatische clusterupdate automatic_cluster_update Automatische clusterupdate zorgt ervoor dat alle clusters in een werkruimte periodiek worden bijgewerkt naar de meest recente installatiekopie en beveiligingsupdates van het hostbesturingssystemen. Accountbeheerders kunnen de frequentie van het onderhoudsvenster, de begindatum en de begintijd plannen. Van toepassing op klassieke compute (clusters, pools, klassieke SQL-warehouses, legacy Model Serving); het geldt niet voor serverless compute. Het inschakelen van deze functie voegt de add-on Enhanced Security and Compliance toe en vereist de Premium-prijslaag.
Toegestane samenwerkingsplatforms collaboration_platform_connectivity Controleert welke externe samenwerkingsplatforms (Slack en/of Microsoft Teams) aan deze werkruimte kunnen koppelen. Standaard staat ALLOW_ALL.
Sta openbare berichten toe in samenwerkingsplatforms collaboration_platform_message_visibility Wanneer ingeschakeld, kunnen gebruikers kiezen of antwoorden van de Databricks-app in Slack of Microsoft Teams zichtbaar zijn voor het kanaal. Wanneer uitgeschakeld, moeten alle antwoorden privé zijn voor de aanvragende gebruiker.
Workspace-toegang voor Databricks-personeel customerApprovedWSLoginExpirationTime Een specifiek tijdstip waarna Databricks-personeel mogelijk niet meer inlogt op je werkruimte. De tijd is geformatteerd als YYYY-MM-DDTHH:MM:SSZ. Je kunt de toegang volledig uitschakelen door het in te stellen op een tijdstempel in het verleden, zoals 1998-01-01T00:00:00.000Z. Schakel toegang onbeperkt in door een lege string of de speciale waarde indefinitete gebruiken.
Standaard naamruimte default_namespace_ws De standaard naamruimte-instelling API stelt gebruikers in staat de standaardnaamruimte voor een Databricks-werkruimte te configureren.
Schakel legacy-toegang uit disable_legacy_access 'Legacy access uitschakelen' heeft de volgende gevolgen: 1. Schakelt directe toegang tot Hive Metastores uit vanuit de werkruimte (toegang via de Hive Metastore-federatie wordt niet beïnvloed). 2. Schakelt de terugvalmodus uit voor externe locatietoegang vanuit de werkruimte. 3. Schakelt Databricks uit Runtime-versies vóór 13.3LTS. Belangrijk: deze instelling kan niet worden ingeschakeld zolang de standaardcatalogus van de werkruimte is ingesteld op een legacy catalogus (hive_metastore of spark_catalog). Verander eerst de standaardcatalogus naar een Unity Catalog-catalogus.
DBFS-root en mounts uitschakelen disable_legacy_dbfs Het uitschakelen van legacy DBFS heeft de volgende twee gevolgen: 1. Toegang tot DBFS-root- en DBFS-mounts is niet toegestaan (evenals het aanmaken van nieuwe mounts). 2. Schakelt Databricks uit Runtime-versies vóór 13.3LTS. Wanneer de instelling uitstaat, is alle DBFS-functionaliteit ingeschakeld en worden er geen beperkingen opgelegd aan Databricks Runtime-versies. Deze instelling kan tot 20 minuten duren voordat deze van kracht wordt genomen en vereist een handmatige herstart van allround compute clusters en SQL-warehouses.
Schakel auto-flexibele knooptypes in enableAutoNodeTypeFlexibility Wanneer ingeschakeld, kunnen clusters in deze werkruimte automatisch opstarten op alternatieve knooppunttypes wanneer het gevraagde knooppunttype niet beschikbaar is, wat de betrouwbaarheid van de lancering verbetert bij capaciteitstekorten.
Enforce Unity Gateway enforce_ai_gateway_v3_only Bepaalt of alle toegang tot het foundation model via Unity Gateway moet gaan. Wanneer ingeschakeld, worden modeltoegangsrechten, AI-budgetten en beveiligingsbeleid centraal beheerd met Unity Gateway, en moet al het verkeer van de foundation model erdoorheen gaan. Legacy Foundation model bedient eindpunten die Unity Gateway omzeilen en verkeer afwijzen.
Sta alleen app-implementaties toe vanuit Git enforceGitAppDeployments Wanneer ingeschakeld, kunnen apps in deze werkruimte alleen vanuit Git worden uitgezet.
Door partners aangedreven AI-functies llm_proxy_partner_powered Bepaalt of door partners aangedreven modellen zijn ingeschakeld of niet. Deze instelling is beschikbaar op zowel account- als werkruimteniveau
Missie Cruciaal mission_critical Levert de hoogste niveaus van operationele veerkracht en beveiliging voor kritieke workloads. Omvat rampenherstel en verbeterde beveiliging en naleving.
Repos toestaan om IPYNB-uitvoer te exporteren reposIpynbResultsExportPermissions Bepaalt of gebruikers .ipynb-notebookuitvoer kunnen committen naar externe Git-repositories in de workspace.
Beperk Workspace-beheerders restrict_workspace_admins Met de instelling Werkruimtebeheerders beperken kunt u de mogelijkheden van werkruimtebeheerders beheren. Met de instelling op ALLOW_ALL kunnen workspace-beheerders service principal persoonlijke toegangstokens aanmaken namens elke service principal in hun workspace. Werkruimtebeheerders kunnen de eigenaar van een klus ook wijzigen naar een andere gebruiker in hun werkruimte. En ze kunnen de functie run_as instelling wijzigen naar elke gebruiker in hun werkruimte of naar een serviceprincipal waarop ze de rol Service Principal User hebben. Met de instelling ingesteld op RESTRICT_TOKENS_AND_JOB_RUN_AS kunnen workspacebeheerders alleen persoonlijke toegangstokens aanmaken namens servicehoofden waarop zij de rol Service Principal User hebben. Ze kunnen ook alleen de eigenaar van een functie zelf wijzigen. En ze kunnen de functie run_as instelling aanpassen naar zichzelf of naar een serviceprincipe waarop zij de rol Service Principal User hebben.
Compliance-beveiligingsprofiel shield_csp_enablement_ws_db Bepaalt of het compliance-beveiligingsprofiel voor deze werkruimte is ingeschakeld. Het compliancebeveiligingsprofiel biedt een zeer veilige basislijn (extra monitoring, een versterkt compute-image, afgedwongen instance-types voor inter-node encryptie en andere controles) die het makkelijker maakt om aan toepasselijke compliance-standaarden te voldoen en te beheren. Het permanent inschakelen maakt ook verbeterde beveiligingsmonitoring en automatische clusterupdates op de werkruimte mogelijk, en voegt de add-on Enhanced Security and Compliance toe.
Verbeterde beveiligingsbewaking shield_esm_enablement_ws_db Bepaalt of verbeterde beveiligingsmonitoring is ingeschakeld voor deze werkruimte. Verbeterde beveiligingsmonitoring biedt een versterkt compute-image en extra beveiligingsmonitoringagenten (bestandsintegriteitsmonitoring, antivirus en kwetsbaarheidsscanning) die controleerbare logrijen genereren. Het geldt alleen voor klassieke rekenplane-resources, niet serverless. Als het compliance-beveiligingsprofiel op de werkruimte is ingeschakeld, wordt deze instelling permanent afgedwongen.
Werkruimtelabel workspace_label Een aangepast label en kleurbadge worden weergegeven naast de naam van de werkruimte in de bovenste navigatie van de Databricks-console. Werkruimtebeheerders kunnen deze instelling gebruiken om werkruimtes visueel te onderscheiden tussen omgevingen. De waarde is een object met een label veld (tekststring) en een color veld (één van: coral, lemon, lime, turquoise, indigo, purple, , ). pink Beide velden zijn lege strings wanneer er geen label is ingesteld.

Gebruikersvoorkeuren

Instellingen die van toepassing zijn op een gebruiker in een account.

Setting Sleutelnaam Beschrijving
Maak automatisch sessies aan bij interactie met de editor autoCreateSessionOnEditorInteraction Bepaalt of er automatisch een sessie wordt aangemaakt tijdens interactie met de editor.
Automatisch starten en aanhechten autoLaunchAndAttach Bepaalt of notebooks automatisch worden gestart en gekoppeld aan clusters.
Bevestig Commando Verwijderen confirmCommandDelete Bepaalt of bevestiging nodig is voordat een commando wordt verwijderd.
Maak nieuwe assets aan in de Drafts-map createNewAssetsInDraftsFolder Bepaalt of er nieuwe assets worden aangemaakt in de drafts-map.
Databricks Unified SQL Editor maakt en converteert queries op open pref databricks-unified-sql-editor-create-and-convert-queries-on-open-pref Beheert het aanmaken en conversiegedrag van querys in de unified SQL-editor.
Standaard Python Inspring-eenheid defaultPythonIndentUnit Bestuurt de standaard Python-inspringunit. Toegestane waarden: 2, 4, of '' (lege string voor standaard).
Redacteur Aangepast Donker Thema. editorCustomDarkTheme Bestuurt het aangepaste donkere thema voor de editor. Toegestane waarden: defaultTheme, Atom-One-Dark, Ayu-Dark, Blackboard, Dracula, GitHub-DarkMonokaiOne-Dark-Pro, , . Winter-is-Coming-Dark
Editor Aangepast Lichtthema editorCustomLightTheme Regelt het aangepaste lichtthema voor de editor. Toegestane waarden: defaultTheme, Active4D, Atom-One-Light, Ayu-Light, , GitHub-Light, Tomorrow. Winter-is-Coming-Light
Editor lettergrootte editorFontSize Regelt de lettergrootte in de editor. Toegestane waarden: geheel getal varieert van 10 tot 30.
Schakel automatische inline snelle oplossing in enableAutoInlineQuickFix Bepaalt of snelle oplossingen automatisch worden voorgesteld.
Schakel automatische snelle inline oplossing in voor afmelden enableAutoInlineQuickFixOptOut Opt-out control voor automatische inline quick fixes.
Schakel automatische triggerdiagnose in enableAutoTriggerDiagnose Bepaalt of diagnostiek automatisch wordt geactiveerd.
Activeer automatische triggerdiagnose en opt-out inschakelen enableAutoTriggerDiagnoseOptOut Opt-out control voor automatische diagnose.
Schakel Gecentreerde Layout in enableCenteredLayout Bepaalt of de editor een gecentreerde lay-out gebruikt.
Schakel klassieke snelkoppelingen in enableClassicShortcuts Bedient de sneltoetsmodus. Toegestane waarden: default, classic.
Schakel commandonummers in enableCommandNumbers Bepaalt of commandonummers in notitieboekjes worden weergegeven.
Schakel voltooiingen in terwijl je typt enableCompletionsAsYouType Bepaalt of autocomplete-suggesties verschijnen terwijl je typt.
Cursor Blink Inschakelen enableCursorBlink Bepaalt of de cursor knippert in de editor.
Schakel Donkere Modus in enableDarkMode Bestuurt de themamodus. Toegestane waarden: light, dark, system.
Inzetten Accepteert Suggesties Inschakelen enableEnterAcceptsSuggestions Bepaalt of het indrukken van Enter autocomplete-suggesties accepteert.
Hover Voor Editor inschakelen enableHoverForEditor Bepaalt of hover tooltips in de editor worden weergegeven.
Schakel inline suggestie in terwijl je optout typt enableInlineSuggestionAsYouTypeOptOut Opt-out control voor inline suggesties terwijl je typt.
Schakel regelnummers in enableLineNumbers Bepaalt of regelnummers in de editor worden weergegeven.
Schakel regelnummers V2 in enableLineNumbersV2 Bepaalt of regelnummers in de editor (v2) worden weergegeven.
Schakel Line Wrap in enableLineWrap Bepaalt of tekst naar de volgende regel wordt gewrapt in de editor.
Schakel Monaco Multicursor in enableMonacoMultiCursor Bedient de multicursor-modificatortoets. Toegestane waarden: alt, ctrlCmd.
Activeer notebook debugger opt-out enableNotebookDebuggerOptOut Opt-out control voor de notebook debugger.
Schakel Serverless Observability Toggle in enableServerlessObservabilityToggle Gebruiker kunt kiezen voor verbeterde Serverless Observability in Jobs wanneer de workspace-preview is ingeschakeld.
Toon commandostatistieken in de nieuwe cel-UI inschakelen enableShowCommandStatsInNewCellUi Bepaalt of commandostatistieken worden weergegeven in de nieuwe celinterface.
Activeer gepromoveerde Celtitels Weergeven enableShowPromotedCellTitles Bepaalt of gepromoveerde celtitels worden weergegeven.
Schakel slimme quotes in enableSmartQuotes Bepaalt of slimme citaten in de editor zijn ingeschakeld.
Schakel zachte tabbladen in voor notitieboeken en bestanden enableSoftTabsForNotebooksAndFiles Bepaalt of tabbladen worden omgezet naar ruimtes in notitieboeken en bestanden.
Schakel SQL-syntaxis foutmarkering in enableSqlSyntaxErrorHighlighting Bepaalt of SQL-syntaxisfouten worden gemarkeerd.
Schakel naar commandomodus in na uitvoering enableSwitchToCommandModeAfterExecution Bepaalt of de editor na celuitvoering overschakelt naar commandomodus.
Schakel de Unified File Tree Explorer in enableUnifiedFileTreeExplorer Bepaalt of de unified file tree explorer is ingeschakeld.
Focus enableUnifiedSchemaBrowserTreeExplorer Bepaalt of de unified schema browser tree explorer is ingeschakeld.
Schakel Vega Lite Renderer in enableVegaLiteRenderer Bepaalt of de Vega-Lite renderer is ingeschakeld voor visualisaties.
Schakel Vega Lite Renderer Opt-out in enableVegaLiteRendererOptOut Opt-out control voor de Vega-Lite renderer.
Schakel Vega Lite Renderer Preview-tag in enableVegaLiteRendererPreviewTag Bepaalt of de Vega-Lite renderer preview-tag wordt getoond.
Verlengd onderpaneel extendedBottomPanel Bepaalt of het uitgebreide onderste paneel wordt weergegeven.
Lakeflow Nieuwe Pijpleidingen Monitoring UI lakeflowNewPipelinesMonitoringUi Bepaalt of de nieuwe Lakeflow-pipeline monitoring-UI is ingeschakeld.
Notebook Standaard Exportformaat notebookDefaultExportFormat Beheert het standaard exportformaat voor notitieboeken. Toegestane waarden: SOURCE, JUPYTER.
Optiepijl Snelkoppelingsmodus optionArrowShortcutMode Regelt het gedrag van sneltoetsen Option+Arrow. Toegestane waarden: navigate, move.
Pipelines Multifile Authoring pipelinesMultifileAuthoring Bepaalt of multifile authoring is ingeschakeld voor pipelines.
Stuur reacties per e-mail sendCommentEmailNotifications Bepaalt of e-mailmeldingen worden verzonden voor opmerkingen.
Toon celuitvoeringsminimap showCellExecutionMinimap Bepaalt of de celuitvoeringsminimap wordt weergegeven.
Toon Pip Aan Omgeving Paneelprompt showPipToEnvironmentPanelPrompt Bepaalt of pip aan het omgevingspaneel wordt weergegeven.
Show Spark Adviseur showSparkAdvisor Bepaalt of Spark-optimalisatiesuggesties worden weergegeven.
Fouttips voor Show Spark showSparkErrorTips Bepaalt of er nuttige tips worden getoond voor Spark-fouten.
Gebruiker activeert Python-formaat foutmarkering userActivatesPythonFormatErrorHighlighting Bepaalt of Python-opmaakfouten worden gemarkeerd.
Gebruiker activeert Python syntax fout markering opt-out userActivatesPythonSyntaxErrorHighlightingOptOut Opt-out control voor het hervormen van Python-syntaxisfouten.
Gebruiker activeert Python Type Checking userActivatesPythonTypeChecking Bepaalt of Python type checking is ingeschakeld.
Gebruiker activeert snapshotherstel userActivatesSnapshotRestore Bepaalt of snapshot-herstelfunctionaliteit is ingeschakeld.
Standaardlimiet 1000 voor nieuwe queries usqleDefaultQueryAutoLimit Regelt de standaard autolimiet voor SQL-queries in de editor.

Aanvullende bronnen

  • Laatst bijgewerkt om