Esta página foi traduzida pela API Cloud Translation.

Gerenciar recursos do Dataplex Universal Catalog usando restrições personalizadas

Nesta página, mostramos como usar restrições personalizadas do serviço de políticas da organização para restringir operações específicas nos seguintes recursos do Google Cloud :

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

Para saber mais sobre políticas da organização, consulte Políticas personalizadas da organização.

Sobre políticas da organização e restrições

O serviço de políticas da organização do Google Cloud oferece controle centralizado e programático sobre os recursos da sua organização. Um administrador de políticas da organização pode definir políticas da organização, ou seja, conjuntos de restrições que se aplicam aos recursos doGoogle Cloud e aos elementos que descendem dele na hierarquia de recursos doGoogle Cloud . É possível aplicar políticas da organização no nível da organização, de pastas ou de projetos.

Uma política da organização oferece restrições gerenciadas e integradas para vários serviços do Google Cloud . No entanto, para ter controle mais granular e personalizável sobre os campos específicos restritos nas políticas da organização, também é possível criar restrições personalizadas e usá-las nessas políticas.

Herança de políticas

As políticas da organização são herdadas por padrão pelos elementos que descendem dos recursos em que elas são aplicadas. Por exemplo, se você aplicar uma política a uma pasta, o Google Cloud vai aplicá-la todos os projetos dessa pasta. Para saber mais sobre esse comportamento e como alterá-lo, consulte Regras de avaliação de hierarquia.

Limitações

As restrições personalizadas e as políticas da organização não são compatíveis com os seguintes recursos:

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

