Databricks CLI の構成プロファイル

注

この情報は、Databricks CLI バージョン 0.205 以降に適用されます。 Databricks CLI はパブリックプレビュー段階です。

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

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

この記事では、Databricks CLI が既にインストールされ、認証用に CLI が設定されていることを前提としています。見る：

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

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

ヒント

構成プロファイル名を手動で入力する代わりに、--profileまたは-pの後に Tab を押すと、既存の使用可能な構成プロファイルの一覧が表示され、そこから選択できます。

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

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

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

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

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

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

たとえば、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プロファイルに関連付けられている Databricks ワークスペースで使用可能な Databricks Runtime バージョンを一覧表示する次のようなコマンドを実行します。

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

databricks clusters spark-versions

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

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

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

ヒント

構成プロファイル名を手動で入力する代わりに、--profileまたは-pの後に Tab を押すと、既存の使用可能な構成プロファイルの一覧が表示され、そこから選択できます。

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

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

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

databricks auth profiles