Klucze API – odniesienie do ustawień

Ta strona zawiera listę ustawień dostępnych za pośrednictwem publicznego API ustawień Azure Databricks, pogrupowanych według zakresu. Każde ustawienie jest identyfikowane przez stabilną nazwę ustawienia (klucz). Aby dowiedzieć się, jak odnaleźć, przeczytać i zaktualizować te ustawienia, zobacz Zarządzanie ustawieniami przez API Ustawień.

Podglądy funkcji są również zarządzane przez API Ustawień, ale nie są tutaj wymienione, ponieważ są przejściowe i ostatecznie dochodzą do końca życia. Odkryj dostępne obecnie podglądy za pomocą punktu końcowego ustawień i metadanych.

Dostępne ustawienia

Poniższe ustawienia są dostępne poprzez publiczne API Ustawień, pogrupowane według zakresu. Ta lista jest generowana okresowo; Dla autorytatywnego, zawsze aktualnego zestawu ustawień i ich linków do dokumentacji wywołaj punkt końcowy Settings-Metadata, który zwraca dla namekażdego ustawienia , description, type, oraz docs_link.

Ustawienia konta

Ustawienia obowiązujące na całym koncie.

Setting Nazwa klucza Description
Wyłącz funkcje starsze disable_legacy_features Wyłącz starsze funkcje dla nowych przestrzeni roboczych Databricks. Dla nowo utworzonych przestrzeni roboczych: 1. Wyłącza użycie roota i mountów DBFS. 2. Hive Metastore nie będzie udostępniany. 3. Wyłącza użycie klastrów bez izolacji. 4. Wyłącza wersje uruchomieniowe Databricks sprzed 13.3LTS.
Funkcje sztucznej inteligencji oparte na partnerach llm_proxy_partner_powered Określa, czy modele zasilane przez partnera są włączone, czy nie. To ustawienie jest dostępne zarówno na poziomie konta, jak i przestrzeni roboczej
Egzekwuj funkcje AI oparte na partnerach llm_proxy_partner_powered_enforce Określa, czy ustawienie wymuszania zasilane przez partnera jest włączone. Po włączeniu, wartość oparta na partnerze na poziomie konta nadpisuje wszelkie nadpisania na poziomie przestrzeni roboczej.
Ogranicz administratorów przestrzeni roboczej restrict_workspace_admins Ustawienie Ogranicz administratorów obszaru roboczego umożliwia kontrolowanie możliwości administratorów obszaru roboczego. Przy ustawieniu statusu ustawienia na ALLOW_ALL, administratorzy przestrzeni roboczej mogą tworzyć osobiste tokeny dostępu do głównej usługi w imieniu dowolnego podmiotu w swojej przestrzeni roboczej. Administratorzy obszaru roboczego mogą również zmienić właściciela zadania na dowolnego użytkownika w swoim obszarze roboczym. Mogą też zmienić run_as ustawienia zadania na dowolnego użytkownika w swoim workspace lub na podmiot usługowy, na którym mają rolę Użytkownika Dostawcy Usług. Przy ustawieniu statusu na RESTRICT_TOKENS_AND_JOB_RUN_AS, administratorzy przestrzeni roboczej mogą tworzyć osobiste tokeny dostępu tylko w imieniu głównych podmiotów usług, na których jest rola Użytkownika Dostawcy Usługi. Mogą jedynie zmienić właściciela zadania na siebie. Mogą też zmienić run_as ustawienia pracy na siebie lub na zasadę usługi, na której pełni rolę Użytkownika Dostawcy Usługi.

Ustawienia przestrzeni roboczej

Ustawienia dotyczące jednej przestrzeni roboczej.

