Google uses AI technology to translate content into your preferred language. AI translations can contain errors.

メタデータストアでカスタム制約を使用する

このページでは、組織のポリシーサービスのカスタム制約を使用して、次の Google Cloud リソースに対する特定のオペレーションを制限する方法について説明します。

aiplatform.googleapis.com/MetadataStore

組織のポリシーの詳細については、カスタムの組織のポリシーをご覧ください。

組織のポリシーと制約について

Google Cloud 組織のポリシーサービスを使用すると、組織のリソースをプログラマティックに一元管理できます。組織のポリシー管理者は組織のポリシーを定義できます。組織のポリシーは、Google Cloud リソース階層内のGoogle Cloud リソースやそれらのリソースの子孫に適用される、制約と呼ばれる一連の制限です。組織のポリシーは、組織レベル、フォルダレベル、またはプロジェクトレベルで適用できます。

組織のポリシーを利用することで、あらかじめ用意されたマネージド制約をさまざまな Google Cloud サービスに適用できます。ただし、組織のポリシーで制限されている特定の項目をより細かくカスタマイズして制御したい場合は、カスタム制約を作成して、それを組織のポリシーで使うこともできます。

ポリシーの継承

デフォルトでは、組織のポリシーは、そのポリシーを適用したリソースの子孫に継承されます。たとえば、フォルダにポリシーを適用した場合、 Google Cloud はそのフォルダ内のすべてのプロジェクトにそのポリシーを適用します。この動作の詳細と変更方法については、階層評価ルールをご覧ください。

利点

カスタムの組織のポリシーを使用すると、Vertex ML Metadata リソースに対する特定のオペレーションを許可または拒否できます。たとえば、MetadataStore リソースの説明の作成または更新を行うリクエストが、組織のポリシーによって設定されたカスタム制約検証を満たしていない場合、リクエストは失敗し、エラーが呼び出し元に返されます。

始める前に

1. プロジェクトを設定する

Google Cloud アカウントにログインします。 Google Cloudを初めて使用する場合は、アカウントを作成して、実際のシナリオでの Google プロダクトのパフォーマンスを評価してください。新規のお客様には、ワークロードの実行、テスト、デプロイができる無料クレジット $300 分を差し上げます。

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

Roles required to select or create a project

Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Vertex ML Metadata API.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the API

Google Cloud CLI をインストールします。

外部 ID プロバイダ（IdP）を使用している場合は、まず連携 ID を使用して gcloud CLI にログインする必要があります。

gcloud CLI を初期化するには、次のコマンドを実行します。

gcloud init

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

Roles required to select or create a project

Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Vertex ML Metadata API.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the API

Google Cloud CLI をインストールします。

外部 ID プロバイダ（IdP）を使用している場合は、まず連携 ID を使用して gcloud CLI にログインする必要があります。

gcloud CLI を初期化するには、次のコマンドを実行します。

gcloud init

組織リソース ID を取得します。

必要なロール

組織のポリシーを管理するために必要な権限を取得するには、次の IAM ロールを付与するように管理者に依頼してください。

組織のポリシーを管理する: 組織リソースに対する組織のポリシー管理者（roles/orgpolicy.policyAdmin）
メタデータストアを作成または更新する: プロジェクトリソースに対するエージェントプラットフォーム管理者（roles/aiplatform.admin）またはエージェントプラットフォームユーザー（roles/aiplatform.user）

ロールの付与については、プロジェクト、フォルダ、組織へのアクセス権の管理をご覧ください。

必要な権限は、カスタムロールや他の事前定義ロールから取得することもできます。

Vertex ML Metadata でサポートされているリソース

次の表に、カスタム制約で参照できる Vertex ML Metadata リソースを示します。

リソース	フィールド
aiplatform.googleapis.com/MetadataStore	`resource.dataplexConfig.enabledPipelinesLineage`
	`resource.description`
	`resource.encryptionSpec.kmsKeyName`

カスタム制約を設定する

カスタム制約は、組織のポリシーを適用しているサービスでサポートされるリソース、メソッド、条件、アクションを使用して YAML ファイルで定義されます。カスタム制約の条件は、Common Expression Language（CEL）を使用して定義されます。CEL を使用してカスタム制約で条件を作成する方法については、カスタム制約の作成と管理の CEL セクションをご覧ください。

コンソール

カスタム制約を作成する手順は次のとおりです。

