Nastavení API klíčů reference

Tato stránka uvádí nastavení dostupná prostřednictvím veřejného API nastavení Azure Databricks, seskupená podle rozsahu. Každé nastavení je identifikováno jménem stabilního nastavení (klíčem). Jak tato nastavení objevit, přečíst a aktualizovat, viz Spravovat nastavení přes API Nastavení.

Ukázky funkcí jsou také spravovány přes API Nastavení, ale zde nejsou uvedeny, protože jsou přechodné a nakonec dosáhnou konce životnosti. Objevte aktuálně dostupné ukázky prostřednictvím endpointu nastavení-metadata.

Dostupná nastavení

Následující nastavení jsou dostupná prostřednictvím veřejného API Nastavení, seskupená podle rozsahu. Tento seznam je generován periodicky; Pro autoritativní, vždy aktuální sadu nastavení a jejich dokumentační odkazy volejte endpoint Settings-Metadata, který vrací každé nastavení , namedescription, type, a docs_link.

Nastavení účtu

Nastavení, která platí napříč celým účtem.

Setting Název klíče Description
Vypnout starší funkce disable_legacy_features Vypněte starší funkce pro nové Databricks pracovní prostory. Pro nově vytvořená pracovní prostory: 1. Vypíná použití DBFS root a mountů. 2. Hive Metastore nebude provisionován. 3. Vypíná použití 'klastrů bez izolace'. 4. Vypíná runtime verze Databricks před verzí 13.3LTS.
Enforce Unity Gateway enforce_ai_gateway_v3_only Kontroluje, zda veškerý přístup k modelu základů musí projít Unity Gateway. Po zapnutí jsou přístupová oprávnění k modelům, rozpočty AI a bezpečnostní politiky centrálně spravovány pomocí Unity Gateway a veškerý provoz základního modelu musí procházet tímto systémem. Legacy foundation model slouží koncovým zařízením, které obcházejí Unity Gateway, a odmítají provoz.
Funkce umělé inteligence založené na partnerech llm_proxy_partner_powered Určuje, zda jsou modely poháněné partnerem povolené nebo ne. Toto nastavení je dostupné jak na úrovni účtu, tak pracovního prostoru
Vynucujte funkce AI poháněné partnery llm_proxy_partner_powered_enforce Určuje, zda je zapnuté nastavení vynucování s partnerem. Po zapnutí hodnota na úrovni účtu přepisuje jakékoli přepsání na úrovni pracovního prostoru.
Omezit správce pracovního prostoru restrict_workspace_admins Nastavení Omezit správce pracovních prostorů umožňuje řídit možnosti správců pracovních prostorů. S nastavením nastaveným na ALLOW_ALL mohou správci pracovního prostoru vytvářet osobní přístupové tokeny pro hlavní službu jménem jakéhokoli principa služby ve svém pracovním prostoru. Správci pracovního prostoru můžou také změnit vlastníka úlohy na libovolného uživatele v pracovním prostoru. A mohou změnit nastavení run_as role na libovolného uživatele ve svém pracovním prostoru nebo na principála služby, na kterém má roli uživatele služebního principálu. Se stavem nastavení nastaveným na RESTRICT_TOKENS_AND_JOB_RUN_AS mohou správci pracovního prostoru vytvářet osobní přístupové tokeny pouze jménem principalů služby, na kterých mají roli uživatele principálu služby. Můžou také změnit vlastníka pracovní pozice sami. A mohou změnit nastavení run_as práce na sebe nebo na služebního zástupce, na kterém mají roli uživatele služebního principála.

Nastavení pracovního prostoru

Nastavení, která platí pro jeden pracovní prostor.

