Use políticas da organização personalizadas

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:

  • bigquerydatatransfer.googleapis.com/TransferConfig

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.

Vantagens

Pode usar uma política da organização personalizada para permitir ou negar operações específicas nas configurações de transferência do Serviço de transferência de dados do BigQuery de modo a cumprir os requisitos de conformidade e segurança da sua organização. Se um pedido para criar ou atualizar uma configuração de transferência não cumprir as restrições personalizadas definidas pela política da sua organização, o pedido falha e é devolvido um erro ao autor da chamada.

Limitações

  • Para especificar uma origem de dados na restrição personalizada, use o campo resource.dataSourceId juntamente com o valor da origem de dados. Para ver uma lista de valores suportados para resource.dataSourceId, chame o método dataSources.list.

Antes de começar

  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. Se estiver a usar um fornecedor de identidade (IdP) externo, tem primeiro de iniciar sessão na CLI gcloud com a sua identidade federada.

  6. Para inicializar a CLI gcloud, execute o seguinte comando: 

    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. Se estiver a usar um fornecedor de identidade (IdP) externo, tem primeiro de iniciar sessão na CLI gcloud com a sua identidade federada.

  11. Para inicializar a CLI gcloud, execute o seguinte comando: 

    gcloud init
  12. Certifique-se de que sabe o seu ID da organização.

    13. Funções necessárias

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

    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 as políticas da organização:

    • orgpolicy.* no recurso da organização
    • Crie ou atualize uma configuração de transferência do Serviço de transferência de dados do BigQuery:
      • bigquery.transfers.get no recurso do projeto
      • bigquery.transfers.update no recurso do projeto

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

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

    Consola

    Para criar uma restrição personalizada, faça o seguinte:

    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. Clique em Restrição personalizada.
    4. Na caixa Nome a apresentar, introduza um nome legível para a restrição. Este nome é usado em mensagens de erro e pode ser usado para identificação e depuração. Não use IIP nem dados confidenciais em nomes a apresentar, uma vez que este nome pode ser exposto em mensagens de erro. Este campo pode conter até 200 carateres.
    5. Na caixa ID da restrição, introduza o nome pretendido para a nova restrição personalizada. Uma restrição personalizada só pode conter letras (incluindo maiúsculas e minúsculas) ou números, por exemplo, custom.disableGkeAutoUpgrade. Este campo pode conter até 70 carateres, sem contar com o prefixo (custom.), por exemplo, organizations/123456789/customConstraints/custom. Não inclua PII nem dados confidenciais no ID da restrição, uma vez que podem ser expostos em mensagens de erro.
    6. Na caixa Descrição, introduza uma descrição legível da restrição. Esta descrição é usada como uma mensagem de erro quando a política é violada. Inclua detalhes sobre o motivo pelo qual a violação de política ocorreu e como resolvê-la. Não inclua PII nem dados confidenciais na descrição, uma vez que podem ser expostos em mensagens de erro. Este campo pode conter até 2000 carateres.
    7. Na caixa Tipo de recurso, selecione o nome do Google Cloud recurso REST que contém o objeto e o campo que quer restringir, por exemplo, container.googleapis.com/NodePool. A maioria dos tipos de recursos suporta até 20 restrições personalizadas. Se tentar criar mais restrições personalizadas, a operação falha.
    8. Em Método de aplicação, selecione se quer aplicar a restrição a um método CREATE do REST ou aos métodos CREATE e UPDATE. Se aplicar a restrição com o método UPDATE num recurso que viole a restrição, as alterações a esse recurso são bloqueadas pela política da organização, a menos que a alteração resolva a violação.

      9. Nem todos os serviços Google Cloud suportam ambos os métodos. Para ver os métodos suportados para cada serviço, encontre o serviço em Serviços suportados.

    9. Para definir uma condição, clique em Editar condição.
      1. No painel Adicionar condição, crie uma condição CEL que faça referência a um recurso de serviço suportado, por exemplo, resource.management.autoUpgrade == false. Este campo pode conter até 1000 carateres. Para ver detalhes sobre a utilização do IEC, consulte o artigo Idioma de expressão comum. Para mais informações sobre os recursos de serviço que pode usar nas suas restrições personalizadas, consulte Serviços suportados de restrições personalizadas.
      2. Clique em Guardar.
    10. Em Ação, selecione se quer permitir ou recusar o método avaliado se a condição for cumprida.

      11. A ação de recusa significa que a operação para criar ou atualizar o recurso é bloqueada se a condição for avaliada como verdadeira.

      A ação allow significa que a operação para criar ou atualizar o recurso só é permitida se a condição for avaliada como verdadeira. Todos os outros casos, exceto os explicitamente listados na condição, são bloqueados.

    11. Clique em Criar restrição.

      12. Quando tiver introduzido um valor em cada campo, a configuração YAML equivalente para esta restrição personalizada é apresentada à direita.

    gcloud

    1. Para criar uma restrição personalizada, crie um ficheiro YAML com o seguinte formato: 
      2.       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 só pode conter letras (incluindo maiúsculas e minúsculas) ou números, por exemplo, custom.dtsEnableEmailNotification. Este campo pode conter até 70 carateres.
      • RESOURCE_NAME: o nome totalmente qualificado do recurso que contém o objeto e o campo que quer restringir. Google CloudPor exemplo, bigquerydatatransfer.googleapis.com/TransferConfig.
      • CONDITION: uma condição CEL escrita em função de uma representação de um recurso de serviço suportado. Este campo pode conter até 1000 carateres. Por exemplo, resource.emailPreferences.enableFailureEmail == true.

        • Para mais informações sobre os recursos disponíveis para escrever condições, consulte o artigo Recursos suportados.

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

        • A ação allow significa que, se a condição for avaliada como verdadeira, a operação para criar ou atualizar o recurso é permitida. Isto também significa que todos os outros casos, exceto o que está explicitamente listado na condição, são bloqueados.

        A ação de recusa significa que, se a condição for avaliada como verdadeira, a operação para criar ou atualizar o recurso é bloqueada.

      • DISPLAY_NAME: um nome intuitivo para a restrição. Este campo pode conter até 200 carateres.
      • DESCRIPTION: uma descrição simples da restrição a apresentar como uma mensagem de erro quando a política é violada. Este campo pode conter até 2000 carateres.
    2. 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: 
      3.         gcloud org-policies set-custom-constraint CONSTRAINT_PATH

      Substitua CONSTRAINT_PATH pelo caminho completo para o ficheiro de restrição personalizado. Por exemplo, /home/user/customconstraint.yaml.

      Após a conclusão desta operaçã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.

    3. Para verificar se a restrição personalizada existe, use o comando gcloud org-policies list-custom-constraints: 
      4.       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 esta política de organização é aplicada ou não.
    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 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. Para mais informações, consulte o artigo Teste as alterações da política da organização com o simulador de políticas.
    10. Para aplicar a política da organização no modo de execução de ensaio, clique em Definir política de execução de ensaio. Para mais informações, consulte Crie uma política de organização no modo de teste.
    11. Depois de verificar que a política da organização no modo de teste funciona como pretendido, defina a política ativa clicando em Definir política.

    gcloud

    1. 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: 
      2.         name: projects/PROJECT_ID/policies/CONSTRAINT_NAME
        spec:
          rules:
          - enforce: true
        
        dryRunSpec:
          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.dtsEnableEmailNotification.
    2. Para aplicar a política da organização no modo de teste, execute o seguinte comando com a flag dryRunSpec: 
      3.         gcloud org-policies set-policy POLICY_PATH \
          --update-mask=dryRunSpec

      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.

    3. Depois de verificar que a política da organização no modo de teste funciona como pretendido, defina a política ativa com o comando org-policies set-policy e a flag spec: 
      4.         gcloud org-policies set-policy POLICY_PATH \
          --update-mask=spec

      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 exigem que as notificações por email sejam ativadas para todas as novas configurações de transferência num projeto específico.

    Antes de começar, deve saber o seguinte:

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

    Crie a restrição

    1. Guarde o seguinte ficheiro como constraint-dts-enable-email.yaml:

      name: organizations/ORGANIZATION_ID/customConstraints/custom.dtsEnableEmailNotification
