Databricks IDE拡張の認可を設定する

この記事では、プロジェクト設定でまだ拡張機能を設定していない場合、Databricks IDE拡張機能とAzure Databricksワークスペース間の認証と認証の設定方法を説明します。 DatabricksのIDE拡張を参照してください。

Databricks IDE拡張はDatabricks統一認証標準の一部を実装しており、Azure Databricks OAuth 2.0ベースの認証を一度設定し、その後複数のAzure DatabricksツールやSDKでその設定を、追加の認可や認証設定変更なしで使用できるようにします。 また、アクティブなアクセス トークンの自動更新も提供されるため、開発時のプロセスの複雑さが軽減されます。

Databricksは OAuthのインタラクティブユーザー認証を推奨しており、これはDatabricks IDE拡張機能を使って簡単に設定できます。 「OAuth 承認と認証を設定する」を参照してください。

それ以外の場合は、Azure Databricks の個人用アクセス トークン (レガシー) を用いた認証OAuth を用いて Azure Databricks にサービス プリンシパル アクセスを許可、または Microsoft Entra のサービス プリンシパルでの認証を利用している場合は、構成プロファイルを使用した認証の設定を参照してください。 Azure CLI を使用した認証については、「Azure CLI 認証の設定」を参照してください。

Databricks IDE拡張機能はAzure管理IDs(旧AzureマネージドサービスIDENTITIES(MSI))を使った認証をサポートしていませんが、Databricks IDE拡張機能なしで使用しているDatabricks Connectは対応しています。 Databricks Connect をインストールするには、「Install Databricks Connect for Python。

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

Azure Databricksは、OAuth 2.0 ベースの承認と認証をサポートし、Databricks 統合認証によるアクセス トークン管理を簡略化します。 Azure Databricksを使用したユーザーとサービス プリンシパルの承認の詳細については、「Azure Databricks リソースへのアクセスを認証するを参照してください。

OAuth認証の設定を完了するには、Databricks IDE拡張機能を有効にしたVSCodeプロジェクトを開いてください:

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

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

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

    1. メッセージが表示されたら、Web ブラウザーで画面上の指示を完了して、Azure Databricksでの認証を完了します。
    2. さらに、求められた場合は、all-apis アクセスを許可します。
    3. 「コードとジョブを実行するためのコンピューティングの選択」に進んでください。
  3. [コマンド パレット]の「認証方法の選択」で、「OAuth (ユーザーからマシン)」をクリックします。

  4. 認証方法を選択するには、OAuth (ユーザーからマシン)を選びます。

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

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

    Databricks にログインする

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

  8. メッセージが表示されたら、Web ブラウザーで画面上の指示を完了して、Azure Databricksでの認証を完了します。 さらに、求められた場合は、all-apis アクセスを許可します。

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

構成プロファイルを使用して認証を設定する

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

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

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

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

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

    ヒント

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

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

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

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

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

  3. 次を実行するために、画面上の指示を完了します。

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

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

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

Azure CLI 認証を設定する

Azure Databricksでは、ローカルにインストールされている Azure CLI による認証がサポートされます。 これにより、有効期間が短い (1 時間) Microsoft Entra ID トークンを生成できます。これにより、バージョン管理のチェックインやその他の手段を介して個人用アクセス トークンAzure Databricksなど、有効期間の長いトークンが誤って公開されるリスクがなくなります。

プロジェクトと拡張機能が開き、Azure CLIがローカルにインストールされたら、次の操作を行います。

  1. [構成] ビューで、[Databricks の構成] をクリックします。

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

    ワークスペース設定を構成するための歯車アイコン 1

  2. コマンド パレットDatabricks Host に、ワークスペースごとの URL (例: https://adb-1234567890123456.7.azuredatabricks.net) を入力します。 次に、Enter キーを押します。

  3. Azure CLI を選択します。