建立資料產品

本文適用於想要在 Dataplex Universal Catalog 中建立及設定資料產品的資料產品擁有者。

如要進一步瞭解資料產品的架構和重要概念,請參閱「關於資料產品」。

事前準備

  1. 啟用 Dataplex 和 BigQuery API。

    啟用 API 時所需的角色

    如要啟用 API,您需要服務使用情形管理員 IAM 角色 (roles/serviceusage.serviceUsageAdmin),其中包含 serviceusage.services.enable 權限。瞭解如何授予角色

    啟用 API

  2. 確認資料資產 (例如 BigQuery 資料集、資料表和檢視) 已建立並填入資料。

    如要進一步瞭解如何建立資料資產,請參閱下列文件:

  3. 找出或建立要在資料產品中設定的Google 群組。每個資料產品都必須有專屬的 Google 群組。

必要的角色

本節列出兩大主要使用者群組所需的最低 IAM 角色:資料產品擁有者 (建立及管理資料產品的使用者),以及資料產品消費者 (搜尋及使用資料產品的使用者)。

資料產品擁有者的角色

如要取得建立及管理資料產品所需的權限,請要求系統管理員授予您專案的下列 IAM 角色:

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

這些預先定義的角色具備建立及管理資料產品所需的權限。如要查看確切的必要權限,請展開「Required permissions」(必要權限) 部分:

所需權限

如要建立及管理資料產品,必須具備下列權限:

  • 編輯 overview 系統切面類型: dataplex.entryGroups.useOverviewAspect
  • 編輯 refresh cadence 系統切面類型: dataplex.entryGroups.useRefreshCadenceAspect

您或許還可透過自訂角色或其他預先定義的角色取得這些權限。

資料產品消費者適用的角色

為方便資料產品消費者搜尋、查看及要求存取資料產品,資料產品擁有者必須確保資料產品可供探索。如要這麼做,請在資料產品中授予資料產品消費者下列 IAM 角色:

  • 在 Dataplex Universal Catalog Search 中搜尋及存取資料產品: Dataplex 資料產品消費者 (dataplex.dataProductsConsumer)
  • 唯讀存取權,可查看資料產品定義和中繼資料: Dataplex 資料產品檢視者 (dataplex.dataProductsViewer)
  • 要求資料產品的存取權:Dataplex 資料產品消費者 (dataplex.dataProductsConsumer)

建立及設定資料產品

建立資料產品時,需要完成下列高階工作:

  1. 建立資料產品

    這個必要初始步驟需要定義核心詳細資料,例如專屬資料產品名稱、說明、建立資料產品的區域,以及擁有者詳細資料。

  2. 選用:新增素材資源

    在這個階段,您可以選取要納入資料產品的資產。重要限制是資產必須與資料產品本身位於相同區域。資料產品最多只能新增 10 項資產。

    如需支援的資產清單,請參閱「支援的資產」。

  3. 選用:設定存取權群組和資產權限

    在這個選用階段,您可以建立存取權群組,簡化存取控管。這些存取群組是基礎 Google 群組的別名,方便使用者辨識 (例如 AnalystReader)。接著,選取特定 IAM 角色並對應至特定資產的存取權群組,即可指派權限。

  4. 選用:新增其他詳細資料,例如合約、切面和文件

    這個選用階段可強化治理和中繼資料。您可以新增合約 (第一方層面類型),正式傳達雙方同意的資料重新整理頻率,並指定重新整理頻率、重新整理時間和門檻等參數。您也可以加入切面,為資料產品提供其他中繼資料。此外,您還可以新增 RTF 格式的說明文件,例如使用手冊和查詢範例。

如要建立及設定資料產品,請完成下列各節的步驟:

建立資料產品

控制台

  1. 在 Google Cloud 控制台,前往 Dataplex Universal Catalog 的「資料產品」頁面。

    前往「資料產品」

  2. 點選「建立」

  3. 在「建立資料產品」窗格中,輸入下列詳細資料:

    • 資料產品名稱:輸入資料產品的專屬名稱。
    • 資料產品 ID:這是系統自動產生的專屬 ID。 您可以編輯這個欄位。
    • 專案 ID:這是建立資料產品的專案專屬 ID。瀏覽並選取專案。
    • 區域:選取資料產品的建立區域或多區域。
    • 圖示:瀏覽並選取圖示,以視覺化方式識別資料產品。您可以視需要決定是否啟用。
    • 說明:輸入資料產品的簡要說明。
    • 聯絡人:輸入資料產品擁有者的電子郵件 ID。
    • 標籤:新增鍵值標籤,整理資源。這項設定為選用。
  4. 按一下「建立資料產品」