Setting Název klíče Description
Politika přístupu k vkládání AI/BI dashboardu aibi_dash_embed_ws_acc_policy Ovládá, zda je na úrovni pracovního prostoru povoleno, podmíněně povoleno nebo zakázáno vkládání dashboardu publikovaným AI/BI. Ve výchozím nastavení je toto nastavení podmíněně povoleno (ALLOW_APPROVED_DOMAINS).
AI/BI dashboard s vkládáním schválených domén aibi_dash_embed_ws_apprvd_domains Řídí seznam domén schválených k hostování vestavěných AI/BI dashboardů. Seznam schválených domén nelze měnit, pokud současná přístupová politika není nastavena na ALLOW_APPROVED_DOMAINS.
Omezit rozsahy OAuth pro aplikace na vybrané hodnoty allowedAppsUserApiScopes Omezte, které OAuth rozsahy mohou vývojáři aplikací požadovat při jednání jménem uživatelů. Zadejte seznam povolených rozsahů nebo použijte "*" pro povolení všech podporovaných rozsahů. Prázdný seznam fakticky deaktivuje autorizaci uživatelů pro aplikace.
Automatická aktualizace clusteru automatic_cluster_update Automatická aktualizace clusteru zajišťuje, aby se všechny clustery v pracovním prostoru pravidelně aktualizovaly na nejnovější bitovou kopii operačního systému hostitele a aktualizace zabezpečení. Správci účtu můžou naplánovat frekvenci časových intervalů údržby, počáteční datum a čas spuštění. Platí pro klasické výpočty (clustery, pooly, klasické SQL sklady, legacy Model Serving); Nevztahuje se na serverless výpočetní systém. Zapnutí této funkce přidává doplněk Enhanced Security and Compliance a vyžaduje cenovou úroveň Premium.
Povolené platformy pro spolupráci collaboration_platform_connectivity Ovládá, které externí kolaborační platformy (Slack a/nebo Microsoft Teams) se mohou připojit k tomuto pracovnímu prostoru. Výchozí nastavení je ALLOW_ALL.
Povolit veřejné zprávy na platformách pro spolupráci collaboration_platform_message_visibility Po zapnutí si uživatelé mohou vybrat, zda jsou odpovědi z aplikace Databricks ve Slacku nebo Microsoft Teams viditelné pro kanál. Po deaktivaci jsou všechny odpovědi nuceny zůstat soukromé pro žádajícího uživatele.
Přístup k pracovnímu prostoru pro zaměstnance Databricks customerApprovedWSLoginExpirationTime Konkrétní čas, po kterém se zaměstnanci Databricku již nemusí přihlašovat do vašeho pracovního prostoru. Čas je formátován jako YYYY-MM-DDTHH:MM:SSZ. Přístup můžete zcela zakázat nastavením časového razítka v minulosti, například 1998-01-01T00:00:00.000Z. Povolte přístup neomezeně pomocí prázdného řetězce nebo speciální hodnoty indefinite.
Výchozí jmenný prostor default_namespace_ws Výchozí API pro nastavení jmenného prostoru umožňuje uživatelům nastavit výchozí jmenný prostor pro pracovní prostor Databricks.
Vypnout přístup k legacy disable_legacy_access "Zakázání přístupu k dědictví" má následující důsledky: 1. Vypíná přímý přístup k Hive Metastore z pracovního prostoru (přístup přes federaci Hive Metastore není ovlivněn). 2. Zakáže režim nouzového stavu při přístupu na externí umístění z pracovního prostoru. 3. Vypíná runtime verze Databricks před verzí 13.3LTS. Důležité: toto nastavení nelze povolit, pokud je výchozí katalog pracovního prostoru nastaven na starší katalog (hive_metastore nebo spark_catalog). Nejprve změňte výchozí katalog na katalog Unity Catalog.
Zakázání kořenového adresáře a připojení DBFS disable_legacy_dbfs Vypnutí legacy DBFS má následující dva důsledky: 1. Přístup k DBFS root a DBFS mountům je zakázán (stejně jako vytváření nových mountů). 2. Vypíná runtime verze Databricks před verzí 13.3LTS. Když je nastavení vypnuté, veškerá funkce DBFS je povolena a na verze Databricks Runtime nejsou uvaleny žádná omezení. Toto nastavení může trvat až 20 minut, než se projeví, a vyžaduje ruční restart univerzálních výpočetních clusterů a SQL skladů.
Povolit automaticky flexibilní typy uzlů enableAutoNodeTypeFlexibility Po zapnutí mohou clustery v tomto pracovním prostoru automaticky startovat na alternativních typech uzlů, když požadovaný typ uzlu není dostupný, což zlepšuje spolehlivost spuštění během nedostatku kapacity.
Enforce Unity Gateway enforce_ai_gateway_v3_only Kontroluje, zda veškerý přístup k modelu základů musí projít Unity Gateway. Po zapnutí jsou přístupová oprávnění k modelům, rozpočty AI a bezpečnostní politiky centrálně spravovány pomocí Unity Gateway a veškerý provoz základního modelu musí procházet tímto systémem. Legacy foundation model slouží koncovým zařízením, které obcházejí Unity Gateway, a odmítají provoz.
Povolit nasazení aplikací pouze z Gitu enforceGitAppDeployments Když je zapnutý, aplikace v tomto pracovním prostoru lze nasazovat pouze z Gitu.
Funkce umělé inteligence založené na partnerech llm_proxy_partner_powered Určuje, zda jsou modely poháněné partnerem povolené nebo ne. Toto nastavení je dostupné jak na úrovni účtu, tak pracovního prostoru
Mission Critical mission_critical Poskytuje nejvyšší úroveň provozní odolnosti a bezpečnosti pro kritické pracovní zátěže. Zahrnuje obnovu po havárii a zvýšenou bezpečnost a dodržování předpisů.
Povolit exportovat výstup IPYNB repozitářům reposIpynbResultsExportPermissions Ovládá, zda uživatelé mohou commitovat výstupy .ipynb notebooků do vzdálených Git repozitářů v pracovním prostoru.
Omezit správce pracovního prostoru restrict_workspace_admins Nastavení Omezit správce pracovních prostorů umožňuje řídit možnosti správců pracovních prostorů. S nastavením nastaveným na ALLOW_ALL mohou správci pracovního prostoru vytvářet osobní přístupové tokeny pro hlavní službu jménem jakéhokoli principa služby ve svém pracovním prostoru. Správci pracovního prostoru můžou také změnit vlastníka úlohy na libovolného uživatele v pracovním prostoru. A mohou změnit nastavení run_as role na libovolného uživatele ve svém pracovním prostoru nebo na principála služby, na kterém má roli uživatele služebního principálu. Se stavem nastavení nastaveným na RESTRICT_TOKENS_AND_JOB_RUN_AS mohou správci pracovního prostoru vytvářet osobní přístupové tokeny pouze jménem principalů služby, na kterých mají roli uživatele principálu služby. Můžou také změnit vlastníka pracovní pozice sami. A mohou změnit nastavení run_as práce na sebe nebo na služebního zástupce, na kterém mají roli uživatele služebního principála.
Bezpečnostní profil souladu shield_csp_enablement_ws_db Kontroluje, zda je bezpečnostní profil souladu povolen pro tento pracovní prostor. Profil bezpečnosti souladu poskytuje vysoce bezpečnou základní úroveň (další monitorování, zpevněný výpočetní obraz, vynucené typy instancí pro šifrování mezi uzly a další kontroly), která usnadňuje splnění a správu příslušných standardů shody. Její zapnutí také trvale umožňuje vylepšené monitorování bezpečnosti a automatickou aktualizaci clusteru na pracovním prostoru a přidává doplněk Enhanced Security and Compliance.
Vylepšené monitorování zabezpečení shield_esm_enablement_ws_db Kontroluje, zda je pro toto pracovní prostředí povoleno zvýšené bezpečnostní monitorování. Vylepšené bezpečnostní monitorování poskytuje zpevněný výpočetní obraz a další bezpečnostní monitorovací agenty (monitorování integrity souborů, antivir a skenování zranitelností), které generují kontrolovatelné řádky v logu. Platí to pouze pro klasické zdroje výpočetní roviny, ne pro serverless. Pokud je bezpečnostní profil souladu na pracovišti zapnut, toto nastavení je trvale vynucováno.
Štítek Workspace workspace_label Vlastní štítek a barevný odznak se zobrazovaly vedle názvu pracovního prostoru v horní navigaci konzole Databricks. Správci pracovních prostor mohou toto nastavení využít k vizuálnímu rozlišení pracovních prostorů napříč prostředími. Hodnota je objekt s polem label (textovým řetězcem) a color polem (jedním z: coral, lemon, lime, turquoise, indigo, , purple, ). pink Obě pole jsou prázdné řetězce, pokud není nastaven žádný štítek.

