Faça a gestão de recursos do BigQuery através de restrições personalizadas

Pré-visualização

Este produto ou funcionalidade está sujeito aos "Termos das Ofertas de Pré-DG" na secção Termos Gerais de Serviço dos Termos Específicos do Serviço. Os produtos e as funcionalidades pré-GA estão disponíveis "tal como estão" e podem ter apoio técnico limitado. Para mais informações, consulte as descrições das fases de lançamento.

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

• bigquery.googleapis.com/Dataset

Para saber mais sobre a política de organização, consulte o artigo Políticas de organização personalizadas.

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

O Google Cloud serviço de políticas da organização dá-lhe um controlo centralizado e programático sobre os recursos da sua organização. Enquanto administrador de políticas da organização, pode definir uma política da organização, que é um conjunto de restrições denominadas restrições que se aplicam aGoogle Cloud recursos e descendentes desses recursos na Google Cloud hierarquia de recursos. Pode aplicar políticas de organização ao nível da organização, da pasta ou do projeto.

A política da organização oferece restrições geridas incorporadas para vários serviços Google Cloud . No entanto, se quiser um controlo mais detalhado e personalizável sobre os campos específicos que estão restritos nas políticas da sua organização, também pode criar restrições personalizadas e usar essas restrições personalizadas numa política da organização.

Herança de políticas

Por predefinição, as políticas da organização são herdadas pelos descendentes dos recursos nos quais aplica a política. Por exemplo, se aplicar uma política a uma pasta, Google Cloud aplica a política a todos os projetos na pasta. Para saber mais acerca deste comportamento e como o alterar, consulte as regras de avaliação da hierarquia.

Limitações

• PolicyViolationInfo não é publicada nos registos de auditoria do BigQuery quando o acesso é negado devido a restrições personalizadas. A mensagem de erro indica o constraintId que negou a operação.

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.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Install the Google Cloud CLI.

Se estiver a usar um fornecedor de identidade (IdP) externo, tem primeiro de iniciar sessão na CLI gcloud com a sua identidade federada.

Para inicializar a CLI gcloud, 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.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Install the Google Cloud CLI.

Se estiver a usar um fornecedor de identidade (IdP) externo, tem primeiro de iniciar sessão na CLI gcloud com a sua identidade federada.

Para inicializar a CLI gcloud, execute o seguinte comando:

gcloud init

1. Certifique-se de que sabe o seu ID da organização.

Funções necessárias

Para receber as autorizações de que precisa para gerir políticas de organização, peça ao seu administrador que lhe conceda as seguintes funções do IAM:

• Administrador da política da organização (roles/orgpolicy.policyAdmin) no recurso da organização
• Para criar ou atualizar um conjunto de dados do BigQuery: Administrador do BigQuery ou editor do BigQuery (roles/bigquery.admin ou roles/bigquery.editor) no recurso do projeto

Para mais informações sobre a atribuição de funções, consulte o artigo Faça a gestão do acesso a projetos, pastas e organizações.

Estas funções predefinidas contêm as autorizações necessárias para gerir as políticas da organização. Para ver as autorizações exatas que são necessárias, expanda a secção Autorizações necessárias:

Autorizações necessárias

São necessárias as seguintes autorizações para gerir políticas da organização:

• orgpolicy.* no recurso da organização
• Para criar ou atualizar um conjunto de dados do BigQuery:
  • bigquery.datasets.create no recurso do projeto
  • bigquery.datasets.get no recurso do projeto
  • bigquery.datasets.list no recurso do projeto
  • bigquery.datasets.update no recurso do projeto

Também pode conseguir estas autorizações com funções personalizadas ou outras funções predefinidas.

Crie uma restrição personalizada

Uma restrição personalizada é definida num ficheiro YAML pelos recursos, métodos, condições e ações suportados pelo serviço no qual está a aplicar a política da organização. As condições para as restrições personalizadas são definidas através do Idioma de expressão comum (IEC). Para mais informações sobre como criar condições em restrições personalizadas através da CEL, consulte a secção CEL do artigo Criar e gerir restrições personalizadas.

Para criar uma restrição personalizada, crie um ficheiro 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 o seguinte:

• ORGANIZATION_ID: o ID da sua organização, como 123456789.

• CONSTRAINT_NAME: o nome que quer para a nova restrição personalizada. Uma restrição personalizada tem de começar com custom. e só pode incluir letras maiúsculas, letras minúsculas ou números. Por exemplo, custom.enforceDatasetId. O comprimento máximo deste campo é de 70 carateres.

• RESOURCE_NAME: o nome totalmente qualificado do recurso que contém o objeto e o campo que quer restringir.Google Cloud Por exemplo, bigquery.googleapis.com/Dataset.

• CONDITION: uma condição CEL escrita em função de uma representação de um recurso de serviço suportado. Este campo tem um comprimento máximo de 1000 carateres. Consulte o artigo Recursos suportados para mais informações sobre os recursos disponíveis para escrever condições. Por exemplo, "datasetReference.datasetId.startsWith('test')".

• ACTION: a ação a tomar se a condição condition for cumprida. Os valores possíveis são ALLOW e DENY.

