Dataplex-Ressourcen mit benutzerdefinierten Einschränkungen verwalten

Auf dieser Seite erfahren Sie, wie Sie mithilfe von benutzerdefinierten Einschränkungen des Organisationsrichtliniendienstes bestimmte Vorgänge für die folgenden Google Cloud Ressourcen einschränken:

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

Weitere Informationen zu Organisationsrichtlinien finden Sie unter Benutzerdefinierte Organisationsrichtlinien.

Informationen zu Organisationsrichtlinien und Einschränkungen

Mit dem Google Cloud Organisationsrichtliniendienst können Sie die Ressourcen Ihrer Organisation zentral und programmatisch steuern. Als Administrator für Organisationsrichtlinien können Sie eine Organisationsrichtlinie definieren, also eine Reihe von Einschränkungen, die fürGoogle Cloud -Ressourcen und untergeordnete Elemente dieser Ressourcen in der Google Cloud -Ressourcenhierarchie gelten. Sie können Organisationsrichtlinien auf Organisations-, Ordner- oder Projektebene erzwingen.

Die Organisationsrichtlinie bietet vordefinierte Einschränkungen für verschiedene Google Cloud Dienste. Wenn Sie jedoch eine detailliertere, anpassbare Steuerung der spezifischen Felder wünschen, die in Ihren Organisationsrichtlinien eingeschränkt werden, können Sie auch benutzerdefinierte Einschränkungen erstellen und diese benutzerdefinierten Einschränkungen in einer Organisationsrichtlinie verwenden.

Übernahme von Richtlinien

Standardmäßig werden Organisationsrichtlinien von den Nachfolgerelementen der Ressourcen übernommen, für die Sie die Richtlinie erzwingen. Wenn Sie beispielsweise eine Richtlinie für einen Ordner erzwingen, erzwingt Google Cloud die Richtlinie für alle Projekte in dem Ordner. Weitere Informationen zu diesem Verhalten und zu dessen Änderung finden Sie unter Regeln für die Evaluierung der Hierarchie.

Beschränkungen

Benutzerdefinierte Einschränkungen und Organisationsrichtlinien werden für die folgenden Ressourcen nicht unterstützt:

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

Hinweise

  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.
  2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  3. Make sure that billing is enabled for your Google Cloud project.

  4. Install the Google Cloud CLI.
  5. If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

  6. To initialize the gcloud CLI, run the following command:

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

    Go to project selector

  8. Make sure that billing is enabled for your Google Cloud project.

  9. Install the Google Cloud CLI.
  10. If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

  11. To initialize the gcloud CLI, run the following command:

    gcloud init
  12. Sie müssen Ihre Organisations-ID kennen.

Erforderliche Rollen

Bitten Sie Ihren Administrator, Ihnen die IAM-Rolle Organization policy administrator (roles/orgpolicy.policyAdmin) für die Organisationsressource zu gewähren, um die Berechtigungen zu erhalten, die Sie zum Verwalten benutzerdefinierter Organisationsrichtlinien benötigen. Weitere Informationen zum Zuweisen von Rollen finden Sie unter Zugriff auf Projekte, Ordner und Organisationen verwalten.

Sie können die erforderlichen Berechtigungen auch über benutzerdefinierte Rollen oder andere vordefinierte Rollen erhalten.

Benutzerdefinierte Einschränkung erstellen

Eine benutzerdefinierte Einschränkung wird in einer YAML-Datei durch die Ressourcen, Methoden, Bedingungen und Aktionen definiert, die von dem Dienst unterstützt werden, für den Sie die Organisationsrichtlinie erzwingen. Bedingungen für Ihre benutzerdefinierten Einschränkungen werden mithilfe der Common Expression Language (CEL) definiert. Weitere Informationen zum Erstellen von Bedingungen in benutzerdefinierten Einschränkungen mit CEL finden Sie im Abschnitt CEL unter Benutzerdefinierte Einschränkungen erstellen und verwalten.

Erstellen Sie eine YAML-Datei im folgenden Format, um eine benutzerdefinierte Einschränkung zu erstellen:

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

