本頁面由 Cloud Translation API 翻譯而成。

搭配中繼資料儲存庫使用自訂限制

本頁說明如何使用 Organization Policy Service 自訂限制，限制對下列 Google Cloud 資源執行的特定作業：

aiplatform.googleapis.com/MetadataStore

如要進一步瞭解機構政策，請參閱「自訂機構政策」。

關於機構政策和限制

Google Cloud 機構政策服務可讓您透過程式以集中方式控管機構的資源。身為機構政策管理員，您可以定義機構政策，也就是一組稱為「限制」的限制，適用於Google Cloud 資源和Google Cloud 資源階層中這些資源的子系。您可以在機構、資料夾或專案層級強制執行機構政策。

機構政策提供各種 Google Cloud 服務的內建代管限制。不過，如要更精細地自訂機構政策中受限的特定欄位，也可以建立自訂限制，並在機構政策中使用這些自訂限制。

政策繼承

根據預設，機構政策會由您強制執行政策的資源子系繼承。舉例來說，如果您對資料夾強制執行政策， Google Cloud 系統會對該資料夾中的所有專案強制執行政策。如要進一步瞭解這項行為及如何變更，請參閱「階層評估規則」。

優點

您可以透過自訂機構政策，允許或拒絕對 Vertex 機器學習中繼資料資源執行特定作業。舉例來說，如果建立或更新 MetadataStore 資源說明的要求，無法滿足貴機構政策設定的自訂限制驗證，要求就會失敗，並向呼叫端傳回錯誤。

事前準備

1. 設定專案

Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Vertex AI API.

Enable the API

Install the Google Cloud CLI.

如果您使用外部識別資訊提供者 (IdP)，請先使用聯合身分登入 gcloud CLI。

如要初始化 gcloud CLI，請執行下列指令：

gcloud init

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Vertex AI API.

Enable the API

Install the Google Cloud CLI.

如果您使用外部識別資訊提供者 (IdP)，請先使用聯合身分登入 gcloud CLI。

如要初始化 gcloud CLI，請執行下列指令：

gcloud init

取得機構資源 ID。

必要的角色

如要取得管理機構政策所需的權限，請要求管理員授予下列 IAM 角色：

如要管理機構政策，請在機構資源上指派機構政策管理員 (roles/orgpolicy.policyAdmin) 角色。
建立或更新中繼資料儲存庫： Vertex AI 管理員 (roles/aiplatform.admin) 或 Vertex AI 使用者 (roles/aiplatform.user) 專案資源

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

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

建立自訂限制

自訂限制是在 YAML 檔案中定義，其中包含您要強制執行機構政策的服務所支援的資源、方法、條件和動作。自訂限制的條件是使用一般運算語言 (CEL) 定義。如要進一步瞭解如何使用 CEL 在自訂限制中建構條件，請參閱「建立及管理自訂限制」一文的 CEL 一節。

如要建立自訂限制，請使用下列格式建立 YAML 檔案：

name: organizations/ORGANIZATION_ID/customConstraints/CONSTRAINT_NAME
resourceTypes:
- RESOURCE_NAME
methodTypes:
- CREATE
condition: "CONDITION"
actionType: ACTION
displayName: DISPLAY_NAME
description: DESCRIPTION

更改下列內容：

ORGANIZATION_ID：您的機構 ID，例如 123456789。
CONSTRAINT_NAME：新自訂限制的名稱。自訂限制條件必須以 custom. 開頭，且只能包含大寫英文字母、小寫英文字母或數字。例如，custom.denyMetadataStoreDescription。這個欄位的長度上限為 70 個字元。
RESOURCE_NAME：包含要限制物件和欄位的Google Cloud 資源完整名稱。例如：aiplatform.googleapis.com/MetadataStore/resource.Description。
CONDITION：針對支援服務資源的代表項目編寫的 CEL 條件。這個欄位的長度上限為 1000 個字元。如要進一步瞭解可編寫條件的資源，請參閱「支援的資源」。例如："resource.displayName.startsWith('Test')"。
ACTION：如果符合 condition，應採取的動作。可能的值為 ALLOW 和 DENY。
DISPLAY_NAME：限制條件的易記名稱。這個欄位的長度上限為 200 個字元。
DESCRIPTION：違反政策時，要以錯誤訊息形式顯示的限制說明。這個欄位的長度上限為 2000 個字元。

