メインコンテンツまでスキップ

settings コマンド グループ

注記

この情報は、Databricks CLI バージョン 0.205 以降に適用されます。Databricks CLI は パブリック プレビュー段階です。

Databricks CLI 使用には、使用状況データを含む Databricks ライセンス および Databricks プライバシー通知が適用されます。

Databricks CLI内のsettingsコマンドグループには、ワークスペース全体に適用されるさまざまな機能とポリシーを制御するコマンド管理ワークスペースレベルの設定が含まれています。ワークスペースの管理を参照してください。

databricks settings aibi-dashboard-embedding-access-policy​

AI/BI で公開されたダッシュボードの埋め込みを、ワークスペース レベルで有効にするか、条件付きで有効にするか、無効にするかを制御します。デフォルトでは、この設定は条件付きで有効になっています(ALLOW_APPROVED_DOMAINS)。

  • delete - AI/BI dashboard 埋め込みアクセスポリシーを削除します。
  • get - AI/BI dashboard 埋め込みアクセスポリシーを取得する
  • update - AI/BI dashboard 埋め込みアクセスポリシーを更新する

databricks settings aibi-dashboard-embedding-access-policy get​

AI/BI dashboard埋め込みアクセスポリシーを取得します。デフォルト設定は ALLOW_APPROVED_DOMAINSで、承認済みドメインに AI/BI ダッシュボードを埋め込むことができます。

databricks settings aibi-dashboard-embedding-access-policy get [flags]

オプション​

--etag string

etag を使用します。

グローバルフラグ

例​

Bash
databricks settings aibi-dashboard-embedding-access-policy get

databricks settings aibi-dashboard-embedding-access-policy update​

ワークスペース レベルで AI/BI dashboard 埋め込みアクセス ポリシーを更新します。

databricks settings aibi-dashboard-embedding-access-policy update [flags]

オプション​

--json JSON

インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。

グローバルフラグ

例​

Bash
databricks settings aibi-dashboard-embedding-access-policy update --json '{"access_policy": "ALLOW_ALL"}'

databricks settings aibi-dashboard-embedding-access-policy delete​

AI/BI dashboard埋め込みアクセスポリシーを削除し、デフォルトに戻します。

databricks settings aibi-dashboard-embedding-access-policy delete [flags]

オプション​

--etag string

etag を使用します。

グローバルフラグ

例​

Bash
databricks settings aibi-dashboard-embedding-access-policy delete

databricks settings aibi-dashboard-embedding-approved-domains​

埋め込み AI/BI ダッシュボードをホストすることが承認されたドメインのリストを制御します。現在のアクセスポリシーが ALLOW_APPROVED_DOMAINSに設定されていない場合、承認済みドメインリストを変更することはできません。

  • delete - 承認済みドメインの削除 AI/BI dashboard 埋め込み
  • get - 組み込み AI/BI ダッシュボードのホストが承認されたドメインのリストを取得する
  • update - 組み込み AI/BI ダッシュボードのホストが承認されたドメインのリストを更新する

オプション​

グローバルフラグ

例​

Bash
databricks settings aibi-dashboard-embedding-approved-domains get
Bash
databricks settings aibi-dashboard-embedding-approved-domains update --json '{"approved_domains": ["example.com", "mydomain.org"]}'

databricks settings automatic-cluster-update​

現在のワークスペースでクラスターの自動更新を有効にするかどうかを制御します。 デフォルトでは、オフになっています。

  • get - クラスター自動更新設定を取得する
  • update - クラスターの自動更新設定の更新

オプション​

グローバルフラグ

databricks settings automatic-cluster-update get​

クラスターの自動更新設定を取得します。

databricks settings automatic-cluster-update get [flags]

オプション​

--etag string

etag を使用します。

グローバルフラグ

例​

Bash
databricks settings automatic-cluster-update get

databricks settings automatic-cluster-update update​

ワークスペースのクラスターの自動更新設定を更新します。 更新リクエストで新しい etag を指定する必要があります (設定フィールドの一部として)。etag は、更新要求の前に get 要求を行うことで取得できます。

databricks settings automatic-cluster-update update [flags]

オプション​

--json JSON

インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。

グローバルフラグ

例​

Bash
databricks settings automatic-cluster-update update --json '{"automatic_cluster_update": {"enabled": true}}'

databricks settings compliance-security-profile​

現在のワークスペースのコンプライアンス セキュリティ プロファイルを有効にするかどうかを制御します。ワークスペースで有効にすると、永続的です。デフォルトでは、オフになっています。

警告

