安装扩展程序

借助适用于 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 项目，请创建一个 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 扩展程序所需的权限，请让您的管理员向您授予项目的以下 Identity and Access Management (IAM) 角色。如需了解详情，请参阅查看必需的角色。

根据您的使用场景，您可能需要其他角色，但这些角色可让您安装和设置扩展程序。完整列表可在 IDE 扩展程序设置中找到。

  • BigQuery Data Viewer (roles/bigquery.dataViewer)
  • BigQuery Job User (roles/bigquery.jobUser)
  • BigQuery Metadata Viewer (roles/bigquery.metadataViewer)
  • BigQuery Read Session User (roles/bigquery.readSessionUser)
  • Dataproc Editor (roles/dataproc.editor)

如需详细了解如何授予角色，请参阅管理对项目、文件夹和组织的访问权限。

您也可以通过自定义角色或其他预定义角色来获取所需的权限。

这些预定义角色包含使用该扩展程序所需的权限。如需查看所需的确切权限，请展开“所需权限”部分：

所需权限

  • 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 数据代理套件

接下来，您必须使用登录 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. 选择通用。
  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 扩展程序问题。

后续步骤