メインコンテンツまでスキップ
に最終更新

Databricks CLI の構成プロファイル

注記

Databricks CLI 使用には、 Databricks ライセンス および Databricks プライバシー通知(使用データのプロビジョニングを含む)が適用されます。

この記事では、Databricks CLI を構成プロファイルと共に使用する方法について説明します。 Databricks CLI を既にインストールし、Databricks 構成プロファイル ファイルを作成していることを前提としています。 「Databricks CLI のインストールまたは更新」および「Databricks 構成プロファイル」を参照してください。

構成プロファイルに関する情報の取得​

.databrickscfgファイルに複数の構成プロファイルを追加すると、コマンドの--profileまたは-pフラグでターゲット構成プロファイルの名前を指定することで、さまざまなワークスペースでコマンドをすばやく実行できます。プロファイルを指定しない場合、CLI は次の順序で選択します。

  1. DATABRICKS_CONFIG_PROFILE 環境変数が設定されている場合。
  2. .databrickscfg の [__settings__] セクションにある default_profile 設定（存在する場合）。これをdatabricks auth switchを使用して設定できます。databricks auth switchをご覧ください。
  3. DEFAULTプロファイルです。
ヒント

--profile または -p の後に Tab を押すと、既存の使用可能な設定プロファイルのリストが表示され、そこから選択できます。

たとえば、開発ワークロードに使用する Databricks ワークスペースを参照する DEV という名前の構成プロファイルと、本番運用ワークロードに使用する別の Databricks ワークスペースを参照する PROD という名前の別の構成プロファイルがあるとします。

デフォルトでは、Databricks CLIは~ (Unix、Linux、または macOS の場合は user ホームフォルダー、または %USERPROFILE% (Windowsの場合は user ホームフォルダー) で.databrickscfgファイルを検索します。.databrickscfg ファイルのデフォルトパスを変更するには、環境変数 DATABRICKS_CONFIG_FILE を別のパスに設定します。「 .databrickscfg 固有のフィールド」を参照してください。

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

Bash
databricks auth describe --profile <configuration-profile-name>

たとえば、Databricks 個人用アクセス トークン認証で構成されたプロファイルの出力を次に示します。

Output
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` を使用し、またはキャッシュされた OAuth アクセストークンを取得するには `databricks auth token` を使用します。

使用可能なすべてのプロファイルに関する情報を取得するには、 auth profiles コマンドを実行します。

Bash
databricks auth profiles
Output
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 プロファイルに関連付けられている Databricks ワークスペースで使用可能な Databricks Runtime バージョンを一覧表示します。

注記

このコマンドは、 DEFAULT プロファイルの設定よりも優先される環境変数が設定されていないことを前提としています。 詳細については、「 評価の認証順序」を参照してください。

Bash
databricks clusters spark-versions

特定の構成プロファイルを確認するには、 -p フラグを使用してプロファイル名を指定します。

Bash
databricks clusters spark-versions -p PROD
このページの見出し