Uživatelské předvolby

Nastavení, která platí pro uživatele v účtu.

Setting Název klíče Description
Automaticky vytvořit relaci při interakci s editorem autoCreateSessionOnEditorInteraction Ovládá, zda je relace automaticky vytvořena při interakci s editorem.
Automatické spuštění a připojení autoLaunchAndAttach Ovládá, zda notebooky automaticky spustí a připojí se ke clusterům.
Potvrdit příkaz Delete confirmCommandDelete Ovládá, zda je před smazáním příkazu potřeba potvrdit.
Vytvořte nové assety ve složce Drafts createNewAssetsInDraftsFolder Ovládá, zda jsou ve složce koncepty vytvářeny nové assety.
Databricks Unified SQL Editor Vytvářejte a Převádějte dotazy na Open Pref databricks-unified-sql-editor-create-and-convert-queries-on-open-pref Řídí chování při vytváření a konverzi dotazů v jednotném SQL editoru.
Výchozí jednotka odsazení v Python defaultPythonIndentUnit Ovládá výchozí jednotku odsazení v Python. Povolené hodnoty: 2, 4, nebo '' (výchozí prázdný řetězec).
Editor Vlastní temné téma editorCustomDarkTheme Ovládá vlastní tmavé téma editoru. Povolené hodnoty: defaultTheme, Atom-One-Dark, Ayu-Dark, Blackboard, , Dracula, GitHub-Dark, Monokai, , One-Dark-Pro. Winter-is-Coming-Dark
Editor Vlastní světelné téma editorCustomLightTheme Ovládá vlastní světelné téma editoru. Povolené hodnoty: defaultTheme, Active4D, Atom-One-Light, Ayu-Light, GitHub-Light, Tomorrow, , Winter-is-Coming-Light.
Velikost fontu editoru editorFontSize Ovládá velikost písma v editoru. Povolené hodnoty: celočíselné pohyby se pohybují od 10 do 30.
Zapnout automatickou rychlou opravu enableAutoInlineQuickFix Ovládá, zda jsou automaticky navrhovány rychlé opravy přímo v řadě.
Zapnout automatickou rychlou opravu Vypnout enableAutoInlineQuickFixOptOut Ovládání automatických rychlých oprav v řadě.
Povolit automatickou diagnostiku spouštěče enableAutoTriggerDiagnose Ovládá, zda se diagnostika spustí automaticky.
Zapnout automatickou diagnostiku spouštěč Odhlásit se enableAutoTriggerDiagnoseOptOut Automatické ovládání automatické diagnostiky.
Povolit centrální rozložení enableCenteredLayout Ovládá, zda editor používá středové rozložení.
Povolit klasické zkratky enableClassicShortcuts Ovládá režim klávesových zkratek. Povolené hodnoty: default, classic.
Povolit čísla příkazů enableCommandNumbers Ovládá, zda jsou čísla příkazů zobrazena v zápisnících.
Povolte dokončení při psaní enableCompletionsAsYouType Ovládá, zda se při psaní objeví návrhy automatického doplňování.
Povolit blikání kurzoru enableCursorBlink Ovládá, zda kurzor v editoru bliká.
Zapnout tmavý režim enableDarkMode Ovládá režim tématu. Povolené hodnoty: light, dark, system.
Povolit Enter přijímá doporučení enableEnterAcceptsSuggestions Ovládá, zda stisknutí Enter přijímá automatické doplňování.
Povolit najedení myší pro editor enableHoverForEditor Ovládá, zda se v editoru zobrazí nápovědy pro najedo.
Povolte návrh přímo při psaní Odhlásit se enableInlineSuggestionAsYouTypeOptOut Ovládání odhlášení pro návrhy přímo při psaní.
Povolit číslování řádků enableLineNumbers Ovládá, zda jsou čísla řádků zobrazena v editoru.
Povolit čísla řádků V2 enableLineNumbersV2 Ovládá, zda jsou čísla řádků zobrazena v editoru (v2).
Povolit Line Wrap enableLineWrap Ovládá, zda se text zablokuje na další řádek v editoru.
Povolte Monaco Multi Cursor enableMonacoMultiCursor Ovládá klávesu modifikátoru více kurzorů. Povolené hodnoty: alt, ctrlCmd.
Povolit notovací debugger, odhlásit se enableNotebookDebuggerOptOut Ovládání odhlášení pro debugger notebooku.
Zapnout přepínač bezserverové pozorovatelnosti enableServerlessObservabilityToggle Uživatel se přihlásí k Improved Serverless Observability v Jobs, když je povolen náhled pracovního prostoru.
Povolit zobrazit statistiky příkazů v novém buněkovém rozhraní enableShowCommandStatsInNewCellUi Ovládá, zda se statistiky příkazů zobrazují v novém rozhraní buňky.
Povolit Zobrazit propagované názvy buněk enableShowPromotedCellTitles Ovládá, zda jsou zobrazeny povýšené názvy buněk.
Povolte chytré citáty enableSmartQuotes Ovládá, zda jsou v editoru povoleny chytré uvozovky.
Povolte měkké záložky pro zápisníky a soubory enableSoftTabsForNotebooksAndFiles Ovládá, zda se záložky převádějí na mezery v zápisnících a souborech.
Povolit zvýraznění chyb syntaxe SQL enableSqlSyntaxErrorHighlighting Kontroluje, zda jsou zvýrazněny chyby syntaxe SQL.
Povolit přepnutí do režimu příkazů po spuštění enableSwitchToCommandModeAfterExecution Ovládá, zda editor po spuštění buňky přepne do režimu příkazů.
Povolit Unified File Tree Explorer enableUnifiedFileTreeExplorer Ovládá, zda je povolen sjednocený průzkumník souborového stromu.
Zaměření enableUnifiedSchemaBrowserTreeExplorer Ovládá, zda je povolen průzkumník stromů v jednotném schématu prohlížeče.
Enable Vega Lite Renderer enableVegaLiteRenderer Ovládá, zda je renderer Vega-Lite povolen pro vizualizace.
Enable Vega Lite Renderer Opt Out enableVegaLiteRendererOptOut Ovládání odhlášení pro Vega-Lite renderer.
Enable Vega Lite Renderer Preview Tag enableVegaLiteRendererPreviewTag Ovládá, zda se zobrazí tag Vega-Lite renderer náhledu.
Prodloužený spodní panel extendedBottomPanel Ovládá, zda je rozšířený spodní panel zobrazen.
Uživatelské rozhraní monitorování nových potrubí Lakeflow lakeflowNewPipelinesMonitoringUi Ovládá, zda je monitorovací UI nových potrubí Lakeflow povoleno.
Výchozí formát exportu notebooku notebookDefaultExportFormat Ovládá výchozí formát exportu pro zápisníky. Povolené hodnoty: SOURCE, JUPYTER.
Režim zkratek s volbovou šipkou optionArrowShortcutMode Ovládá chování klávesových zkratek Option+Arrow. Povolené hodnoty: navigate, move.
Vícesouborové authorování pipeline pipelinesMultifileAuthoring Ovládá, zda je pro pipeline povoleno vícesouborové authoring.
Posílejte komentáře E-mailová upozornění sendCommentEmailNotifications Ovládá, zda jsou zasílány e-mailové notifikace na komentáře.
Zobrazit minimapu vykonávání buněk showCellExecutionMinimap Ovládá, zda je zobrazena minimapa pro vykonávání buněk.
Zobrazit Pip na panel Environment showPipToEnvironmentPanelPrompt Ovládá, zda se ukáže pip na panel prostředí.
Poradce Show Spark showSparkAdvisor Ovládá, zda jsou zobrazeny návrhy optimalizace Spark.
Tipy na chybu Spark Show showSparkErrorTips Ovládá, zda jsou užitečné tipy zobrazeny pro chyby ve Sparku.
Uživatel aktivuje zvýrazňování chyby formátu Python userActivatesPythonFormatErrorHighlighting Ovládá, zda jsou zvýrazněny chyby ve formátování Python.
Uživatel aktivuje chybu syntaxe v Python Zvýrazňování Odhlásit se userActivatesPythonSyntaxErrorHighlightingOptOut Ovládání odhlášení pro zvýrazňování chyb syntaxe v Python.
Uživatel aktivuje kontrolu typu v Python userActivatesPythonTypeChecking Ovládá, zda je kontrola typu v Python povolena.
Uživatel aktivuje obnovení snímku userActivatesSnapshotRestore Ovládá, zda je funkce obnovy snímků povolená.
Výchozí limit 1000 pro nové dotazy usqleDefaultQueryAutoLimit Ovládá výchozí automatický limit pro SQL dotazy v editoru.

Dodatečné zdroje

  • Poslední aktualizace v