共用方式為

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 擴充功能。

注意

如果您已完成 Databricks 的 VSCode 延伸模塊教學課程：在叢集和作業上執行 Python，而且想要繼續使用您在該教學課程中設定的 Azure Databricks 個人存取令牌驗證，請直接跳至 選取適用於 Visual Studio Code 的 Databricks 擴充功能的叢集。

根據您想要使用的驗證類型，完成目標 Azure Databricks 驗證類型的指示。

注意

適用於 Visual Studio Code 的 Databricks 擴充功能尚不支援使用 Azure 受控識別進行驗證（先前稱為 Azure 受控服務識別 （MSI））。

Databricks 連線 支援使用 Azure 受控識別進行驗證。 不過，您無法在適用於 Visual Studio Code 的 Databricks 擴充功能中使用 Databricks 連線 整合來執行 Azure 受控識別驗證。 若要單獨搭配 Visual Studio Code 使用 Databricks 連線，請與適用於 Visual Studio Code 的 Databricks 擴充功能分開，請參閱搭配使用 Visual Studio Code 搭配 Databricks 連線 for Python。

使用組態配置檔設定驗證

下列指示假設您已經使用 Azure Databricks 驗證類型所需的欄位來設定 Azure Databricks 組態設定檔。 如需 Azure Databricks 自動化驗證中的驗證類型，請參閱 Azure Databricks 組態配置檔和 [配置檔] 索引標籤或區段 - 概觀。

例如，如果您想要使用 Azure Databricks 個人存取令牌驗證進行驗證，請執行下列動作來建立您的個人存取令牌：

  1. 在 Azure Databricks 工作區中，按兩下頂端列中的 Azure Databricks 使用者名稱，然後從下拉式清單中選取 [設定]。
  2. 按兩下 [ 開發人員]。
  3. 按兩下 [存取令牌] 旁的 [管理]。
  4. 按兩下 [ 產生新的令牌]。
  5. （選擇性）輸入批注，協助您在未來識別此令牌，並變更令牌的預設存留期 90 天。 若要建立沒有存留期的令牌（不建議），請將 [ 存留期（天）] 方塊保留空白（空白）。
  6. 按一下 [產生]。
  7. 將顯示的令牌複製到安全的位置，然後按兩下 [ 完成]。

注意

請務必將複製的令牌儲存在安全的位置。 請勿與其他人共享複製的令牌。 如果您遺失複製的令牌，就無法重新產生完全相同的令牌。 相反地，您必須重複此程式來建立新的令牌。 如果您遺失複製的令牌，或您認為令牌已遭入侵，Databricks 強烈建議您按兩下存取令牌頁面上令牌旁邊的垃圾桶 （Revoke） 圖示，立即從工作區中刪除該令牌。

如果您無法在工作區中建立或使用令牌，這可能是因為您的工作區系統管理員已停用令牌，或未授與您建立或使用令牌的許可權。 請參閱您的工作區管理員或下列專案：

例如，若要為個人存取令牌建立名為 DEFAULT 的組態配置檔，請執行下列動作：

注意

下列程式會使用 Databricks CLI 來建立名稱為 DEFAULT的 Azure Databricks 組態配置檔。 如果您已經有組 DEFAULT 態配置檔，此程式會覆寫現有的 DEFAULT 組態配置檔。

若要檢查您是否已經有組 DEFAULT 態設定檔，以及若要檢視此設定檔的設定是否存在，請使用 Databricks CLI 來執行命令 databricks auth env --profile DEFAULT。

若要使用 以外的DEFAULT名稱建立組態配置檔，請將下列databricks configure命令中的 部分--profile DEFAULT取代DEFAULT為組態配置檔的不同名稱。

  1. 使用 Databricks CLI 建立名為 DEFAULT 的 Azure Databricks 組態配置檔，該配置檔會使用 Azure Databricks 個人存取令牌驗證。 若要這樣做，請執行下列命令：

    databricks configure --profile DEFAULT

  2. 如需提示 Databricks Host，請輸入您的 Azure Databricks 個別工作區 URL，例如 https://adb-1234567890123456.7.azuredatabricks.net。

  3. 針對提示 個人存取令牌，輸入工作區的 Azure Databricks 個人存取令牌。

準備好 Azure Databricks 組態配置文件之後，您的專案和延伸模組隨即開啟，請執行下列動作：

  1. 在 [ 設定 ] 窗格中，按兩下 [ 設定 Databricks]。

    注意

    如果看不到 [設定 Databricks]，請按兩下 [設定] 旁的齒輪 （設定工作區） 圖示。

    設定工作區設定的齒輪圖示 1

  2. 在命令選擇區中，針對 Databricks Host，輸入每個工作區的 URL，例如 https://adb-1234567890123456.7.azuredatabricks.net。 然後按 Enter。

  3. 在 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） 驗證。 這可讓您產生短期的（一小時）OAuth 存取令牌，這可避免不小心透過版本控制簽入或其他方式公開較長存留令牌的風險，例如 Azure Databricks 個人存取令牌。 這也會啟用更佳的伺服器端會話失效和範圍。

若要完成 OAuth U2M 驗證的設定，並開啟您的專案和延伸模組，請執行下列動作：

  1. 在 [ 設定 ] 窗格中，按兩下 [ 設定 Databricks]。

    注意

    如果看不到 [設定 Databricks]，請按兩下 [設定] 旁的齒輪 （設定工作區） 圖示。

    設定工作區設定的齒輪圖示 1

  2. 在命令選擇區中，針對 Databricks Host，輸入每個工作區的 URL，例如 https://adb-1234567890123456.7.azuredatabricks.net。 然後按 Enter。

  3. 選取 [OAuth][用戶到計算機]。

  4. 完成網頁瀏覽器中的畫面指示，以使用 Azure Databricks 帳戶完成驗證。 如果出現提示，請允許 所有 API 存取 。

如果專案不存在，此延伸模組會在您的專案中建立名為 .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 的驗證。 這可讓您產生短期（一小時）的 Microsoft Entra ID（先前稱為 Azure Active Directory）令牌，這可避免不小心透過版本控制簽入或其他方式公開較長存留令牌的風險。

在您的項目和擴充功能開啟，並在本機安裝 Azure CLI 時，請執行下列動作：

  1. 在 [ 設定 ] 窗格中，按兩下 [ 設定 Databricks]。

    注意

    如果看不到 [設定 Databricks]，請按兩下 [設定] 旁的齒輪 （設定工作區） 圖示。

    設定工作區設定的齒輪圖示 1

  2. 在命令選擇區中，針對 Databricks Host，輸入每個工作區的 URL，例如 https://adb-1234567890123456.7.azuredatabricks.net。 然後按 Enter。

  3. 選取 [Azure CLI]。

如果專案不存在，此延伸模組會在您的專案中建立名為 .databricks 的隱藏資料夾。 如果檔案不存在，此擴展名也會在此資料夾中建立名為 project.json 的檔案。 此檔案包含您輸入的 URL，以及 Visual Studio Code Databricks 擴充功能必須運作的一些 Azure Databricks 驗證詳細數據。

如果檔案不存在，或找不到任何父資料夾中的現有.gitignore檔案，此擴展名也會將隱藏.gitignore的檔案新增至專案。 如果已建立新的 .gitignore 檔案，擴充功能會將專案新增 .databricks/ 至這個新檔案。 如果延伸模組找到現有的 .gitignore 檔案，它會將專案新增 .databricks/ 至現有的檔案。

繼續針對 Visual Studio Code 的 Databricks 擴充功能選取叢集。