• DISPLAY_NAME: um nome simples para a restrição. Este campo tem um comprimento máximo de 200 carateres.

• DESCRIPTION: uma descrição acessível da restrição a apresentar como uma mensagem de erro quando a política é violada. Este campo tem um comprimento máximo de 2000 carateres.

Para mais informações sobre como criar uma restrição personalizada, consulte o artigo Definir restrições personalizadas.

Configure uma restrição personalizada

Depois de criar o ficheiro YAML para uma nova restrição personalizada, tem de o configurar para o disponibilizar para as políticas da organização na sua organização. Para configurar uma restrição personalizada, use o comando gcloud org-policies set-custom-constraint:

gcloud org-policies set-custom-constraint CONSTRAINT_PATH

Substitua CONSTRAINT_PATH pelo caminho completo para o seu ficheiro de restrições personalizado. Por exemplo, /home/user/customconstraint.yaml. Após a conclusão, as restrições personalizadas ficam disponíveis como políticas da organização na sua lista de Google Cloud políticas da organização. Para verificar se a restrição personalizada existe, use o comando gcloud org-policies list-custom-constraints:

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

Substitua ORGANIZATION_ID pelo ID do recurso da sua organização. Para mais informações, consulte o artigo Ver políticas da organização.

Aplique uma política da organização personalizada

Pode aplicar uma restrição criando uma política da organização que a referencie e, em seguida, aplicando essa política da organização a um Google Cloud recurso.

Consola

1. Na Google Cloud consola, aceda à página Políticas de organização.

   Aceda às políticas da organização

2. No seletor de projetos, selecione o projeto para o qual quer definir a política de organização.
3. Na lista da página Políticas da organização, selecione a restrição para ver a página Detalhes da política dessa restrição.
4. Para configurar a política da organização para este recurso, clique em Gerir política.
5. Na página Editar política, selecione Substituir política do elemento principal.
6. Clique em Adicionar regra.
7. Na secção Aplicação, selecione se a aplicação desta política organizacional está ativada ou desativada.
8. Opcional: para tornar a política de organização condicional a uma etiqueta, clique em Adicionar condição. Tenha em atenção que, se adicionar uma regra condicional a uma política da organização, tem de adicionar, pelo menos, uma regra incondicional. Caso contrário, não é possível guardar a política. Para mais informações, consulte o artigo Definir uma política de organização com etiquetas.
9. Clique em Testar alterações para simular o efeito da política da organização. A simulação de políticas não está disponível para restrições geridas antigas. Para mais informações, consulte o artigo Teste as alterações à política da organização com o simulador de políticas.
10. Para concluir e aplicar a política da organização, clique em Definir política. A política demora até 15 minutos a entrar em vigor.

gcloud

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

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

Substitua o seguinte:

• PROJECT_ID: o projeto no qual quer aplicar a restrição.
• CONSTRAINT_NAME: o nome que definiu para a restrição personalizada. Por exemplo, custom.enforceDatasetId.

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 ficheiro YAML da política da organização. A política demora até 15 minutos a entrar em vigor.

Teste a política da organização personalizada

O exemplo seguinte cria uma restrição e uma política personalizadas que proíbem que todos os IDs de conjuntos de dados novos num projeto específico comecem por test.

Antes de começar, tem de ter o seguinte:

• O ID da sua organização
• Um ID do projeto

Crie a restrição

Para criar uma restrição personalizada, siga estes passos:

1. Crie o seguinte ficheiro YAML e guarde-o como 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'.
   

   Substitua ORGANIZATION_ID pelo ID da sua organização.

   Isto define uma restrição em que, para cada novo conjunto de dados, se o ID do conjunto de dados começar por test, a operação é recusada.

2. Aplique a restrição:

   gcloud org-policies set-custom-constraint ~/constraint-enforce-datasetId
   

3. Verifique se a restrição existe:

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

   O resultado é semelhante ao seguinte:

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

Crie a política

Agora, crie uma política e aplique-a à restrição personalizada que criou.

1. Guarde o seguinte ficheiro como policy-enforce-datasetId.yaml:

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

   Substitua PROJECT_ID pelo ID do seu projeto.

2. Aplique a política:

   gcloud org-policies set-policy ~/policy-enforce-datasetId.yaml
   

3. Verifique se a política existe:

   gcloud org-policies list --project=PROJECT_ID
   

   O resultado é semelhante ao seguinte:

   CONSTRAINT                  LIST_POLICY    BOOLEAN_POLICY    ETAG
   custom.enforceDatasetId     -              SET               COCsm5QGENiXi2E=
   

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

Teste a política

Tente criar um conjunto de dados do BigQuery no projeto:

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

O resultado é o seguinte:

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

Recursos suportados do BigQuery

A tabela seguinte apresenta os recursos do BigQuery que pode referenciar em restrições personalizadas.

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

O que se segue?

• Saiba como atualizar as propriedades do conjunto de dados.
• Saiba mais sobre o serviço de políticas da organização.
• Saiba como criar e gerir políticas de organização.
• Veja a lista completa de restrições de políticas da organização geridas.