カスタム制約を使用して Dataplex Universal Catalog リソースを管理する

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

dataplex.googleapis.com/AspectType
dataplex.googleapis.com/EntryType
dataplex.googleapis.com/EntryGroup
dataplex.googleapis.com/DataScan
dataplex.googleapis.com/MetadataJob

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

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

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

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

ポリシーの継承

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

制限事項

カスタムの制約と組織のポリシーは、次のリソースではサポートされていません。

dataplex.googleapis.com/Lake
dataplex.googleapis.com/Zone
dataplex.googleapis.com/Task
dataplex.googleapis.com/Asset
dataplex.googleapis.com/Environment

始める前に

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.

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.

Install the 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.

Install the Google Cloud CLI.

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

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

gcloud init

組織 ID を確認します。

必要なロール

カスタムの組織のポリシーを管理するために必要な権限を取得するには、組織のリソースに対する組織のポリシー管理者（roles/orgpolicy.policyAdmin）の IAM ロールを付与するよう管理者に依頼してください。ロールの付与については、プロジェクト、フォルダ、組織へのアクセス権の管理をご覧ください。

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

カスタム制約を設定する

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

コンソール

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

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

すべての Google Cloud サービスで、両方のメソッドをサポートしているわけではありません。各サービスでサポートされているメソッドを確認するには、サポートされるサービスでサービスを検索してください。

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

[条件を追加] パネルで、サポートされているサービスリソースを参照する 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
- UPDATE 
      condition: "CONDITION"
      actionType: ACTION
      displayName: DISPLAY_NAME
      description: DESCRIPTION

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

ORGANIZATION_ID: 組織 ID（例: 123456789）。
CONSTRAINT_NAME: 新しいカスタム制約の名前。カスタム制約の名前には、英字（大文字と小文字）または数字のみを使用できます（例: custom.denyDataplexEntryGroup）。このフィールドには、最大 70 文字まで入力できます。
RESOURCE_NAME: 制限するオブジェクトとフィールドを含む Google Cloudリソースの完全修飾名。例: dataplex.googleapis.com/dataplex.googleapis.com/EntryGroup。
CONDITION: サポート対象のサービスリソースの表現に対して書き込まれる CEL 条件。このフィールドには、最大 1,000 文字を入力できます。例: "resource.description.contains('invalid_name')"。

条件の書き込み先として使用できるリソースの詳細については、サポート対象のリソースをご覧ください。

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

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

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