REST

如要建立資料產品,請使用 dataProducts.create 方法。

舉例來說,請傳送下列 POST 要求:

curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-d '{"display_name": "DISPLAY_NAME", "owner_emails": ["EMAIL_IDs"]}' \
https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/dataProducts?data_product_id=DATA_PRODUCT_ID

更改下列內容:

  • DISPLAY_NAME:資料產品的簡單易懂名稱
  • EMAIL_IDs:以半形逗號分隔的資料產品擁有者電子郵件 ID
  • PROJECT_ID:您 Google Cloud專案的 ID
  • LOCATION:要建立資料產品的區域
  • DATA_PRODUCT_ID:資料產品的專屬 ID

Terraform

如要建立資料產品,請使用 google_dataplex_data_product 資源。

resource "google_dataplex_data_product" "example_product" {
project         = "PROJECT_ID"
location        = "LOCATION"
data_product_id = "DATA_PRODUCT_ID"
display_name    = "DISPLAY_NAME"
description     = "DESCRIPTION"
owner_emails    = ["EMAIL_IDs"]

provider = google-beta
}

更改下列內容:

  • PROJECT_ID:您 Google Cloud 專案的 ID
  • LOCATION:要建立資料產品的區域
  • DATA_PRODUCT_ID:資料產品的專屬 ID
  • DISPLAY_NAME:資料產品的簡單易懂名稱
  • DESCRIPTION:資料產品的簡要說明
  • EMAIL_IDs:以半形逗號分隔的資料產品擁有者電子郵件 ID,例如 ["user1@example.com", "user2@example.com"]

選用:新增素材資源

控制台

  1. 在「新增資產」窗格中,按一下「+新增」

  2. 搜尋並選取要新增至資料產品的資產。 所選資產必須與資料產品位於相同區域。

    如果您擁有必要權限,點選資產即可查看資產的中繼資料。

  3. 如要縮小搜尋結果範圍,請使用「篩選器」

  4. 選取資產後,按一下「新增」

  5. 按一下「繼續」

REST

如要將資料資產新增至資料產品,請使用 dataAssets.create 方法。

舉例來說,請傳送下列 POST 要求:

curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-d '{"resource": "RESOURCE_NAME"}' \
https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/dataProducts/DATA_PRODUCT_ID/dataAssets?data_asset_id=DATA_ASSET_ID

