Visual Studio Code 用の Google Cloud Data Agent Kit 拡張機能を使用すると、お好みの IDE で Google Cloud データリソースを操作できます。
始める前に
VS Code 用の Data Agent Kit 拡張機能をインストールする前に、次の操作を行います。
VS Code と Python をインストールする
ローカルマシンに Visual Studio Code と Python をインストールします。
- Visual Studio Code をインストールして設定します。すでにインストールしている場合は、最新バージョンに更新します。
- Python をインストールします。
Google Cloudを設定する
- まだ作成していない場合は、 Google Cloud プロジェクトを作成します。
- 課金を有効にする。
gcloud CLI をインストールする
Google Cloud CLI をインストールしてログインする必要があります。この拡張機能は、gcloud CLI とアプリケーションのデフォルト認証情報(ADC)の両方の認証情報を使用します。
- ローカルマシンまたは VS Code でターミナルを開きます。
- gcloud CLI をまだインストールしていない場合は、gcloud CLI をインストールするの手順に沿って、gcloud CLI をダウンロードしてインストールします。
ターミナルで
gcloud initを実行して、gcloud CLI を初期化します。gcloud init次のコマンドを実行し、プロンプトに従って認証を行い、アプリケーションのデフォルト認証情報を設定します。
gcloud auth login && gcloud auth application-default logingcloud CLI を最新バージョンに更新します。
gcloud components update
必要なロール
VS Code 用 Data Agent Kit 拡張機能の使用に必要な権限を取得するには、プロジェクトに対する次の Identity and Access Management(IAM)ロールを付与するよう管理者に依頼してください。詳細については、必要なロールを確認するをご覧ください。
ユースケースによっては追加のロールが必要になる場合がありますが、これらのロールを使用すると、拡張機能をインストールして設定できます。完全なリストは、IDE 拡張機能の設定で確認できます。
- BigQuery データ閲覧者(
roles/bigquery.dataViewer) - BigQuery ジョブユーザー(
roles/bigquery.jobUser) - BigQuery メタデータ閲覧者(
roles/bigquery.metadataViewer) - BigQuery 読み取りセッション ユーザー(
roles/bigquery.readSessionUser) - Dataproc 編集者(
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
拡張機能をインストールする
- VS Code で、[Extensions] をクリックするか、
Ctrl/Cmd+Shift+Xを押します。 Google Cloud Data Agent Kitを検索します。- [インストール] をクリックします。
- プロンプトが表示されたら、VS Code を再起動します。拡張機能が正常にインストールされると、Google Cloud Data Agent Kit のアイコンがアクティビティ バーに追加されます。
Google Cloud Data Agent Kit にログインする
次に、gcloud CLI へのログインに使用したのと同じアカウントを使用して、Google Cloud Data Agent Kit に対して認証を行う必要があります。
ログイン ダイアログが自動的に開かない場合は、IDE ウィンドウの下部にあるステータスバーで Google Cloud Data Agent Kit のログインリンクを探してクリックします。
または、
Ctrl/Cmd+Shift+Pを押してコマンド パレットを開き、[Google Cloud Data Agent Kit: Sign in] を検索して選択します。画面の指示に沿ってログインします。
認証が完了したことを確認するウェブページが表示されます。
ページを閉じて IDE に戻ります。
API を有効にする
Google アカウントにログインしたら、データ サイエンスまたはデータ エンジニアリングのワークフローで使用するすべてのサービスについて、Google Cloud プロジェクトで API を有効にする必要があります。
API のリストを表示し、すでに有効になっている API を確認するには、次の操作を行います。
- アクティビティ バーで、Google Cloud Data Agent Kit アイコンをクリックします。
- [設定] を展開し、[設定] をクリックします。
- [共通] を選択します。
- [必要な 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 拡張機能のトラブルシューティングをご覧ください。