VS Code 用 Databricks 拡張機能の認証の設定
この記事では、Visual Studio Code 用 Databricks 拡張機能と Azure Databricks ワークスペースの間の認証の設定方法について説明します。 「Visual Studio Code 用 Databricks 拡張機能とは?」を参照してください
Visual Studio Code 用 Databricks 拡張機能は、Databricks クライアント統合認証標準を実装しています。これは、統合されていて一貫性がある、アーキテクチャとプログラムによる認証アプローチです。 このアプローチは、Azure Databricks を使用した認証の設定と自動化を、より一元的で予測可能なものにするのに役立ちます。 これにより、Azure Databricks 認証を一度構成すれば、それ以上認証構成を変更しなくても、複数の Azure Databricks ツールおよび SDK でその構成を使用できます。
以下の情報は、Visual Studio Code 用 Databricks 拡張機能のインストールが既に完了していることを前提としています。 「Visual Studio Code 用 Databricks 拡張機能のインストール」を参照してください。
Note
Databricks 用 VSCode 拡張機能チュートリアルを既に完了している場合: クラスター上でジョブとして Python を実行し、そのチュートリアルで設定した Azure Databricks 個人用アクセス トークン認証を引き続き使用する場合は、「Visual Studio Code 用 Databricks 拡張機能のクラスターを選ぶ」までスキップしてください。
使用したい認証の種類に応じて、ターゲットの Azure Databricks 認証の種類用の手順を完了してください。
- 次の認証の種類については、「構成プロファイルを使用した認証の設定」までスキップしてください。
- OAuth ユーザー対マシン (U2M) 認証の場合は、「OAuth U2M 認証を設定する」に進んでください。
- Azure CLI 認証の場合は、「Azure CLI 認証を設定する」に進んでください。
Note
Visual Studio Code 用 Databricks 拡張機能では、Azure マネージド ID (旧称 Azure マネージド サービス ID (MSI)) を使う認証はまだサポートされていません。
Databricks Connect では、Azure マネージド ID を使用した認証がサポートされています。 ただし、Azure マネージド ID 認証を行うために、Visual Studio Code 用 Databricks 拡張機能内で Databricks Connect 統合を使用することはできません。 Visual Studio Code 用 Databricks 拡張機能とは別に、Databricks Connect を Visual Studio Code で単独で使用するには、「Databricks Connect for Python で Visual Studio Code を使用する」を参照してください。
構成プロファイルを使用して認証を設定する
次の手順では、Azure Databricks 認証タイプに必要なフィールドを使用して Azure Databricks 構成プロファイルが既に設定されていることを前提としています。 「Azure Databricks 構成プロファイル」と [プロファイル] タブまたは「Azure Databricks 自動化の認証 - 概要」内のご利用の認証の種類のセクションをご参照ください。
たとえば、Azure Databricks 個人用アクセス トークン認証を使用して認証する場合は、次の手順に従って個人用アクセス トークンを作成します。
- Azure Databricks ワークスペースの上部バーで、目的の Azure Databricks ユーザー名をクリックし、次にドロップダウンから [設定] を選択します。
- [開発者] をクリックします。
- [アクセス トークン] の横にある [管理] をクリックします。
- [新しいトークンの生成] をクリックします。
- (省略可能) 将来このトークンを識別するのに役立つコメントを入力し、トークンの既定の有効期間 90 日を変更します。 有効期間のないトークンを作成するには (推奨されません)、[有効期間 (日)] ボックスを空のままにします。
- [Generate](生成) をクリックします。
- 表示されたトークンを安全な場所にコピーし、[完了] をクリックします。
Note
コピーしたトークンは必ず安全な場所に保存してください。 コピーしたトークンは他人に見せないでください。 コピーしたトークンを失った場合、それとまったく同じトークンは再生成できません。 代わりに、この手順を繰り返して新しいトークンを作成する必要があります。 コピーしたトークンを紛失した場合や、トークンが侵害されていると思われる場合、Databricks では、[アクセス トークン] ページのトークンの横にあるごみ箱 ([取り消し]) アイコンをクリックして、ワークスペースからそのトークンをすぐに削除することを強くお勧めします。
ワークスペースでトークンを作成することや使用することができない場合は、ワークスペース管理者によってトークンが無効にされているか、トークンを作成または使用する権限が作業者に付与されていない可能性があります。 ワークスペース管理者に連絡するか、以下の情報を参照してください。
たとえば、個人用アクセス トークンに対して DEFAULT という名前の構成プロファイルを作成するには、次の手順を実行します。
Note
次の手順では、Databricks CLI を使って、DEFAULT という名前で Azure Databricks 構成プロファイルを作成します。 DEFAULT 構成プロファイルが既にある場合、この手順により既存の DEFAULT 構成プロファイルは上書きされます。
DEFAULT 構成プロファイルが既にあるか確認するには、また、それが存在する場合にこのプロファイルの設定を表示するには、Databricks CLI を使用してコマンド databricks auth env --profile DEFAULT を実行してください。
DEFAULT 以外の名前で構成プロファイルを作成するには、次の databricks configure コマンドの --profile DEFAULT の DEFAULT の部分を構成プロファイルの別の名前に置き換えます。
Databricks CLI を使って、Azure Databricks 個人用アクセス トークン認証を使う
DEFAULTという名前の Azure Databricks 構成プロファイルを作成します。 そのためには、次のコマンドを実行します。databricks configure --profile DEFAULTプロンプト [Databricks Host] には、Azure Databricks のワークスペースごとの URL (例:
https://adb-1234567890123456.7.azuredatabricks.net) を入力します。プロンプト [Personal Access Token] には、お使いのワークスペースの Azure Databricks 個人用アクセス トークンを入力します。
プロジェクトと拡張機能を開いた状態で Azure Databricks 構成プロファイルの準備ができたら、次の手順を実行します。
[構成] ウィンドウで、[Configure Databricks](Databricks の構成) をクリックします。
注意
[Configure Databricks](Databricks の構成) が表示されない場合は、代わりに [構成] の横にある歯車 (ワークスペースの構成) アイコンをクリックします。
コマンド パレットの Databricks Host に、ワークスペースごとの URL (例:
https://adb-1234567890123456.7.azuredatabricks.net) を入力します。 次に、Enter キーを押します。URL の一覧でターゲットの Azure Databricks 構成プロファイルを選択します。
この拡張機能では、.databricks という名前のプロジェクトにまだ存在しない場合に、非表示フォルダーが作成されます。 この拡張機能では、project.json という名前のファイルがまだ存在しない場合にもこのフォルダーに作成されます。 このファイルには、入力した URL と、Visual Studio Code 用の Databricks 拡張機能が動作するために必要な Azure Databricks 認証の詳細が含まれています。
また、ファイルが存在しない場合、または親フォルダーに既存の .gitignore ファイルが見つからない場合は、拡張機能によってプロジェクトに非表示の .gitignore ファイルも追加されます。 新しい .gitignore ファイルが作成された場合は、拡張機能により、この新しいファイルに .databricks/ エントリが追加されます。 拡張機能によって既存の .gitignore ファイルが見つかった場合は、既存のファイルに .databricks/ エントリが追加されます。
続けて、「Visual Studio Code 用 Databricks 拡張機能のクラスターの選択」に進んでください。
OAuth U2M 認証を設定する
Azure Databricks では、OAuth ユーザー対マシン (U2M) 認証がサポートされています。 これを使うと、有効期間の短い (1 時間) OAuth アクセス トークンを生成できます。これにより、バージョン コントロールのチェックインや他の手段により、Azure Databricks 個人用アクセス トークンなどの有効期間の長いトークンが誤って公開されるリスクがなくなります。 これにより、サーバー側のセッションの無効化とスコーピングも向上します。
OAuth U2M 認証のセットアップを完了するには、プロジェクトと拡張機能を開いて、以下のようにします。
[構成] ウィンドウで、[Configure Databricks](Databricks の構成) をクリックします。
注意
[Configure Databricks](Databricks の構成) が表示されない場合は、代わりに [構成] の横にある歯車 (ワークスペースの構成) アイコンをクリックします。
コマンド パレットの Databricks Host に、ワークスペースごとの URL (例:
https://adb-1234567890123456.7.azuredatabricks.net) を入力します。 次に、Enter キーを押します。[OAuth (user to machine)] を選択します。
Web ブラウザーで画面の指示を実行して、Azure Databricks アカウントでの認証を完了します。 メッセージが表示されたら、all-apis アクセスを許可 します。
この拡張機能では、.databricks という名前のプロジェクトにまだ存在しない場合に、非表示フォルダーが作成されます。 この拡張機能では、project.json という名前のファイルがまだ存在しない場合にもこのフォルダーに作成されます。 このファイルには、入力した URL と、Visual Studio Code 用の Databricks 拡張機能が動作するために必要な Azure Databricks 認証の詳細が含まれています。
また、ファイルが存在しない場合、または親フォルダーに既存の .gitignore ファイルが見つからない場合は、拡張機能によってプロジェクトに非表示の .gitignore ファイルも追加されます。 新しい .gitignore ファイルが作成された場合は、拡張機能により、この新しいファイルに .databricks/ エントリが追加されます。 拡張機能によって既存の .gitignore ファイルが見つかった場合は、既存のファイルに .databricks/ エントリが追加されます。
続けて、「Visual Studio Code 用 Databricks 拡張機能のクラスターの選択」に進んでください。
Azure CLI 認証を設定する
Azure Databricks では、ローカルにインストールされた Azure CLI での認証がサポートされています。 これを使用すると、有効期間の短い (1 時間) Microsoft Entra ID (旧称 Azure Active Directory) トークンを生成できます。これにより、バージョン コントロール チェックインやその他の手段を介して、Azure Databricks 個人用アクセス トークンなどの有効期間の長いトークンを誤って公開するリスクがなくなります。
プロジェクトと拡張機能が開かれ、Azure CLI がローカルにインストールされている状態で、以下を実行します。
[構成] ウィンドウで、[Configure Databricks](Databricks の構成) をクリックします。
注意
[Configure Databricks](Databricks の構成) が表示されない場合は、代わりに [構成] の横にある歯車 (ワークスペースの構成) アイコンをクリックします。
コマンド パレットの Databricks Host に、ワークスペースごとの URL (例:
https://adb-1234567890123456.7.azuredatabricks.net) を入力します。 次に、Enter キーを押します。[Azure CLI] を選びます。
この拡張機能では、.databricks という名前のプロジェクトにまだ存在しない場合に、非表示フォルダーが作成されます。 この拡張機能では、project.json という名前のファイルがまだ存在しない場合にもこのフォルダーに作成されます。 このファイルには、入力した URL と、Visual Studio Code 用の Databricks 拡張機能が動作するために必要な Azure Databricks 認証の詳細が含まれています。
また、ファイルが存在しない場合、または親フォルダーに既存の .gitignore ファイルが見つからない場合は、拡張機能によってプロジェクトに非表示の .gitignore ファイルも追加されます。 新しい .gitignore ファイルが作成された場合は、拡張機能により、この新しいファイルに .databricks/ エントリが追加されます。 拡張機能によって既存の .gitignore ファイルが見つかった場合は、既存のファイルに .databricks/ エントリが追加されます。
続けて、「Visual Studio Code 用 Databricks 拡張機能のクラスターの選択」に進んでください。
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示