Google Cloud コンソールで [組織のポリシー] ページに移動します。
[組織のポリシー] に移動
プロジェクト選択ツールで、組織のポリシーを設定するプロジェクトを選択します。
[ カスタム制約] をクリックします。
[表示名] ボックスに、人が読める形式で制約の名前を入力します。この名前はエラーメッセージで使用されるほか、識別やデバッグにも使用できます。エラーメッセージで公開される可能性があるため、表示名に個人を特定できる情報（PII）や機密データを使用しないでください。このフィールドには、最大 200 文字まで入力できます。
[制約 ID] ボックスに、新しいカスタム制約の ID を入力します。カスタム制約の名前に使用できるのは、英字（大文字と小文字）と数字のみです（例: custom.denyMetadataStoreDescription）。このフィールドには、接頭辞（custom.）を除き、最大 70 文字まで入力できます（例: organizations/123456789/customConstraints/custom）。エラーメッセージで公開される可能性があるため、制約 ID に個人情報（PII）や機密データを含めないでください。
[説明] ボックスに、人が読める形式で制約の説明を入力します。この説明は、ポリシー違反の際にエラーメッセージとして使用されます。ポリシー違反が発生した理由と、ポリシー違反を解決する方法に関する詳細を含めてください。エラーメッセージで公開される可能性があるため、説明に個人情報（PII）や機密データを含めないでください。このフィールドには、最大 2,000 文字まで入力できます。
[リソースの種類] ボックスで、制限するオブジェクトとフィールドを含む Google Cloud REST リソースの名前を選択します（例: container.googleapis.com/NodePool）。ほとんどの種類のリソースは、最大 20 個のカスタム制約をサポートしています。これより多くのカスタム制約を作成しようとすると、オペレーションは失敗します。
この制約は、REST CREATE メソッドにのみ適用できます。

各サービスでサポートされているメソッドを確認するには、カスタム制約をサポートするサービスをご覧ください。

条件を定義するには、[ 条件を編集] をクリックします。

[条件を追加] パネルで、サポートされているサービスリソースを参照する CEL 条件を作成します（例: resource.management.autoUpgrade == false）。このフィールドには、最大 1,000 文字まで入力できます。CEL の使用方法の詳細については、Common Expression Language をご覧ください。カスタム制約で使用できるサービスリソースの詳細については、カスタム制約のサポートサービスをご覧ください。
[保存] をクリックします。

[アクション] で、条件が満たされた場合に評価対象のメソッドを許可するか拒否するかを選択します。

拒否アクションは、条件が true と評価された場合に、リソースを作成または更新するオペレーションがブロックされることを意味します。

許可アクションは、条件が true と評価された場合にのみ、リソースを作成または更新するオペレーションが許可されることを意味します。条件に明記されているケースを除き、他のケースはすべてブロックされます。

[制約を作成] をクリックします。

各フィールドに値を入力すると、このカスタム制約に対応する YAML 構成が右側に表示されます。

gcloud

カスタム制約を作成するには、次の形式で 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.denyMetadataStoreDescription）。このフィールドには、接頭辞（custom.）を除き、最大 70 文字まで入力できます（例: organizations/123456789/customConstraints/custom）。エラーメッセージで公開される可能性があるため、制約 ID に個人情報（PII）や機密データを含めないでください。
RESOURCE_NAME: 制限するオブジェクトとフィールドを含む Google Cloudリソースの完全修飾名。たとえば、aiplatform.googleapis.com/MetadataStore/resource.Description のようにします。ほとんどの種類のリソースは、最大 20 個のカスタム制約をサポートしています。これより多くのカスタム制約を作成しようとすると、オペレーションは失敗します。
methodTypes: 制約が適用される REST メソッド。CREATE のみです。

各サービスでサポートされているメソッドを確認するには、カスタム制約をサポートするサービスをご覧ください。

CONDITION: サポート対象のサービスリソースの表現に対して記述する CEL 条件。このフィールドには、最大 1,000 文字まで入力できます。例: "resource.displayName.startsWith('Test')"。

条件を記述できるリソースの詳細については、サポートされているリソースをご覧ください。

ACTION: condition が満たされた場合に実行するアクション。有効な値は ALLOW と DENY です。

許可アクションは、条件が true と評価された場合に、リソースを作成または更新するオペレーションが許可されることを意味します。つまり、条件に明記されているケース以外はすべてブロックされます。

拒否アクションは、条件が true と評価された場合に、リソースを作成または更新するオペレーションがブロックされることを意味します。

DISPLAY_NAME: 制約の名前。わかりやすい名前を入力してください。この名前はエラーメッセージで使用されるほか、識別やデバッグにも使用できます。エラーメッセージで公開される可能性があるため、表示名に個人情報（PII）や機密データを使用しないでください。このフィールドには、最大 200 文字まで入力できます。
DESCRIPTION: ポリシー違反の際にエラーメッセージとして表示される制約の説明。わかりやすい説明を入力してください。このフィールドには、最大 2,000 文字まで入力できます。