如要進一步瞭解如何建立自訂限制，請參閱「定義自訂限制」。

設定自訂限制

gcloud org-policies set-custom-constraint

gcloud org-policies set-custom-constraint CONSTRAINT_PATH

CONSTRAINT_PATH

/home/user/customconstraint.yaml

gcloud org-policies list-custom-constraints

gcloud org-policies list-custom-constraints --organization=ORGANIZATION_ID

ORGANIZATION_ID

查看組織政策

強制執行自訂機構政策

控制台

前往 Google Cloud 控制台的「Organization policies」(機構政策) 頁面。
前往「機構政策」
在專案選擇工具中，選取要設定機構政策的專案。
在「Organization policies」(機構政策) 頁面上的清單中選取限制條件，即可查看該限制條件的「Policy details」(政策詳情) 頁面。
如要設定資源的機構政策，請按一下「管理政策」。
在「編輯政策」頁面中，選取「覆寫上層政策」。
按一下「新增規則」。
在「Enforcement」(強制執行) 區段中，選取是否要強制執行這項機構政策。
選用：如要根據標記設定機構政策條件，請按一下「新增條件」。請注意，如果為組織政策新增條件式規則，您必須至少新增一項無條件規則，否則無法儲存政策。詳情請參閱「使用標記設定組織政策」。
按一下「測試變更」，模擬機構政策的影響。舊版受管理限制不支援政策模擬。詳情請參閱「使用 Policy Simulator 測試組織政策變更」。
如要完成並套用機構政策，請按一下「設定政策」。這項政策最多需要 15 分鐘才會生效。

gcloud

如要建立含有布林值規則的機構政策，請建立參照限制的政策 YAML 檔案：

      name: projects/PROJECT_ID/policies/CONSTRAINT_NAME
      spec:
        rules:
        - enforce: true

取代下列項目：

PROJECT_ID：您要強制執行限制的專案。
CONSTRAINT_NAME：您為自訂限制定義的名稱。例如：custom.denyMetadataStoreDescription。

如要強制執行包含限制的機構政策，請執行下列指令：

    gcloud org-policies set-policy POLICY_PATH

將 POLICY_PATH 替換為機構政策 YAML 檔案的完整路徑。這項政策最多需要 15 分鐘才會生效。

測試自訂機構政策

以下範例會建立自訂限制和政策，禁止中繼資料商店的說明以「test」開頭。

開始之前，請務必瞭解下列事項：

機構 ID
專案 ID

建立限制

將下列檔案儲存為 constraint-validate-displayname-test.yaml：

name: organizations/ORGANIZATION_ID/customConstraints/custom.denyMetadataStoreDescription
resourceTypes:
- resource.Description
methodTypes:
  - CREATE
  condition: "resource.displayName.startsWith('Test')"
  actionType: DENY
  displayName: Deny metadata store descriptions that start with 'test'
  description: Only allow metadata store descriptions that don't start with 'test'

這項限制規定新中繼資料商店的說明不得以「test」開頭。

套用限制：

gcloud org-policies set-custom-constraint ~/constraint-validate-displayname-test.yaml

確認限制條件是否存在：

gcloud org-policies list-custom-constraints --organization=ORGANIZATION_ID

輸出結果會與下列內容相似：

CUSTOM_CONSTRAINT                      ACTION_TYPE  METHOD_TYPES   RESOURCE_TYPES         DISPLAY_NAME
custom.denyMetadataStoreDescription    DENY         CREATE         resource.Description   Deny metadata store descriptions that start with 'test'
...

建立政策

