このページでは、公開されているAzure Databricks設定APIを通じて利用可能な設定をスコープごとにまとめてリストアップしています。 各設定は安定した 設定名 (キー)で識別されます。 これらの設定の発見、読み取り、更新方法については、「 設定APIを通じた設定管理」をご覧ください。
機能プレビューも設定APIを通じて管理されますが、一時的で最終的にはサービス終了を迎えるため、ここには掲載されていません。 settings-metadataエンドポイントを通じて現在利用可能なプレビューをご覧いただけます。
使用可能な設定
以下の設定は、公開設定APIを通じてスコープごとにグループ化されて利用可能です。 このリストは定期的に生成されます。常に最新の設定セットとそのドキュメントリンクについては、 settings-metadataエンドポイントを呼び出し、各設定の name、 description、 type、 docs_linkを返します。
アカウント設定
アカウント全体に適用される設定です。
| Setting | キー名 | Description |
|---|---|---|
| レガシー機能を無効にする | disable_legacy_features |
新しいDatabricksワークスペースのレガシー機能を無効にしてください。 新たに作成されたワークスペースの場合:1. DBFSのrootやマウントの使用を無効にします。 2. Hive Metastoreはプロビジョニングされません。 3. 「ノーアイソレーションクラスター」の使用を無効にします。 4. 13.3LTS以前のDatabricksランタイムバージョンを無効にします。 |
| UnforceのUnity Gateway | enforce_ai_gateway_v3_only |
すべての基礎モデルへのアクセスがUnityゲートウェイ経由でなければならないかどうかを制御します。 有効化されると、モデルアクセス権限、AI予算、セキュリティポリシーはUnity Gatewayで中央管理され、すべての基礎モデルのトラフィックはUnityゲートウェイを通過する必要があります。 Unity Gatewayをバイパスするエンドポイントに対応するレガシー基盤モデルはトラフィックを拒否します。 |
| パートナーによる AI 機能 | llm_proxy_partner_powered |
パートナー駆動モデルが有効かどうかを判定します。 この設定はアカウントレベルとワークスペースレベルの両方で利用可能です |
| パートナー主導のAI機能を強制する | llm_proxy_partner_powered_enforce |
パートナー主導の強制設定がオンかどうかを判定します。 有効化すると、アカウントレベルのパートナー主導の価値がワークスペースレベルの上書きを上書きします。 |
| ワークスペース管理者を制限する | restrict_workspace_admins |
[ワークスペース管理者の制限] 設定では、ワークスペース管理者の機能を制御できます。 設定ステータスをALLOW_ALLに設定することで、ワークスペース管理者は自分のワークスペース内の任意のサービスプリンシパルの個人アクセストークンを作成できます。 ワークスペース管理者は、自分のワークスペース内の任意のユーザーにジョブ所有者を変更することもできます。 また、ジョブrun_as設定を自分のワークスペース内の任意のユーザーや、サービスプリンシパルユーザーロールを持つサービスプリンシパルに変更することも可能です。 ステータス設定がRESTRICT_TOKENS_AND_JOB_RUN_ASに設定されている場合、ワークスペース管理者はサービスプリンシパルユーザーロールを持つサービスプリンシパルの代理としてのみパーソナルアクセストークンを作成できます。 自分自身にのみジョブの所有者を変更できます。 また、ジョブrun_as設定を自分自身やサービスプリンシパルユーザーの役割を持つサービスプリンシパルに変更することも可能です。 |
ワークスペースの設定
単一のワークスペースに適用される設定。
| Setting | キー名 | Description |
|---|---|---|
| AI/BIダッシュボードの埋め込みアクセスポリシー | aibi_dash_embed_ws_acc_policy |
ワークスペースレベルで、AI/BI公開ダッシュボードの埋め込みが有効、条件付き有効、無効にするかを制御します。デフォルトでは、この設定は条件付き有効(ALLOW_APPROVED_DOMAINS)になっています。 |
| 承認ドメインの埋め込みAI/BIダッシュボード | aibi_dash_embed_ws_apprvd_domains |
組み込みAI/BIダッシュボードのホストとして承認されたドメインのリストを管理します。現在のアクセスポリシーがALLOW_APPROVED_DOMAINSに設定されていない場合、承認済みドメインリストを変更することはできません。 |
| アプリのOAuthスコープを選択した値に制限する | allowedAppsUserApiScopes |
ユーザーを代表して行動する際にアプリ開発者が要求できるOAuthの範囲を制限してください。 許可されるスコープのリストを指定するか、「*」を使ってすべてのサポートスコープを許可してください。 空のリストは、アプリのユーザー認証を事実上無効化します。 |
| クラスターの自動更新 | automatic_cluster_update |
クラスターの自動更新により、ワークスペース内のすべてのクラスターが、最新のホスト OS イメージとセキュリティ更新プログラムに定期的に更新されます。 アカウント管理者は、メンテナンス期間の頻度、開始日、開始時刻をスケジュールできます。 クラシックなコンピュート(クラスタ、プール、クラシックなSQLウェアハウス、レガシーモデルサービング)に適用されます。サーバーレス計算には適用されません。 この機能を有効にすると、強化されたセキュリティおよびコンプライアンスアドオンが追加され、プレミアム価格帯が必要です。 |
| 許可されたコラボレーションプラットフォーム | collaboration_platform_connectivity |
外部のコラボレーションプラットフォーム(SlackやMicrosoft Teams)がこのワークスペースに接続できるかを制御します。 デフォルトはALLOW_ALLです。 |
| コラボレーションプラットフォームで公開メッセージを許可する | collaboration_platform_message_visibility |
有効化すると、ユーザーはSlackのDatabricksアプリから返信をチャネルに表示するか、Microsoft Teamsから表示するかを選択できます。 無効化すると、すべての応答はリクエスト側のプライベートなものに強制されます。 |
| Databricks担当者向けのワークスペースアクセス | customerApprovedWSLoginExpirationTime |
Databricksの担当者があなたのワークスペースにログインできなくなる特定の時間帯。 時間は YYYY-MM-DDTHH:MM:SSZのフォーマットです。 過去のタイムスタンプ(例えば 1998-01-01T00:00:00.000Z)に設定することで、アクセスを完全に無効にできます。 空文字列または特別な値 indefiniteを使って無期限にアクセスを有効にします。 |
| 既定の名前空間 | default_namespace_ws |
デフォルト名前空間設定APIは、ユーザーがDatabricksワークスペースのデフォルト名前空間を設定できるようにします。 |
| レガシーアクセスを無効にする | disable_legacy_access |
「レガシーアクセスを無効化」には以下のような影響があります。1. ワークスペースからHive Metastoreへの直接アクセスを無効にします(Hive Metastoreフェデレーション経由のアクセスには影響なし)。 2. ワークスペースからの外部の場所へのアクセスでフォールバック モードを無効にします。 3. 13.3LTS以前のDatabricksランタイムバージョンを無効にします。 重要:この設定は、ワークスペースのデフォルトカタログがレガシーカタログ(hive_metastoreまたはspark_catalog)に設定されている間は有効にできません。 まずはデフォルトのカタログをUnityカタログに変更してください。 |
| DBFS ルートとマウントを無効にする | disable_legacy_dbfs |
レガシーDBFSを無効にすることには、以下の2つの影響があります。1. DBFSのrootおよびDBFSマウントへのアクセスは禁止されており(新規マウントの作成も禁止されています)。 2. 13.3LTS以前のDatabricksランタイムバージョンを無効にします。 設定がオフになると、すべてのDBFS機能が有効になり、Databricksのランタイムバージョンには制限が課されません。 この設定は効果が発動するまでに最大20分かかることがあり、汎用計算クラスターやSQLウェアハウスの手動再起動が必要です。 |
| 自動フレキシブルノードタイプを有効にする | enableAutoNodeTypeFlexibility |
有効化されると、このワークスペース内のクラスタは、要求されたノードタイプが利用できない場合に自動的に別のノードタイプで起動し、容量不足時のローンチ信頼性を向上させます。 |
| UnforceのUnity Gateway | enforce_ai_gateway_v3_only |
すべての基礎モデルへのアクセスがUnityゲートウェイ経由でなければならないかどうかを制御します。 有効化されると、モデルアクセス権限、AI予算、セキュリティポリシーはUnity Gatewayで中央管理され、すべての基礎モデルのトラフィックはUnityゲートウェイを通過する必要があります。 Unity Gatewayをバイパスするエンドポイントに対応するレガシー基盤モデルはトラフィックを拒否します。 |
| Gitからのアプリのデプロイのみ許可 | enforceGitAppDeployments |
有効になっている場合、このワークスペース内のアプリはGitからのみデプロイ可能です。 |
| パートナーによる AI 機能 | llm_proxy_partner_powered |
パートナー駆動モデルが有効かどうかを判定します。 この設定はアカウントレベルとワークスペースレベルの両方で利用可能です |
| ミッションクリティカル | mission_critical |
重要なワークロードに対して最高レベルの運用レジリエンスとセキュリティを提供します。 災害復旧やセキュリティおよびコンプライアンスの強化が含まれます。 |
| リポジトリがIPYNB出力をエクスポートできるように | reposIpynbResultsExportPermissions |
ユーザーが.ipynbノートブックの出力をワークスペース内のリモートGitリポジトリにコミットできるかどうかを制御します。 |
| ワークスペース管理者を制限する | restrict_workspace_admins |
[ワークスペース管理者の制限] 設定では、ワークスペース管理者の機能を制御できます。 設定ステータスをALLOW_ALLに設定することで、ワークスペース管理者は自分のワークスペース内の任意のサービスプリンシパルの個人アクセストークンを作成できます。 ワークスペース管理者は、自分のワークスペース内の任意のユーザーにジョブ所有者を変更することもできます。 また、ジョブrun_as設定を自分のワークスペース内の任意のユーザーや、サービスプリンシパルユーザーロールを持つサービスプリンシパルに変更することも可能です。 ステータス設定がRESTRICT_TOKENS_AND_JOB_RUN_ASに設定されている場合、ワークスペース管理者はサービスプリンシパルユーザーロールを持つサービスプリンシパルの代理としてのみパーソナルアクセストークンを作成できます。 自分自身にのみジョブの所有者を変更できます。 また、ジョブrun_as設定を自分自身やサービスプリンシパルユーザーの役割を持つサービスプリンシパルに変更することも可能です。 |
| コンプライアンスセキュリティプロファイル | shield_csp_enablement_ws_db |
このワークスペースでコンプライアンスセキュリティプロファイルが有効かどうかを制御します。 コンプライアンスセキュリティプロファイルは、追加の監視、強化された計算イメージ、ノード間暗号化のためのインスタンスタイプ強制、その他の制御などの高度な基準を提供し、適用されるコンプライアンス基準の達成と管理を容易にします。 有効化すると、ワークスペースのセキュリティ監視強化と自動クラスタ更新が恒久的に可能になり、さらに強化されたセキュリティおよびコンプライアンスアドオンも追加されます。 |
| 拡張セキュリティ監視 | shield_esm_enablement_ws_db |
このワークスペースで強化されたセキュリティ監視が有効かどうかを制御します。 強化されたセキュリティ監視は、強化された計算イメージと、ファイル整合性監視、ウイルス対策、脆弱性スキャンなどの追加のセキュリティ監視エージェントを提供し、レビュー可能なログ行を生成します。 これは従来のコンピュートプレーンリソースにのみ適用され、サーバーレスには適用されません。 ワークスペースでコンプライアンスセキュリティプロファイルが有効の場合、この設定は恒久的に強制されます。 |
| ワークスペースラベル | workspace_label |
Databricksコンソールの上部ナビゲーションで、ワークスペース名の横にカスタムラベルと色のバッジが表示されました。 ワークスペース管理者はこの設定を使って、環境間でワークスペースを視覚的に区別できます。 値は、 label フィールド(テキスト文字列)と color フィールド( coral、 lemon、 lime、 turquoise、 indigo、 purple、 pinkのいずれか)を持つオブジェクトです。 ラベルが設定されていない場合、両方のフィールドは空文字列となります。 |
ユーザー設定
アカウント内のユーザーに適用される設定。
| Setting | キー名 | Description |
|---|---|---|
| 編集者とのやり取りで自動的にセッションを作成する | autoCreateSessionOnEditorInteraction |
エディターとやり取りする際にセッションが自動的に作成されるかどうかを制御します。 |
| オートローンチ&アタッチ | autoLaunchAndAttach |
ノートパソコンが自動的に起動し、クラスターに接続するかどうかを制御します。 |
| コマンドの確認 削除 | confirmCommandDelete |
コマンドを削除する前に確認が必要かどうかを制御します。 |
| Draftsフォルダで新しいアセットを作成する | createNewAssetsInDraftsFolder |
ドラフトフォルダ内で新しいアセットが作成されるかどうかを制御します。 |
| Databricks Unified SQL Editor Open Pref 上でクエリを作成・変換 | databricks-unified-sql-editor-create-and-convert-queries-on-open-pref |
統合SQLエディタでのクエリ作成および変換動作を制御します。 |
| デフォルトのPythonインデントユニット | defaultPythonIndentUnit |
デフォルトのPythonインデントユニットを制御します。 許可される値: 2、 4、または「'」(デフォルトは空文字列)。 |
| エディターカスタムダークテーマ | editorCustomDarkTheme |
エディターのカスタムダークテーマを制御します。 許可される値: defaultTheme、 Atom-One-Dark、 Ayu-Dark、 Blackboard、 Dracula、 GitHub-Dark、 Monokai、 One-Dark-Pro、 Winter-is-Coming-Dark。 |
| エディターカスタムライトテーマ | editorCustomLightTheme |
エディター用のカスタムライトテーマを制御します。 使用できる値: defaultTheme、 Active4D、 Atom-One-Light、 Ayu-Light、 GitHub-Light、 Tomorrow、 Winter-is-Coming-Light。 |
| エディターフォントサイズ | editorFontSize |
エディター内でフォントサイズを制御します。 許容値:整数の範囲は10から30までです。 |
| 自動インラインクイックフィックスを有効にする | enableAutoInlineQuickFix |
インラインのクイックフィックスが自動的に提案されるかどうかを制御します。 |
| 自動インラインクイックフィックスを有効にする オプトアウト | enableAutoInlineQuickFixOptOut |
自動インラインのクイックフィックスのためのオプトアウトコントロール。 |
| 自動トリガー診断を有効にする | enableAutoTriggerDiagnose |
診断が自動的にトリガーされるかどうかを制御します。 |
| 自動トリガー 診断 オプトアウトを有効にする | enableAutoTriggerDiagnoseOptOut |
自動診断のためのオプトアウトコントロール。 |
| 中央配置を有効にする | enableCenteredLayout |
エディターが中央配置を使うかどうかを制御します。 |
| クラシックショートカットを有効にする | enableClassicShortcuts |
キーボードショートカットモードを操作します。 使用できる値: default、classic。 |
| コマンド番号を有効にする | enableCommandNumbers |
ノートブックにコマンド番号が表示されるかどうかを制御します。 |
| 入力中に完了を有効にする | enableCompletionsAsYouType |
入力時にオートコンプリートの提案が表示されるかどうかを制御します。 |
| カーソルブリンクを有効にする | enableCursorBlink |
エディター内でカーソルが点滅するかどうかを制御します。 |
| ダークモードを有効にする | enableDarkMode |
テーマモードを操作します。 許可値: light、dark、system。 |
| Enable Enter Accepts Suggestions | enableEnterAcceptsSuggestions |
Enterキーがオートコンプリートの提案を受け入れるかどうかを制御します。 |
| 編集者用にホバーを有効にする | enableHoverForEditor |
エディタにホバーツールチップを表示するかどうかを制御します。 |
| 入力中にインライン提案を有効にしてオプトアウトをする | enableInlineSuggestionAsYouTypeOptOut |
入力中のインライン提案のオプトアウトコントロール。 |
| 行番号を有効にする | enableLineNumbers |
エディタ内で行番号が表示されるかどうかを制御します。 |
| ライン番号V2を有効にする | enableLineNumbersV2 |
エディタ(v2)で行番号が表示されるかどうかを制御します。 |
| ラインラップを有効にする | enableLineWrap |
エディタ内でテキストが次の行にラップされるかどうかを制御します。 |
| モナコマルチカーソルを有効にする | enableMonacoMultiCursor |
マルチカーソル修飾キーを操作します。 使用できる値: alt、ctrlCmd。 |
| Notebook Debugger Optout を有効にする | enableNotebookDebuggerOptOut |
ノートブックデバッガのオプトアウトコントロール。 |
| サーバーレス観測性トグルを有効にする | enableServerlessObservabilityToggle |
ワークスペースプレビューが有効であるジョブの改善されたサーバーレス観察可能性のユーザーオプトイン。 |
| 新しいセルUIでコマンドステータス表示を有効にする | enableShowCommandStatsInNewCellUi |
コマンド統計が新しいセルUIに表示されるかどうかを制御します。 |
| 番組プロモーションセルタイトルを有効にする | enableShowPromotedCellTitles |
プロモーションされたセルタイトルが表示されるかどうかを制御します。 |
| スマートクォートを有効にする | enableSmartQuotes |
エディターでスマートクォートが有効かどうかを制御します。 |
| ノートブックとファイルのソフトタブを有効にする | enableSoftTabsForNotebooksAndFiles |
ノートブックやファイルのタブがスペースに変換されるかどうかを制御します。 |
| SQL構文エラーハイライトを有効にする | enableSqlSyntaxErrorHighlighting |
SQLの構文エラーがハイライトされるかどうかを制御します。 |
| 実行後にコマンドモードへの切り替えを有効にする | enableSwitchToCommandModeAfterExecution |
セル実行後にエディターがコマンドモードに切り替わるかどうかを制御します。 |
| 統一ファイルツリーエクスプローラーを有効にする | enableUnifiedFileTreeExplorer |
統合ファイルツリーエクスプローラーが有効になっているかどうかを制御します。 |
| フォーカス | enableUnifiedSchemaBrowserTreeExplorer |
統合スキーマブラウザツリーエクスプローラーが有効かどうかを制御します。 |
| Vega Lite レンダラーを有効にする | enableVegaLiteRenderer |
Vega-Lite レンダラーが可視化のために有効かどうかを制御します。 |
| Vega Liteレンダラーのオプトアウトを有効にする | enableVegaLiteRendererOptOut |
Vega-Lite レンダラーのオプトアウトコントロール。 |
| Vega Lite Renderer プレビュータグを有効にする | enableVegaLiteRendererPreviewTag |
Vega-Lite レンダラープレビュータグが表示されるかどうかを制御します。 |
| 拡張された底板 | extendedBottomPanel |
拡張された下部パネルが表示されるかどうかを制御します。 |
| レイクフロー新パイプラインモニタリングUIです | lakeflowNewPipelinesMonitoringUi |
新しいLakeflowパイプライン監視UIが有効かどうかを制御します。 |
| ノートブックのデフォルトエクスポートフォーマット | notebookDefaultExportFormat |
ノートブックのデフォルトのエクスポート形式を制御します。 使用できる値: SOURCE、JUPYTER。 |
| オプション矢印ショートカットモード | optionArrowShortcutMode |
オプション+矢印キーボードショートカットの挙動を制御します。 使用できる値: navigate、move。 |
| パイプラインマルチファイルオーサリング | pipelinesMultifileAuthoring |
パイプラインでマルチファイルオーサリングが有効かどうかを制御します。 |
| コメントメール通知を送信 | sendCommentEmailNotifications |
コメントのためのメール通知の送信を制御します。 |
| セル実行ミニマップを表示 | showCellExecutionMinimap |
セル実行ミニマップの表示を制御します。 |
| 「Pipを環境パネルに表示」プロンプト | showPipToEnvironmentPanelPrompt |
環境パネルのプロンプトにPIPを表示するかどうかを制御します。 |
| ショースパークアドバイザー | showSparkAdvisor |
Spark最適化提案が表示されるかどうかを制御します。 |
| Show Sparkエラーのヒント | showSparkErrorTips |
Sparkエラーの有用なヒントが表示されるかどうかを制御します。 |
| ユーザーが Python フォーマットエラーハイライトを有効にする | userActivatesPythonFormatErrorHighlighting |
Pythonのフォーマットエラーがハイライトされるかどうかを制御します。 |
| ユーザーがPython構文エラーを起動し、オプトアウトを強調する | userActivatesPythonSyntaxErrorHighlightingOptOut |
Pythonの構文エラーハイライトのオプトアウトコントロール。 |
| ユーザーがPython型検査を有効化する | userActivatesPythonTypeChecking |
Python型検査が有効かどうかを制御します。 |
| ユーザーがスナップショット復元を有効にする | userActivatesSnapshotRestore |
スナップショット復元機能が有効かどうかを制御します。 |
| 新規クエリのデフォルト上限は1000 | usqleDefaultQueryAutoLimit |
エディタ内のSQLクエリのデフォルト自動制限を制御します。 |