安裝擴充功能

Visual Studio Code 適用的 Google Cloud Data Agent Kit 擴充功能，可讓您在偏好的 IDE 中處理 Google Cloud 資料資源。

事前準備

安裝 VS Code 的 Data Agent Kit 擴充功能前，請先完成下列步驟。

安裝 VS Code 和 Python

在本機電腦上安裝 Visual Studio Code 和 Python。

  1. 安裝並設定 Visual Studio Code。 如果已安裝，請更新至最新版本。
  2. 安裝 Python。

設定 Google Cloud

  1. 如果沒有，請建立 Google Cloud 專案。
  2. 啟用計費功能。

安裝 gcloud CLI

您必須安裝並登入 Google Cloud CLI。擴充功能會使用 gcloud CLI 和應用程式預設憑證 (ADC) 的憑證。

  1. 在本機電腦或 VS Code 中開啟終端機。
  2. 如果先前未安裝 gcloud CLI，請按照「安裝 gcloud CLI」中的步驟下載及安裝 gcloud CLI。

  3. 在終端機中執行 gcloud init，初始化 gcloud CLI：

    gcloud init

  4. 執行下列指令，然後按照提示驗證及設定應用程式預設憑證：

    gcloud auth login && gcloud auth application-default login

  5. 將 gcloud CLI 更新到最新版本：

    gcloud components update

必要的角色

如要取得使用 VS Code 適用的 Data Agent Kit 擴充功能所需的權限，請要求管理員授予您專案的下列身分與存取權管理 (IAM) 角色。詳情請參閱「查看必要角色」。

視用途而定，您可能需要其他角色，但這些角色可讓您安裝及設定擴充功能。完整清單位於 IDE 擴充功能設定中。

  • BigQuery 資料檢視者 (roles/bigquery.dataViewer)
  • BigQuery 工作使用者 (roles/bigquery.jobUser)
  • BigQuery 中繼資料檢視者 (roles/bigquery.metadataViewer)
  • BigQuery 讀取工作階段使用者 (roles/bigquery.readSessionUser)
  • Dataproc 編輯者 (roles/dataproc.editor)

如要進一步瞭解如何授予角色，請參閱「管理專案、資料夾和機構的存取權」。

您或許也能透過自訂角色或其他預先定義的角色，取得必要權限。

預先定義的角色具備使用擴充功能所需的權限。如要查看確切的必要權限，請展開「Required permissions」(必要權限) 部分：

所需權限

  • bigquery.config.get
  • bigquery.datasets.get
  • bigquery.datasets.getIamPolicy
  • bigquery.jobs.create
  • bigquery.readsessions.create
  • bigquery.readsessions.getData
  • bigquery.readsessions.update
  • bigquery.tables.createSnapshot
  • bigquery.tables.export
  • bigquery.tables.get
  • bigquery.tables.getIamPolicy
  • bigquery.tables.list
  • bigquery.tables.replicateData
  • dataform.locations.get
  • dataform.locations.list
  • dataform.repositories.create
  • dataform.repositories.list
  • dataplex.projects.search
  • dataproc.clusters.use
  • dataproc.operations.get
  • dataproc.sessions.create
  • dataproc.sessions.delete
  • dataproc.sessions.get
  • dataproc.sessions.list
  • dataproc.sessions.terminate
  • dataproc.sessionTemplates.create
  • dataproc.sessionTemplates.delete
  • dataproc.sessionTemplates.get
  • dataproc.sessionTemplates.list
  • dataproc.sessionTemplates.update
  • resourcemanager.projects.get

安裝擴充功能

  1. 在 VS Code 中，按一下「擴充功能」或按下 Ctrl/Cmd+Shift+X。
  2. 搜尋 Google Cloud Data Agent Kit。
  3. 按一下 [安裝]。
  4. 如果系統提示，請重新啟動 VS Code。擴充功能安裝完成後，活動列會新增 Google Cloud Data Agent Kit 圖示。

登入 Google Cloud Data Agent Kit

接著，您必須使用登入 gcloud CLI 時的帳戶，向 Google Cloud Data Agent Kit 進行驗證。

  1. 如果登入對話方塊未自動開啟，請在 IDE 視窗底部的狀態列中，尋找 Google Cloud Data Agent Kit 登入連結，然後按一下該連結。

    或者，您也可以按下 Ctrl/Cmd+Shift+P 開啟指令面板，然後搜尋並選取「Google Cloud Data Agent Kit: Sign in」。

  2. 按照提示完成登入程序。

    系統會顯示網頁，確認驗證完成。

  3. 關閉頁面並返回 IDE。

啟用 API

登入 Google 帳戶後，您必須在Google Cloud 專案中啟用所有服務的 API，才能用於資料科學或資料工程工作流程。

如要查看 API 清單和已啟用的 API，請按照下列步驟操作：

  1. 在活動列中，按一下「Google Cloud Data Agent Kit」圖示。
  2. 展開「設定」，然後點選「設定」。
  3. 選取「Common」。
  4. 按一下「必要 API」。

要啟用的 API

  • AlloyDB API
  • BigLake API
  • BigQuery API
  • Cloud Composer API
  • Cloud Dataplex API
  • Cloud Resource Manager API
  • Cloud Spanner API
  • Cloud SQL
  • Cloud SQL Admin API
  • Cloud Storage API
  • Dataproc API
  • Dataproc Release Manager API
  • Vertex AI API

疑難排解

如果遇到問題，請嘗試登出 Google Cloud Data Agent Kit 和 gcloud CLI，然後重新登入。如要瞭解診斷及解決安裝錯誤的其他方法，請參閱「排解 VS Code 的 Data Agent Kit 擴充功能問題」。

後續步驟