メインコンテンツまでスキップ

Visual Studio Code の Databricks 拡張機能の承認を設定する

この記事では、プロジェクトのセットアップを通じて拡張機能をまだ構成していない場合に、Visual Studio Code の Databricks 拡張機能と Databricks ワークスペースの間で承認と認証を設定する方法について説明します。 「Visual Studio Code の Databricks 拡張機能とは」を参照してください。

Visual Studio Code 用の Databricks 拡張機能は、 Databricks クライアント統合認証 標準の一部を実装しているため、Databricks OAuth 2.0 ベースの承認を一度構成すると、承認や認証の構成をさらに変更することなく、その構成を複数の Databricks ツールや SDK で使用できます。 また、アクティブなアクセストークンの自動更新も提供し、開発時の複雑さを軽減します。

Databricks では、Visual Studio Code の Databricks 拡張機能を使用して簡単に構成できる OAuth 対話型ユーザー認証が推奨されています。 「OAuth 認証と認証の設定」を参照してください。

それ以外の場合、Databricks personal access token 認証 を使用している場合、またはDatabricksを使用してサービスプリンシパルを使用して リソースへの無人アクセスを承認OAuth している場合は、構成プロファイルを使用した認証の設定 を参照してください。

注記

Databricks のユーザー名とパスワードを使用した基本認証は、2024 年 7 月 10 日にサポートが終了しました。 「Databricks で管理されるパスワードのサポート終了」を参照してください。

OAuth の認証と認証を設定する​

Databricks は OAuth 2.0 ベースの承認と認証をサポートし、 Databricks 統合クライアント認証によりアクセス トークンの管理を簡素化します。 Databricksによるユーザーおよびサービスプリンシパルの権限付与について詳しくは、Databricksリソースへのアクセスの権限付与を参照してください。

OAuth 認証のセットアップを完了するには、Visual Studio Code の Databricks 拡張機能が有効になっている VSCode プロジェクトを開きます。

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

    Databricks ワークスペースにサインインする

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

    1. プロンプトが表示されたら、Web ブラウザーの画面上の指示を完了して、Databricks での認証を完了します。
    2. プロンプトが表示されたら、 すべての API アクセスを許可します。
    3. 「コードとジョブを実行するためのコンピュートを選択する」に進んでください。

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

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

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

  6. [構成 ] ビューで、[ Databricks にログイン ] をクリックします。

    Databricks にログイン

  7. コマンドパレットの [ 認証方法の選択 ] で、作成した認証設定プロファイルの名前を選択します。

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

  9. ログインに成功したら、Visual Studio Codeに戻ってください。

構成プロファイルによる認証のセットアップ​

次の手順は、Databricks 認証タイプの必須フィールドを使用して Databricks 構成プロファイルを既に設定していることを前提としています。 プロファイルを作成するには、「 Databricks 構成プロファイル」を参照してください。 プロファイルの設定を構成するには、「Databricksリソースへのアクセスの承認 」の認証の種類の[プロファイル] タブまたはセクションを参照してください。

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

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

    Databricks ワークスペースにサインインする

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

ヒント

ターゲット ワークスペース ホストは、プロジェクトに関連付けられている databricks.yml 構成ファイルのターゲット workspace設定を変更することで、後で変更できます。「Databricks アセット バンドルの構成」を参照してください。

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

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

    Databricks ワークスペースにサインインする

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

  3. 画面上のプロンプトに記入して、次の操作を行います。

    1. 関連付けられている Databricks 認証プロファイルの名前を入力します。
    2. Databricks ワークスペースで個人用アクセストークンを生成し、トークンの値をコピーします。
    3. 拡張機能に戻り、コピーしたトークンの値を入力します。

この拡張機能は、プロジェクトに .databricks という名前のフォルダーと databricks.envという名前のファイルを作成します (まだ存在しない場合)。 このファイルには、入力したワークスペース ホストと、Visual Studio Code の Databricks 拡張機能で使用されるその他の Databricks 構成の詳細が含まれています。

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

に最終更新