BigQuery-Ressourcen mit benutzerdefinierten Einschränkungen verwalten

Auf dieser Seite erfahren Sie, wie Sie benutzerdefinierte Beschränkungen des Organisationsrichtliniendienstes verwenden, um bestimmte Vorgänge für die folgenden Ressourcen von Google Cloud einzuschränken:

  • bigquery.googleapis.com/Dataset

Weitere Informationen zu Organisationsrichtlinien finden Sie unter Benutzerdefinierte Organisationsrichtlinien.

Informationen zu Organisationsrichtlinien und Beschränkungen

Mit dem Organisationsrichtliniendienst von Google Cloud 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 Beschränkungen, die für Ressourcen vonGoogle Cloud und nachfolgende Elemente dieser Ressourcen in der Ressourcenhierarchie vonGoogle Cloud gelten. Sie können Organisationsrichtlinien auf Organisations-, Ordner- oder Projektebene erzwingen.

Die Organisationsrichtlinie bietet integrierte verwaltete Beschränkungen für verschiedene Dienste von Google Cloud . Wenn Sie jedoch eine detailliertere, anpassbare Steuerung der spezifischen Felder wünschen, die in Ihren Organisationsrichtlinien beschränkt werden, können Sie auch benutzerdefinierte Beschränkungen erstellen und diese benutzerdefinierten Beschrä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 Bewertung der Hierarchie.