この設定は、一度有効にすると無効にすることはできません。

  • get - コンプライアンス セキュリティ プロファイル設定を取得する
  • update - コンプライアンス セキュリティ プロファイル設定を更新する

オプション​

グローバルフラグ

例​

Bash
databricks settings compliance-security-profile get
Bash
databricks settings compliance-security-profile update --json '{"compliance_security_profile": {"enabled": true}}'

databricks settings dashboard-email-subscriptions​

スケジュールまたはワークロードタスクを更新するかどうかを制御します AI/BI ダッシュボード ダッシュボードの PDF や画像を含むサブスクリプション メールを送信できます。 デフォルトでは、この設定は有効になっています (true に設定)。

  • delete - ダッシュボードの電子メール購読設定を削除する
  • get - ダッシュボードの電子メール購読設定を取得する
  • update - ダッシュボードの電子メール購読設定を更新する

オプション​

グローバルフラグ

例​

Bash
databricks settings dashboard-email-subscriptions get
Bash
databricks settings dashboard-email-subscriptions update --json '{"dashboard_email_subscriptions": {"enabled": false}}'

databricks settings default-namespace​

Databricksワークスペースのデフォルト名前空間を設定します。

このコマンドを使用すると、ユーザーは、クエリが完全修飾 3 レベル名を参照しない場合に使用されるデフォルト名前空間を取得、設定、または変更できます。 たとえば、API を使用して retail_prod をデフォルトのカタログとして設定すると、クエリ SELECT * FROM myTable はオブジェクト retail_prod.default.myTable を参照します (スキーマ default は常に想定されます)。

注記

この設定を有効にするには、クラスターと SQLウェアハウスを再起動する必要があります。 さらに、デフォルト名前空間は、Unity Catalog 対応コンピュートを使用する場合にのみ適用されます。

  • delete - デフォルトの名前空間設定を削除する
  • get - デフォルトの名前空間設定を取得する
  • update - デフォルトの名前空間設定を更新する

オプション​

グローバルフラグ

例​

Bash
databricks settings default-namespace get
Bash
databricks settings default-namespace update --json '{"namespace": {"value": "retail_prod"}}'
Bash
databricks settings default-namespace delete

databricks settings disable-legacy-access​

レガシーアクセスを無効にすると、以下のような影響があります。

  • ワークスペースからHiveメタストアへの直接アクセスを無効にします。ただし、Hiveメタストアフェデレーションを通じてHiveメタストアにアクセスすることは可能です。

  • ワークスペースからの外部ロケーションアクセスのフォールバックモードを無効にします。

  • 13.3 LTS より前のバージョンの Databricks Runtime を無効にします。

  • delete - レガシーアクセスの無効化ステータスを削除する

  • get - レガシーアクセスの無効化ステータスを取得する

  • update - レガシーアクセスの無効化ステータスを更新する

オプション​

グローバルフラグ

例​

Bash
databricks settings disable-legacy-access get
Bash
databricks settings disable-legacy-access update --json '{"disable_legacy_access": {"disabled": true}}'

databricks settings enable-export-notebook​

ユーザーがワークスペース UI からノートブックとファイルをエクスポートできるかどうかを制御します。デフォルトでは、この設定は有効になっています。

  • get-enable-export-notebook - ノートブックとファイルのエクスポート設定を取得する
  • patch-enable-export-notebook - ノートブックとファイルのエクスポート設定を更新する

オプション​

グローバルフラグ

例​

Bash
databricks settings enable-export-notebook get-enable-export-notebook
Bash
databricks settings enable-export-notebook patch-enable-export-notebook --json '{"allow_missing": true, "setting": {"enabled": false}}'

databricks settings enable-notebook-table-clipboard​

ユーザーが UI を介して表形式データをクリップボードにコピーできるかどうかを制御します。デフォルトでは、この設定は有効になっています。

  • get-enable-notebook-table-clipboard - 結果テーブルのクリップボード機能設定を取得する
  • patch-enable-notebook-table-clipboard - 結果テーブルのクリップボード機能設定を更新する

オプション​

グローバルフラグ

例​

Bash
databricks settings enable-notebook-table-clipboard get-enable-notebook-table-clipboard
Bash
databricks settings enable-notebook-table-clipboard patch-enable-notebook-table-clipboard --json '{"allow_missing": true, "setting": {"enabled": false}}'

databricks settings enable-results-downloading​

ユーザーがノートブックの結果をダウンロードできるかどうかを制御します。デフォルトでは、この設定は有効になっています。

  • get-enable-results-downloading - ノートブックの結果ダウンロード設定を取得する
  • patch-enable-results-downloading - ノートブックの結果ダウンロード設定を更新する