新しいカスタム制約の YAML ファイルを作成したら、組織内で組織のポリシーとして使用できるように設定する必要があります。カスタム制約を設定するには、gcloud org-policies set-custom-constraint コマンドを使用します。

gcloud org-policies set-custom-constraint CONSTRAINT_PATH

CONSTRAINT_PATH は、カスタム制約ファイルのフルパスに置き換えます。例: /home/user/customconstraint.yaml。

この操作が完了すると、カスタム制約が Google Cloud の組織ポリシーのリストに表示され、組織のポリシーとして使用できるようになります。

カスタム制約が存在することを確認するには、gcloud org-policies list-custom-constraints コマンドを使用します。

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

ORGANIZATION_ID は組織リソースの ID に置き換えます。

詳細については、組織のポリシーの表示をご覧ください。

カスタムの組織のポリシーを適用する

制約を適用するには、それを参照する組織のポリシーを作成し、その組織のポリシーを Google Cloud リソースに適用します。

コンソール

Google Cloud コンソールで [組織のポリシー] ページに移動します。
[組織のポリシー] に移動
プロジェクト選択ツールで、組織のポリシーを設定するプロジェクトを選択します。
[組織のポリシー] ページのリストで制約を選択して、その制約の [ポリシーの詳細] ページを表示します。
このリソースの組織のポリシーを構成するには、[ポリシーを管理] をクリックします。
[ポリシーの編集] ページで、[Override parent's policy] を選択します。
[ルールを追加] をクリックします。
[適用] セクションで、この組織のポリシーを適用するかどうかを選択します。
省略可: タグで組織のポリシーに条件を設定するには、[条件を追加] をクリックします。組織のポリシーに条件付きルールを追加する場合は、少なくとも 1 つは無条件のルールを追加する必要があります。そうしないとポリシーを保存できないのでご注意ください。詳細については、タグを使用して組織のポリシーのスコープを設定するをご覧ください。
[変更内容をテスト] をクリックして、組織のポリシーの効果をシミュレートします。詳細については、Policy Simulator で組織のポリシーの変更をテストするをご覧ください。
ドライランモードで組織のポリシーを適用するには、[ドライランポリシーを設定] をクリックします。詳細については、組織のポリシーをテストするをご覧ください。
ドライランモードで組織のポリシーが想定どおりに動作することを確認したら、[ポリシーを設定] をクリックして有効なポリシーを設定します。

gcloud

ブール値のルールを含む組織のポリシーを作成するには、制約を参照するポリシーの YAML ファイルを作成します。

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

dryRunSpec:
  rules:
  - enforce: true

次のように置き換えます。

PROJECT_ID: 制約を適用するプロジェクト。
CONSTRAINT_NAME: カスタム制約に定義した名前。例: custom.denyMetadataStoreDescription。

ドライランモードで組織のポリシーを適用するには、dryRunSpec フラグを指定して次のコマンドを実行します。

gcloud org-policies set-policy POLICY_PATH --update-mask=dryRunSpec

POLICY_PATH は、組織のポリシーの YAML ファイルのフルパスに置き換えます。ポリシーが有効になるまでに最大 15 分かかります。

ドライランモードで組織のポリシーが想定どおりに動作することを確認したら、org-policies set-policy コマンドと spec フラグを使用して有効なポリシーを設定します。

gcloud org-policies set-policy POLICY_PATH --update-mask=spec

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 がポリシーの適用を開始するまで 2 分ほど待ちます。

ポリシーをテストする

「test_metadata_store」という説明のメタデータストアを作成してみます。

REST

MetadataStore リソースを作成するには、metadataStores/create メソッドを使用して POST リクエストを送信します。

リクエストのデータを使用する前に、次のように置き換えます。

LOCATION: メタデータストアを作成するリージョン。Vertex ML Metadata を利用できるリージョンの詳細については、Vertex ML Metadata ロケーションガイドをご覧ください。
PROJECT_ID: メタデータストアを作成する Google Cloud プロジェクト。

HTTP メソッドと URL:

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 ML Metadata でサポートされているリソース

カスタム制約を設定する

コンソール

gcloud

カスタムの組織のポリシーを適用する

コンソール

gcloud

カスタム組織のポリシーをテストする

制約を作成する

ポリシーを作成する

ポリシーをテストする

REST

curl

PowerShell

次のステップ

メタデータストアでカスタム制約を使用する