注
Databricks CLI の使用には、Databricks ライセンスおよび使用状況データのプロビジョニングを含むDatabricks のプライバシーに関する通知が適用されます。
この記事では、構成プロファイルで Databricks CLI を使用する方法について説明します。 Databricks CLI を既にインストールし、Databricks 構成プロファイル ファイルを作成済みであることを前提としています。 Databricks CLI のインストールまたは更新と Azure Databricks 構成プロファイルの に関するページを参照してください。
構成プロファイルに関する情報を取得する
.databrickscfg ファイルに複数の構成プロファイルを追加すると、コマンドの--profileまたは-p フラグでターゲット構成プロファイルの名前を指定することで、さまざまなワークスペース間でコマンドをすばやく実行できます。 プロファイルを指定しない場合、CLI は次の順序でプロファイルを選択します。
-
DATABRICKS_CONFIG_PROFILE環境変数 (設定されている場合)。 -
.databrickscfgの[__settings__]セクションにあるdefault_profile設定（存在する場合）。 これは、databricks auth switchで設定できます。 databricks 認証スイッチを参照してください。 -
DEFAULTプロファイル。
ヒント
Tab 後に --profile を押すか、-p を押して、選択する既存の使用可能な構成プロファイルの一覧を表示できます。
たとえば、開発ワークロードに使用する Azure Databricks ワークスペースを参照する、DEV という名前の構成プロファイルと、運用ワークロードに使用する別の Azure Databricks ワークスペースを参照する、PROD という名前の別の構成プロファイルを作成できます。
既定では、Databricks CLI は、Unix、Linux、macOS の .databrickscfg (ユーザー ホーム) フォルダー、または Windows の ~ (ユーザー ホーム) フォルダーで %USERPROFILE% ファイルを検索します。
.databrickscfg ファイルの既定のパスを変更するには、環境変数 DATABRICKS_CONFIG_FILE を別のパスに設定します。
.databrickscfg 固有のフィールドを参照してください。
既存の構成プロファイルに関する情報を取得するには、auth describe コマンドを実行します。
databricks auth describe --profile <configuration-profile-name>
例として、Azure Databricks 個人用アクセス トークン認証で構成されたプロファイルの出力は次のとおりです。
Host: https://dbc-a1b2345c-d6e7.cloud.databricks.com
User: user@example.com
Authenticated with: pat
-----
Current configuration:
✓ host: https://dbc-a1b2345c-d6e7.cloud.databricks.com (from ~/.databrickscfg config file)
✓ token: ******** (from ~/.databrickscfg config file)
✓ profile: <configuration-profile-name> (from --profile flag)
✓ auth_type: pat
注
auth env コマンドは非推奨です。
databricks auth describeを使用してプロファイルの構成を検査するか、databricks auth tokenしてキャッシュされた OAuth アクセス トークンを取得します。
使用可能なすべてのプロファイルに関する情報を取得するには、auth profiles コマンドを実行します。
databricks auth profiles
Name Host Valid
DEFAULT https://dbc-a1b2345c-d6e7.cloud.databricks.com YES
Development https://dbc-a1b2345c-d6e7.cloud.databricks.com YES
Staging https://dbc-a1b2345c-d6e7.cloud.databricks.com YES
Production https://dbc-a1b2345c-d6e7.cloud.databricks.com YES
auth profiles コマンドの出力には、アクセス トークンは表示されません。 特定のプロファイルのトークンの詳細を表示するには、 databricks auth describe --profile <profile-name> または databricks auth token --profile <profile-name>を実行します。
重要
Databricks CLI は、.netrc ファイルでは動作しません。
.netrc ファイルを他の目的でご利用の環境に含めることができますが、Databricks CLI ではその .netrc ファイルは使用されません。
構成プロファイルをテストする
構成プロファイルをテストし、認証が正しく設定されていることを確認するには、ワークスペースに接続するコマンドを実行します。
プロファイルを指定しない場合は、既定のプロファイルが使用されます。 たとえば、次のコマンドは、DEFAULT プロファイルに関連付けられている Azure Databricks ワークスペースで使用可能な Databricks Runtime のバージョンを一覧表示します。
注
このコマンドは、DEFAULT プロファイルの設定よりも優先される環境変数が設定されていないことを前提としています。 詳細については、「認証の評価順序」を参照してください。
databricks clusters spark-versions
特定の構成プロファイルを確認するには、-p フラグを使用してプロファイル名を指定します。
databricks clusters spark-versions -p PROD