Databricks CLI の構成プロファイル

[アーティクル]
03/01/2024

Note

この情報は、パブリックプレビュー段階である Databricks CLI バージョン 0.205 以降に適用されます。お使いの Databricks CLI のバージョンを確認するには、databricks -v を実行してください。

この記事では、Databricks CLI と Azure Databricks アカウントおよびワークスペースの間に認証を設定する方法について説明します。「Databricks CLI とは」を参照してください。

この記事では、Databricks CLI をインストール済みで、CLI を認証用に設定済みであることを前提としています。参照トピック

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

.databrickscfg ファイルに複数の構成プロファイルを追加すると、コマンドの --profile または -p オプションで対象の構成プロファイルの名前を指定することで、さまざまなワークスペース間でコマンドをすばやく実行できます (このオプションをサポートするコマンドの場合)。このオプションをサポートするコマンドで --profile または -p オプションを指定しない場合、コマンドは既定で DEFAULT 接続プロファイルを使います。

ヒント

--profile または -p の後に Tab を押すと、構成プロファイル名を手動で入力する代わりに、選択できる既存の構成プロファイルの一覧を表示できます。

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

既定では、Databricks CLI は、Unix、Linux、macOS の ~ (ユーザーホーム) フォルダー、または Windows の %USERPROFILE% (ユーザーホーム) フォルダーで .databrickscfg ファイルを検索します。環境変数 DATABRICKS_CONFIG_FILE を設定することによって、.databrickscfg ファイルの既定のパスを変更できます。環境変数の設定方法については、お使いのオペレーティングシステムのドキュメントを参照してください。

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

databricks auth env --profile <configuration-profile-name>

# Or:
databricks auth env --host <account-console-url>

# Or:
databricks auth env --host <workspace-url>

例として、Azure Databricks 個人用アクセストークン認証で構成されたプロファイルの出力は次のとおりです。

{
  "env": {
    "DATABRICKS_AUTH_TYPE": "pat",
    "DATABRICKS_CONFIG_PROFILE": "<configuration-profile-name>",
    "DATABRICKS_HOST": "<workspace-url>",
    "DATABRICKS_TOKEN": "<token-value>"
  }
}

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

databricks auth profiles

出力 (省略記号は簡潔にするために省略された内容を表します)。

{
  "profiles": [
    {
      "name": "<configuration-profile-name>",
      "host": "<workspace-url>",
      "cloud": "<cloud-id>",
      "auth_type": "<auth-type>",
      "valid": true
    },
    {
      "...": "..."
    }
  ]
}

auth profiles コマンドの出力には、アクセストークンは表示されません。アクセストークンを表示するには、前述の auth env コマンドを実行します。

重要

Databricks CLI は、.netrc ファイルでは動作しません。 .netrc ファイルを他の目的でご利用の環境に含めることができますが、Databricks CLI ではその .netrc ファイルは使用されません。

DEFAULT 構成プロファイルのセットアップをテストする

認証を正しく設定されているかどうかを確認するには、次のようなコマンドを実行します。このコマンドで、DEFAULT プロファイルに関連付けられている Azure Databricks ワークスペースで使用可能な Databricks Runtime のバージョンが一覧表示されます。

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

databricks clusters spark-versions

構成プロファイルをテストする

構成プロファイルが正しく設定されているかどうかを確認するには、ワークスペースレベルの構成プロファイル名のいずれかを指定して次のようなコマンドを実行します。このコマンドは、指定された構成プロファイルに関連付けられている Azure Databricks ワークスペースで使用できる Databricks Runtime のバージョンを一覧表示します。ここではプレースホルダー <configuration-profile-name> で示します。

databricks clusters spark-versions -p <configuration-profile-name>

ヒント

特定のプロファイルの詳細を一覧表示するには、次のコマンドを実行します。

databricks auth env --profile <configuration-profile-name>

使用可能なすべてのプロファイルの詳細を一覧表示するには、次のコマンドを実行します。

databricks auth profiles

Databricks CLI の構成プロファイル

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

DEFAULT 構成プロファイルのセットアップをテストする

構成プロファイルをテストする

その他のリソース