resourceTypes:
- bigquerydatatransfer.googleapis.com/TransferConfig
methodTypes:
- CREATE
condition: resource.emailPreferences.enableFailureEmail == true
actionType: ALLOW
displayName: The BigQuery Data Transfer Service always enables email notications
description: The BigQuery Data Transfer Service always enables email notications on data transfer failures.

      Substitua ORGANIZATION_ID pelo seu ID da organização.

      Esta definição define uma restrição que verifica se as notificações por email estão ativadas para uma nova configuração de transferência. Se não estiverem ativadas, a operação é recusada.

    2. Aplique a restrição:

      gcloud org-policies set-custom-constraint ~/constraint-dts-enable-email.yaml

    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.dtsEnableEmailNotification  ALLOW        CREATE         bigquerydatatransfer.googleapis.com/TransferConfig  The BigQuery Data Transfer Service always enables email notications
...

    Crie a política

    1. Guarde o seguinte ficheiro como policy-dts-enable-email.yaml:

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

      Substitua PROJECT_ID pelo ID do seu projeto.

    2. Aplique a política:

      gcloud org-policies set-policy ~/policy-dts-enable-email.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.dtsEnableEmailNotification  -            SET                   CPyxlbgGENDL3tEC-

    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

    No projeto, tente criar uma configuração de transferência do Serviço de transferência de dados do BigQuery com a notificação por email desativada.

    O resultado é o seguinte:

    Operation denied by custom org policy: ["customConstraints/custom.dtsEnableEmailNotification": "The BigQuery Data Transfer Service always enables email notications on data transfer failures."].

    Exemplos de políticas da organização personalizadas para exemplos de utilização comuns

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

    Descrição Sintaxe de restrição
    Não permitir transferências de dados do armazenamento de blobs do Azure 
        name: organizations/ORGANIZATION_ID/customConstraints/custom.denyDtsAzureTransfers
    resourceTypes:
    - bigquerydatatransfer.googleapis.com/TransferConfig
    methodTypes:
    - CREATE
    condition: resource.dataSourceId == "azure_blob_storage"
    actionType: DENY
    displayName: Deny data transfers from Azure Blob Storage to BigQuery
    description: Disallow creating data transfer configurations from Azure Blob Storage.
    Ative sempre o agendamento automático 
        name: organizations/ORGANIZATION_ID/customConstraints/custom.dtsNoManualSchedule
    resourceTypes:
    - bigquerydatatransfer.googleapis.com/TransferConfig
    methodTypes:
    - CREATE
    - UPDATE
    condition: resource.scheduleOptions.disableAutoScheduling == false
    actionType: ALLOW
    displayName: Transfer configurations always enable auto-scheduling
    description: Always enable auto-scheduling for BigQuery Data Transfer Service transfer configurations.
    As transferências do Google Ads têm de ter um período de atualização de dados superior a três dias 
        name: organizations/ORGANIZATION_ID/customConstraints/custom.dtsGoogleAdsConstraint
    resourceTypes:
    - bigquerydatatransfer.googleapis.com/TransferConfig
    methodTypes:
    - CREATE
    - UPDATE
    condition: resource.dataSourceId == "google_ads" && resource.dataRefreshWindowDays < 3
    actionType: DENY
    displayName: Google Ads transfers data refresh window must be greater than three days
    description: Disallow creating Google Ads data transfer configurations whose data refresh window is less than three days.

    Recursos suportados pelo Serviço de transferência de dados do BigQuery

    A tabela seguinte apresenta os recursos do Serviço de transferência de dados do BigQuery que pode referenciar em restrições personalizadas.

    Recurso Campo
    bigquerydatatransfer.googleapis.com/TransferConfig resource.dataRefreshWindowDays
    resource.dataSourceId
    resource.destinationDatasetId
    resource.disabled
    resource.displayName
    resource.emailPreferences.enableFailureEmail
    resource.encryptionConfiguration.kmsKeyName
    resource.name
    resource.notificationPubsubTopic
    resource.schedule
    resource.scheduleOptions.disableAutoScheduling
    resource.scheduleOptions.endTime
    resource.scheduleOptions.startTime
    resource.scheduleOptionsV2.eventDrivenSchedule.pubsubSubscription
    resource.scheduleOptionsV2.timeBasedSchedule.endTime
    resource.scheduleOptionsV2.timeBasedSchedule.schedule
    resource.scheduleOptionsV2.timeBasedSchedule.startTime

    O que se segue?