Ersetzen Sie Folgendes:

  • ORGANIZATION_ID: Ihre Organisations-ID, z. B. 123456789.

  • CONSTRAINT_NAME: Name, den Sie für Ihre neue benutzerdefinierte Einschränkung verwenden möchten. Eine benutzerdefinierte Einschränkung muss mit custom. beginnen und darf nur Großbuchstaben, Kleinbuchstaben oder Ziffern enthalten. Beispiel: custom.denyDataplexEntryGroup. Die maximale Länge dieses Feldes beträgt 70 Zeichen.

  • RESOURCE_NAME: Der vollständige Name derGoogle Cloud Ressource, die das Objekt und das Feld enthält, das Sie einschränken möchten. Beispiel: dataplex.googleapis.com/dataplex.googleapis.com/EntryGroup

  • CONDITION: eine CEL-Bedingung, die für eine Darstellung einer unterstützten Dienstressource geschrieben wird. Dieses Feld hat eine maximale Länge von 1000 Zeichen. Weitere Informationen zu den verfügbaren Ressourcen, auf die Bedingungen geschrieben werden können, finden Sie unter Unterstützte Ressourcen. Beispiel: "resource.description.contains('invalid_name')".

  • ACTION: Aktion, die ausgeführt werden soll, wenn condition erfüllt ist. Mögliche Werte sind ALLOW und DENY.

  • DISPLAY_NAME: Ein nutzerfreundlicher Name für die Einschränkung. Dieses Feld hat eine maximale Länge von 200 Zeichen.

  • DESCRIPTION: Eine nutzerfreundliche Beschreibung der Einschränkung, die als Fehlermeldung angezeigt werden soll, wenn die Richtlinie verletzt wird Dieses Feld hat eine maximale Länge von 2000 Zeichen.

Weitere Informationen zum Erstellen einer benutzerdefinierten Einschränkung finden Sie unter Benutzerdefinierte Einschränkungen definieren.

Benutzerdefinierte Einschränkung einrichten

Nachdem Sie die YAML-Datei für eine neue benutzerdefinierte Einschränkung erstellt haben, müssen Sie sie einrichten, um sie für Organisationsrichtlinien in Ihrer Organisation verfügbar zu machen. Verwenden Sie zum Einrichten einer benutzerdefinierten Einschränkung den Befehl gcloud org-policies set-custom-constraint:
gcloud org-policies set-custom-constraint CONSTRAINT_PATH
Ersetzen Sie CONSTRAINT_PATH durch den vollständigen Pfad zu Ihrer benutzerdefinierten Einschränkungsdatei. Beispiel: /home/user/customconstraint.yaml Nach Abschluss des Vorgangs sind Ihre benutzerdefinierten Einschränkungen als Organisationsrichtlinien in der Liste der Google Cloud Organisationsrichtlinien verfügbar. Prüfen Sie mit dem Befehl gcloud org-policies list-custom-constraints, ob die benutzerdefinierte Einschränkung vorhanden ist:
gcloud org-policies list-custom-constraints --organization=ORGANIZATION_ID
Ersetzen Sie ORGANIZATION_ID durch die ID Ihrer Organisationsressource. Weitere Informationen finden Sie unter Organisationsrichtlinien aufrufen.

Benutzerdefinierte Organisationsrichtlinie erzwingen

Sie können eine boolesche Einschränkung erzwingen, indem Sie eine Organisationsrichtlinie erstellen, die darauf verweist, und diese Organisationsrichtlinie dann auf eine Google Cloud -Ressource anwenden.

Console

  1. Google Cloud Wechseln Sie in der Console zur Seite Organisationsrichtlinien.

    Zu den Organisationsrichtlinien

  2. Wählen Sie in der Projektauswahl das Projekt aus, für das Sie die Organisationsrichtlinie festlegen möchten.
  3. Wählen Sie auf der Seite Organisationsrichtlinien die gewünschte Einschränkung aus, um die Seite Richtliniendetails aufzurufen.
  4. Zum Konfigurieren der Organisationsrichtlinie für diese Ressource klicken Sie auf Richtlinie verwalten.
  5. Wählen Sie auf der Seite Richtlinie bearbeiten die Option Richtlinie der übergeordneten Ressource überschreiben aus.
  6. Klicken Sie auf Regel hinzufügen.
  7. Wählen Sie im Abschnitt Erzwingung aus, ob die Erzwingung dieser Organisationsrichtlinie aktiviert oder deaktiviert werden soll.
  8. Klicken Sie optional auf Bedingung hinzufügen, um die Organisationsrichtlinie von einem Tag abhängig zu machen. Wenn Sie einer Organisationsrichtlinie eine bedingte Regel hinzufügen, müssen Sie mindestens eine bedingungsfreie Regel hinzufügen oder die Richtlinie kann nicht gespeichert werden. Weitere Informationen finden Sie unter Organisationsrichtlinie mit Tags festlegen.
  9. Wenn dies eine benutzerdefinierte Einschränkung ist, können Sie auf Änderungen testen klicken, um die Auswirkungen dieser Organisationsrichtlinie zu simulieren. Weitere Informationen finden Sie unter Änderungen an Organisationsrichtlinien mit dem Richtliniensimulator testen.
  10. Klicken Sie auf Richtlinie festlegen, um den Vorgang abzuschließen und die Organisationsrichtlinie anzuwenden. Es kann bis zu 15 Minuten dauern, bis die Richtlinie wirksam wird.