更改下列內容:

  • RESOURCE_NAME:資料資產的完整資源名稱 (例如 //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID)
  • PROJECT_ID:您 Google Cloud 專案的 ID
  • LOCATION:資料產品所在的區域
  • DATA_PRODUCT_ID:資料產品的 ID
  • DATA_ASSET_ID:這個資料資產在資料產品中的專屬 ID

Terraform

如要將資料資產新增至資料產品,請使用 google_dataplex_data_product_data_asset 資源。

resource "google_dataplex_data_product_data_asset" "example_asset" {
project         = "PROJECT_ID"
location        = "LOCATION"
data_product_id = "DATA_PRODUCT_ID"
data_asset_id   = "DATA_ASSET_ID"
resource        = "RESOURCE_NAME"

provider = google-beta
}

更改下列內容:

  • PROJECT_ID:您 Google Cloud 專案的 ID
  • LOCATION:資料產品所在的區域
  • DATA_PRODUCT_ID:資料產品的 ID
  • DATA_ASSET_ID:這個資料資產在資料產品中的專屬 ID
  • RESOURCE_NAME:資料資產的完整資源名稱 (例如 //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID)

選用:設定存取權群組和資產權限

在「設定存取權群組和資產權限」窗格中,您可以建立存取權群組,並將權限指派給資產。

設定存取權群組

控制台

  1. 按一下「新增存取權群組」

  2. 在「存取群組名稱」欄位中,輸入存取群組的名稱。例如:Analyst

  3. 在「存取權群組說明」欄位中,輸入存取權群組的說明。

  4. 在「存取權群組 ID」欄位中,輸入要指派給這個存取權群組的 Google 群組電子郵件地址。要求存取這個存取權群組的資料產品消費者,可以新增為對應 Google 群組的成員。

    如果沒有 Google 群組,可以自行建立。詳情請參閱「在 Google Cloud 控制台中建立及管理 Google 群組」。

  5. 按一下「新增」。

REST

如要設定資料產品的存取權群組,請使用 dataProducts.patch 方法。

舉例來說,請傳送下列 PATCH 要求:

curl -X PATCH \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-d '{"access_groups": ACCESS_GROUPS_MAP}' \
https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/dataProducts/DATA_PRODUCT_ID?update_mask="access_groups"

更改下列內容:

  • ACCESS_GROUPS_MAP:JSON 物件,代表對應項,其中每個鍵都是存取權群組 ID,值則是 AccessGroup 物件。例如:

    {
    "analyst": {
      "id": "analyst","display_name": "Analyst access group","description": "Access group for analysts","principal":
    {"google_group": "analyst-team@example.com"}
      }
    }
    
  • PROJECT_ID:您 Google Cloud專案的 ID

  • LOCATION:資料產品所在的區域

  • DATA_PRODUCT_ID:資料產品的 ID

Terraform

如要為資料產品定義存取群組,請使用 google_dataplex_data_product 資源中的 access_groups 巢狀區塊。

舉例來說,請使用下列設定:

resource "google_dataplex_data_product" "example_data_product" {
project         = "PROJECT_ID"
location        = "LOCATION"
data_product_id = "DATA_PRODUCT_ID"
display_name    = "DISPLAY_NAME"
owner_emails    = ["EMAIL_IDs"]

access_groups {
  id           = "analyst" # Internal identifier for configuration
  group_id     = "analyst" # Unique identifier of the access group, should be same as the 'id'
  display_name = "Business Analyst"
  description  = "Access group for regional analysts"
  principal {
    google_group = "analyst-team@example.com"
  }

provider = google-beta
}

更改下列內容:

  • PROJECT_ID:您 Google Cloud 專案的 ID
  • LOCATION:資料產品所在的區域
  • DATA_PRODUCT_ID:資料產品的專屬 ID
  • DISPLAY_NAME:資料產品的簡單易懂名稱
  • EMAIL_IDs:以半形逗號分隔的資料產品擁有者電子郵件 ID,例如 ["user1@example.com", "user2@example.com"]

設定資產權限

設定存取群組後,即可設定資料產品中資產的權限。

控制台

  1. 在「資產權限」部分,選取要設定權限的資產。

  2. 按一下「設定權限」

  3. 在「選取存取權群組」欄位中,選取存取權群組。

  4. 在「指派 IAM 角色」欄位中,選取要指派給存取權群組的 IAM 角色。

    舉例來說,如果您的資產是名為 Sales 的 BigQuery 資料表,且您選取 Analyst 存取權群組,並將 BigQuery Metadata Viewer 角色指派給這個存取權群組,則屬於 Analyst 存取權群組的資料產品消費者,會對 Sales 資料表擁有 BigQuery Metadata Viewer 權限。

    您可以為資產新增多個角色。

  5. 按一下「設定」。資產現在會顯示指派的權限。

  6. 如要設定其他資產的權限,請重複上述步驟。

  7. 按一下「繼續」

REST

如要設定資料產品中資產的權限,請使用 dataAssets.patch 方法。

舉例來說,請傳送下列 PATCH 要求:

curl -X PATCH \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-d '{"access_group_configs": ACCESS_GROUP_CONFIGS_MAP}' \
https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/dataProducts/DATA_PRODUCT_ID/dataAssets/DATA_ASSET_ID?update_mask="access_group_configs"

更改下列內容:

  • ACCESS_GROUP_CONFIGS_MAP:JSON 物件,代表地圖,其中每個鍵都是存取權群組 ID,值則是 AccessGroupConfig 物件。例如:

    {
    "analyst": {
      iam_roles: ["roles/bigquery.dataViewer"]
      }
    }
    
  • PROJECT_ID:您 Google Cloud專案的 ID

  • LOCATION:資料產品所在的區域

  • DATA_PRODUCT_ID:資料產品的 ID

  • DATA_ASSET_ID:要設定權限的資產 ID

Terraform

使用 google_dataplex_data_product_data_asset 資源中的 access_group_configs 區塊,為特定資產的存取群組指派 IAM 角色。

舉例來說,請使用下列設定:

resource "google_dataplex_data_product_data_asset" "example_data_asset" {
project         = "PROJECT_ID"
location        = "LOCATION"
data_product_id = "DATA_PRODUCT_ID"
data_asset_id   = "DATA_ASSET_ID"
resource        = "RESOURCE_NAME"

access_group_configs {
  access_group = "analyst" # Must match the 'id' defined in google_dataplex_data_product
  iam_roles    = ["roles/bigquery.dataViewer"]
}

provider = google-beta
}

更改下列內容:

  • PROJECT_ID:您 Google Cloud 專案的 ID
  • LOCATION:資料產品所在的區域
  • DATA_PRODUCT_ID:資料產品的 ID
  • DATA_ASSET_ID:這個資料資產在資料產品中的專屬 ID
  • RESOURCE_NAME:資料資產的完整資源名稱 (例如 //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID)

選填:新增其他詳細資料

您也可以為資料產品新增合約、切面和其他說明文件。

新增合約

如要在資料生產者和消費者之間建立信任基礎,您可以將合約附加至資料產品。指定重新整理時間和門檻等參數,為消費者提供必要背景資訊,瞭解資料更新時間,以及資料是否符合特定業務需求。

控制台

  1. 在「新增其他詳細資料」窗格中,按一下「新增合約」

  2. 在「Select contract」(選取合約) 欄位中,選取「Refresh cadence」。

  3. 在「頻率」欄位中,選取雙方同意的資料更新或傳送時間表,確保資料從產生者到消費者之間有可預測的流程。例如:Weekly

  4. 在「重新整理時間」欄位中,輸入資料在來源更新,以及消費者可存取資料之間,可接受的最長時間。例如:23:00 PST

  5. 在「門檻 (以分鐘為單位)」欄位中,輸入可接受的資料傳送延遲時間 (以分鐘為單位)。舉例來說,輸入 30 可將門檻設為 30 分鐘。

  6. 選用:在「Cron schedule」(Cron 排程) 欄位中,輸入定義資料產生和傳送排程的 Cron 運算式,格式為:MINUTE HOUR DAY_OF_MONTH MONTH DAY_OF_WEEK

    可接受的值如下:

    • MINUTE0-59
    • HOUR0-23
    • DAY_OF_MONTH1-31
    • MONTH1-31JAN-DEC
    • DAY_OF_WEEK0-6SUN-SAT

    舉例來說,0 8 * * 1-5 會在平日 (週一至週五) 上午 8:00 執行。

  7. 按一下 [儲存]

REST

合約會以資料產品的切面形式呈現。如要為資料產品新增 Refresh Cadence 合約,請使用 entries.patch 方法。

舉例來說,請傳送下列 PATCH 要求:

curl -X PATCH \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-d \
'{
  "aspects": {
    "dataplex-types.global.refresh-cadence": {
      "aspectType": "projects/dataplex-types/locations/global/aspectTypes/refresh-cadence",
      "data": {
        "frequency": "REFRESH_FREQUENCY"
      }
    }
  }
}' \
"https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/entryGroups/@dataplex/entries/projects/DATA_PRODUCT_PROJECT_NUMBER/locations/DATA_PRODUCT_LOCATION/dataProducts/DATA_PRODUCT_ID?updateMask=aspects"

更改下列內容:

  • REFRESH_FREQUENCY:雙方同意的資料更新或傳送頻率時間表,確保資料從產生者到消費者之間有可預測的流程。例如:Weekly
  • PROJECT_ID:發出 API 呼叫的 Google Cloud 專案 ID
  • LOCATION:您要呼叫的 Dataplex Universal Catalog 服務端點區域 (例如 us-central1)
  • DATA_PRODUCT_PROJECT_NUMBER:資料產品資源所在的專案編號
  • DATA_PRODUCT_LOCATION:資料產品資源的位置
  • DATA_PRODUCT_ID:資料產品的 ID

Terraform

合約會以資料產品的切面形式呈現。如要管理合約,您必須管理基礎 Dataplex Universal Catalog 項目。由於 Terraform 不會自動探索現有層面,您必須先匯入 google_dataplex_entry

如要匯入項目,請使用下列指令:

terraform import google_dataplex_entry.data_product_metadata "projects/DATA_PRODUCT_PROJECT_NUMBER/locations/LOCATION/entryGroups/@dataplex/entries/projects/DATA_PRODUCT_PROJECT_NUMBER/locations/LOCATION/dataProducts/DATA_PRODUCT_ID"

Terraform 設定:

resource "google_dataplex_entry" "data_product_metadata" {
project        = "DATA_PRODUCT_PROJECT_NUMBER"
location       = "LOCATION"
entry_group_id = "@dataplex"
entry_id       = "projects/DATA_PRODUCT_PROJECT_NUMBER/locations/LOCATION/dataProducts/DATA_PRODUCT_ID"
entry_type     = "projects/655216118709/locations/global/entryTypes/data-product"

aspects {
  aspect_key = "655216118709.global.refresh-cadence"
  aspect {
    data = jsonencode({
      frequency = "REFRESH_FREQUENCY"
    })
  }
}

provider = google-beta
}

更改下列內容:

  • DATA_PRODUCT_PROJECT_NUMBER:資料產品資源所在的專案編號
  • LOCATION:您要呼叫的 Dataplex Universal Catalog 服務端點區域 (例如 us-central1)
  • DATA_PRODUCT_ID:資料產品的 ID
  • REFRESH_FREQUENCY:雙方同意的資料更新或傳送頻率時間表,確保資料從產生者到消費者之間有可預測的流程。例如:Weekly

如需匯入程序的一般資訊,請參閱 Terraform 匯入說明文件

新增切面

使用切面,以可重複使用的結構化中繼資料,豐富資料產品。這些範本為資料生產者提供標準化方式,可傳達資料產品的品質和適用性,進而改善治理機制,並協助消費者判斷產品是否符合業務需求。

如要為資料產品新增切面,請按照下列步驟操作:

控制台

  1. 在「新增其他詳細資料」窗格中,按一下「+ 新增切面」

  2. 在「選取層面類型」欄位中,搜尋並從清單中選取層面類型。例如:Geo context

  3. 在「國家/地區」欄位中,選取資產所屬的國家/地區。

  4. 在「Region」(區域) 欄位中,選取資產所屬的業務區域。

  5. 按一下 [儲存]

REST

如要為資料產品新增切面,請使用 entries.patch 方法。

舉例來說,請傳送下列 PATCH 要求:

curl -X PATCH \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-d \
'{
  "aspects": {
    "ASPECT_PROJECT_ID.ASPECT_LOCATION.ASPECT_NAME": {
      "aspectType": "projects/ASPECT_PROJECT_ID/locations/ASPECT_LOCATION/aspectTypes/ASPECT_NAME",
      "data": {}
    }
  }
}' \
"https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/entryGroups/@dataplex/entries/projects/DATA_PRODUCT_PROJECT_NUMBER/locations/DATA_PRODUCT_LOCATION/dataProducts/DATA_PRODUCT_ID?updateMask=aspects"

更改下列內容:

  • ASPECT_PROJECT_ID:建立構面所在專案的 ID Google Cloud
  • ASPECT_LOCATION:建立切面的 Dataplex Universal Catalog 服務端點所在區域 (例如 us-central1)
  • ASPECT_NAME:要附加至資料產品的層面名稱
  • PROJECT_ID:發出 API 呼叫的 Google Cloud 專案 ID
  • LOCATION:您要呼叫的 Dataplex Universal Catalog 服務端點區域 (例如 us-central1)
  • DATA_PRODUCT_PROJECT_NUMBER:資料產品資源所在的專案編號
  • DATA_PRODUCT_LOCATION:資料產品資源的位置
  • DATA_PRODUCT_ID:資料產品的 ID

Terraform

如要管理切面,必須管理基礎 Dataplex Universal Catalog 項目。 由於 Terraform 不會自動探索現有層面,您必須先匯入 google_dataplex_entry

如要匯入項目,請使用下列指令:

terraform import google_dataplex_entry.data_product_metadata "projects/DATA_PRODUCT_PROJECT_NUMBER/locations/LOCATION/entryGroups/@dataplex/entries/projects/DATA_PRODUCT_PROJECT_NUMBER/locations/LOCATION/dataProducts/DATA_PRODUCT_ID"

Terraform 設定:

resource "google_dataplex_entry" "data_product_metadata" {
project        = "DATA_PRODUCT_PROJECT_NUMBER"
location       = "LOCATION"
entry_group_id = "@dataplex"
entry_id       = "projects/DATA_PRODUCT_PROJECT_NUMBER/locations/LOCATION/dataProducts/DATA_PRODUCT_ID"
entry_type     = "projects/655216118709/locations/global/entryTypes/data-product"

aspects {
  aspect_key = "ASPECT_PROJECT_NUMBER.ASPECT_LOCATION.ASPECT_NAME"
  aspect {
    data = {}
  }
}

provider = google-beta
}

更改下列內容:

  • DATA_PRODUCT_PROJECT_NUMBER:資料產品資源所在的專案編號
  • LOCATION:您要呼叫的 Dataplex Universal Catalog 服務端點區域 (例如 us-central1)
  • DATA_PRODUCT_ID:資料產品的 ID
  • ASPECT_PROJECT_NUMBER:建立構面的 Google Cloud 專案 編號
  • ASPECT_LOCATION:建立切面的 Dataplex Universal Catalog 服務端點所在區域 (例如 us-central1)
  • ASPECT_NAME:要附加至資料產品的層面名稱

如需匯入程序的一般資訊,請參閱 Terraform 匯入說明文件

新增說明文件

文件提供必要脈絡,有助於消費者瞭解及有效使用資料產品。您可以加入使用者指南、範例 SQL 查詢和商業邏輯說明等詳細資料,協助使用者從基礎資產產生洞察資料。在 Dataplex Universal Catalog 中,文件是透過 overview 系統切面管理。

如要為資料產品新增說明文件,請按照下列步驟操作:

控制台

  1. 在「新增其他詳細資料」窗格中,按一下「文件」旁的 「編輯」

  2. 在 RTF 格式編輯器中輸入內容。

  3. 按一下 [儲存]

    新建立的資料產品會顯示在 Dataplex Universal Catalog 的「資料產品」頁面。

REST

說明文件會以資料產品的切面形式呈現。如要新增說明文件,請使用 entries.patch 方法。

舉例來說,請傳送下列 PATCH 要求:

curl -X PATCH \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-d \
'{
  "aspects": {
    "dataplex-types.global.overview": {
      "aspectType": "projects/dataplex-types/locations/global/aspectTypes/overview",
      "data": {
        "content": "DOCUMENTATION"
      }
    }
  }
}' \
"https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/entryGroups/@dataplex/entries/projects/DATA_PRODUCT_PROJECT_NUMBER/locations/DATA_PRODUCT_LOCATION/dataProducts/DATA_PRODUCT_ID?updateMask=aspects"

更改下列內容:

  • PROJECT_ID:發出 API 呼叫的 Google Cloud 專案 ID
  • LOCATION:您要呼叫的 Dataplex Universal Catalog 服務端點區域 (例如 us-central1)
  • DATA_PRODUCT_PROJECT_NUMBER:資料產品資源所在的專案編號
  • DATA_PRODUCT_LOCATION:資料產品資源的位置
  • DATA_PRODUCT_ID:資料產品的 ID
  • DOCUMENTATION:您要附加至資料產品的內容

Terraform

說明文件會以資料產品的切面形式呈現。如要管理說明文件,必須管理基礎 Dataplex Universal Catalog 項目。由於 Terraform 不會自動探索現有層面,您必須先匯入 google_dataplex_entry

如要匯入項目,請使用下列指令:

terraform import google_dataplex_entry.data_product_metadata "projects/DATA_PRODUCT_PROJECT_NUMBER/locations/LOCATION/entryGroups/@dataplex/entries/projects/DATA_PRODUCT_PROJECT_NUMBER/locations/LOCATION/dataProducts/DATA_PRODUCT_ID"

Terraform 設定:

resource "google_dataplex_entry" "data_product_metadata" {
project        = "DATA_PRODUCT_PROJECT_NUMBER"
location       = "LOCATION"
entry_group_id = "@dataplex"
entry_id       = "projects/DATA_PRODUCT_PROJECT_NUMBER/locations/LOCATION/dataProducts/DATA_PRODUCT_ID"
entry_type     = "projects/655216118709/locations/global/entryTypes/data-product"

aspects {
  aspect_key = "655216118709.global.overview"
  aspect {
    data = jsonencode({
      content = "DOCUMENTATION"
    })
  }
}

provider = google-beta
}

更改下列內容:

  • DATA_PRODUCT_PROJECT_NUMBER:資料產品資源所在的專案編號
  • LOCATION:您要呼叫的 Dataplex Universal Catalog 服務端點區域 (例如 us-central1)
  • DATA_PRODUCT_ID:資料產品的 ID
  • DOCUMENTATION:您要附加至資料產品的內容

如需匯入程序的一般資訊,請參閱 Terraform 匯入說明文件

後續步驟