configure コマンド グループ
この情報は、Databricks CLI バージョン 0.205 以降に適用されます。 Databricks CLI は パブリック プレビュー段階です。
Databricks CLI 使用には、 Databricks ライセンス および Databricks プライバシー通知(使用データのプロビジョニングを含む)が適用されます。
Databricks CLI 内の configure コマンド グループを使用すると、Databricks 個人用アクセス トークンを使用して Databricks CLI を Databricks で認証できます。
セキュリティのベストプラクティスとして、自動化されたツール、システム、スクリプト、アプリで認証する場合、Databricks では、ワークスペースユーザーではなく 、サービスプリンシパル に属する個人用アクセストークンを使用することをお勧めします。 サービスプリンシパルのトークンを作成するには、「 サービスプリンシパルのトークンの管理」を参照してください。
この記事では、 ワークスペース レベルの コマンドの呼び出しを有効にするための Databricks トークン認証について説明します。 その他の認証構成オプションについては、「 Databricks CLI の認証」を参照してください。
このコマンドを実行する前に、 Databricks CLI を必ず設定してください。
configureコマンドを実行するには、コマンドを databricks configureに追加します。configure コマンドのヘルプを表示するには、databricks configure -hを実行します。
設定プロファイルを作成してください
構成プロファイル は、Databricks ワークスペース URL やアクセス トークン値などの認証情報を含む設定のコレクションです。構成プロファイルには、 DEFAULT、 DEV、 PRODなどのプログラム名があります。
構成プロファイルを作成するには、次のように configure コマンドを実行します。
databricks configure --host <workspace-url>
[ <workspace-url>] に「 https:// 」と入力し、その後にインスタンス名を入力します (例: https://<prefix>.<random-number>.gcp.databricks.com)。 インスタンス名を取得するには 、「ワークスペースインスタンス名、URL、およびID」を参照してください。
このコマンドでは、指定した <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を押すと、選択可能な既存の構成プロファイルのリストが表示されます。
指定した接続プロファイル内の既存のホストとトークンの情報は、新しいホストとトークンの情報で上書きされます。
.databrickscfgファイルに複数の接続プロファイルを追加すると、コマンドの--profileオプションにターゲット接続プロファイルの名前を指定することで、さまざまなワークスペース間でコマンドをすばやく実行できます。このオプションをサポートするコマンドで --profile オプションを指定しない場合、コマンドはデフォルトで DEFAULT 接続プロファイルを使用します。
たとえば、開発ワークロードに使用する Databricks ワークスペースを参照する DEV という名前の接続プロファイルと、本番運用ワークロードに使用する別の Databricks ワークスペースを参照する PROD 接続プロファイルという名前の別の接続プロファイルがあるとします。
この .databrickscfg ファイルのデフォルトパスを変更するには、環境変数を DATABRICKS_CONFIG_FILEに設定します。 環境変数の設定方法については、オペレーティングシステムのドキュメントを参照してください。
既存の構成プロファイルに関する情報を取得するには、 auth コマンド グループを使用します。