configure コマンド
この情報は、Databricks CLI バージョン 0.205 以降に適用されます。Databricks CLI は パブリック プレビュー段階です。
Databricks CLI 使用には、使用状況データを含む Databricks ライセンス および Databricks プライバシー通知が適用されます。
Databricks CLI 内の configure コマンドを使用すると、Databricks 個人用アクセス トークンを使用して Databricks CLI を Databricks で認証できます。
セキュリティのベストプラクティスとして、自動化されたツール、システム、スクリプト、アプリで認証する場合、Databricks では、ワークスペースユーザーではなく、サービスプリンシパル に属する個人用アクセストークンを使用することをお勧めします。 サービスプリンシパルのトークンを作成するには、「 サービスプリンシパルのトークンの管理」を参照してください。
この記事では、 ワークスペース レベルの コマンドの呼び出しを有効にするための Databricks トークン認証のみについて説明します。その他の認証構成オプションについては、「 Databricks CLI の認証」を参照してください。
databricks configure
~/.databrickscfgファイルでプロファイルを設定します。 構成プロファイル は、Databricks ワークスペース URL やアクセス トークン値などの認証情報を含む設定のコレクションです。
構成プロファイルには、 DEFAULT、 DEV、 PRODなどのプログラム名が付けられます。.databrickscfgファイルに複数のプロファイルを追加すると、コマンドの--profileオプションでターゲット接続プロファイルの名前を指定することで、さまざまなワークスペースでコマンドをすばやく実行できます。このオプションをサポートするコマンドで --profile オプションを指定しない場合、コマンドはデフォルトで DEFAULT 接続プロファイルを使用します。
たとえば、開発ワークロードに使用するDatabricksワークスペースを参照する DEV という名前の接続プロファイルと、本番運用ワークロードに使用する別のDatabricksワークスペースを参照する PROD 接続プロファイルという名前の別の接続プロファイルを持つことができます。
既存の構成プロファイルに関する情報を取得するには、 auth コマンドグループを使用します。
.databrickscfgファイルのデフォルトパスを変更するには、環境変数 DATABRICKS_CONFIG_FILEを設定します。
このコマンドが非対話モードで呼び出されると、stdinからトークンが読み取られます。ホストは、 --host フラグまたは DATABRICKS_HOST 環境変数で指定する必要があります。
databricks configure [flags]
オプション
--configure-cluster
クラスターを設定するプロンプト
--host string
Databricks ワークスペース ホスト URL
ワークスペースホスト URL の後にインスタンス名 (例: https://<prefix>.<random-number>.gcp.databricks.com) がhttps://されます。インスタンス名を取得するには、「 ワークスペースインスタンス名、URL、および ID」を参照してください。
--profile string
構成する接続プロファイルの名前。(デフォルト "デフォルト")
例
次の例では、デフォルトプロファイルの認証を設定します。
databricks configure
次の例では、特定のプロファイルの認証を設定します。
databricks configure --profile my-profile
次の例では、特定のホストで認証を設定します。
databricks configure --host https://my-workspace.cloud.databricks.com
次の例では、クラスター設定を使用して認証を設定します。
databricks configure --configure-cluster
グローバルフラグ
--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
該当する場合は、使用するバンドル・ターゲット
構成プロファイルを作成する
構成プロファイルを作成するには、 configure コマンドを実行します。
databricks configure --host <workspace-url>
このコマンドでは、指定した<workspace-url>にマップされる Databricks 個人用アクセス トークンを入力するように求められます。
✔ Databricks Token:
アクセストークンを入力すると、アクセストークンは、LinuxまたはmacOSではファイル ~/.databrickscfg に保存され、Windowsではデフォルトで %USERPROFILE%\.databrickscfg に保存されます。このファイルには、 DEFAULTという名前のデフォルトの接続プロファイルエントリが含まれています。
[DEFAULT]
host = <workspace-url>
token = <access-token>
接続プロファイルに DEFAULTではなく別の名前を使用するには、次のように configure コマンドに --profile オプションを追加します。
databricks configure --host <workspace-url> --profile <profile-name>
構成プロファイル名を手動で入力する代わりに、--profileまたは-pの後にTabを押すと、選択可能な既存の構成プロファイルのリストが表示されます。
指定された接続プロファイル内の既存のホストおよびトークン情報は、新しいホストおよびトークン情報で上書きされます。