Este documento fornece uma referência de permissões do Identity and Access Management (IAM) para recursos do Knowledge Catalog. Use essas permissões para criar papéis personalizados ou verificar o acesso granular necessário para gerenciamento de metadados, verificações de dados, operações de lake, tarefas e ambientes.
Permissões e papéis
Você não concede permissões diretamente aos usuários. Em vez disso, você concede papéis, que têm uma ou mais permissões. Essa abordagem está alinhada ao princípio de privilégio mínimo, incentivando você a conceder apenas o acesso necessário para que um usuário ou uma conta de serviço execute as tarefas.
O IAM oferece papéis predefinidos para casos de uso comuns. Se esses papéis predefinidos não atenderem às suas necessidades específicas, crie seus próprios papéis personalizados contendo apenas as permissões específicas necessárias.
Para mais informações sobre os papéis predefinidos do Knowledge Catalog e as permissões que eles contêm, consulte Papéis do IAM do Knowledge Catalog.
Para uma descrição detalhada do IAM e dos recursos dele, consulte a documentação do IAM.
Permissões de definição e recebimento da política do IAM
A tabela a seguir lista as permissões necessárias para receber e definir permissões do IAM:
| Recurso | Método de API | Permissão do IAM |
|---|---|---|
| Tipos de aspecto | GetIamPolicy |
dataplex.aspectTypes.getIamPolicy |
| Tipos de aspecto | SetIamPolicy |
dataplex.aspectTypes.setIamPolicy |
| Grupos de entradas | GetIamPolicy |
dataplex.entryGroups.getIamPolicy |
| Grupos de entradas | SetIamPolicy |
dataplex.entryGroups.setIamPolicy |
| Tipos de entrada | GetIamPolicy |
dataplex.entryTypes.getIamPolicy |
| Tipos de entrada | SetIamPolicy |
dataplex.entryTypes.setIamPolicy |
| Lakes | GetIamPolicy |
dataplex.lakes.getIamPolicy |
| Lakes | SetIamPolicy |
dataplex.lakes.setIamPolicy |
Permissões de gerenciamento de metadados
O conjunto de permissões necessárias para realizar operações em tipos de entrada, tipos de link de entrada, tipos de aspecto, grupos de entrada, entradas e links de entrada depende se os recursos são do sistema ou personalizados. Os recursos do sistema são definidos pelo Knowledge Catalog, e os recursos personalizados são definidos por você ou pela sua organização.
Para enriquecer entradas e links de entrada com mais informações, anexe aspectos.
Para realizar operações relacionadas a vários recursos (por exemplo, criar uma entrada de um tipo de entrada específico ou adicionar um aspecto de um tipo de aspecto específico a uma entrada ou link de entrada), talvez sejam necessárias várias permissões associadas aos recursos.
Tipos de entrada
Para criar e gerenciar tipos de entrada, você precisa receber pelo menos as permissões padrão
create, get, list, update e delete.
Ao criar um tipo de entrada, você precisa receber permissões para usar cada tipo de aspecto que quer marcar como obrigatório para esse tipo de entrada.
Para usar um tipo de entrada (por exemplo, para criar entradas de um tipo de entrada), é necessário
ter a permissão use no tipo de entrada.
A tabela a seguir lista as permissões necessárias para operar em tipos de entrada:
| Operação | Permissão do IAM |
|---|---|
Create entry types |
|
Delete entry types |
|
Get entry types |
dataplex.entryTypes.get |
List entry types |
dataplex.entryTypes.list |
Update entry types |
|
|
Usar tipos de entrada (ao criar entradas, atualizar campos de entrada de nível superior e valores de tipo de aspecto obrigatórios) |
|
Tipos de aspecto
Para criar e gerenciar tipos de aspecto, você precisa receber as permissões padrão create,
get, list, update e delete.
Para usar um tipo de aspecto (por exemplo, para anexá-lo como um aspecto opcional em uma
entrada ou atualizar o aspecto obrigatório no link de entrada), é necessário receber a
permissão use no tipo de aspecto.
Os tipos de aspecto são categorizados em tipos de aspecto do sistema e tipos de aspecto personalizados. Os tipos de aspecto do sistema são criados pelo Knowledge Catalog, e os tipos de aspecto personalizados são criados por você ou pela sua organização. Os tipos de aspecto do sistema são categorizados em utilizáveis e somente leitura. Para mais informações, consulte Categorias de tipos de aspecto.
A tabela a seguir lista as permissões necessárias para operar em tipos de aspecto personalizados e do sistema:
| Operação | Permissões necessárias para tipos de aspecto personalizados | Permissões necessárias para tipos de aspecto do sistema utilizáveis | Permissões necessárias para tipos de aspecto do sistema somente leitura |
|---|---|---|---|
Create aspect types |
dataplex.aspectTypes.create |
Não relevante | Não relevante |
Delete aspect types |
dataplex.aspectTypes.delete |
Não relevante | Não relevante |
Get aspect types |
dataplex.aspectTypes.get |
Concedido a allUsers |
Concedido a allUsers |
List aspect types |
dataplex.aspectTypes.list |
Não relevante | Não relevante |
| Ao criar ou atualizar entradas, defina valores opcionais de tipo de aspecto |
|
|
Não relevante |
| Ao criar ou atualizar entradas, defina os valores de tipo de aspecto obrigatórios |
|
|
Não relevante |
Update aspect types |
dataplex.aspectTypes.update |
N/A | N/A |
| Definir valores de tipo de aspecto obrigatórios ao criar ou atualizar o link de entrada | N/A |
|
N/A |
Grupos de entradas
Para criar e gerenciar grupos de entradas, você precisa receber as permissões padrão create,
get, list, update e delete.
Os grupos de entrada são categorizados em grupos de entrada do sistema, criados pelo Knowledge Catalog, e grupos de entrada personalizados, criados por você ou pela sua organização. Para mais informações, consulte Categorias de grupos de entrada.
A tabela a seguir lista as permissões necessárias para operar em grupos de entradas:
| Operação | Permissões necessárias para grupos de entrada personalizados | Permissões necessárias para grupos de entrada do sistema (começando com @) |
|---|---|---|
Create entry groups |
dataplex.entryGroups.create |
Não relevante |
Delete entry groups |
dataplex.entryGroups.delete |
Não relevante |
Get entry groups |
dataplex.entryGroups.get |
dataplex.entryGroups.get |
List entry groups |
dataplex.entryGroups.list |
dataplex.entryGroups.list |
Update entry groups |
dataplex.entryGroups.update |
Não relevante |
Entradas
Para criar e gerenciar entradas, você precisa receber as permissões padrão create, get,
list, update e delete.
Observe o seguinte:
- Para os métodos de pesquisa (
<code>LookupEntry</code>) e busca (<code>SearchEntries</code>), a permissão do sistema de origem original é necessária na entrada. Por exemplo, se a origem for uma tabela do BigQuery, você vai precisar da permissãobigquery.tables.getpara visualizar metadados ebigquery.tables.getDatapara visualizar aspectos de dados. - Se a permissão para visualizar aspectos de dados não estiver presente, as entradas ainda estarão visíveis, mas o conteúdo dos aspectos de dados ficará oculto.
- Ao criar uma entrada ou atualizar os campos de nível superior dela, você precisa receber a permissão
useno tipo de entrada. - Ao criar ou atualizar um aspecto obrigatório, você precisa receber a permissão
useno tipo de entrada de uma entrada, bem como no tipo de aspecto subjacente. Isso ocorre porque os aspectos obrigatórios são aplicados pelo tipo de entrada. - Ao criar, atualizar ou excluir um aspecto opcional, você precisa receber
a permissão
useno tipo de aspecto de um aspecto. - Ao fazer upsert de uma entrada (
<code>UpdateEntry</code>com<code>allow_missing = True</code>), você precisa receber a permissãocreate.
Para mais informações sobre os tipos de entrada em que as entradas se baseiam, consulte Categorias de tipos de entrada.
A tabela a seguir lista as permissões necessárias para operar em entradas:
| Operação | Entrada com base no tipo de entrada personalizada | Entrada com base no tipo de entrada do sistema utilizável | Entrada com base no tipo de entrada do sistema somente leitura |
|---|---|---|---|
Create entries |
|
|
Não relevante |
Get entries |
Para visualizar os aspectos de dados,
|
Para visualizar os aspectos de dados,
|
Para visualizar os aspectos de dados,
|
List entries |
dataplex.entries.list |
dataplex.entries.list |
dataplex.entries.list |
Lookup entries |
Requer permissão de leitura de metadados do sistema de origem. É necessário ter permissão para ler dados do sistema de origem para visualizar os aspectos de dados. Para entradas personalizadas, em que o Knowledge Catalog é tratado como o sistema de origem, essas permissões são |
Requer permissão de leitura de metadados do sistema de origem. A permissão para ler dados do sistema de origem é necessária para visualizar os aspectos de dados. Para entradas personalizadas, em que o Knowledge Catalog é tratado como o sistema de origem, essas permissões são |
Requer permissão de leitura de metadados do sistema de origem. É necessário ter permissão para ler dados do sistema de origem para visualizar os aspectos de dados. Para entradas personalizadas, em que o Knowledge Catalog é tratado como o sistema de origem, essas permissões são |
Search entries |
Permissão de leitura do sistema de origem original. Para entradas personalizadas, é |
Permissão de leitura do sistema de origem original. Para entradas personalizadas, é |
Permissão de leitura do sistema de origem original. Para entradas personalizadas, é |
Update entries |
|
|
Não é possível editar os campos de nível superior e os aspectos obrigatórios. |
Links de entrada
Para criar e gerenciar links de entrada, você precisa receber as permissões create, get, list
e delete em dataplex.entryLinks.
Observe o seguinte:
- A criação de links de entrada (
CreateEntryLink) também requer permissões no tipo de link de entrada e permissões para as entradas específicas do link. - Ao criar um link de entrada com um aspecto obrigatório, você precisa das permissões para usar o tipo de aspecto.
- Ao fazer upsert de um link de entrada (
UpdateEntryLinkcomallow_missing = True), você também precisa ter as mesmas permissões necessárias paraCreateEntryLink.
A tabela a seguir lista as permissões necessárias para operar em links de entrada:
| Operação | Permissão do IAM |
|---|---|
| Criar links de entrada |
Permissões necessárias com base no tipo de link de entrada:
Permissão para usar o tipo de link de entrada:
Permissões para todos os aspectos obrigatórios especificados pelo tipo de link de entrada:
|
| Excluir links de entrada | dataplex.entryLinks.delete (no grupo de entrada) |
| Receber links de entrada |
|
| Links de entrada de pesquisa |
Requer permissão de leitura de metadados do sistema de origem na entrada para que os links de entrada sejam procurados. Para entradas personalizadas vinculadas, em que o Knowledge Catalog é tratado como o sistema de origem, as permissões são Para entradas de sistema vinculadas, a permissão é permissão de leitura do sistema de origem da entrada vinculada. |
| Atualizar link de entrada |
Permissão para usar o tipo de link de entrada:
Permissões para todos os aspectos obrigatórios especificados pelo tipo de link de entrada:
Se |
Limitações de aspectos em links de entrada
As limitações a seguir se aplicam ao uso de aspectos com links de entrada.
Conjuntos de contexto
Os conjuntos de contexto são contêineres limitados de recursos de dados de destino e metadados usados para embasar modelos de IA na sua lógica de negócios proprietária. Embora possam conter informações específicas do banco de dados, como modelos de consulta SQL ou consultas de pesquisa de valor para ferramentas de texto para SQL, como o QueryData, o Knowledge Studio também usa conjuntos de contexto para armazenar glossários de terminologia, visões gerais de tabelas estruturadas e mapeamentos de dados corporativos.
Para mais informações sobre como os conjuntos de contexto são usados no Google Cloud, consulte a visão geral dos conjuntos de contexto para o Knowledge Studio, o AlloyDB para PostgreSQL, o Cloud SQL para MySQL, o Cloud SQL para PostgreSQL ou o Spanner.
Para criar e gerenciar conjuntos de contexto para embasamento de IA, você precisa receber os seguintes papéis do IAM:
- Leitor do Dataplex Catalog (
roles/dataplex.catalogViewer): acesso somente leitura para visualizar, listar e baixar conjuntos de contexto, além de visualizar locais. - Editor do Dataplex Catalog (
roles/dataplex.catalogEditor): acesso para atualizar, excluir, fazer upload e download de conjuntos de contexto. - Administrador do catálogo do Dataplex (
roles/dataplex.catalogAdmin) ou Proprietário do grupo de entrada do Dataplex (roles/dataplex.entryGroupOwner): acesso administrativo total aos conjuntos de contexto, incluindo a permissãodataplex.entryGroups.setIamPolicynecessária para criar conjuntos de contexto.
A tabela a seguir lista as permissões do IAM necessárias para operar em conjuntos de contexto:
| Operação | Permissão do IAM |
|---|---|
| Criar conjuntos de contexto | dataplex.entryGroups.createContextSet |
| Excluir conjuntos de contexto | dataplex.entryGroups.deleteContextSet |
| Ler conjuntos de contexto | dataplex.entryGroups.getContextSet |
| Atualizar conjuntos de contexto | dataplex.entryGroups.updateContextSet |
| Mudanças no contexto da solicitação | dataplex.entryGroups.requestContextChanges |
| Criar entradas de contexto | dataplex.entries.createContext |
| Excluir entradas de contexto | dataplex.entries.deleteContext |
| Ler entradas de contexto | dataplex.entries.getContext |
| Listar entradas de contexto | dataplex.entries.listContext |
| Atualizar entradas de contexto | dataplex.entries.updateContext |
Para mais informações, consulte Papéis do IAM do Knowledge Catalog.
Permissões de job de metadados
A tabela a seguir lista as permissões necessárias para trabalhar com jobs de importação de metadados e jobs de exportação de metadados.
| Operação | Permissão do IAM |
|---|---|
| Acessar os resultados exportados de jobs de exportação de metadados |
|
Cancel metadata jobs |
|
Create metadata export jobs |
|
Create metadata import jobs |
|
Get metadata jobs |
|
List metadata jobs |
|
Tipos de aspecto, de entrada e de link de entrada do sistema
Cada tipo de aspecto, tipo de entrada e tipo de link de entrada definido pelo sistema tem as próprias permissões do IAM. Essas permissões
usam um formato como dataplex.entryGroups.useASPECT_TYPE,
dataplex.entryGroups.useENTRY_TYPE ou
dataplex.entryGroups.useENTRY_LINK_TYPE. Por exemplo,
a permissão para o tipo de aspecto do sistema overview é
dataplex.entryGroups.useOverviewAspect.
A tabela a seguir lista as permissões que se aplicam a tipos de aspecto, tipos de entrada e tipos de link de entrada definidos pelo sistema.
| Recurso | Permissão do IAM |
|---|---|
contacts (tipo de aspecto do sistema) |
dataplex.entryGroups.useContactsAspect |
data-profile (tipo de aspecto do sistema) |
dataplex.entryGroups.useDataProfileAspect |
data-quality-rule-template (tipo de aspecto do sistema) |
dataplex.entryGroups.useDataQualityRuleTemplateAspect |
data-quality-scorecard (tipo de aspecto do sistema) |
dataplex.entryGroups.useDataQualityScorecardAspect |
data-rules (tipo de aspecto do sistema) |
dataplex.entryGroups.useDataRulesAspect |
generic (tipo de aspecto do sistema) |
dataplex.entryGroups.useGenericAspect |
guidelines (tipo de aspecto do sistema) |
dataplex.entryGroups.useGuidelinesAspect |
overview (tipo de aspecto do sistema) |
dataplex.entryGroups.useOverviewAspect |
schema (tipo de aspecto do sistema) |
dataplex.entryGroups.useSchemaAspect |
schema-join (tipo de aspecto do sistema) |
dataplex.entryGroups.useSchemaJoinAspect |
generic (tipo de entrada do sistema) |
dataplex.entryGroups.useGenericEntry |
definition (tipo de link de entrada do sistema) |
dataplex.entryGroups.useDefinitionEntryLink |
related (tipo de link de entrada do sistema) |
dataplex.entryGroups.useRelatedEntryLink |
synonym (tipo de link de entrada do sistema) |
dataplex.entryGroups.useSynonymEntryLink |
schema-join (tipo de link de entrada do sistema) |
dataplex.entryGroups.useSchemaJoinEntryLink |
Permissões de lake, zona e recurso
A tabela a seguir lista as permissões necessárias para operar em lakes, zonas e recursos:
| Método de API | Permissão do IAM |
|---|---|
CreateAsset |
dataplex.assets.create |
CreateLake |
dataplex.lakes.create |
CreateZone |
dataplex.zones.create |
DeleteAsset |
dataplex.assets.delete |
DeleteLake |
dataplex.lakes.delete |
DeleteZone |
dataplex.zones.delete |
GetAsset |
dataplex.assets.get |
GetLake |
dataplex.lakes.get |
GetZone |
dataplex.zones.get |
ListAssetActions |
dataplex.assetActions.list |
ListAssets |
dataplex.assets.list |
ListLakeActions |
dataplex.lakeActions.list |
ListLakes |
dataplex.lakes.list |
ListZoneActions |
dataplex.zoneActions.list |
ListZones |
dataplex.zones.list |
UpdateAsset |
dataplex.assets.update |
UpdateLake |
dataplex.lakes.update |
UpdateZone |
dataplex.zones.update |
Permissões de tarefas
A tabela a seguir lista as permissões necessárias para operar em tarefas:
| Método de API | Permissão do IAM |
|---|---|
CancelJob |
dataplex.tasks.cancel |
CreateTask |
dataplex.tasks.create |
DeleteTask |
dataplex.tasks.delete |
GetJob |
dataplex.tasks.get |
GetTask |
dataplex.tasks.get |
ListJobs |
dataplex.tasks.get |
ListTasks |
dataplex.tasks.list |
UpdateTask |
dataplex.tasks.update |
Permissões de metadados
A tabela a seguir lista as permissões necessárias para operar em entidades e partições:
| Método de API | Permissão do IAM |
|---|---|
CreateEntity |
dataplex.entities.create |
CreatePartition |
dataplex.partitions.create |
DeleteEntity |
dataplex.entities.delete |
DeletePartition |
dataplex.partitions.delete |
GetEntity |
dataplex.entities.get |
GetPartition |
dataplex.partitions.get |
ListEntities |
dataplex.entities.list |
ListPartitions |
dataplex.partitions.list |
Permissões de verificação de dados
A tabela a seguir lista as permissões necessárias para operar em verificações de dados:
| Método de API | Permissão do IAM |
|---|---|
CancelDataScanJob |
dataplex.datascans.cancel |
CreateDataScan |
dataplex.datascans.create |
DeleteDataScan |
dataplex.datascans.delete |
GetDataScan (visualização básica) |
dataplex.datascans.get |
GetDataScan (visualização completa) |
dataplex.datascans.getData |
GetDataScanJob (visualização básica) |
dataplex.datascans.get |
GetDataScanJob (visualização completa) |
dataplex.datascans.getData |
ListDataScanJobs |
dataplex.datascans.get |
ListDataScans |
dataplex.datascans.list |
RunDataScan |
dataplex.datascans.run |
UpdateDataScan |
dataplex.datascans.update |
Tarefas de enriquecimento do Knowledge Studio
As seguintes permissões são necessárias para criar e gerenciar tarefas de enriquecimento do Knowledge Studio:
| Operação | Permissão do IAM |
|---|---|
| Criar tarefas de enriquecimento | dataplex.agentTasks.create |
| Excluir tarefas de enriquecimento | dataplex.agentTasks.delete |
| Ler detalhes da tarefa de enriquecimento | dataplex.agentTasks.get |
| Ler e buscar resultados de dados subjacentes | dataplex.agentTasks.getData |
| Listar tarefas de enriquecimento | dataplex.agentTasks.list |
| Atualizar tarefas de enriquecimento | dataplex.agentTasks.update |
| Executar tarefas de enriquecimento | dataplex.agentTasks.run |
| Solicitar mudanças em grupos de entrada (propostas) | dataplex.entryGroups.requestChanges |
| Aprovar solicitações de mudança de metadados | dataplex.changeRequests.use |
| Cancelar execuções de tarefas de enriquecimento | dataplex.agentTasks.cancel |
Permissões de provedores de autenticação de terceiros
Ao configurar conectores externos, as seguintes permissões de identidade do agente são necessárias para gerenciar provedores de autenticação:
| Operação | Permissão do IAM |
|---|---|
| Criar provedores de autenticação | agentidentity.authProviders.create |
| Ver detalhes do provedor de autenticação | agentidentity.authProviders.get |
| Excluir provedores de autenticação | agentidentity.authProviders.delete |
| Atualizar provedores de autenticação | agentidentity.authProviders.update |
Permissões de criação de perfil do BigQuery
Para permitir que o agente de enriquecimento realize a criação de perfil de dados do BigQuery
e leia o histórico de consultas da tabela, conceda os papéis de Leitor de dados do BigQuery
(roles/bigquery.dataViewer) e Leitor de recursos do BigQuery
(roles/bigquery.resourceViewer) ao Agente de serviço do catálogo de conhecimento
(service-<var>PROJECT_NUMBER</var>@gcp-sa-dataplex.iam.gserviceaccount.com) do projeto de destino.