gcloud

Um eine Organisationsrichtlinie zu erstellen, die eine boolesche Einschränkung erzwingt, erstellen Sie eine YAML-Richtliniendatei, die auf die Einschränkung verweist:

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

Ersetzen Sie Folgendes:

  • PROJECT_ID: das Projekt, für das Sie die Einschränkung erzwingen möchten
  • CONSTRAINT_NAME: der Name, den Sie für Ihre benutzerdefinierte Einschränkung definiert haben. Beispiel: custom.denyDataplexEntryGroup.

Führen Sie den folgenden Befehl aus, um die Organisationsrichtlinie mit der Einschränkung zu erzwingen:

    gcloud org-policies set-policy POLICY_PATH
    

Ersetzen Sie POLICY_PATH durch den vollständigen Pfad zur YAML-Datei Ihrer Organisationsrichtlinie. Es kann bis zu 15 Minuten dauern, bis die Richtlinie wirksam wird.

Benutzerdefinierte Organisationsrichtlinie testen

Im folgenden Beispiel werden eine benutzerdefinierte Einschränkung und eine Richtlinie erstellt, die Nutzer daran hindern, in einem bestimmten Projekt Eintragsgruppen zu erstellen, deren Beschreibung den Text invalid_name enthält.

Bevor Sie beginnen, müssen Sie Folgendes wissen:

  • Ihre Organisations-ID.
  • Eine Projekt-ID.

Einschränkung erstellen

  1. Speichern Sie die folgende Datei als 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.
    

    Dies definiert eine Einschränkung, bei der für jede neue Eintragsgruppe der Vorgang abgelehnt wird, wenn die Beschreibung den Text invalid_name enthält.

  2. Wenden Sie die Einschränkung an:

    gcloud org-policies set-custom-constraint ~/constraint-valid-entry-groups.yaml
    
  3. Prüfen Sie, ob die Einschränkung vorhanden ist:

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

    Die Ausgabe sieht in etwa so aus:

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

Richtlinie erstellen

  1. Speichern Sie die folgende Datei als policy-deny-entry-group.yaml:

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

    Ersetzen Sie PROJECT_ID durch Ihre Projekt-ID.

  2. Wenden Sie die Richtlinie an:

    gcloud org-policies set-policy ~/policy-deny-entry-group.yaml
    
  3. Prüfen Sie, ob die Richtlinie vorhanden ist:

    gcloud org-policies list --project=PROJECT_ID
    

    Die Ausgabe sieht etwa so aus:

    CONSTRAINT                      LIST_POLICY    BOOLEAN_POLICY    ETAG
    custom.denyDataplexEntryGroup   -              SET               COCsm5QGENiXi2E=
    

Warten Sie nach dem Anwenden der Richtlinie etwa 15 Minuten, bis Google Cloud die Richtlinie durchgesetzt hat.

Richtlinie testen

Versuchen Sie, im Projekt eine Eintragsgruppe zu erstellen:

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

Der Vorgang wird abgelehnt. Die Ausgabe sieht so aus:

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

Beispiele für benutzerdefinierte Organisationsrichtlinien für häufige Anwendungsfälle

Die folgende Tabelle enthält die Syntax einiger benutzerdefinierter Einschränkungen für gängige Anwendungsfälle:

Beschreibung Einschränkungssyntax
Bestimmten Aspekttyp für Eintragstypen voraussetzen
    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
    
Mindestens eine Stichprobenerhebung für Datenprofilierungsscans erfordern
    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
    

Von Dataplex unterstützte Ressourcen

In der folgenden Tabelle sind die Dataplex-Ressourcen aufgeführt, auf die Sie in benutzerdefinierten Einschränkungen verweisen können.

Ressource Feld
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
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

Nächste Schritte