DISPLAY_NAME: 制約の名前。わかりやすい名前を入力してください。このフィールドには、最大 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 コンソールで [組織のポリシー] ページに移動します。
[組織のポリシー] に移動
プロジェクト選択ツールで、組織のポリシーを設定するプロジェクトを選択します。
[組織のポリシー] ページのリストで制約を選択して、その制約の [ポリシーの詳細] ページを表示します。
このリソースの組織のポリシーを構成するには、[ポリシーを管理] をクリックします。
[ポリシーの編集] ページで、[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.denyDataplexEntryGroup。

ドライランモードで組織のポリシーを適用するには、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 分かかります。

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

次の例では、特定のプロジェクトでエントリグループの説明に invalid_name というテキストが含まれている場合にエントリグループを作成できないようにするカスタムの制約とポリシーを作成します。

始める前に、以下を把握しておく必要があります。

組織の ID
プロジェクト ID

制約を作成する

次のファイルに constraint-valid-entry-groups.yaml という名前を付けて保存します。

name: organizations/ORGANIZATION_ID/customConstraints/custom.denyDataplexEntryGroup
resourceTypes:
- dataplex.googleapis.com/EntryGroup
methodTypes:
- CREATE
condition: "resource.description.contains('invalid_name')"
actionType: DENY
displayName: Validate entry group description
description: All new entry groups have valid descriptions.

これにより、新しいエントリグループごとに、説明にテキスト invalid_name が含まれている場合にオペレーションが拒否される制約が定義されます。

制約を適用します。

gcloud org-policies set-custom-constraint ~/constraint-valid-entry-groups.yaml

制約が存在することを確認します。

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

出力は次のようになります。

CUSTOM_CONSTRAINT                           ACTION_TYPE  METHOD_TYPES   RESOURCE_TYPES                       DISPLAY_NAME
custom.denyDataplexEntryGroup               DENY         CREATE         dataplex.googleapis.com/EntryGroup   Validate Entry Group description
...

ポリシーを作成する

次のファイルに policy-deny-entry-group.yaml という名前を付けて保存します。
```
name: projects/PROJECT_ID/policies/custom.denyDataplexEntryGroup
spec:
  rules:
  - enforce: true
```
PROJECT_ID は、実際のプロジェクト ID に置き換えます。

ポリシーを適用します。

gcloud org-policies set-policy ~/policy-deny-entry-group.yaml

ポリシーが存在することを確認します。

gcloud org-policies list --project=PROJECT_ID

出力は次のようになります。

CONSTRAINT                      LIST_POLICY    BOOLEAN_POLICY    ETAG
custom.denyDataplexEntryGroup   -              SET               COCsm5QGENiXi2E=

ポリシーを適用したら、 Google Cloud がポリシーの適用を開始するまで 15 分ほど待ちます。

ポリシーをテストする

プロジェクトにエントリグループを作成してみます。

gcloud dataplex entry-groups create org-policy-test \
    --project=PROJECT_ID \
    --location=LOCATION \
    --display-name=DISPLAY_NAME \
    --description='invalid_name'

オペレーションが拒否されました。次のような出力が表示されます。

Operation denied by custom org policy on resource 'projects/PROJECT_ID/locations/LOCATION/entryGroups/org-policy-test': ["customConstraints/custom.denyDataplexEntryGroup"]

一般的なユースケースのカスタム組織ポリシーの例

次の表では一般的なカスタム制約の構文例をまとめています。

説明	制約の構文
エントリタイプに特定のアスペクトタイプを必須にする	name: organizations/`ORGANIZATION_ID`/customConstraints/custom.requireAspectTypeForEntryType resourceTypes: - dataplex.googleapis.com/EntryType methodTypes: - CREATE - UPDATE condition: "resource.requiredAspects.exists(value, value.type =="projects/`PROJECT_ID`/locations/`LOCATION`/aspectTypes/exampleAspectType") actionType: DENY displayName: All entry types require aspect type exampleAspectType description: All entry types require the aspect type exampleAspectType
データプロファイリングスキャンに最小サンプリングレートを要求する	name: organizations/`ORGANIZATION_ID`/customConstraints/custom.minimumSamplingDataScans resourceTypes: - dataplex.googleapis.com/DataScan methodTypes: - CREATE - UPDATE condition: "resource.dataProfileSpec.samplingPercent >= 20.0" actionType: ALLOW displayName: Require minimum sampling for data profiling scans description: All data profiling scans need at least 20% sampling rate

説明

制約の構文

エントリタイプに特定のアスペクトタイプを必須にする

    name: organizations/ORGANIZATION_ID/customConstraints/custom.requireAspectTypeForEntryType
    resourceTypes:
    - dataplex.googleapis.com/EntryType
    methodTypes:
    - CREATE
    - UPDATE
    condition: "resource.requiredAspects.exists(value, value.type =="projects/PROJECT_ID/locations/LOCATION/aspectTypes/exampleAspectType")
    actionType: DENY
    displayName: All entry types require aspect type exampleAspectType
    description: All entry types require the aspect type exampleAspectType

データプロファイリングスキャンに最小サンプリングレートを要求する

    name: organizations/ORGANIZATION_ID/customConstraints/custom.minimumSamplingDataScans
    resourceTypes:
    - dataplex.googleapis.com/DataScan
    methodTypes:
    - CREATE
    - UPDATE
    condition: "resource.dataProfileSpec.samplingPercent >= 20.0"
    actionType: ALLOW
    displayName: Require minimum sampling for data profiling scans
    description: All data profiling scans need at least 20% sampling rate

Dataplex Universal Catalog でサポートされているリソース

リソース	フィールド
dataplex.googleapis.com/AspectType	`resource.authorization.alternateUsePermission`
	`resource.description`
	`resource.displayName`
	`resource.metadataTemplate.annotations.deprecated`
	`resource.metadataTemplate.annotations.description`
	`resource.metadataTemplate.annotations.displayName`
	`resource.metadataTemplate.annotations.displayOrder`
	`resource.metadataTemplate.annotations.stringType`
	`resource.metadataTemplate.annotations.stringValues`
	`resource.metadataTemplate.constraints.required`
	`resource.metadataTemplate.enumValues.deprecated`
	`resource.metadataTemplate.enumValues.index`
	`resource.metadataTemplate.enumValues.name`
	`resource.metadataTemplate.index`
	`resource.metadataTemplate.name`
	`resource.metadataTemplate.type`
	`resource.metadataTemplate.typeId`
	`resource.metadataTemplate.typeRef`
dataplex.googleapis.com/DataScan	`resource.data.entity`
	`resource.data.resource`
	`resource.dataDiscoverySpec.bigqueryPublishingConfig.connection`
	`resource.dataDiscoverySpec.bigqueryPublishingConfig.location`
	`resource.dataDiscoverySpec.bigqueryPublishingConfig.tableType`
	`resource.dataDiscoverySpec.storageConfig.csvOptions.delimiter`
	`resource.dataDiscoverySpec.storageConfig.csvOptions.encoding`
	`resource.dataDiscoverySpec.storageConfig.csvOptions.headerRows`
	`resource.dataDiscoverySpec.storageConfig.csvOptions.quote`
	`resource.dataDiscoverySpec.storageConfig.csvOptions.typeInferenceDisabled`
	`resource.dataDiscoverySpec.storageConfig.excludePatterns`
	`resource.dataDiscoverySpec.storageConfig.includePatterns`
	`resource.dataDiscoverySpec.storageConfig.jsonOptions.encoding`
	`resource.dataDiscoverySpec.storageConfig.jsonOptions.typeInferenceDisabled`
	`resource.dataProfileSpec.excludeFields.fieldNames`
	`resource.dataProfileSpec.includeFields.fieldNames`
	`resource.dataProfileSpec.postScanActions.bigqueryExport.resultsTable`
	`resource.dataProfileSpec.rowFilter`
	`resource.dataProfileSpec.samplingPercent`
	`resource.dataQualitySpec.postScanActions.bigqueryExport.resultsTable`
	`resource.dataQualitySpec.postScanActions.notificationReport.recipients.emails`
	`resource.dataQualitySpec.postScanActions.notificationReport.scoreThresholdTrigger.scoreThreshold`
	`resource.dataQualitySpec.rowFilter`
	`resource.dataQualitySpec.rules.column`
	`resource.dataQualitySpec.rules.description`
	`resource.dataQualitySpec.rules.dimension`
	`resource.dataQualitySpec.rules.ignoreNull`
	`resource.dataQualitySpec.rules.name`
	`resource.dataQualitySpec.rules.rangeExpectation.maxValue`
	`resource.dataQualitySpec.rules.rangeExpectation.minValue`
	`resource.dataQualitySpec.rules.rangeExpectation.strictMaxEnabled`
	`resource.dataQualitySpec.rules.rangeExpectation.strictMinEnabled`
	`resource.dataQualitySpec.rules.regexExpectation.regex`
	`resource.dataQualitySpec.rules.rowConditionExpectation.sqlExpression`
	`resource.dataQualitySpec.rules.setExpectation.values`
	`resource.dataQualitySpec.rules.sqlAssertion.sqlStatement`
	`resource.dataQualitySpec.rules.statisticRangeExpectation.maxValue`
	`resource.dataQualitySpec.rules.statisticRangeExpectation.minValue`
	`resource.dataQualitySpec.rules.statisticRangeExpectation.statistic`
	`resource.dataQualitySpec.rules.statisticRangeExpectation.strictMaxEnabled`
	`resource.dataQualitySpec.rules.statisticRangeExpectation.strictMinEnabled`
	`resource.dataQualitySpec.rules.suspended`
	`resource.dataQualitySpec.rules.tableConditionExpectation.sqlExpression`
	`resource.dataQualitySpec.rules.threshold`
	`resource.dataQualitySpec.samplingPercent`
	`resource.description`
	`resource.displayName`
	`resource.executionSpec.field`
	`resource.executionSpec.trigger.schedule.cron`
dataplex.googleapis.com/EntryGroup	`resource.description`
dataplex.googleapis.com/EntryGroup	`resource.displayName`
dataplex.googleapis.com/EntryType	`resource.authorization.alternateUsePermission`
	`resource.description`
	`resource.displayName`
	`resource.platform`
	`resource.requiredAspects.type`
	`resource.system`
	`resource.typeAliases`
dataplex.googleapis.com/MetadataJob	`resource.exportSpec.outputPath`
	`resource.exportSpec.scope.aspectTypes`
	`resource.exportSpec.scope.entryGroups`
	`resource.exportSpec.scope.entryTypes`
	`resource.exportSpec.scope.organizationLevel`
	`resource.exportSpec.scope.projects`
	`resource.importSpec.aspectSyncMode`
	`resource.importSpec.entrySyncMode`
	`resource.importSpec.logLevel`
	`resource.importSpec.scope.aspectTypes`
	`resource.importSpec.scope.entryGroups`
	`resource.importSpec.scope.entryTypes`
	`resource.importSpec.sourceCreateTime`
	`resource.importSpec.sourceStorageUri`
	`resource.type`

次のステップ

組織のポリシーサービスについて詳細を学習する。
組織のポリシーの作成と管理の方法について学習する。
マネージドの組織のポリシーの制約全一覧を参照する。

カスタム制約を使用して Dataplex Universal Catalog リソースを管理する コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

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

ポリシーの継承

制限事項

始める前に

必要なロール

カスタム制約を設定する

コンソール

gcloud

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

コンソール

gcloud

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

制約を作成する

ポリシーを作成する

ポリシーをテストする

一般的なユースケースのカスタム組織ポリシーの例

Dataplex Universal Catalog でサポートされているリソース

次のステップ

カスタム制約を使用して Dataplex Universal Catalog リソースを管理する