Databricks CLI の構成プロファイル

注

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

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

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

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

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

ヒント

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

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

デフォルトでは、 Databricks CLI は、~ (Unix、Linux、macOS の your user ホームフォルダー、または Windowsの %USERPROFILE% (your user ホームフォルダー ) で .databrickscfg ファイルを検索します。 .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>

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

{
  "env": {
    "DATABRICKS_AUTH_TYPE": "pat",
    "DATABRICKS_CONFIG_PROFILE": "DEFAULT",
    "DATABRICKS_HOST": "https://dbc-a1b2345c-d6e7.cloud.databricks.com",
    "DATABRICKS_TOKEN": "dapi123..."
  }
}

使用可能なすべてのプロファイルに関する情報を取得するには、 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 コマンドの出力には、アクセストークンは表示されません。アクセストークンを表示するには、前の auth env コマンドを実行します。

重要

Databricks CLI は .netrc ファイルでは機能しません。他の目的で環境に .netrc ファイルを持つことはできますが、Databricks CLI はその .netrc ファイルを使用しません。

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

構成プロファイルをテストし、認証が正しく設定されたことを確認するには、ワークスペースに接続するコマンドを実行します。

プロファイルを指定しない場合は、デフォルトのプロファイルが使用されます。たとえば、次のコマンドは、 DEFAULT プロファイルに関連付けられている Databricks ワークスペースで使用可能な Databricks Runtime バージョンを一覧表示します。

注

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

databricks clusters spark-versions

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

databricks clusters spark-versions -p PROD