Ressourcen für die Serviceverwaltung mit benutzerdefinierten Einschränkungen verwalten

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

• servicemanagement.googleapis.com/Service

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 integrierte verwaltete 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.

Hinweise

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

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

Install the Google Cloud CLI.

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

To initialize the gcloud CLI, run the following command:

gcloud init

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

Go to project selector

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

Install the Google Cloud CLI.

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

To initialize the gcloud CLI, run the following command:

gcloud init

1. Sie müssen Ihre Organisations-ID kennen.

Erforderliche Rollen

Bitten Sie Ihren Administrator, Ihnen die IAM-Rolle Organisationsrichtlinienadministrator (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.

Zum Erstellen einer benutzerdefinierten Einschränkung erstellen Sie eine YAML-Datei im folgenden Format:

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.authorizationCheck. Die maximale Länge dieses Feldes beträgt 70 Zeichen.

• RESOURCE_NAME: Der vollständig qualifizierte Name derGoogle Cloud -Ressource, die das Objekt und das Feld enthält, das Sie einschränken möchten. Beispiel: servicemanagement.googleapis.com/Service

• 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.name == \"test-service-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 Einschränkung erzwingen, indem Sie eine Organisationsrichtlinie erstellen, die darauf verweist, und diese Organisationsrichtlinie dann auf eine Google Cloud -Ressource anwenden.

Console

1. Rufen Sie in der Google Cloud Console die Seite Organisationsrichtlinien auf.

   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. Klicken Sie auf Änderungen testen, um die Auswirkungen der Organisationsrichtlinie zu simulieren. Die Richtliniensimulation ist für Legacy-Verwaltungseinschränkungen nicht verfügbar. 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

Wenn Sie eine Organisationsrichtlinie mit booleschen Regeln erstellen möchten, 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.authorizationCheck.

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 wird eine benutzerdefinierte Einschränkung basierend auf den Attributen der Dienstressource erstellt. Mit diesen Regeln können bestimmte CreateServiceConfig-Anfragen zugelassen oder abgelehnt werden.

Bevor Sie beginnen, sollten Sie Folgendes kennen:

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

Einschränkung erstellen

1. Speichern Sie die folgende Datei als constraint-file-name.yaml:

       name: organizations/ORGANIZATION_ID/customConstraints/custom.authorizationCheck
       resourceTypes:
       -  servicemanagement.googleapis.com/Service
       methodTypes:
       -   CREATE
       -   UPDATE
       condition: resource.name == \"test-service-name\"
       actionType: ALLOW
       displayName: Check Configuration time policy enforcement
       description: Organization policies, defined with CEL and enforced via service manager APIs, allow admins to control service configurations through inheritable and granular rules.
   

   Damit wird eine Einschränkung definiert, bei der der Dienstname für jedes Service Management gleich test-service-name sein muss.

2. Wenden Sie die Einschränkung an:

   gcloud org-policies set-custom-constraint ~/constraint-file-name.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.configTimeEnforcement ALLOW CREATE,UPDATE servicemanagement.googleapis.com/Service Configuration time policy enforcement
   

Richtlinie erstellen

1. Speichern Sie die folgende Datei als policy-file-name.yaml:

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

   Ersetzen Sie PROJECT_ID durch Ihre Projekt-ID.

2. Wenden Sie die Richtlinie an:

   gcloud org-policies set-policy ~/policy-file-name.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.configTimeEnforcement - SET COCsm5QGENiXi2E=
   

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

Richtlinie testen

Führen Sie den folgenden Befehl aus, um die Dienstkonfiguration zum Prüfen der Einschränkungen zu erstellen.

  gcloud endpoints services deploy policy-file-name.yaml

Die Ausgabe sieht etwa so aus:

  Operation denied by custom org policies: ["customConstraints/custom.authorizationCheck": "error Message"]

Von Service Management unterstützte Ressourcen

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

Ressource	Feld
servicemanagement.googleapis.com/Service	resource.authentication.providers.audiences
	resource.authentication.providers.authorizationUrl
	resource.authentication.providers.issuer
	resource.authentication.providers.jwksUri
	resource.authentication.providers.jwtLocations.cookie
	resource.authentication.providers.jwtLocations.header
	resource.authentication.providers.jwtLocations.query
	resource.authentication.providers.jwtLocations.valuePrefix
	resource.authentication.rules.allowWithoutCredential
	resource.authentication.rules.oauth.canonicalScopes
	resource.authentication.rules.requirements.audiences
	resource.authentication.rules.requirements.providerId
	resource.authentication.rules.selector
	resource.backend.rules.address
	resource.backend.rules.deadline
	resource.backend.rules.disableAuth
	resource.backend.rules.jwtAudience
	resource.backend.rules.operationDeadline
	resource.backend.rules.pathTranslation
	resource.backend.rules.protocol
	resource.backend.rules.selector
	resource.billing.consumerDestinations.metrics
	resource.billing.consumerDestinations.monitoredResource
	resource.context.rules.allowedRequestExtensions
	resource.context.rules.allowedResponseExtensions
	resource.context.rules.provided
	resource.context.rules.requested
	resource.context.rules.selector
	resource.control.environment
	resource.control.methodPolicies.requestPolicies.resourcePermission
	resource.control.methodPolicies.requestPolicies.resourceType
	resource.control.methodPolicies.requestPolicies.selector
	resource.control.methodPolicies.selector
	resource.customError.rules.isErrorType
	resource.customError.rules.selector
	resource.customError.types
	resource.endpoints.aliases
	resource.endpoints.allowCors
	resource.endpoints.name
	resource.endpoints.target
	resource.logging.consumerDestinations.logs
	resource.logging.consumerDestinations.monitoredResource
	resource.logging.producerDestinations.logs
	resource.logging.producerDestinations.monitoredResource
	resource.logs.description
	resource.logs.displayName
	resource.logs.name
	resource.metrics.description
	resource.metrics.displayName
	resource.metrics.launchStage
	resource.metrics.metadata.ingestDelay
	resource.metrics.metadata.samplePeriod
	resource.metrics.metadata.timeSeriesResourceHierarchyLevel
	resource.metrics.metricKind
	resource.metrics.monitoredResourceTypes
	resource.metrics.name
	resource.metrics.type
	resource.metrics.unit
	resource.metrics.valueType
	resource.monitoredResources.description
	resource.monitoredResources.displayName
	resource.monitoredResources.launchStage
	resource.monitoredResources.name
	resource.monitoredResources.type
resource.monitoring.consumerDestinations.metrics
resource.monitoring.consumerDestinations.monitoredResource
resource.monitoring.producerDestinations.metrics
resource.monitoring.producerDestinations.monitoredResource
resource.name
resource.producerProjectId
resource.publishing.apiShortName
resource.publishing.codeownerGithubTeams
resource.publishing.docTagPrefix
resource.publishing.documentationUri
resource.publishing.githubLabel
resource.publishing.librarySettings.cppSettings.common.destinations
resource.publishing.librarySettings.cppSettings.common.selectiveGapicGeneration.methods
resource.publishing.librarySettings.dotnetSettings.common.destinations
resource.publishing.librarySettings.dotnetSettings.common.selectiveGapicGeneration.methods
resource.publishing.librarySettings.dotnetSettings.forcedNamespaceAliases
resource.publishing.librarySettings.dotnetSettings.handwrittenSignatures
resource.publishing.librarySettings.dotnetSettings.ignoredResources
resource.publishing.librarySettings.dotnetSettings.renamedResources
resource.publishing.librarySettings.dotnetSettings.renamedServices
resource.publishing.librarySettings.goSettings.common.destinations
resource.publishing.librarySettings.goSettings.common.selectiveGapicGeneration.methods
resource.publishing.librarySettings.javaSettings.common.destinations
resource.publishing.librarySettings.javaSettings.common.selectiveGapicGeneration.methods
resource.publishing.librarySettings.javaSettings.libraryPackage
resource.publishing.librarySettings.javaSettings.serviceClassNames
resource.publishing.librarySettings.launchStage
resource.publishing.librarySettings.nodeSettings.common.destinations
resource.publishing.librarySettings.nodeSettings.common.selectiveGapicGeneration.methods
resource.publishing.librarySettings.phpSettings.common.destinations
resource.publishing.librarySettings.phpSettings.common.selectiveGapicGeneration.methods
resource.publishing.librarySettings.pythonSettings.common.destinations
resource.publishing.librarySettings.pythonSettings.common.selectiveGapicGeneration.methods
resource.publishing.librarySettings.pythonSettings.experimentalFeatures.restAsyncIoEnabled
resource.publishing.librarySettings.restNumericEnums
resource.publishing.librarySettings.rubySettings.common.destinations
resource.publishing.librarySettings.rubySettings.common.selectiveGapicGeneration.methods
resource.publishing.librarySettings.version
resource.publishing.methodSettings.autoPopulatedFields
resource.publishing.methodSettings.longRunning.initialPollDelay
resource.publishing.methodSettings.longRunning.maxPollDelay
resource.publishing.methodSettings.longRunning.pollDelayMultiplier
resource.publishing.methodSettings.longRunning.totalPollTimeout
resource.publishing.methodSettings.selector
resource.publishing.newIssueUri
resource.publishing.organization
resource.publishing.protoReferenceDocumentationUri
resource.publishing.restReferenceDocumentationUri
resource.quota.limits.defaultLimit
resource.quota.limits.description
resource.quota.limits.displayName
resource.quota.limits.duration
resource.quota.limits.freeTier
resource.quota.limits.maxLimit
resource.quota.limits.metric
resource.quota.limits.name
resource.quota.limits.unit
resource.quota.limits.values
resource.quota.metricRules.metricCosts
resource.quota.metricRules.selector
resource.systemParameters.rules.parameters.httpHeader
resource.systemParameters.rules.parameters.name
resource.systemParameters.rules.parameters.urlQueryParameter
resource.systemParameters.rules.selector
resource.title
resource.usage.producerNotificationChannel
resource.usage.requirements
resource.usage.rules.allowUnregisteredCalls
resource.usage.rules.selector
resource.usage.rules.skipServiceControl

Nächste Schritte

• Weitere Informationen zu Service Management-Optionen finden Sie in der Übersicht zu Service Management.
• Informationen zur Behebung häufiger Probleme bei der Verwendung von Service Management finden Sie unter Fehlerbehebung.
• Vordefinierte Einschränkungen für Organisationsrichtlinien für die Dienstverwaltung
• Weitere Informationen zum Organisationsrichtliniendienst
• Organisationsrichtlinien erstellen und verwalten
• Eine vollständige Liste der verwalteten Einschränkungen für Organisationsrichtlinien finden Sie hier.