Antes de começar

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 (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.

Ao usar um provedor de identidade (IdP) externo, primeiro faça login na gcloud CLI com sua identidade federada.

Para inicializar a gcloud CLI, execute o seguinte comando:

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 (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.

Ao usar um provedor de identidade (IdP) externo, primeiro faça login na gcloud CLI com sua identidade federada.

Para inicializar a gcloud CLI, execute o seguinte comando:

gcloud init

Verifique qual é o ID da organização.

Papéis necessários

Para receber as permissões necessárias a fim de gerenciar as políticas da organização, peça ao administrador para conceder a você o papel do IAM de Administrador de políticas da organização (roles/orgpolicy.policyAdmin) no recurso da organização. Para mais informações sobre a concessão de papéis, consulte Gerenciar o acesso a projetos, pastas e organizações.

Também é possível conseguir as permissões necessárias usando papéis personalizados ou outros papéis predefinidos.

Criar uma restrição personalizada

Uma restrição personalizada é definida em um arquivo YAML pelos recursos, métodos, condições e ações compatíveis com o serviço em que você está aplicando a política da organização. As condições das restrições personalizadas são definidas usando a Common Expression Language (CEL). Para saber como criar condições em restrições personalizadas usando a CEL, consulte a seção CEL em Como criar e gerenciar restrições personalizadas.

Para criar uma restrição personalizada, crie um arquivo YAML com o seguinte formato:

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

Substitua:

ORGANIZATION_ID: o ID da organização, como 123456789.
CONSTRAINT_NAME: o nome da nova restrição personalizada. Uma restrição personalizada precisa começar com custom. e só pode incluir letras maiúsculas, minúsculas ou números. Por exemplo, custom.denyDataplexEntryGroup. Esse campo pode ter no máximo 70 caracteres.
RESOURCE_NAME: o nome totalmente qualificado do recurso doGoogle Cloud que contém o objeto e o campo que você quer restringir. Por exemplo, dataplex.googleapis.com/dataplex.googleapis.com/EntryGroup.
CONDITION: uma condição de CEL gravada em uma representação de um recurso de serviço compatível. Esse campo pode ter no máximo 1000 caracteres. Consulte Recursos compatíveis para mais informações sobre os recursos disponíveis para gravação de condições. Por exemplo, "resource.description.contains('invalid_name')".
ACTION: a ação a ser realizada ao atender a condition. Os valores possíveis são ALLOW e DENY.
DISPLAY_NAME: um nome legível para a restrição. Esse campo pode ter no máximo 200 caracteres.
DESCRIPTION: uma descrição legível da restrição a ser exibida como mensagem de erro quando a política é violada. Esse campo pode ter no máximo 2000 caracteres.

Para saber como criar uma restrição personalizada, consulte Como definir restrições personalizadas.

Configurar uma restrição personalizada

gcloud org-policies set-custom-constraint

gcloud org-policies set-custom-constraint CONSTRAINT_PATH

CONSTRAINT_PATH

/home/user/customconstraint.yaml

gcloud org-policies list-custom-constraints

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

ORGANIZATION_ID

Como visualizar políticas da organização

Aplicar uma política personalizada da organização

Console

No console do Google Cloud , acesse a página Políticas da organização.
Acessar a página Políticas da organização
No seletor de projetos, selecione o projeto em que você quer definir a política da organização.
Na lista da página Políticas da organização, selecione uma restrição para acessar a página Detalhes da política associada.
Para configurar a política da organização nesse recurso, clique em Gerenciar política.
Na página Editar política, selecione Substituir a política do recurso pai.
Clique em Adicionar regra.
Na seção Aplicação, escolha entre ativar ou desativar a aplicação dessa política da organização.
Opcional: para tornar a política da organização condicional em uma tag, clique em Adicionar condição. Se você adicionar uma regra condicional a uma política da organização, inclua pelo menos uma regra não condicional para que a política seja salva. Para mais informações, consulte Como configurar uma política da organização com tags.
Clique em Testar mudanças para simular o efeito da política da organização. A simulação da política não está disponível para restrições gerenciadas legadas. Para mais informações, consulte Testar mudanças na política da organização com o Simulador de política.
Para concluir e aplicar a política da organização, clique em Definir política. A política levará até 15 minutos para entrar em vigor.

gcloud

Para criar uma política da organização com regras booleanas, crie um arquivo YAML para a política que faça referência à restrição:

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

Substitua:

PROJECT_ID: o projeto em que você quer aplicar a restrição.
CONSTRAINT_NAME: o nome definido para a restrição personalizada. Por exemplo, custom.denyDataplexEntryGroup.

Para aplicar a política da organização que contém a restrição, execute o seguinte comando:

    gcloud org-policies set-policy POLICY_PATH

Substitua POLICY_PATH pelo caminho completo para o arquivo YAML da política da organização. A política leva até 15 minutos para entrar em vigor.

Testar a política personalizada da organização

O exemplo a seguir cria uma restrição e política personalizada que impede que os usuários criem grupos de entradas em um projeto específico em que a descrição do grupo de entradas contenha o texto invalid_name.

Antes de começar, você precisa saber o seguinte:

O ID da sua organização.
Um ID de projeto

Criar a restrição

Salve o seguinte arquivo como 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.

Isso define uma restrição em que, para cada novo grupo de entradas, se a descrição contiver o texto invalid_name, a operação será negada.

Aplique a restrição:

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

Verifique se a restrição existe:

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

O resultado será o seguinte:

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

Criar a política

Salve o seguinte arquivo como policy-deny-entry-group.yaml:

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

Substitua PROJECT_ID pelo ID do seu projeto.

Aplique a política:

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

Verifique se a política existe:

gcloud org-policies list --project=PROJECT_ID

O resultado será assim:

CONSTRAINT                      LIST_POLICY    BOOLEAN_POLICY    ETAG
custom.denyDataplexEntryGroup   -              SET               COCsm5QGENiXi2E=

Depois de aplicar a política, aguarde cerca de 15 minutos para que o Google Cloud comece a aplicar a política.

Testar a política

Tente criar um grupo de entrada no projeto:

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

A operação foi negada. A saída é esta:

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

Exemplos de políticas personalizadas da organização para casos de uso comuns

Esta tabela fornece exemplos de sintaxe para algumas restrições personalizadas comuns.

Descrição	Sintaxe da restrição
Exigir um tipo de aspecto específico para tipos de entrada	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
Exigir uma taxa de amostragem mínima para verificações de criação de perfil de dados	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

Descrição

Sintaxe da restrição

Exigir um tipo de aspecto específico para tipos de entrada

    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

Exigir uma taxa de amostragem mínima para verificações de criação de perfil de dados

    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

Recursos compatíveis com o Dataplex Universal Catalog

Recurso	Campo
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`

A seguir

Saiba mais sobre o Serviço de políticas da organização.
Saiba como criar e gerenciar políticas da organização.
Confira a lista completa de restrições de política da organização gerenciadas.

Gerenciar recursos do Dataplex Universal Catalog usando restrições personalizadas Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.

Sobre políticas da organização e restrições

Herança de políticas

Limitações

Antes de começar

Papéis necessários

Criar uma restrição personalizada

Configurar uma restrição personalizada

Aplicar uma política personalizada da organização

Console

gcloud

Testar a política personalizada da organização

Criar a restrição

Criar a política

Testar a política

Exemplos de políticas personalizadas da organização para casos de uso comuns

Recursos compatíveis com o Dataplex Universal Catalog

A seguir

Gerenciar recursos do Dataplex Universal Catalog usando restrições personalizadas