Visual Studio Code 用の Databricks 拡張機能の認証セットアップ

この記事では、Visual Studio Code の Databricks 拡張機能と Databricks ワークスペースの間で認証を設定する方法について説明します。 「 Visual Studio Code の Databricks 拡張機能とは」を参照してください。

Visual Studio Code の Databricks 拡張機能は、 Databricks クライアント統合 認証標準の一部、認証に対する統合された一貫性のあるアーキテクチャとプログラムによるアプローチを実装します。 このアプローチにより、Databricks での認証の設定と自動化が一元化され、予測可能になります。 これにより、Databricks 認証を一度構成すると、認証構成をさらに変更することなく、複数の Databricks ツールと SDK でその構成を使用できます。

次の情報は、Visual Studio Code 用の Databricks 拡張機能が既にインストールされていることを前提としています。 「Visual Studio Code 用の Databricks 拡張機能のインストール」を参照してください。

注:

Databricks の VSCode 拡張機能のチュートリアル: クラスターでジョブとして Python を実行する を既に完了していて、そのチュートリアルで設定した Databricks 個人用アクセストークン認証を引き続き使用する場合は、「Visual Studio Code 用 Databricks 拡張機能のクラスターを選択する」に進んでください。

使用する認証の種類に応じて、ターゲットの Databricks 認証の種類の手順を完了します。

構成プロファイル を使用した認証の設定

注:

次の手順では、一般公開されている Visual Studio Code の Databricks 拡張機能バージョン 1 を使用します。 現在プライベート プレビュー段階にある Visual Studio Code 用 Databricks 拡張機能バージョン 2 のこの手順を完了するには、 「構成プロファイルと拡張機能バージョン 2 を使用した認証のセットアップ」に進んでください。

次の手順では、Databricks 認証の種類に必要なフィールドを使用して Databricks 構成プロファイルを既に設定していることを前提としています。 「Databricks 自動化 の認証 - 概要 」の「Databricks 構成プロファイル」と、認証の種類の [ プロファイル ] タブまたはセクションを参照してください。

たとえば、Databricks の個人用アクセストークン認証を使用して認証する場合は、次の手順で個人用アクセストークンを作成します。

  1. Databricksワークスペースで、上部バーにあるDatabricksユーザー名をクリックし、ドロップダウンから [ユーザー設定] を選択します。

  2. [ 開発者] をクリックします。

  3. [アクセストークン] の横にある [管理] をクリックします。

  4. [ 新しいトークンの生成] をクリックします。

  5. (任意)今後このトークンを識別するのに役立つコメントを入力し、トークンのデフォルトの有効期間である90日を変更します。有効期間のないトークンを作成するには(非推奨)、[有効期間 (日) ] ボックスを空白のままにしてください。

  6. [生成] をクリックします。

  7. 表示されたトークンを安全な場所にコピーし、[完了] をクリックします。

注:

コピーしたトークンは、必ず安全な場所に保存してください。 コピーしたトークンを他のユーザーと共有しないでください。 コピーしたトークンを紛失した場合、まったく同じトークンを再生成することはできません。 代わりに、この手順を繰り返して新しいトークンを作成する必要があります。 コピーしたトークンを紛失した場合、またはトークンが侵害されたと思われる場合は、アクセストークン ページでトークンの横にあるごみ箱 (取り消し) アイコンをクリックして、ワークスペースからそのトークンをすぐに削除することを強くお勧めします。

ワークスペースでトークンを作成または使用できない場合は、ワークスペース管理者がトークンを無効にしたか、トークンを作成または使用する権限を与えていないことが原因である可能性があります。ワークスペース管理者に問い合わせるか、以下をご覧ください。

たとえば、個人用アクセストークン用に DEFAULT という名前の構成プロファイルを作成するには、次の操作を行います。

注:

次の手順では、Databricks CLI を使用して、DEFAULTという名前の Databricks 構成プロファイルを作成します。DEFAULT構成プロファイルが既にある場合は、この手順によって既存のDEFAULT構成プロファイルが上書きされます。

DEFAULT構成プロファイルが既にあるかどうかを確認し、このプロファイルの設定が存在する場合は表示するには、Databricks CLI を使用してコマンド databricks auth env --profile DEFAULTを実行します。

