次の方法で共有

configure コマンド グループ

  • [アーティクル]

Note

この情報は、Databricks CLI バージョン 0.205 以降に適用されます。 Databricks CLI は Public Preview です。

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

Databricks CLI 内の configure コマンド グループを使うと、Azure Databricks 個人用アクセス トークンまたは Microsoft Entra ID (旧称 Azure Active Directory) トークンを使って、Azure Databricks で Databricks CLI を認証することができます。

Note

セキュリティのベスト プラクティスとして、自動化ツール、システム、スクリプト、アプリを使用して認証する場合、Databricks では、ワークスペース ユーザーではなくサービス プリンシパルに属する個人用アクセス トークンを使用することを推奨しています。 サービス プリンシパルのトークンを作成するには、「サービス プリンシパルのトークンを管理する」をご覧ください。

この記事では、ワークスペース レベルのコマンドの呼び出しを有効にするための Azure Databricks 個人用アクセス トークンと Microsoft Entra ID トークン認証についてのみ説明していることに注意してください。 その他の認証構成オプションについては、「Databricks CLI の認証」を参照してください。

重要

このコマンドを実行する前に、必ず Databricks CLI を設定してください。

configure コマンドは、databricks configure に追加して実行します。 configure コマンドのヘルプを表示するには、databricks configure -h を実行します。

構成プロファイルの作成

構成プロファイルは、Azure Databricks ワークスペース URL やアクセス トークン値などの認証情報を含む設定のコレクションです。 構成プロファイルには、DEFAULT、DEV、PROD などのプログラム名があります。

構成プロファイルを作成するには、configure コマンドを次のように実行します。

databricks configure --host <workspace-url>

<workspace-url> の場合、ワークスペースごとの URL を https://adb-<workspace-id>.<random-number>.azuredatabricks.net の形式で入力します。 ワークスペースごとの URL を取得するには、「ワークスペースごとの URL」を参照してください。

コマンドを実行すると、指定した <workspace-url> にマップされる Azure Databricks 個人用アクセス トークンまたは Microsoft Entra ID (旧称 Azure Active Directory) トークンを入力するように求められます。

✔ Databricks Token:

アクセス トークンを入力すると、既定ではアクセス トークンは Linux や macOS の場合 ~/.databrickscfg、Windows の場合 %USERPROFILE%\.databrickscfg ファイルに格納されます。 このファイルには DEFAULT という既定の接続プロファイル エントリが含まれています。

[DEFAULT]
host  = <workspace-url>
token = <access-token>

接続プロファイルに DEFAULT ではなく別の名前を使うには、--profile オプションを configure コマンドに追加します。次に例を示します。

databricks configure --host <workspace-url> --profile <profile-name>

ヒント

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

指定した接続プロファイル内の既存のホストとトークン情報は、新しいホストとトークン情報で上書きされます。

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

たとえば、開発ワークロードに使う Azure Databricks ワークスペースを参照する DEV という接続プロファイルと、運用ワークロードに使う別の Azure Databricks ワークスペースを参照する PROD 接続プロファイルという別個の接続プロファイルを持つことができます。

環境変数 DATABRICKS_CONFIG_FILE を設定することによって、この .databrickscfg ファイルの既定のパスを変更できます。 環境変数の設定方法については、お使いのオペレーティング システムのドキュメントを参照してください。

既存の構成プロファイルに関する情報を取得するには、auth コマンド グループを使います。