この記事では、プロジェクトのセットアップで拡張機能をまだ構成していない場合に、Visual Studio Code用の Databricks 拡張機能と Azure Databricks ワークスペースの間で承認と認証を設定する方法について説明します。 Visual Studio Code については、
Visual Studio Code用 Databricks 拡張機能は、Databricks 統合認証 標準の一部を実装します。これにより、Azure Databricks OAuth 2.0 ベースの承認を 1 回構成し、その構成を複数のAzure Databricksで使用できます。さらに承認と認証の構成を変更することなく、ツールと SDK を使用できます。 また、アクティブなアクセス トークンの自動更新も提供されるため、開発時のプロセスの複雑さが軽減されます。
Databricks では、OAuth 対話型ユーザー承認 をお勧めします。これは、Visual Studio Code用の Databricks 拡張機能を使用して簡単に構成できます。 「OAuth 承認と認証を設定する」を参照してください。
それ以外の場合は、Azure Databricks の個人用アクセス トークン (レガシー) を用いた認証、OAuth を用いて Azure Databricks にサービス プリンシパル アクセスを許可、または Microsoft Entra のサービス プリンシパルでの認証を利用している場合は、構成プロファイルを使用した認証の設定を参照してください。 Azure CLI を使用した認証については、「Azure CLI 認証の設定」を参照してください。
注
Visual Studio Code用のDatabricks拡張機能は、AzureマネージドID（以前はAzureマネージドサービスID (MSI)）を使用した認証をサポートしていませんが、Databricks ConnectはVisual Studio Code用のDatabricks拡張機能なしで使用する場合にサポートします。 Databricks Connect をインストールするには、「
OAuth の承認と認証を設定する
Azure Databricksは、OAuth 2.0 ベースの承認と認証をサポートし、Databricks 統合認証によるアクセス トークン管理を簡略化します。 Azure Databricksを使用したユーザーとサービス プリンシパルの承認の詳細については、「Azure Databricks リソースへのアクセスを認証するを参照してください。
OAuth 承認のセットアップを完了するには、Databricks 拡張機能を有効にした状態で VSCode プロジェクトを開きます。
[構成] ビューで、[認証の種類] をクリックし、次に歯車 ([Databricks ワークスペースにサインイン]) アイコンをクリックします。
この一覧に認証 構成プロファイル が既に存在し、が OAuth (ユーザーからマシン) ラベルを使用して認証され、ターゲット Databricks ホストに対応していることがわかっている場合は、一覧から選択し、次の操作を行います。
- メッセージが表示されたら、Web ブラウザーで画面上の指示を完了して、Azure Databricksでの認証を完了します。
- さらに、求められた場合は、all-apis アクセスを許可します。
- 「コードとジョブを実行するためのコンピューティングの選択」に進んでください。
[コマンド パレット]の「認証方法の選択」で、「OAuth (ユーザーからマシン)」をクリックします。
認証方法を選択するには、OAuth (ユーザーからマシン)を選びます。
関連付けられているAzure Databricks認証プロファイルの名前を入力します。
[構成] ビューで、[Databricks へのログイン] をクリックします。
[コマンド パレット]で、[認証方法の選択]を開き、先ほど作成した認証構成プロファイルの名前を選択します。
メッセージが表示されたら、Web ブラウザーで画面上の指示を完了して、Azure Databricksでの認証を完了します。 さらに、求められた場合は、all-apis アクセスを許可します。
正常にログインしたら、Visual Studio Codeに戻ります。
構成プロファイルを使用して認証を設定する
次の手順では、Azure Databricks認証の種類に必要なフィールドを使用して、Azure Databricks構成プロファイルを既に設定していることを前提としています。 プロファイルを作成するには、Azure Databricks構成プロファイルを参照してください。 プロファイルの設定を構成するには、Azure Databricks リソースへのアクセスを認証 のプロファイル認証タイプの Profile タブまたはセクションを参照してください。
拡張機能で使用する構成プロファイルを選択するには、プロジェクトと拡張機能を開いて、次の操作を行います。
[構成] ビューで、[認証の種類] をクリックし、次に歯車 ([Databricks ワークスペースにサインイン]) アイコンをクリックします。
コマンド パレットで、一覧からターゲット Azure Databricks構成プロファイルを選択します。
ヒント
ターゲット ワークスペースのホストは、プロジェクトに関連付けられている
workspace構成ファイル内でターゲットのdatabricks.yml設定を変更することで、後から変更が可能です。 「targets」を参照してください。
構成プロファイルがない場合は、次のように、Azure Databricks個人用アクセス トークンを使用して認証を行うプロファイルを作成できます。
プロジェクトと拡張機能を開いた状態で、[構成] ビューで [認証の種類] または [Databricks へのログイン] をクリックし、歯車 ([Databricks ワークスペースにサインイン]) アイコンをクリックします。
[コマンド パレット] で、[個人用アクセス トークン] を選択します。
次を実行するために、画面上の指示を完了します。
- 関連付けられているAzure Databricks認証プロファイルの名前を入力します。
- Azure Databricks ワークスペースで個人用アクセス トークンを生成し、トークンの値をコピーします。
- 拡張機能に戻り、コピーしたトークンの値を入力します。
それがまだ存在しない場合、拡張機能は、.databricks という名前のファイルを含む databricks.env という名前のプロジェクトにフォルダーを作成します。 このファイルには、入力したワークスペース ホストと、Databricks 拡張機能でVisual Studio Codeに使用されるその他のAzure Databricks構成の詳細が含まれます。
また、ファイルが存在しない場合、または親フォルダーに既存の .gitignore ファイルが見つからない場合は、拡張機能によってプロジェクトに非表示の .gitignore ファイルも追加されます。 新しい .gitignore ファイルが作成された場合は、拡張機能により、この新しいファイルに .databricks/ エントリが追加されます。 拡張機能によって既存の .gitignore ファイルが見つかった場合は、既存のファイルに .databricks/ エントリが追加されます。
Azure CLI 認証を設定する
Azure Databricksでは、ローカルにインストールされている Azure CLI による認証がサポートされます。 これにより、有効期間が短い (1 時間) Microsoft Entra ID トークンを生成できます。これにより、バージョン管理のチェックインやその他の手段を介して個人用アクセス トークンAzure Databricksなど、有効期間の長いトークンが誤って公開されるリスクがなくなります。
プロジェクトと拡張機能が開き、Azure CLIがローカルにインストールされたら、次の操作を行います。
[構成] ビューで、[Databricks の構成] をクリックします。
注
[Configure Databricks](Databricks の構成) が表示されない場合は、代わりに [構成] の横にある歯車 (ワークスペースの構成) アイコンをクリックします。
コマンド パレットの Databricks Host に、ワークスペースごとの URL (例:
https://adb-1234567890123456.7.azuredatabricks.net) を入力します。 次に、Enter キーを押します。Azure CLI を選択します。