Beschränkungen

  • PolicyViolationInfo wird nicht in den BigQuery-Audit-Logs veröffentlicht, wenn der Zugriff aufgrund benutzerdefinierter Einschränkungen verweigert wird. Die Fehlermeldung enthält die constraintId, die den Vorgang abgelehnt hat.

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.

    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

  3. Verify that billing is enabled for your Google Cloud project.

  4. Install the Google Cloud CLI.

  5. Wenn Sie einen externen Identitätsanbieter (IdP) verwenden, müssen Sie sich zuerst mit Ihrer föderierten Identität in der gcloud CLI anmelden.

  6. Führen Sie den folgenden Befehl aus, um die gcloud CLI zu initialisieren:

    gcloud init
  7. 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

  8. Verify that billing is enabled for your Google Cloud project.

  9. Install the Google Cloud CLI.

  10. Wenn Sie einen externen Identitätsanbieter (IdP) verwenden, müssen Sie sich zuerst mit Ihrer föderierten Identität in der gcloud CLI anmelden.

  11. Führen Sie den folgenden Befehl aus, um die gcloud CLI zu initialisieren:

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

    Bitten Sie Ihren Administrator, Ihnen die folgenden IAM-Rollen zuzuweisen, um die Berechtigungen zu erhalten, die Sie zur Verwaltung von Organisationsrichtlinien benötigen:

    Weitere Informationen zum Zuweisen von Rollen finden Sie unter Zugriff auf Projekte, Ordner und Organisationen verwalten.

    Diese vordefinierten Rollen enthalten die Berechtigungen, die zum Verwalten von Organisationsrichtlinien erforderlich sind. Erweitern Sie den Abschnitt Erforderliche Berechtigungen, um die erforderlichen Berechtigungen anzuzeigen:

    Erforderliche Berechtigungen

    Die folgenden Berechtigungen sind für die Verwaltung von Organisationsrichtlinien erforderlich:

    • orgpolicy.* für die Organisationsressource
    • So erstellen oder aktualisieren Sie ein BigQuery-Dataset:
      • bigquery.datasets.create für die Projektressource
      • bigquery.datasets.get für die Projektressource
      • bigquery.datasets.list für die Projektressource
      • bigquery.datasets.update für die Projektressource

    Sie können diese Berechtigungen auch mit benutzerdefinierten Rollen oder anderen vordefinierten Rollen erhalten.

    Benutzerdefinierte Beschränkung einrichten

    Eine benutzerdefinierte Beschrä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 Beschränkungen werden mithilfe der Common Expression Language (CEL) definiert. Weitere Informationen zum Erstellen von Bedingungen in benutzerdefinierten Beschränkungen mit CEL finden Sie im Abschnitt CEL unter Benutzerdefinierte Beschränkungen erstellen und verwalten.

    Console

    So erstellen Sie eine benutzerdefinierte Einschränkung:

    1. Wechseln Sie in der Google Cloud 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. Klicken Sie auf Benutzerdefinierte Einschränkung.
    4. Geben Sie im Feld Anzeigename einen nutzerfreundlichen Namen für die Einschränkung ein. Dieser Name wird in Fehlermeldungen verwendet und kann zur Identifizierung und Fehlerbehebung genutzt werden. Verwenden Sie keine personenidentifizierbaren Informationen oder vertraulichen Daten in Anzeigenamen, da dieser Name in Fehlermeldungen angezeigt werden kann. Dieses Feld kann bis zu 200 Zeichen enthalten.
    5. Geben Sie im Feld Einschränkungs-ID den gewünschten Namen für die neue benutzerdefinierte Einschränkung ein. Eine benutzerdefinierte Einschränkung darf nur Buchstaben (Groß- und Kleinbuchstaben) oder Ziffern enthalten, z. B. custom.disableGkeAutoUpgrade. Dieses Feld kann bis zu 70 Zeichen enthalten. Das Präfix (custom.) wird nicht gezählt, z. B. organizations/123456789/customConstraints/custom. Die Einschränkungs-ID darf keine personenidentifizierbaren Informationen oder vertraulichen Daten enthalten, da diese in Fehlermeldungen angezeigt werden können.
    6. Geben Sie im Feld Beschreibung eine für Menschen lesbare Beschreibung der Einschränkung ein. Diese Beschreibung wird als Fehlermeldung verwendet, wenn gegen die Richtlinie verstoßen wird. Geben Sie Details dazu an, warum der Richtlinienverstoß aufgetreten ist und wie er behoben werden kann. Nehmen Sie keine personenidentifizierbaren Informationen oder vertraulichen Daten in die Beschreibung auf, da sie in Fehlermeldungen preisgegeben werden könnten. Dieses Feld kann bis zu 2.000 Zeichen enthalten.
    7. Wählen Sie im Feld Ressourcentyp den Namen der Google Cloud REST-Ressource aus, die das Objekt und das Feld enthält, das Sie einschränken möchten, z. B. container.googleapis.com/NodePool. Die meisten Ressourcentypen unterstützen bis zu 20 benutzerdefinierte Einschränkungen. Wenn Sie versuchen, weitere benutzerdefinierte Einschränkungen zu erstellen, schlägt der Vorgang fehl.
    8. Wählen Sie unter Methode erzwingen aus, ob die Einschränkung für eine REST-Methode CREATE oder sowohl für die Methoden CREATE als auch UPDATE erzwungen werden soll. Wenn Sie die Einschränkung mit der Methode UPDATE für eine Ressource erzwingen, die gegen die Einschränkung verstößt, werden Änderungen an dieser Ressource durch die Organisationsrichtlinie blockiert, sofern die Änderung den Verstoß nicht behebt.
    9. Nicht alle Google Cloud Dienste unterstützen beide Methoden. Unter Unterstützte Dienste finden Sie die unterstützten Methoden für jeden Dienst.

    10. Klicken Sie zum Definieren einer Bedingung auf Bedingung bearbeiten.
      1. Erstellen Sie im Bereich Bedingung hinzufügen eine CEL-Bedingung, die auf eine unterstützte Dienstressource verweist, z. B. resource.management.autoUpgrade == false. Dieses Feld kann bis zu 1.000 Zeichen enthalten. Weitere Informationen zur Verwendung von CEL finden Sie unter Common Expression Language. Weitere Informationen zu den Dienstressourcen, die Sie in Ihren benutzerdefinierten Einschränkungen verwenden können, finden Sie unter Von benutzerdefinierten Einschränkungen unterstützte Dienste.
      2. Klicken Sie auf Speichern.
    11. Wählen Sie unter Aktion aus, ob die ausgewertete Methode zugelassen oder abgelehnt werden soll, wenn die Bedingung erfüllt ist.
    12. Die Aktion „Verweigern“ bedeutet, dass der Vorgang zum Erstellen oder Aktualisieren der Ressource blockiert wird, wenn die Bedingung als „true“ ausgewertet wird.

      Die Aktion „Zulassen“ bedeutet, dass der Vorgang zum Erstellen oder Aktualisieren der Ressource nur zulässig ist, wenn die Bedingung als „true“ ausgewertet wird. Alle anderen Fälle, die nicht explizit in der Bedingung aufgeführt sind, werden blockiert.

    13. Klicken Sie auf Einschränkung erstellen.
    14. Wenn Sie in jedes Feld einen Wert eingegeben haben, wird rechts die entsprechende YAML-Konfiguration für diese benutzerdefinierte Einschränkung angezeigt.

    gcloud

    1. Zum Erstellen einer benutzerdefinierten Beschränkung erstellen Sie eine YAML-Datei im folgenden Format:
    2.       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: der Name, den Sie für Ihre neue benutzerdefinierte Einschränkung verwenden möchten. Eine benutzerdefinierte Einschränkung darf nur Buchstaben (Groß- und Kleinbuchstaben) oder Ziffern enthalten, z. B. custom.enforceDatasetId. Dieses Feld kann bis zu 70 Zeichen enthalten.
      • RESOURCE_NAME: Der vollständig qualifizierte Name der Google Cloud-Ressource, die das Objekt und das Feld enthält, das Sie einschränken möchten. Beispiel: bigquery.googleapis.com/Dataset.
      • CONDITION: eine CEL-Bedingung, die für eine Darstellung einer unterstützten Dienstressource geschrieben wird. Dieses Feld kann bis zu 1.000 Zeichen enthalten. Beispiel: "datasetReference.datasetId.startsWith('test')".
      • Weitere Informationen zu den verfügbaren Ressourcen, auf die Bedingungen geschrieben werden können, finden Sie unter Unterstützte Ressourcen.

      • ACTION: Aktion, die ausgeführt werden soll, wenn condition erfüllt ist. Mögliche Werte sind ALLOW und DENY.
      • Die Aktion „allow“ bedeutet, dass der Vorgang zum Erstellen oder Aktualisieren der Ressource zulässig ist, wenn die Bedingung als „true“ ausgewertet wird. Das bedeutet auch, dass jeder andere Fall als der, der explizit in der Bedingung aufgeführt ist, blockiert wird.

        Die Aktion „Verweigern“ bedeutet, dass der Vorgang zum Erstellen oder Aktualisieren der Ressource blockiert wird, wenn die Bedingung als „true“ ausgewertet wird.

      • DISPLAY_NAME: Ein nutzerfreundlicher Name für die Einschränkung. Dieses Feld kann bis zu 200 Zeichen enthalten.
      • DESCRIPTION: Eine nutzerfreundliche Beschreibung der Einschränkung, die als Fehlermeldung angezeigt werden soll, wenn die Richtlinie verletzt wird. Dieses Feld kann bis zu 2.000 Zeichen enthalten.
    3. 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:
    4.         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 Organisationsrichtlinien von Google Cloud verfügbar.

    5. Prüfen Sie mit dem Befehl gcloud org-policies list-custom-constraints, ob die benutzerdefinierte Einschränkung vorhanden ist:
    6.       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 Beschränkung erzwingen, indem Sie eine Organisationsrichtlinie erstellen, die darauf verweist, und diese Organisationsrichtlinie dann auf eine Ressource von Google Cloud anwenden.

    Console

    1. Wechseln Sie in der Google Cloud 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 Beschrä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 diese Organisationsrichtlinie erzwungen wird.
    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 unbedingte Regel hinzufügen, da die Richtlinie sonst nicht gespeichert werden kann. Weitere Informationen finden Sie unter Organisationsrichtlinie mit Tags festlegen.
    9. Klicken Sie auf Änderungen testen, um die Auswirkungen der Organisationsrichtlinie zu simulieren. Weitere Informationen finden Sie unter Änderungen an Organisationsrichtlinien mit dem Richtliniensimulator testen.
    10. Klicken Sie auf Probelaufrichtlinie festlegen, um die Organisationsrichtlinie im Probelaufmodus zu erzwingen. Weitere Informationen finden Sie unter Organisationsrichtlinie im Probelaufmodus erstellen.
    11. Nachdem Sie überprüft haben, ob die Organisationsrichtlinie im Probelaufmodus wie vorgesehen funktioniert, legen Sie die aktive Richtlinie fest, indem Sie auf Richtlinie festlegen klicken.

    gcloud

    1. Wenn Sie eine Organisationsrichtlinie mit booleschen Regeln erstellen möchten, erstellen Sie eine YAML-Richtliniendatei, die auf die Beschränkung verweist:
    2.         name: projects/PROJECT_ID/policies/CONSTRAINT_NAME
              spec:
                rules:
                - enforce: true
              
              dryRunSpec:
                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 Beschränkung definiert haben. Beispiel: custom.enforceDatasetId.
    3. Führen Sie den folgenden Befehl mit dem Flag dryRunSpec aus, um die Organisationsrichtlinie im Probelaufmodus zu erzwingen:
    4.         gcloud org-policies set-policy POLICY_PATH \
                --update-mask=dryRunSpec
            

      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.

    5. Nachdem Sie überprüft haben, ob die Organisationsrichtlinie im Probelaufmodus wie vorgesehen funktioniert, legen Sie die aktive Richtlinie mit dem Befehl org-policies set-policy und dem Flag spec fest:
    6.         gcloud org-policies set-policy POLICY_PATH \
                --update-mask=spec
            

      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 verhindern, dass alle neuen Dataset-IDs in einem bestimmten Projekt mit test beginnen.

    Bevor Sie beginnen, benötigen Sie Folgendes:

    • Ihre Organisations-ID
    • Eine Projekt-ID

    Einschränkung erstellen

    So erstellen Sie eine benutzerdefinierte Einschränkung:

    1. Erstellen Sie die folgende YAML-Datei und speichern Sie sie als constraint-enforce-datasetId.yaml:

      name: organizations/ORGANIZATION_ID/customConstraints/custom.enforceDatasetId
      resourceTypes:
      - bigquery.googleapis.com/Dataset
      methodTypes:
      - CREATE
      condition: "datasetReference.datasetId.startsWith('test')"
      actionType: DENY
      displayName: Reject test datasets
      description: All new datasets can't begin with 'test'.
      

      Ersetzen Sie ORGANIZATION_ID durch Ihre Organisations-ID.

      Dies definiert eine Einschränkung, bei der für jedes neue Dataset der Vorgang abgelehnt wird, wenn die Dataset-ID mit test beginnt.

    2. Wenden Sie die Einschränkung an:

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

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

      Die Ausgabe sieht etwa so aus:

      CUSTOM_CONSTRAINT                       ACTION_TYPE  METHOD_TYPES   RESOURCE_TYPES                     DISPLAY_NAME
      custom.enforceDatasetId                 DENY         CREATE         bigquery.googleapis.com/Dataset    Reject test datasets
      ...
      

    Richtlinie erstellen

    Erstellen Sie nun eine Richtlinie und wenden Sie sie auf die benutzerdefinierte Einschränkung an, die Sie erstellt haben.

    1. Speichern Sie die folgende Datei als policy-enforce-datasetId.yaml:

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

      Ersetzen Sie PROJECT_ID durch Ihre Projekt-ID.

    2. Wenden Sie die Richtlinie an:

      gcloud org-policies set-policy ~/policy-enforce-datasetId.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.enforceDatasetId     -              SET               COCsm5QGENiXi2E=
      

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

    Richtlinie testen

    Versuchen Sie, ein BigQuery-Dataset im Projekt zu erstellen:

    bq --location=US mk -d \
        --default_table_expiration 3600 \
        --description "This is my dataset." \
        testdataset
    

    Die Ausgabe sieht so aus:

    Operation denied by custom org policies: ["customConstraints/custom.enforceDatasetId": "All new datasets can't begin with 'test'."]
    

    Unterstützte BigQuery-Ressourcen

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

    Ressource Feld
    bigquery.googleapis.com/Dataset resource.datasetReference.datasetId
    resource.defaultCollation
    resource.defaultEncryptionConfiguration.kmsKeyName
    resource.defaultPartitionExpirationMs
    resource.defaultRoundingMode
    resource.defaultTableExpirationMs
    resource.description
    resource.externalCatalogDatasetOptions.defaultStorageLocationUri
    resource.externalCatalogDatasetOptions.parameters
    resource.externalDatasetReference.connection
    resource.externalDatasetReference.externalSource
    resource.friendlyName
    resource.isCaseInsensitive
    resource.linkedDatasetSource.sourceDataset.datasetId
    resource.location
    resource.maxTimeTravelHours
    resource.storageBillingModel

    Nächste Schritte