configure コマンド グループ

この情報は、 パブリック プレビュー段階の Databricks CLI バージョン 0.205 以降に適用されます。 Databricks CLI のバージョンを見つけるには、 databricks -vを実行します。

Databricks CLI 内の configure コマンド グループを使用すると、Databricks personal アクセストークンを使用して、Databricks で Databricks CLI を認証できます。

セキュリティのベストプラクティスとして、自動化されたツール、システム、スクリプト、およびアプリで認証する場合、 Databricks では、ワークスペースユーザーではなく、 サービスプリンシパル に属する個人用アクセストークンを使用することをお勧めします。 サービスプリンシパルのトークンを作成するには、「 サービスプリンシパルのトークンを管理する」を参照してください。

この記事では、ワークスペース レベルのコマンドの呼び出しを有効にするための Databricks トークン認証についてのみ説明します。 追加の認証構成オプションについては、「 Databricks CLI の認証」を参照してください。

重要

このコマンドを実行する前に、 必ず Databricks CLI を設定してください。

configure コマンドを実行するには、コマンドを databricks configureに追加します。configure コマンドのヘルプを表示するには、 databricks configure -hを実行します。

構成プロファイル を作成する

構成プロファイル は、Databricks ワークスペースの URL やアクセストークン値などの認証情報を含む設定のコレクションです。構成プロファイルには、 DEFAULTDEVPRODなどのプログラム上の名前が付けられます。

構成プロファイルを作成するには、次のように configure コマンドを実行します。

databricks configure --host <workspace-url>

[ <workspace-url>] には、 https:// に続けてインスタンス名を入力します (例: https://<prefix>.<random-number>.gcp.databricks.com)。 インスタンス名を取得するには、「 ワークスペースのインスタンス名、URL、および ID」を参照してください。

このコマンドでは、指定した<workspace-url>にマップされる Databricks personal アクセストークンを入力するように求められます。

✔ Databricks Token:

アクセストークンを入力すると、アクセストークンはファイルに保存されます ~/.databrickscfg Linux または macOS の場合、または 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 を押すと、既存の使用可能な構成プロファイルの一覧が表示され、そこから選択できます。

指定された接続プロファイル内の既存のホストおよびトークン情報は、新しいホストおよびトークン情報で上書きされます。

複数の接続プロファイルを .databrickscfg ファイルに追加すると、コマンドの --profile オプションでターゲット接続プロファイルの名前を指定することで、さまざまなワークスペースでコマンドをすばやく実行できます。 このオプションをサポートするコマンドで --profile オプションを指定しない場合、コマンドはデフォルトで DEFAULT 接続プロファイルを使用します。

たとえば、開発ワークロードに使用する Databricks ワークスペースを参照する DEV という名前の接続プロファイルと PROD 運用ワークロードに使用する別の Databricks ワークスペースを参照する接続プロファイルという名前の別の接続プロファイルを作成できます。

この .databrickscfg ファイルのデフォルトパスを変更するには、環境変数を DATABRICKS_CONFIG_FILEに設定します。 環境変数の設定方法については、オペレーティング システムのマニュアルを参照してください。

既存の構成プロファイルに関する情報を取得するには、 auth コマンド グループを使用します。