Setting Nazwa klucza Description
Polityka dostępu do osadzania AI/BI Dashboard aibi_dash_embed_ws_acc_policy Kontroluje, czy osadzanie osadzeń AI/BI publikowanych przez AI/BI jest włączone, warunkowo lub wyłączone na poziomie przestrzeni roboczej. Domyślnie to ustawienie jest warunkowo włączone (ALLOW_APPROVED_DOMAINS).
Domeny osadzające AI/BI Dashboard aibi_dash_embed_ws_apprvd_domains Kontroluje listę domen zatwierdzonych do hostowania wbudowanych pulpitów AI/BI. Lista zatwierdzonych domen nie może być zmieniana, jeśli obecna polityka dostępu nie jest ustawiona na ALLOW_APPROVED_DOMAINS.
Ogranicz zakres OAuth dla aplikacji do wybranych wartości allowedAppsUserApiScopes Ogranicz, o jakie zakresy OAuth mogą prosić deweloperzy aplikacji, działając w imieniu użytkowników. Określ listę dozwolonych zakresów lub użyj "*", aby dopuścić wszystkie obsługiwane zakresy. Pusta lista skutecznie wyłącza autoryzację użytkowników dla aplikacji.
Automatyczna aktualizacja klastra automatic_cluster_update Automatyczna aktualizacja klastra gwarantuje, że wszystkie klastry w obszarze roboczym są okresowo aktualizowane do najnowszego obrazu systemu operacyjnego hosta i aktualizacji zabezpieczeń. Administratorzy konta mogą zaplanować częstotliwość okna obsługi, datę rozpoczęcia i godzinę rozpoczęcia. Dotyczy klasycznych obliczeń (klastry, pule, klasyczne magazyny SQL, starsze modelowanie Serving); Nie dotyczy to obliczeń serwerowych. Włączanie tej funkcji dodaje dodatek Enhanced Security and Compliance oraz wymaga poziomu cenowego Premium.
Platformy umożliwiające współpracę collaboration_platform_connectivity Kontroluje, które zewnętrzne platformy współpracy (Slack i/lub Microsoft Teams) mogą być połączone z tym obszarem pracy. Domyślnie ustawia się ALLOW_ALL.
Pozwól na publiczne wiadomości na platformach współpracy collaboration_platform_message_visibility Po włączeniu użytkownicy mogą wybrać, czy odpowiedzi z aplikacji Databricks w Slacku czy Microsoft Teams są widoczne dla kanału. Po wyłączeniu wszystkie odpowiedzi są wymuszone, aby pozostały prywatne dla użytkownika żądającego.
Dostęp do przestrzeni roboczej dla personelu Databricks customerApprovedWSLoginExpirationTime Określony czas, po którym pracownicy Databricks mogą przestać logować się do Twojego workspace. Czas jest sformatowany jako YYYY-MM-DDTHH:MM:SSZ. Możesz całkowicie wyłączyć dostęp, ustawiając znacznik czasu z przeszłości, na przykład 1998-01-01T00:00:00.000Z. Włączaj dostęp w nieskończoność, używając pustego ciągu lub specjalnej wartości indefinite.
Domyślna przestrzeń nazw default_namespace_ws Domyślne API ustawień przestrzeni nazw pozwala użytkownikom konfigurować domyślną przestrzeń nazw dla przestrzeni roboczej Databricks.
Wyłącz dostęp starszy disable_legacy_access "Wyłączanie dostępu do dziedziczonych danych" ma następujące skutki: 1. Wyłącza bezpośredni dostęp do Hive Metastore z przestrzeni roboczej (dostęp przez federację Hive Metastore pozostaje nienaruszony). 2. Wyłącza tryb rezerwowy dostępu do lokalizacji zewnętrznej z poziomu obszaru roboczego. 3. Wyłącza wersje uruchomieniowe Databricks sprzed 13.3LTS. Ważne: tego ustawienia nie można włączyć, gdy domyślny katalog w przestrzeni roboczej jest ustawiony na katalog starszy (hive_metastore lub spark_catalog). Najpierw zmień domyślny katalog na katalog Unity Catalog.
Wyłączanie katalogu głównego i instalacji systemu plików DBFS disable_legacy_dbfs Wyłączenie starszego DBFS ma następujące dwie konsekwencje: 1. Dostęp do podstawowych i DBFS mountów DBFS jest zabroniony (podobnie jak tworzenie nowych mountów). 2. Wyłącza wersje uruchomieniowe Databricks sprzed 13.3LTS. Gdy ustawienie jest wyłączone, wszystkie funkcje DBFS są włączone i nie nakłada się żadnych ograniczeń na wersje Databricks Runtime. To ustawienie może zająć do 20 minut i wymaga ręcznego restartu uniwersalnych klastrów obliczeniowych i magazynów SQL.
Pozwalać na wdrażanie aplikacji tylko z Gita enforceGitAppDeployments Po włączeniu aplikacje w tym workspace mogą być wdrażane wyłącznie z Gita.
Funkcje sztucznej inteligencji oparte na partnerach llm_proxy_partner_powered Określa, czy modele zasilane przez partnera są włączone, czy nie. To ustawienie jest dostępne zarówno na poziomie konta, jak i przestrzeni roboczej
Mission Critical mission_critical Zapewnia najwyższy poziom odporności operacyjnej i bezpieczeństwa dla krytycznych obciążeń. Obejmuje odzyskiwanie po awarii oraz zwiększone bezpieczeństwo i zgodność.
Ogranicz administratorów przestrzeni roboczej restrict_workspace_admins Ustawienie Ogranicz administratorów obszaru roboczego umożliwia kontrolowanie możliwości administratorów obszaru roboczego. Przy ustawieniu statusu ustawienia na ALLOW_ALL, administratorzy przestrzeni roboczej mogą tworzyć osobiste tokeny dostępu do głównej usługi w imieniu dowolnego podmiotu w swojej przestrzeni roboczej. Administratorzy obszaru roboczego mogą również zmienić właściciela zadania na dowolnego użytkownika w swoim obszarze roboczym. Mogą też zmienić run_as ustawienia zadania na dowolnego użytkownika w swoim workspace lub na podmiot usługowy, na którym mają rolę Użytkownika Dostawcy Usług. Przy ustawieniu statusu na RESTRICT_TOKENS_AND_JOB_RUN_AS, administratorzy przestrzeni roboczej mogą tworzyć osobiste tokeny dostępu tylko w imieniu głównych podmiotów usług, na których jest rola Użytkownika Dostawcy Usługi. Mogą jedynie zmienić właściciela zadania na siebie. Mogą też zmienić run_as ustawienia pracy na siebie lub na zasadę usługi, na której pełni rolę Użytkownika Dostawcy Usługi.
Profil bezpieczeństwa zgodności shield_csp_enablement_ws_db Kontroluje, czy profil bezpieczeństwa zgodności jest włączony dla tej przestrzeni roboczej. Profil bezpieczeństwa zgodności zapewnia wysoce bezpieczny poziom bazowy (dodatkowe monitorowanie, utwardzony obraz obliczeniowy, wymuszone typy instancji dla szyfrowania międzywęzłowego oraz inne kontrole), co ułatwia spełnianie i zarządzanie obowiązującymi standardami zgodności. Włączanie go na stałe umożliwia także ulepszony monitoring bezpieczeństwa i automatyczną aktualizację klastra w przestrzeni roboczej, a także dodaje dodatek Enhanced Security and Compliance.
Ulepszone monitorowanie zabezpieczeń shield_esm_enablement_ws_db Kontroluje, czy w tym obszarze pracy włączony jest zwiększony monitoring bezpieczeństwa. Ulepszone monitorowanie bezpieczeństwa zapewnia utwardzony obraz obliczeniowy oraz dodatkowe agenty monitorujące bezpieczeństwo (monitorowanie integralności plików, antywirus oraz skanowanie podatności), które generują przeglądane wiersze logów. Dotyczy to tylko klasycznych zasobów obliczeniowych, nie serwerowych. Jeśli profil bezpieczeństwa zgodności jest włączony w przestrzeni roboczej, to ustawienie jest trwale egzekwowane.
Etykieta Workspace workspace_label Własna etykieta i kolorowa plakietka wyświetlane obok nazwy przestrzeni roboczej w górnej nawigacji konsoli Databricks. Administratorzy przestrzeni roboczych mogą wykorzystać to ustawienie do wizualnego rozróżnienia przestrzeni roboczych w różnych środowiskach. Wartość ta to obiekt z polem label (ciągiem tekstowym) oraz polem color (jednym z: coral, lemon, lime, turquoise, indigo, purple). pink Oba pola są pustymi ciągami znaków, gdy nie jest ustawiona żadna etykieta.