DEFAULT以外の名前で構成プロファイルを作成するには、次の databricks configure コマンドの --profile DEFAULTDEFAULT部分を構成プロファイルの別の名前に置き換えます。

  1. Databricks CLI を使用して、Databricks 個人用アクセストークン認証を使用する DEFAULT という名前の Databricks 構成プロファイルを作成します。これを行うには、次のコマンドを実行します。

    databricks configure --profile DEFAULT
    
  2. プロンプト Databricks Host の場合は、Databricks ワークスペース インスタンスの URL を入力します (例: https://1234567890123456.7.gcp.databricks.com)。

  3. プロンプトの [個人用アクセス トークン] に、ワークスペースの Databricks 個人用アクセストークンを入力します。

Databricks 構成プロファイルの準備ができたら、プロジェクトと拡張機能を開いた状態で、次の操作を行います。

  1. [ 構成 ] ウィンドウで、[ Databricks の構成] をクリックします。

    注:

    [Databricks の構成] が表示されていない場合は、代わりに [構成] の横にある歯車 (ワークスペースの構成) アイコンをクリックします。

    ワークスペース設定を構成するための歯車アイコン 1
  2. コマンド パレット[Databricks Host] に、ワークスペース インスタンスの URL を入力します (例: https://1234567890123456.7.gcp.databricks.com)。次に、 Enter キーを押します。

  3. URL の一覧でターゲットの Databricks 構成プロファイルを選択します。

拡張機能は、 .databricks という名前の隠しフォルダーがまだ存在しない場合は、プロジェクトに作成します。 拡張機能は、このフォルダーに project.json という名前のファイルも作成します (まだ存在しない場合)。 このファイルには、入力した URL と、Visual Studio Code 用の Databricks 拡張機能が動作するために必要ないくつかの Databricks 認証の詳細が含まれています。

また、この拡張機能は、ファイルが存在しない場合、または既存の .gitignore が親フォルダーに見つからない場合に、非表示の .gitignore ファイルをプロジェクトに追加します。新しい .gitignore ファイルが作成されると、拡張機能はこの新しいファイルに .databricks/ エントリを追加します。 拡張機能が既存の .gitignore ファイルを検出すると、既存のファイルに .databricks/ エントリが追加されます。

Visual Studio Code の Databricks 拡張機能のクラスターの選択」に進みます。

OAuth U2M 認証 を設定する

注:

次の手順では、一般公開されている Visual Studio Code の Databricks 拡張機能バージョン 1 を使用します。 現在プライベート プレビュー段階にある Visual Studio Code の Databricks 拡張機能バージョン 2 のこの手順を完了するには、 「拡張機能のバージョン 2 を使用して OAuth U2M 認証をセットアップする」に進んでください。

Databricks は、OAuth ユーザー対マシン (U2M) 認証をサポートしています。 これにより、有効期間の短い (1 時間) OAuth アクセス トークンを生成できるようになり、バージョン管理チェックインやその他の手段を通じて、Databricks の個人アクセス トークンなどの有効期間の長いトークンが誤って公開されるリスクが排除されます。 これにより、サーバー側のセッションの無効化とスコープも向上します。

OAuth U2M 認証の設定を完了するには、プロジェクトと拡張機能を開いた状態で、次の操作を行います。

  1. [ 構成 ] ウィンドウで、[ Databricks の構成] をクリックします。

    注:

    [Databricks の構成] が表示されていない場合は、代わりに [構成] の横にある歯車 (ワークスペースの構成) アイコンをクリックします。

    ワークスペース設定を構成するための歯車アイコン 1
  2. コマンド パレット[Databricks Host] に、ワークスペース インスタンスの URL を入力します (例: https://1234567890123456.7.gcp.databricks.com)。次に、 Enter キーを押します。

  3. OAuth (ユーザーからマシンへ) を選択します。

  4. Web ブラウザーで画面の指示を完了して、Databricks アカウントでの認証を完了します。 プロンプトが表示されたら、 すべての API アクセスを許可します。

拡張機能は、 .databricks という名前の隠しフォルダーがまだ存在しない場合は、プロジェクトに作成します。 拡張機能は、このフォルダーに project.json という名前のファイルも作成します (まだ存在しない場合)。 このファイルには、入力した URL と、Visual Studio Code 用の Databricks 拡張機能が動作するために必要ないくつかの Databricks 認証の詳細が含まれています。

また、この拡張機能は、ファイルが存在しない場合、または既存の .gitignore が親フォルダーに見つからない場合に、非表示の .gitignore ファイルをプロジェクトに追加します。新しい .gitignore ファイルが作成されると、拡張機能はこの新しいファイルに .databricks/ エントリを追加します。 拡張機能が既存の .gitignore ファイルを検出すると、既存のファイルに .databricks/ エントリが追加されます。

Visual Studio Code の Databricks 拡張機能のクラスターの選択」に進みます。

構成プロファイルとバージョン 2 の拡張機能を使用した認証の設定

注:

Visual Studio Code の Databricks 拡張機能バージョン 2 は、プライベート プレビュー段階にあります。

次の手順では、Databricks 認証タイプに必要なフィールドを含む Databricks 構成プロファイルがすでに設定されていることを前提としています。 プロファイルを作成するには、 「Databricks 構成プロファイル」を参照してください。 プロファイルの正しい設定を行うには、 「Databricks オートメーションの認証 - 概要」 の認証タイプの [プロファイル] タブまたはセクションを参照してください。拡張機能のユーザー インターフェイスでは、これらの構成プロファイルをDatabricks CLI プロファイルまたは単にプロファイルと呼ぶことがあります。

機能拡張で使用する構成プロファイルを選択するには、プロジェクトと機能拡張を開いた状態で、以下の操作を行います:

  1. [構成]ペインで[認証タイプ]をクリックし、歯車 ( Databricks ワークスペースにサインイン) アイコンをクリックします。

    Databricks ワークスペースにサインインする
  2. コマンド パレットで、リストからターゲットの Databricks 構成プロファイルを選択します。

  3. Visual Studio Code の Databricks 拡張機能のクラスターの選択」に進みます。

構成プロファイルがない場合は、たとえば次のように、Databricks の個人アクセスウイルスを使用して認証する構成プロファイルを作成できます。

  1. プロジェクトと拡張機能を開いた状態で、 [構成]ペインで[認証タイプ] または [ Databricks へのログイン]をクリックし、歯車 ( Databricks ワークスペースへのサインイン) アイコンをクリックします。

    Databricks ワークスペースにサインインする
  2. コマンド パレットで、 [パーソナル アクセス]を選択します。

  3. 画面の指示に従って、次の操作を行います。

    1. 関連付けられた Databricks 認証プロファイルの名前を入力します。

    2. Databricks ワークスペースで個人用アクセスウイルスを生成し、トークンの値をコピーします。

    3. 拡張機能に戻り、コピーしたトークンの値を入力します。

  4. Visual Studio Code の Databricks 拡張機能のクラスターの選択」に進みます。

拡張機能のバージョン 2 を使用して OAuth U2M 認証をセットアップする

注:

Visual Studio Code の Databricks 拡張機能バージョン 2 は、プライベート プレビュー段階にあります。

Databricks は、OAuth ユーザー対マシン (U2M) 認証をサポートしています。 これにより、有効期間の短い (1 時間) OAuth アクセス トークンを生成できるようになり、バージョン管理チェックインやその他の手段を通じて、Databricks の個人アクセス トークンなどの有効期間の長いトークンが誤って公開されるリスクが排除されます。 これにより、サーバー側のセッションの無効化とスコープも向上します。

OAuth U2M 認証の設定を完了するには、プロジェクトと拡張機能を開いた状態で、次の操作を行います。

  1. [構成]ペインで[認証タイプ]をクリックし、歯車 ( Databricks ワークスペースにサインイン) アイコンをクリックします。

    Databricks ワークスペースにサインインする
  2. このリストにOAuth を使用した認証 (ユーザーからマシンへ)ラベルがあり、ターゲット Databricks ホストに対応することがわかっている認証構成プロファイルがすでにある場合は、それをリストから選択し、次の操作を実行します。

    1. プロンプトが表示されたら、Web ブラウザーで画面上の指示を完了して、Databricks での認証を完了します。

    2. プロンプトが表示された場合は、 すべての API アクセスを許可します。

    3. 「Visual Studio Code の Databricks 拡張機能のクラスターを選択する」に進んでください。

  3. コマンド パレットの [認証方法の選択]で、 [OAuth (ユーザーからマシンへ)]をクリックします。

  4. [認証方法の選択]で、 [OAuth (ユーザーからマシンへ)]を選択します。

  5. 関連付けられた Databricks 認証プロファイルの名前を入力します。

  6. [構成]ペインで、 [Databricks へのログイン] をクリックします。

    Databricks にログインする
  7. [コマンド パレット][認証方法の選択]で、作成したばかりの認証構成プロファイルの名前を選択します。

  8. プロンプトが表示されたら、Web ブラウザーで画面上の指示を完了して、Databricks での認証を完了します。 プロンプトが表示された場合は、 すべての API アクセスを許可します。

  9. 正常にログインしたら、Visual Studio Code に戻ります。

  10. Visual Studio Code の Databricks 拡張機能のクラスターの選択」に進みます。