將下列檔案儲存為 policy-validate-displayname-test.yaml：

  name: projects/PROJECT_ID/policies/custom.denyMetadataStoreDescription
  spec:
    rules:
    - enforce: true

將 PROJECT_ID 替換為您的專案 ID。

套用政策：

  gcloud org-policies set-policy ~/policy-validate-displayname-test.yaml

確認政策存在：

  gcloud org-policies list --project=PROJECT_ID

輸出結果會與下列內容相似：

  CONSTRAINT                            LIST_POLICY    BOOLEAN_POLICY    ETAG
  custom.denyMetadataStoreDescription   -              SET               COCsm5QGENiXi2E=

套用政策後，請等待約兩分鐘， Google Cloud 就會開始強制執行政策。

測試政策

嘗試建立描述為「test_metadata_store」的中繼資料儲存庫。

REST

如要建立 MetadataStore 資源，請使用 metadataStores/create 方法傳送 POST 要求。

使用任何要求資料之前，請先替換以下項目：

LOCATION：要建立中繼資料儲存庫的區域。如要進一步瞭解 Vertex 機器學習中繼資料的適用區域，請參閱 Vertex 機器學習中繼資料位置指南。
PROJECT_ID：您要在其中建立中繼資料商店的 Google Cloud 專案。

HTTP 方法和網址：

POST https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/metadataStores?metadata_store_id=default

JSON 要求主體：

{
  "description":"test_metadata_store",
  "encryptionSpec": {
    "kmsKeyName":""
  },
  "dataplexConfig":{"enabledPipelinesLineage":"false"}
}

如要傳送要求，請選擇以下其中一個選項：

curl

注意： 下列指令假設您已執行 gcloud init 或 gcloud auth login，透過使用者帳戶登入 gcloud CLI，或使用 Cloud Shell，自動登入 gcloud CLI。您可以執行 gcloud auth list 查看目前有效的帳戶。

將要求主體儲存在名為 request.json 的檔案中，然後執行下列指令：

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/metadataStores?metadata_store_id=default"

PowerShell

注意： 下列指令假設您已執行 gcloud init 或 gcloud auth login，透過使用者帳戶登入 gcloud CLI。您可以執行 gcloud auth list 查看目前有效的帳戶。

將要求主體儲存在名為 request.json 的檔案中，然後執行下列指令：

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/metadataStores?metadata_store_id=default" | Select-Object -Expand Content

您應該會收到如下的 JSON 回應：

{
  "error": {
    "code": 400,
    "message": "Operation denied by org policy on resource 'projects/PROJECT_ID/locations/LOCATION': [\"customConstraints/custom.denyMetadataStoreDescription\": \"Only allow metadata store descriptions that don't start with 'test'\"]",
    "status": "FAILED_PRECONDITION",
    "details": [
      {
        "@type": "type.googleapis.com/google.rpc.ErrorInfo",
        "reason": "CUSTOM_ORG_POLICY_VIOLATION",
        "domain": "googleapis.com",
        "metadata": {
          "service": "aiplatform.googleapis.com",
          "customConstraints": "customConstraints/custom.denyMetadataStoreDescription"
        }
      }
    ]
  }
}

Vertex 機器學習中繼資料支援的資源

資源	欄位
aiplatform.googleapis.com/MetadataStore	`resource.dataplexConfig.enabledPipelinesLineage`
	`resource.description`
	`resource.encryptionSpec.kmsKeyName`

後續步驟

進一步瞭解機構政策服務。
進一步瞭解如何建立及管理機構政策。
請參閱受管理機構政策限制的完整清單。

搭配中繼資料儲存庫使用自訂限制 透過集合功能整理內容 你可以依據偏好儲存及分類內容。

關於機構政策和限制

政策繼承

優點

事前準備

必要的角色

建立自訂限制

設定自訂限制

強制執行自訂機構政策

控制台

gcloud

測試自訂機構政策

建立限制

建立政策

測試政策

REST

curl

PowerShell

Vertex 機器學習中繼資料支援的資源

後續步驟

搭配中繼資料儲存庫使用自訂限制