Preferencje użytkownika

Ustawienia dotyczące użytkownika na koncie.

Setting Nazwa klucza Description
Automatycznie twórz sesję podczas interakcji z edytorem autoCreateSessionOnEditorInteraction Kontroluje, czy sesja jest automatycznie tworzona podczas interakcji z edytorem.
Automatyczne uruchamianie i dołączanie autoLaunchAndAttach Kontroluje, czy notebooki automatycznie uruchamiają się i dołączają do klastrów.
Potwierdź polecenie usuwanie confirmCommandDelete Kontroluje, czy przed usunięciem polecenia jest wymagane potwierdzenie.
Utwórz nowe zasoby w folderze Szkice createNewAssetsInDraftsFolder Kontroluje, czy nowe zasoby są tworzone w folderze szkiców.
Databricks Unified Sql Editor Tworz i Konwertuj zapytania w Open Pref databricks-unified-sql-editor-create-and-convert-queries-on-open-pref Kontroluje zachowanie tworzenia i konwersji zapytań w zunifikowanym edytorze SQL.
Domyślna jednostka wcięcia Python defaultPythonIndentUnit Kontroluje domyślną jednostkę wcięcia w Python. Dozwolone wartości: 2, 4, lub '' (domyślnie pusty ciąg).
Edytor Własny Ciemny Motyw editorCustomDarkTheme Kontroluje niestandardowy ciemny motyw edytora. Dozwolone wartości: , , , , , defaultTheme, Atom-One-Dark, Ayu-Dark, , . BlackboardDraculaGitHub-DarkMonokaiOne-Dark-ProWinter-is-Coming-Dark
Edytor Niestandardowy Motyw Światła editorCustomLightTheme Steruje niestandardowym motywem oświetlenia dla edytora. Dozwolone wartości: defaultTheme, , Active4DAtom-One-Light, Ayu-LightGitHub-Light, , Tomorrow, Winter-is-Coming-Light.
Rozmiar czcionki edytora editorFontSize Kontroluje rozmiar czcionki w edytorze. Dozwolone wartości: liczba całkowita obejmuje od 10 do 30.
Włącz automatyczne szybkie poprawki w linii enableAutoInlineQuickFix Kontroluje, czy automatyczne szybkie poprawki są sugerowane.
Włącz automatyczne szybkie rozwiązanie w linii Wyłącz się enableAutoInlineQuickFixOptOut Kontrola automatycznego szybkiego poprawki w linii.
Włącz diagnostykę automatycznego wyzwalania enableAutoTriggerDiagnose Kontroluje, czy diagnostyka jest uruchamiana automatycznie.
Włącz automatyczne diagnozowanie wyzwalacza Rezygnuj enableAutoTriggerDiagnoseOptOut Automatyczna diagnostyka jest wyłączona z trybu wyłączenia.
Włącz układ wyśrodkowany enableCenteredLayout Kontroluje, czy edytor używa układu wyśrodkowanego.
Włącz skróty klasyczne enableClassicShortcuts Steruje trybem skrótów klawiaturowych. Dozwolone wartości: default, classic.
Włącz numery poleceń enableCommandNumbers Kontroluje, czy numery poleceń są wyświetlane w zeszytach.
Włączaj ukończenia podczas pisania enableCompletionsAsYouType Kontroluje, czy sugestie automatycznego uzupełniania pojawiają się podczas pisania.
Włącz miganie kursora enableCursorBlink Kontroluje, czy kursor miga w edytorze.
Włącz tryb ciemny enableDarkMode Steruje trybem motywu. Dozwolone wartości: light, dark, system.
Włącz Enter Akceptuje sugestie enableEnterAcceptsSuggestions Kontroluje, czy naciśnięcie Enter akceptuje sugestie automatycznego uzupełniania.
Włącz najechanie przez edytor enableHoverForEditor Kontroluje, czy w edytorze pojawiają się podpowiedzi do najechania.
Włącz sugestie w linii podczas wpisywania Zrezygnuj enableInlineSuggestionAsYouTypeOptOut Opcja wyłączenia sugestii w linii podczas pisania.
Włącz numery linii enableLineNumbers Kontroluje, czy numery linii są wyświetlane w edytorze.
Włącz numery linii V2 enableLineNumbersV2 Kontroluje, czy numery linii są wyświetlane w edytorze (v2).
Włącz Line Wrap enableLineWrap Kontroluje, czy tekst zostanie zawinięty do kolejnej linii w edytorze.
Włącz Monaco Multi Cursor enableMonacoMultiCursor Steruje klawiszem modyfikującym wiele kursorów. Dozwolone wartości: alt, ctrlCmd.
Włącz debugger notatników Wyłącz się enableNotebookDebuggerOptOut Kontrola rezygnacji z debugera notatnika.
Włącz przełącznik obserwacji serwerowej enableServerlessObservabilityToggle Użytkownik wyraża zgodę na Ulepszoną Obserwowalność Serwerową w Jobs, gdy podgląd przestrzeni roboczej jest włączony.
Włącz statystyki pokazywania poleceń w nowym interfejsie komórki enableShowCommandStatsInNewCellUi Kontroluje, czy statystyki poleceń są wyświetlane w nowym interfejsie komórki.
Włącz Promowanie promowanych tytułów komórkowych enableShowPromotedCellTitles Kontroluje, czy wyświetlane są promowane tytuły komórek.
Włącz inteligentne wyceny enableSmartQuotes Kontroluje, czy w edytorze są włączone inteligentne cytaty.
Włącz miękkie karty dla notatników i plików enableSoftTabsForNotebooksAndFiles Kontroluje, czy karty są przekształcane w space w notatnikach i plikach.
Włącz podświetlanie błędów składni SQL enableSqlSyntaxErrorHighlighting Kontroluje, czy błędy składni SQL są podświetlane.
Włącz przełączanie na tryb poleceń po wykonaniu enableSwitchToCommandModeAfterExecution Kontroluje, czy edytor przechodzi w tryb poleceń po wykonaniu komórki.
Włącz Unified File Tree Explorer enableUnifiedFileTreeExplorer Kontroluje, czy włączony jest zunifikowany eksplorator drzewa plików.
Fokus enableUnifiedSchemaBrowserTreeExplorer Kontroluje, czy włączony jest zunifikowany eksplorator drzewa przeglądarki schematu.
Enable Vega Lite Renderer enableVegaLiteRenderer Kontroluje, czy renderer Vega-Lite jest włączony do wizualizacji.
Enable Vega Lite Renderer Opt Out enableVegaLiteRendererOptOut Opcja wyłączenia renderera Vega-Lite.
Enable Vega Lite Renderer Preview Tag enableVegaLiteRendererPreviewTag Kontroluje, czy tag podglądu renderera Vega-Lite jest wyświetlany.
Wydłużony dolny panel extendedBottomPanel Kontroluje, czy wydłużony dolny panel jest wyświetlany.
Lakeflow – interfejs monitorujący nowe rurociągi lakeflowNewPipelinesMonitoringUi Kontroluje, czy nowy interfejs monitorujący rurociągi Lakeflow jest włączony.
Domyślny format eksportu notatnika notebookDefaultExportFormat Kontroluje domyślny format eksportu dla notebooków. Dozwolone wartości: SOURCE, JUPYTER.
Tryb skrótów z opcją strzałek optionArrowShortcutMode Kontroluje zachowanie skrótów klawiaturowych Opcja+Strzałka. Dozwolone wartości: navigate, move.
Wieloplikowe autorowanie potoków pipelinesMultifileAuthoring Kontroluje, czy dla potoków jest włączone autorowanie wielu plików.
Wyślij komentarze Powiadomienia e-mail sendCommentEmailNotifications Kontroluje, czy wysyłane są powiadomienia e-mail o komentarzach.
Pokaż minimapę wykonania komórek showCellExecutionMinimap Kontroluje, czy minimapa wykonania komórki jest wyświetlana.
Pokaż Pip do panelu środowiskowego showPipToEnvironmentPanelPrompt Kontroluje, czy wyświetlić pip na panelu środowiskowym.
Doradca Show Spark showSparkAdvisor Kontroluje, czy wyświetlane są sugestie optymalizacji Spark.
Wskazówki dotyczące błędów Spark Pokazuj showSparkErrorTips Kontroluje, czy wyświetlane są pomocne wskazówki dotyczące błędów Sparka.
Użytkownik aktywuje podświetlanie błędu formatu Python userActivatesPythonFormatErrorHighlighting Kontroluje, czy błędy formatowania w Python są podświetlane.
Użytkownik aktywuje błąd składni Python Podkreślający Wyłącz się userActivatesPythonSyntaxErrorHighlightingOptOut Kontrola wyłączenia dla podświetlania błędów składni Python.
Użytkownik aktywuje sprawdzanie typów w Python userActivatesPythonTypeChecking Kontroluje, czy Python jest włączony typ.
Użytkownik aktywuje przywracanie snapshotu userActivatesSnapshotRestore Kontroluje, czy funkcja przywracania snapshotów jest włączona.
Domyślny limit 1000 dla nowych zapytań usqleDefaultQueryAutoLimit Kontroluje domyślny automatyczny limit zapytań SQL w edytorze.

Dodatkowe zasoby

  • Last updated on