Note
この情報は、Databricks CLI バージョン 0.205 以降に適用されます。 Databricks CLI は パブリック プレビュー段階です。
Databricks CLI の使用には、Databricks ライセンスおよび使用状況データのプロビジョニングを含むDatabricks のプライバシーに関する通知が適用されます。
configure 内の コマンドを使用すると、Azure Databricks 個人用アクセス トークンまたは Microsoft Entra ID (旧称 Azure Active Directory) トークンを使用して、Azure Databricks で Databricks CLI を認証できます。
Note
セキュリティのベスト プラクティスとして、自動化されたツール、システム、スクリプト、アプリを使用して認証する場合、Databricks では、ワークスペース ユーザーではなく サービス プリンシパル に属する個人用アクセス トークンを使用することをお勧めします。 サービス プリンシパルのトークンを作成するには、「サービス プリンシパルのトークンを管理する」をご覧ください。
この記事では、 ワークスペース レベル のコマンドの呼び出しを有効にするための Azure Databricks 個人用アクセス トークンと Microsoft Entra ID トークン認証についてのみ取り上げます。 その他の認証構成オプションについては、「Databricks CLI の認証」を参照してください。
databricks の設定
~/.databrickscfg ファイルでプロファイルを構成します。
構成プロファイルは、Azure Databricks ワークスペースの URL やアクセス トークン値などの認証情報を含む設定のコレクションです。
構成プロファイルには、DEFAULT、DEV、PROD などのプログラム名があります。
.databrickscfg ファイルに複数のプロファイルを追加すると、コマンドの --profile オプションでターゲット接続プロファイルの名前を指定することで、さまざまなワークスペースでコマンドをすばやく実行できます。 このオプションをサポートするコマンドで --profile オプションを指定しない場合、コマンドは既定で DEFAULT 接続プロファイルを使います。
たとえば、開発ワークロードに使う Azure Databricks ワークスペースを参照する DEV という名前の接続プロファイルと、運用ワークロードに使う別の Azure Databricks ワークスペースを参照する PROD という名前の接続プロファイルを個別の接続プロファイルとして持つことができます。
既存の構成プロファイルに関する情報を取得するには、 auth コマンド グループを使用します。
環境変数を.databrickscfg設定することで、DATABRICKS_CONFIG_FILE ファイルの既定のパスを変更できます。
このコマンドが非対話型モードで呼び出されると、stdin からトークンが読み取られます。 ホストは、 --host フラグまたは DATABRICKS_HOST 環境変数で指定する必要があります。
databricks configure [flags]
オプション
--configure-cluster
クラスターを構成するためのプロンプト
--host string
Databricks ワークスペースのホスト URL
ワークスペース ホスト URL はワークスペースごとの URL で、形式は https://adb-<workspace-id>.<random-number>.azuredatabricks.net。 ワークスペースごとの URL を取得するには、「ワークスペースごとの URL」を参照してください。
--profile string
構成する接続プロファイルの名前。 (既定値は "DEFAULT")
Examples
次の例では、既定のプロファイルの認証を構成します。
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 文字列
出力ログを書き込むファイルを表す文字列。 このフラグが指定されていない場合、既定では stderr に出力ログが書き込まれます。
--log-format 形式
ログ形式の種類、 text 、または json。 既定値は text です。
--log-level 文字列
ログ形式レベルを表す文字列。 指定しない場合、ログ形式レベルは無効になります。
-o, --output 型
コマンド出力の種類( text または json)。 既定値は text です。
-p, --profile 文字列
コマンドの実行に使用する ~/.databrickscfg ファイル内のプロファイルの名前。 このフラグが指定されていない場合は、存在する場合は、 DEFAULT という名前のプロファイルが使用されます。
--progress-format 形式
進行状況ログを表示する形式: default、 append、 inplace、または json
-t, --target 文字列
該当する場合は、使用するバンドル ターゲット
構成プロファイルを作成します。
構成プロファイルを作成するには、 configure コマンドを実行します。
databricks configure --host <workspace-url>
コマンドを実行すると、指定した にマップされる Azure Databricks 個人用アクセス トークンまたは <workspace-url>を入力するように求められます。
✔ Databricks Token:
アクセス トークンを入力すると、既定ではアクセス トークンは Linux や macOS の場合は、ファイル ~/.databrickscfg に、Windows の場合は、ファイル %USERPROFILE%\.databrickscfg に格納されます。 このファイルには DEFAULT という既定の接続プロファイル エントリが含まれます。
[DEFAULT]
host = <workspace-url>
token = <access-token>
接続プロファイルに DEFAULT ではなく別の名前を使うには、--profile オプションを configure コマンドに追加します。次に例を示します。
databricks configure --host <workspace-url> --profile <profile-name>
Tip
構成プロファイル名を手動で入力する代わりに、Tab または --profile の後に -p を押して、選択できる既存の構成プロファイルの一覧を表示することができます。
指定した接続プロファイル内の既存のホストとトークン情報は、新しいホストとトークン情報で上書きされます。