設定APIキーのリファレンス
このページでは、公開されているDatabricks Settings APIを通じて利用可能な設定を、スコープごとにグループ化して一覧表示します。各設定は、安定した 設定名 (キー)によって識別されます。これらの設定の検出、読み取り、更新方法については、Settings APIによる設定の管理を参照してください。
機能プレビューも Settings API を通じて管理されますが、一時的なものであり最終的にサポートが終了するため、ここには一覧表示されません。settings-metadata endpoint を通じて、現在利用可能なプレビューを確認してください。
使用可能な設定
以下の設定は、パブリック Settings API を通じて利用可能であり、スコープごとにグループ化されています。このリストは定期的に生成されます。常に最新の信頼できる設定セットとそのドキュメントリンクについては、settings-metadata endpointを呼び出してください。これにより、各設定の name、description、type、および docs_link が返されます。
アカウント設定
アカウント全体に適用される設定。
設定 | キー名 | 説明 |
|---|---|---|
| 新しい Databricks ワークスペースのレガシー機能を無効にします。新しく作成されたワークスペースの場合: 1. DBFSルートとマウントの使用を無効にします。2. Hive metastoreはプロビジョニングされません。3. 「分離なし共有クラスター」の使用を無効にします。4. 13.3LTSより前のDatabricks Runtimeのバージョンを無効にします。 | |
| パートナー提供のモデルが有効かどうかを決定します。この設定は、アカウントレベルとワークスペースレベルの両方で使用できます | |
| パートナーが提供する強制設定がオンになっているかどうかを判断します。有効にすると、アカウントレベルのパートナー提供値が、ワークスペースレベルのオーバーライドよりも優先されます。 | |
| 「ワークスペース管理者を制限する」設定では、ワークスペース管理者の機能を制御できます。設定ステータスが ALLOW_ALL に設定されている場合、ワークスペース管理者は、ワークスペース内の任意のService Principalに代わって、Service Principalのパーソナルアクセストークンを作成できます。ワークスペース管理者は、ジョブの所有者をワークスペース内の任意のユーザーに変更することもできます。また、ジョブの run_as 設定を、Service Principal内の任意のユーザー、または「Service Principalユーザー」ロールを持つService Principalに変更することもできます。設定ステータスが RESTRICT_TOKENS_AND_JOB_RUN_AS に設定されている場合、ワークスペース管理者は、「Service Principal User」ロールを持つ Service Principal に代わってのみ、パーソナルアクセストークンを作成できます。また、ジョブの所有者を自分自身にのみ変更できます。また、ジョブの run_as 設定を、自分自身、または「Service Principalユーザー」ロールを持つService Principalに変更することもできます。 | |
| アカウント内に作成される新しいワークスペースに対して、コンプライアンス セキュリティ プロファイルをdefaultで有効にするかどうかを制御します。コンプライアンス セキュリティ プロファイルは、適用されるコンプライアンス基準を満たし、管理を容易にする安全性の高いベースライン(追加のモニタリング、強化されたコンピュート イメージ、強制的なインスタンス タイプ、およびその他の制御)を提供します。アカウントのdefaultとして有効にすると、新しいワークスペースに対して強化されたセキュリティ モニタリングと自動クラスター更新も有効になります。 | |
| アカウントで作成された新しいワークスペースに対して、強化されたセキュリティモニタリングがdefaultで有効になるかどうかを制御します。強化されたセキュリティモニタリングは、ハード化されたコンピュートイメージと、レビュー可能なログ行を生成する追加のセキュリティモニタリングエージェントを提供します。新しいワークスペースでコンプライアンスセキュリティプロファイルが有効になっている場合、この設定は永続的に適用されます。アカウントレベルの強化されたセキュリティモニタリングは、AWSおよびGCPでのみサポートされています。 |
ワークスペース設定
単一のワークスペースに適用される設定。
設定 | キー名 | 説明 |
|---|---|---|
| ワークスペースレベルで、AI/BI 公開ダッシュボードの埋め込みを有効、条件付きで有効、または無効にするかどうかを制御します。By default、この設定は条件付きで有効 (ALLOW_APPROVED_DOMAINS) になっています。 | |
| 埋め込みAI/BIダッシュボードをホストするために承認されたドメインのリストを制御します。現在のアクセス ポリシーが ALLOW_APPROVED_DOMAINS に設定されていない場合、承認済みドメインリストを変更することはできません。 | |
| アプリ開発者がユーザーに代わって操作する際にリクエストできるOAuthスコープを制限します。許可されているスコープのリストを指定するか、「*」を使用してすべてのサポートされているスコープを許可します。リストが空の場合、アプリのユーザー認可は実質的に無効になります。 | |
| 自動クラスター更新により、ワークスペース内のすべてのクラスターが最新のホスト OS イメージおよびセキュリティ更新に定期的に更新されます。アカウント管理者は、メンテナンスウィンドウの頻度、開始日、開始時刻をスケジュールできます。クラシック コンピュート(クラスター、プール、クラシック SQL Warehouse、レガシー Model Serving)に適用されます。Serverless コンピュートには適用されません。この機能を有効にすると、強化されたセキュリティおよびコンプライアンス アドオンが追加され、Premium 価格プランが必要になります。 | |
| このワークスペースに接続できる外部コラボレーションプラットフォーム(Slack および/または Microsoft Teams)を制御します。default to ALLOW_ALL. | |
| 有効にすると、ユーザーはSlackのDatabricksアプリからの応答をチャンネルに表示するかどうかを選択できます。無効にすると、すべての応答はリクエストしたユーザーのみが閲覧できるよう強制されます。 | |
| Databricks 担当者がワークスペースにログインできなくなるまでの特定の時間。時刻は | |
| The default namespace setting APIを使用すると、ユーザーはDatabricks workspaceのdefault namespaceを構成できます。 | |
| 「レガシーアクセスの無効化」には以下の影響があります:1. ワークスペースからHive metastoresへの直接アクセスを無効にします(Hive metastore federationを通じたアクセスは影響を受けません)。2. ワークスペースからの外部ロケーションアクセスにおけるfallbackモードを無効にします。3. 13.3LTSより前のDatabricks Runtimeのバージョンを無効にします。重要:ワークスペースのdefaultカタログがレガシーカタログ(hive_metastoreまたはspark_catalog)に設定されている間は、この設定を有効にできません。まず、defaultカタログをUnity Catalogカタログに変更してください。 | |
| レガシーDBFSを無効にすると、次の2つの影響があります。1. DBFSルートおよびDBFSマウントへのアクセス(および新しいマウントの作成)は許可されません。2. 13.3LTSより前のDatabricks Runtimeのバージョンを無効にします。設定が「オフ」の場合、すべてのDBFS機能が有効になり、Databricks Runtimeのバージョンに対する制限は課されません。この設定は有効になるまでに最大20分かかる可能性があり、汎用コンピュートクラスターとSQL Warehouseの手動による再起動が必要になります。 | |
| 有効にすると、このワークスペースのアプリはGitからのみデプロイできます。 | |
| パートナー提供のモデルが有効かどうかを決定します。この設定は、アカウントレベルとワークスペースレベルの両方で使用できます | |
| ミッションクリティカルなワークロードに対し、最高水準の運用の回復性とセキュリティを提供します。ディザスタリカバリと、強化されたセキュリティおよびコンプライアンスが含まれます。 | |
| このワークスペースの運用Eメールの追加受信者。設定すると、Databricks はこれらのEメールをワークスペース管理者とこのアドレスの両方に配信します。AWS および GCP で利用可能です。 | |
| 「ワークスペース管理者を制限する」設定では、ワークスペース管理者の機能を制御できます。設定ステータスが ALLOW_ALL に設定されている場合、ワークスペース管理者は、ワークスペース内の任意のService Principalに代わって、Service Principalのパーソナルアクセストークンを作成できます。ワークスペース管理者は、ジョブの所有者をワークスペース内の任意のユーザーに変更することもできます。また、ジョブの run_as 設定を、Service Principal内の任意のユーザー、または「Service Principalユーザー」ロールを持つService Principalに変更することもできます。設定ステータスが RESTRICT_TOKENS_AND_JOB_RUN_AS に設定されている場合、ワークスペース管理者は、「Service Principal User」ロールを持つ Service Principal に代わってのみ、パーソナルアクセストークンを作成できます。また、ジョブの所有者を自分自身にのみ変更できます。また、ジョブの run_as 設定を、自分自身、または「Service Principalユーザー」ロールを持つService Principalに変更することもできます。 | |
| このワークスペースでコンプライアンス セキュリティ プロファイルを有効にするかどうかを制御します。コンプライアンス セキュリティ プロファイルは、適用されるコンプライアンス標準を満たし、管理しやすくするための非常に安全なベースライン (追加のモニタリング、強化されたコンピュート イメージ、ノード間暗号化のための強制インスタンス タイプ、およびその他の制御) を提供します。これを有効にすると、ワークスペースで拡張セキュリティ モニタリングと自動クラスター更新も永続的に有効になり、Enhanced Security and Compliance アドオンが追加されます。 | |
| このワークスペースで強化されたセキュリティ モニタリングを有効にするかどうかを制御します。強化されたセキュリティ モニタリングは、ハードニング済みのコンピュートイメージと、レビュー可能な Logs 行を生成する追加のセキュリティ モニタリング エージェント(ファイル整合性監視、ウイルス対策、脆弱性スキャン)を提供します。これはクラシック コンピュート プレーンのリソースにのみ適用され、Serverlessには適用されません。ワークスペースでコンプライアンス セキュリティ プロファイルが有効になっている場合、この設定は永続的に適用されます。 |
ユーザー設定
アカウント内のユーザーに適用される設定。
設定 | キー名 | 説明 |
|---|---|---|
エディターとのインタラクションで自動的にセッションを作成 |
| エディターとのインタラクション時にセッションを自動的に作成するかどうかを制御します。 |
自動ローンチとアタッチ |
| ノートブックが自動的にクラスターを起動してアタッチするかどうかを制御します。 |
コマンド削除の確認 |
| コマンドの削除前に確認が必要かどうかをコントロールします。 |
下書きフォルダに新規アセットを作成 |
| 下書きフォルダに新しいアセットを作成するかどうかを制御します。 |
Databricks 統合 SQL エディタでのクエリーの作成および変換の基本設定 |
| 統合SQLエディタにおけるクエリーの作成および変換動作を制御します。 |
default Pythonインデント単位 |
| Controls the default Python indent unit.許可される値: |
エディタのカスタムダークテーマ |
| エディタのカスタムダークテーマを制御します。許可されている値: |
エディタのカスタムライトテーマ |
| エディタのカスタムライトテーマを制御します。許可される値: |
エディタのフォントサイズ |
| エディターのフォントサイズを調整します。許可される値:10から30までの整数。 |
自動インラインクイック修正を有効にする |
| インラインのクイックフィックスを自動的に提案するかどうかを制御します。 |
自動インライン クイック修正のオプトアウトを有効にする |
| 自動インラインクイック修正のオプトアウト制御 |
自動Trigger診断を有効にする |
| 診断を自動的にTriggerするかどうかを制御します。 |
自動Trigger診断のオプトアウトを有効にする |
| 自動診断のオプトアウト制御。 |
中央揃えのLayoutを有効化 |
| エディタで中央揃えのLayoutを使用するかどうかを制御します。 |
クラシックショートカットを有効にする |
| キーボードショートカットモードを制御します。使用できる値: |
コマンド番号を有効にする |
| ノートブックにコマンド番号を表示するかどうかを制御します。 |
入力時に補完を有効にする |
| 入力時にオートコンプリート候補を表示するかどうかを制御します。 |
カーソルの点滅を有効にする |
| エディタでカーソルを点滅させるかどうかを制御します。 |
ダークモードを有効にする |
| テーマモードを制御します。使用できる値: |
Enterキーによる提案の受け入れを有効にする |
| Enterキーを押したときにオートコンプリートの提案を受け入れるかどうかを制御します。 |
エディタのホバーを有効化 |
| エディタでホバーツールヒントを表示するかどうかを制御します。 |
入力時のインライン提案のオプトアウトを有効化 |
| 入力時のインライン提案のオプトアウト制御。 |
行番号を有効にする |
| エディタに行番号を表示するかどうかを制御します。 |
行番号 V2 を有効にする |
| エディタ (v2) で行番号を表示するかどうかを制御します。 |
行の折り返しを有効にする |
| エディターでテキストを次の行に折り返すかどうかを制御します。 |
Monacoマルチカーソルを有効にする |
| マルチカーソル修飾キーを制御します。使用できる値: |
ノートブックデバッガーの有効化とオプトアウト |
| ノートブックデバッガーのオプトアウト制御。 |
Serverless 可観測性トグルの有効化 |
| ワークスペースプレビューが有効な場合に、ジョブにおけるServerlessの可観測性向上に対するユーザーのオプトイン。 |
新しいセルUIでのコマンド統計の表示を有効にする |
| 新しいセルUIでコマンドの統計を表示するかどうかを制御します。 |
昇格したセルのタイトルの表示を有効にする |
| 昇格したセルのタイトルを表示するかどうかを制御します。 |
スマートクォートを有効化 |
| エディタでスマートクォートを有効にするかどうかを制御します。 |
ノートブックとファイルのソフトtabを有効化 |
| ノートブックとファイル内でtabをスペースに変換するかどうかを制御します。 |
SQL構文エラーの強調表示を有効にする |
| SQL 構文エラーを強調表示するかどうかを制御します。 |
実行後にコマンドモードへの切り替えを有効にする |
| セルの実行後にエディタがコマンドモードに切り替わるかどうかを制御します。 |
統合ファイルツリーエクスプローラーを有効にする |
| 統合ファイルツリーエクスプローラーを有効にするかどうかを制御します。 |
フォーカス |
| 統合スキーマブラウザのツリーエクスプローラーを有効にするかどうかを制御します。 |
Vega Liteレンダラーを有効にする |
| ビジュアライゼーションでVega-Liteレンダラーを有効にするかどうかを制御します。 |
Vega Liteレンダラーのオプトアウトを有効にする |
| Vega-Liteレンダラーのオプトアウト制御。 |
Vega-Lite レンダラープレビュータグを有効にする |
| Vega-Liteレンダラーのプレビュータグを表示するかどうかを制御します。 |
展開された下部パネル |
| 展開された下部パネルを表示するかどうかを制御します。 |
Lakeflow 新パイプライン モニタリング UI |
| 新しい Lakeflow Pipelines モニタリング UI を有効にするかどうかを制御します。 |
ノートブックのdefaultのエクスポート形式 |
| ノートブックのdefaultのエクスポート形式を制御します。使用できる値: |
Option + 矢印ショートカット Mode |
| Option+矢印キーボードショートカットの動作を制御します。使用できる値: |
パイプラインのマルチファイルオーサリング |
| パイプラインのマルチファイルオーサリングを有効にするかどうかを制御します。 |
コメントのEメール通知を送信 |
| コメントのEメール通知を送信するかどうかを制御します。 |
セル実行ミニマップを表示 |
| セル実行ミニマップを表示するかどうかを制御します。 |
環境パネルへの Pip プロンプトを表示 |
| 環境パネルへの pip プロンプトを表示するかどうかを制御します。 |
Spark アドバイザーを表示 |
| Spark の最適化に関する提案を表示するかどうかをコントロールします。 |
Sparkエラーのヒントを表示 |
| Spark エラーに関する役立つヒントを表示するかどうかを制御します。 |
ユーザーが Python 形式エラーの強調表示を有効にする |
| Python の書式設定エラーを強調表示するかどうかを制御します。 |
ユーザーがPython構文エラーの強調表示のオプトアウトを有効にする |
| Python構文エラーの強調表示のオプトアウト設定。 |
ユーザーが Python 型チェックを有効にする |
| Python の型チェックを有効にするかどうかを制御します。 |
ユーザーがスナップショットの復元をアクティブ化 |
| スナップショット復元機能が有効かどうかを制御します。 |
新規クエリーのデフォルト上限を1000にする |
| エディタ内のSQLクエリーに対するdefaultの自動制限を制御します。 |