オプション​

グローバルフラグ

例​

Bash
databricks settings enable-results-downloading get-enable-results-downloading
Bash
databricks settings enable-results-downloading patch-enable-results-downloading --json '{"allow_missing": true, "setting": {"enabled": false}}'

databricks settings enhanced-security-monitoring​

現在のワークスペースに対してセキュリティ強化モニタリングを有効にするかどうかを制御します。 コンプライアンス・セキュリティ・プロファイルが有効になっている場合、これは自動的に有効になります。デフォルトでは無効になっています。ただし、コンプライアンス・セキュリティ・プロファイルが有効になっている場合、これは自動的に有効になります。

コンプライアンス セキュリティ プロファイルが無効になっている場合、この設定を有効または無効にできますが、永続的ではありません。

  • get - 強化されたセキュリティモニタリング設定を取得する
  • update - セキュリティ強化モニタリング設定を更新する

オプション​

グローバルフラグ

例​

Bash
databricks settings enhanced-security-monitoring get
Bash
databricks settings enhanced-security-monitoring update --json '{"enhanced_security_monitoring": {"enabled": true}}'

databricks settings restrict-workspace-admins​

[ワークスペース管理者を制限] 設定では、ワークスペース管理者の機能を制御できます。 設定ステータスを ALLOW_ALLに設定すると、ワークスペース管理者は、ワークスペース内のサービスプリンシパルに代わってサービスプリンシパル personal access トークンを作成できます。 ワークスペース管理者は、ワークスペースの任意のユーザーにジョブ所有者を変更することもできます。 また、ジョブ run_as 設定をワークスペース内の任意のユーザー、またはサービスプリンシパルユーザーロールを持つサービスプリンシパルに変更できます。

設定ステータスが RESTRICT_TOKENS_AND_JOB_RUN_ASに設定されている場合、ワークスペース管理者は、サービスプリンシパル ユーザー ロールを持つサービスプリンシパルに代わってのみ個人アクセストークンを作成できます。 また、ジョブの所有者を自分自身に変更することしかできません。また、ジョブ run_as 設定を自分自身に変更することも、サービスプリンシパル ユーザーロールを持つサービスプリンシパルに変更することもできます。

  • delete - ワークスペース管理者の制限設定を削除する
  • get - ワークスペース管理者の制限設定を取得する
  • update - ワークスペース管理者の制限設定を更新する

オプション​

グローバルフラグ

例​

Bash
databricks settings restrict-workspace-admins get
Bash
databricks settings restrict-workspace-admins update --json '{"restrict_workspace_admins": {"status": "RESTRICT_TOKENS_AND_JOB_RUN_AS"}}'
Bash
databricks settings restrict-workspace-admins delete

databricks settings sql-results-download​

ワークスペース内のユーザーが SQL エディターおよび AI/BI ダッシュボード UI から結果をダウンロードできるようにするかどうかを制御します。デフォルトでは、この設定は有効になっています (true に設定)。

  • delete - SQL 結果のダウンロード設定を削除します
  • get - SQL 結果のダウンロード設定を取得する
  • update - SQL 結果のダウンロード設定を更新します

オプション​

グローバルフラグ

例​

Bash
databricks settings sql-results-download get
Bash
databricks settings sql-results-download update --json '{"sql_results_download": {"enabled": false}}'
Bash
databricks settings sql-results-download delete

グローバルフラグ​

--debug

デバッグログを有効にするかどうか。

-h または --help

Databricks CLI、関連するコマンド グループ、または関連するコマンドのヘルプを表示します。

--log-file string

出力ログの書き込み先となるファイルを表す文字列。このフラグが指定されていない場合、デフォルトでは出力ログが stderr に書き込まれます。

--log-format format

ログ・フォーマット・タイプ ( text または json) 。デフォルト値は textです。

--log-level string

ログ形式レベルを表す文字列。指定しない場合、ログ・フォーマット・レベルは使用不可になります。

-o, --output タイプ

コマンド出力タイプ text または json。デフォルト値は textです。

-p, --profile string

コマンドの実行に使用する ~/.databrickscfg ファイル内のプロファイルの名前。このフラグが指定されていない場合、存在する場合は、 DEFAULT という名前のプロファイルが使用されます。

--progress-format format

進行状況ログを表示する形式: default、 append、 inplace、 json

-t, --target string

該当する場合は、使用するバンドル・ターゲット

に最終更新