Visão geral do IAM

Com o Identity and Access Management (IAM), você controla o acesso do usuário e do grupo aos recursos do Spanner nos níveis do projeto, da instância e do banco de dados do Spanner. Por exemplo, você pode especificar que um usuário tenha controle total de um banco de dados específico em uma instância do seu projeto, mas não possa criar, modificar ou excluir instâncias no projeto. O uso do controle de acesso com o IAM permite conceder uma permissão a um usuário ou grupo sem ter que modificar cada instância do Spanner ou permissão de banco de dados individualmente.

Este documento se concentra nas permissões do IAM relevantes ao Spanner e nos papéis do IAM que concedem essas permissões. Para uma descrição detalhada do IAM e dos recursos dele, consulte o guia para desenvolvedores de Identity and Access Management. Consulte especificamente a seção Como gerenciar políticas do IAM.

Permissões

Com elas, os usuários executam ações específicas nos recursos do Spanner. Por exemplo, a permissão spanner.databases.read permite que um usuário leia em um banco de dados usando a API de leitura do Spanner, enquanto spanner.databases.select permite que um usuário execute uma instrução SELECT do SQL em um banco de dados. Não é possível dar permissões diretamente a usuários. Em vez disso, concede a eles papéis predefinidos ou personalizados, com uma ou mais permissões agrupadas.

As tabelas a seguir listam as permissões do IAM associadas ao Spanner.

Configurações da instância

As permissões a seguir se aplicam às configurações de instâncias do Spanner. Para mais informações, consulte as referências de configuração de instância para APIs REST e RPC.

Nome da permissão de configuração da instância	Descrição
spanner.instanceConfigs.create	Criar uma configuração de instância personalizada.
spanner.instanceConfigs.delete	Excluir uma configuração de instância personalizada.
spanner.instanceConfigs.get	Recebe uma configuração de instância.
spanner.instanceConfigs.list	Lista o conjunto de configurações de instância.
spanner.instanceConfigs.update	Atualizar uma configuração de instância personalizada.

Operações de configuração da instância

As permissões a seguir se aplicam às operações de configuração da instância do Spanner. Para mais informações, consulte as referências de instância para APIs REST e RPC.

Nome da permissão de operação de configuração da instância	Descrição
spanner.instanceConfigOperations.list	Lista operações de configuração da instância.
spanner.instanceConfigOperations.get	Recebe uma operação de configuração de instância específica.
spanner.instanceConfigOperations.cancel	Cancelar uma operação de configuração da instância.
spanner.instanceConfigOperations.delete	Exclui uma operação de configuração de instância.

Instâncias

As permissões a seguir se aplicam às instâncias do Spanner. Para mais informações, consulte as referências de instância para APIs REST e RPC.

Nome da permissão de instância	Descrição
spanner.instances.create	Cria uma instância.
spanner.instances.list	Lista instâncias.
spanner.instances.get	Recebe a configuração de uma instância específica.
spanner.instances.getIamPolicy	Recebe uma política do IAM da instância.
spanner.instances.update	Atualiza uma instância.
spanner.instances.setIamPolicy	Define a política do IAM de uma instância.
spanner.instances.delete	Exclui uma instância.

Operações de instância

As permissões a seguir se aplicam às operações da instância do Spanner. Para mais informações, consulte as referências de instância para APIs REST e RPC.

Nome da permissão da operação da instância	Descrição
spanner.instanceOperations.list	Lista operações de instâncias.
spanner.instanceOperations.get	Recebe uma operação de instância específica.
spanner.instanceOperations.cancel	Cancela uma operação de instância.
spanner.instanceOperations.delete	Exclui uma operação de instância.

Bancos de dados

As permissões a seguir se aplicam aos bancos de dados do Spanner. Para mais informações, consulte as referências de banco de dados para APIs REST e RPC.

Nome da permissão do banco de dados	Descrição
spanner.databases.beginPartitionedDmlTransaction	Executa uma declaração de linguagem de manipulação de dados (DML, na sigla em inglês) particionada.
spanner.databases.create	Cria um banco de dados.
spanner.databases.createBackup	Cria um backup a partir do banco de dados. Também requer spanner.backups.create para criar o recurso de backup.
spanner.databases.list	Lista bancos de dados
spanner.databases.update	Atualiza os metadados de um banco de dados. No momento, indisponível para papéis personalizados do IAM.
spanner.databases.updateDdl	Atualiza o esquema de um banco de dados.
spanner.databases.get	Recebe os metadados de um banco de dados.
spanner.databases.getDdl	Recebe o esquema de um banco de dados.
spanner.databases.getIamPolicy	Recebe a política do IAM de um banco de dados.
spanner.databases.setIamPolicy	Define a política do IAM de um banco de dados.
spanner.databases.beginReadOnlyTransaction	Inicie uma transação somente leitura em um banco de dados do Spanner.
spanner.databases.beginOrRollbackReadWriteTransaction	Inicie ou reverter uma transação de leitura e gravação em um banco de dados do Spanner.
spanner.databases.read	Lê de um banco de dados usando a API de leitura.
spanner.databases.select	Executa uma instrução de seleção do SQL em um banco de dados.
spanner.databases.write	Grava em um banco de dados.
spanner.databases.drop	Remove um banco de dados.
spanner.databases.useRoleBasedAccess	Usar controle de acesso detalhado.
spanner.databases.useDataBoost	Use os recursos de computação do Spanner Data Boost para processar consultas particionadas.

Papéis de banco de dados

As permissões a seguir se aplicam aos papéis de banco de dados do Spanner. Para mais informações, consulte as referências de banco de dados para APIs REST e RPC.

Nome da permissão do papel do banco de dados	Descrição
spanner.databaseRoles.list	Listar os papéis do banco de dados.
spanner.databaseRoles.use	Usar um papel de banco de dados especificado.

Operações de banco de dados

As permissões a seguir se aplicam às operações do banco de dados do Spanner. Para mais informações, consulte as referências de banco de dados para APIs REST e RPC.

Nome da permissão de operação do banco de dados	Descrição
spanner.databaseOperations.list	Lista banco de dados e restaura operações de banco de dados.
spanner.databaseOperations.get	Recebe uma operação de banco de dados específica.
spanner.databaseOperations.cancel	Cancela uma operação do banco de dados.

Backups

As permissões a seguir se aplicam aos backups do Spanner. Para mais informações, consulte as referências de backups para APIs REST e RPC.

Nome da permissão de backup	Descrição
spanner.backups.create	Criar um backup. Também requer spanner.databases.createBackup no banco de dados de origem.
spanner.backups.get	Recebe um backup.
spanner.backups.update	Atualiza um backup.
spanner.backups.delete	Exclui um backup
spanner.backups.list	Lista backups
spanner.backups.restoreDatabase	Restaura um banco de dados a partir de um backup. Também requer spanner.databases.create para criar o banco de dados restaurado na instância de destino.
spanner.backups.getIamPolicy	Recebe a política do IAM de backup.
spanner.backups.setIamPolicy	Define a política do IAM de backup.

Operações de backup

As permissões a seguir se aplicam às operações de backup do Spanner. Para mais informações, consulte as referências de banco de dados para APIs REST e RPC.

Nome da permissão da operação de backup	Descrição
spanner.backupOperations.list	Lista operações de backup.
spanner.backupOperations.get	Recebe uma operação de backup específica.
spanner.backupOperations.cancel	Cancela uma operação de backup.

Sessões

As permissões a seguir se aplicam às sessões do Spanner. Para mais informações, consulte as referências de banco de dados para APIs REST e RPC.

Observação: as sessões são um conceito avançado que só se aplica aos usuários da API REST e àqueles que estiverem criando as próprias bibliotecas de cliente. Saiba mais em Sessões.

Nome da permissão da sessão	Descrição
spanner.sessions.create	Cria uma sessão.
spanner.sessions.get	Recebe uma sessão.
spanner.sessions.delete	Exclui uma sessão.
spanner.sessions.list	Lista sessões.

Papéis predefinidos

Papel predefinido é um pacote de uma ou mais permissões. Por exemplo, o papel predefinido roles/spanner.databaseUser contém as permissões spanner.databases.read e spanner.databases.write. Há dois tipos de papéis predefinidos para o Spanner:

• Papéis de pessoa: concedidos a usuários ou grupos, permitem que eles realizem ações nos recursos do projeto.
• Papéis de máquina: concedidos a contas de serviço, permitem que as máquinas executadas como aquelas contas de serviço realizem ações nos recursos do projeto.

Observação :para não fornecer permissões desnecessariamente amplas às máquinas, não conceda papéis de pessoa a contas de serviço.

A tabela a seguir lista o controle de acesso com papéis predefinidos do IAM, incluindo uma lista das permissões associadas a cada papel:

Role	Permissions
Cloud Spanner Admin (roles/spanner.admin) Has complete access to all Spanner resources in a Google Cloud project. A principal with this role can: Grant and revoke permissions to other principals for all Spanner resources in the project. Allocate and delete chargeable Spanner resources. Issue get/list/modify operations on Cloud Spanner resources. Read from and write to all Cloud Spanner databases in the project. Fetch project metadata. Lowest-level resources where you can grant this role: Project	monitoring.timeSeries.list resourcemanager.projects.get resourcemanager.projects.list spanner.* spanner.backupOperations.cancel spanner.backupOperations.get spanner.backupOperations.list spanner.backups.copy spanner.backups.create spanner.backups.delete spanner.backups.get spanner.backups.getIamPolicy spanner.backups.list spanner.backups.restoreDatabase spanner.backups.setIamPolicy spanner.backups.update spanner.databaseOperations.cancel spanner.databaseOperations.delete spanner.databaseOperations.get spanner.databaseOperations.list spanner.databaseRoles.list spanner.databaseRoles.use spanner.databases.beginOrRollbackReadWriteTransaction spanner.databases.beginPartitionedDmlTransaction spanner.databases.beginReadOnlyTransaction spanner.databases.create spanner.databases.createBackup spanner.databases.drop spanner.databases.get spanner.databases.getDdl spanner.databases.getIamPolicy spanner.databases.list spanner.databases.partitionQuery spanner.databases.partitionRead spanner.databases.read spanner.databases.select spanner.databases.setIamPolicy spanner.databases.update spanner.databases.updateDdl spanner.databases.updateTag spanner.databases.useDataBoost spanner.databases.useRoleBasedAccess spanner.databases.write spanner.instanceConfigOperations.cancel spanner.instanceConfigOperations.delete spanner.instanceConfigOperations.get spanner.instanceConfigOperations.list spanner.instanceConfigs.create spanner.instanceConfigs.delete spanner.instanceConfigs.get spanner.instanceConfigs.list spanner.instanceConfigs.update spanner.instanceOperations.cancel spanner.instanceOperations.delete spanner.instanceOperations.get spanner.instanceOperations.list spanner.instances.create spanner.instances.createTagBinding spanner.instances.delete spanner.instances.deleteTagBinding spanner.instances.get spanner.instances.getIamPolicy spanner.instances.list spanner.instances.listEffectiveTags spanner.instances.listTagBindings spanner.instances.setIamPolicy spanner.instances.update spanner.instances.updateTag spanner.sessions.create spanner.sessions.delete spanner.sessions.get spanner.sessions.list
Cloud Spanner Backup Admin (roles/spanner.backupAdmin) A principal with this role can: Create, view, update, and delete backups. View and manage a backup's allow policy. This role cannot restore a database from a backup. Lowest-level resources where you can grant this role: Instance	monitoring.timeSeries.list resourcemanager.projects.get resourcemanager.projects.list spanner.backupOperations.* spanner.backupOperations.cancel spanner.backupOperations.get spanner.backupOperations.list spanner.backups.copy spanner.backups.create spanner.backups.delete spanner.backups.get spanner.backups.getIamPolicy spanner.backups.list spanner.backups.setIamPolicy spanner.backups.update spanner.databases.createBackup spanner.databases.get spanner.databases.list spanner.instances.createTagBinding spanner.instances.deleteTagBinding spanner.instances.get spanner.instances.list spanner.instances.listEffectiveTags spanner.instances.listTagBindings
Cloud Spanner Backup Writer (roles/spanner.backupWriter) This role is intended to be used by scripts that automate backup creation. A principal with this role can create backups, but cannot update or delete them. Lowest-level resources where you can grant this role: Instance	spanner.backupOperations.get spanner.backupOperations.list spanner.backups.copy spanner.backups.create spanner.backups.get spanner.backups.list spanner.databases.createBackup spanner.databases.get spanner.databases.list spanner.instances.get
Cloud Spanner Database Admin (roles/spanner.databaseAdmin) A principal with this role can: Get/list all Spanner instances in the project. Create/list/drop databases in an instance. Grant/revoke access to databases in the project. Read from and write to all Cloud Spanner databases in the project. Lowest-level resources where you can grant this role: Instance	monitoring.timeSeries.list resourcemanager.projects.get resourcemanager.projects.list spanner.databaseOperations.* spanner.databaseOperations.cancel spanner.databaseOperations.delete spanner.databaseOperations.get spanner.databaseOperations.list spanner.databaseRoles.* spanner.databaseRoles.list spanner.databaseRoles.use spanner.databases.beginOrRollbackReadWriteTransaction spanner.databases.beginPartitionedDmlTransaction spanner.databases.beginReadOnlyTransaction spanner.databases.create spanner.databases.drop spanner.databases.get spanner.databases.getDdl spanner.databases.getIamPolicy spanner.databases.list spanner.databases.partitionQuery spanner.databases.partitionRead spanner.databases.read spanner.databases.select spanner.databases.setIamPolicy spanner.databases.update spanner.databases.updateDdl spanner.databases.updateTag spanner.databases.useDataBoost spanner.databases.useRoleBasedAccess spanner.databases.write spanner.instances.createTagBinding spanner.instances.deleteTagBinding spanner.instances.get spanner.instances.getIamPolicy spanner.instances.list spanner.instances.listEffectiveTags spanner.instances.listTagBindings spanner.sessions.* spanner.sessions.create spanner.sessions.delete spanner.sessions.get spanner.sessions.list
Cloud Spanner Database Reader (roles/spanner.databaseReader) A principal with this role can: Read from the Spanner database. Execute SQL queries on the database. View schema for the database. Lowest-level resources where you can grant this role: Database	spanner.databases.beginReadOnlyTransaction spanner.databases.getDdl spanner.databases.partitionQuery spanner.databases.partitionRead spanner.databases.read spanner.databases.select spanner.instances.get spanner.sessions.* spanner.sessions.create spanner.sessions.delete spanner.sessions.get spanner.sessions.list
Cloud Spanner Database Role User (roles/spanner.databaseRoleUser) In conjunction with the IAM role Cloud Spanner Fine-grained Access User, grants permissions to individual Spanner database roles. Add a condition for each desired Spanner database role that includes the resource type of `spanner.googleapis.com/DatabaseRole` and the resource name ending with `/YOUR_SPANNER_DATABASE_ROLE`.	spanner.databaseRoles.use
Cloud Spanner Database User (roles/spanner.databaseUser) A principal with this role can: Read from and write to the Spanner database. Execute SQL queries on the database, including DML and Partitioned DML. View and update schema for the database. Lowest-level resources where you can grant this role: Database	spanner.databaseOperations.* spanner.databaseOperations.cancel spanner.databaseOperations.delete spanner.databaseOperations.get spanner.databaseOperations.list spanner.databases.beginOrRollbackReadWriteTransaction spanner.databases.beginPartitionedDmlTransaction spanner.databases.beginReadOnlyTransaction spanner.databases.getDdl spanner.databases.partitionQuery spanner.databases.partitionRead spanner.databases.read spanner.databases.select spanner.databases.updateDdl spanner.databases.updateTag spanner.databases.write spanner.instances.get spanner.sessions.* spanner.sessions.create spanner.sessions.delete spanner.sessions.get spanner.sessions.list
Cloud Spanner Fine-grained Access User (roles/spanner.fineGrainedAccessUser) Grants permissions to use Spanner's fine-grained access control framework. To grant access to specific database roles, also add the `roles/spanner.databaseRoleUser` IAM role and its necessary conditions.	spanner.databaseRoles.list spanner.databases.useRoleBasedAccess
Cloud Spanner Restore Admin (roles/spanner.restoreAdmin) A principal with this role can restore databases from backups. If you need to restore a backup to a different instance, apply this role at the project level or to both instances. This role cannot create backups. Lowest-level resources where you can grant this role: Instance	monitoring.timeSeries.list resourcemanager.projects.get resourcemanager.projects.list spanner.backups.get spanner.backups.list spanner.backups.restoreDatabase spanner.databaseOperations.cancel spanner.databaseOperations.get spanner.databaseOperations.list spanner.databases.create spanner.databases.get spanner.databases.list spanner.instances.createTagBinding spanner.instances.deleteTagBinding spanner.instances.get spanner.instances.list spanner.instances.listEffectiveTags spanner.instances.listTagBindings
Cloud Spanner Viewer (roles/spanner.viewer) A principal with this role can: View all Spanner instances (but cannot modify instances). View all Spanner databases (but cannot modify or read from databases). For example, you can combine this role with the roles/spanner.databaseUser role to grant a user with access to a specific database, but only view access to other instances and databases. This role is recommended at the Google Cloud project level for users interacting with Cloud Spanner resources in the Google Cloud console. Lowest-level resources where you can grant this role: Project	monitoring.timeSeries.list resourcemanager.projects.get resourcemanager.projects.list spanner.databases.list spanner.instanceConfigs.get spanner.instanceConfigs.list spanner.instances.get spanner.instances.list spanner.instances.listEffectiveTags spanner.instances.listTagBindings

Observação: quando o papel atribuído é spanner.databaseReader, as solicitações para uma transação somente leitura podem falhar de vez em quando com um erro de permissões. Para resolver esse problema, consulte Gerenciar a fração de sessões de gravação.

Papéis básicos

Papéis básicos são aqueles no nível do projeto que antecedem o IAM. Consulte Papéis básicos para mais detalhes.

Embora o Spanner ofereça suporte aos papéis básicos a seguir, é preciso usar um dos papéis predefinidos mostrados anteriormente sempre que possível. Os papéis básicos incluem permissões amplas que se aplicam a todos os recursos do Google Cloud. Por outro lado, os papéis predefinidos do Spanner incluem permissões refinadas que se aplicam apenas ao Spanner.

Papel básico	Descrição
roles/viewer	Pode listar e receber os metadados de esquemas e instâncias. Também pode ler e consultar usando SQL em um banco de dados.
roles/editor	Pode fazer tudo que um roles/viewer faz. Também pode criar instâncias e bancos de dados e gravar dados em um banco de dados.
roles/owner	Pode fazer tudo que um roles/editor faz. Também pode modificar o acesso a bancos de dados e instâncias.

papéis personalizados

Se os papéis predefinidos do Spanner não atenderem aos requisitos de negócios, você poderá definir os próprios papéis personalizados com as permissões especificadas.

Antes de criar um papel personalizado, identifique as tarefas que precisam ser executadas. Em seguida, identifique as permissões necessárias para cada tarefa e adicione-as ao papel personalizado.

Papéis personalizados para tarefas da conta de serviço

Para a maioria das tarefas, é evidente quais permissões você precisa adicionar ao papel personalizado. Por exemplo, se você quer que sua conta de serviço crie um banco de dados, adicione a permissão spanner.databases.create ao papel personalizado.

No entanto, ao ler ou gravar dados em uma tabela do Spanner, você precisa adicionar várias permissões diferentes ao seu papel personalizado. A tabela a seguir mostra quais permissões são obrigatórias para ler e gravar dados.

Tarefa da conta de serviço	Permissões necessárias
Ler dados	spanner.databases.select spanner.sessions.create spanner.sessions.delete
Inserir, atualizar ou excluir dados	spanner.databases.beginOrRollbackReadWriteTransaction spanner.databases.write spanner.sessions.create spanner.sessions.delete
Criar backup	spanner.backups.create spanner.databases.createBackup
Restaurar um banco de dados	spanner.databases.create spanner.backups.restoreDatabase

Papéis personalizados para tarefas do Console do Google Cloud

Para identificar a lista de permissões necessárias para uma determinada tarefa no Console do Google Cloud, determine o fluxo de trabalho dessa tarefa e compile as permissões dele. Por exemplo, para visualizar os dados em uma tabela, siga estas etapas no console do Google Cloud:

Etapa	Permissões
1. Acessar o projeto	resourcemanager.projects.get
2. Ver a lista de instâncias	spanner.instances.list
3. Selecionar uma instância	spanner.instances.get
4. Ver a lista de bancos de dados	spanner.databases.list
5. Selecionar um banco de dados e uma tabela	spanner.databases.getDdl
6. Ver dados em uma tabela	spanner.databases.select, spanner.sessions.create, spanner.sessions.delete

Neste exemplo, são necessárias estas permissões:

• resourcemanager.projects.get
• spanner.databases.getDdl
• spanner.databases.list
• spanner.databases.select
• spanner.instances.get
• spanner.instances.list
• spanner.sessions.create
• spanner.sessions.delete

A tabela a seguir lista as permissões necessárias para ações no console do Google Cloud.

Ação	Permissões
Ver a lista de instâncias na página "Instâncias"	resourcemanager.projects.get spanner.instances.list
Ver a lista na guia "Permissões" da página "Instâncias"	spanner.instances.getIamPolicy
Adicionar membros na guia "Permissões" da página "Instâncias"	spanner.instances.setIamPolicy
Selecionar uma instância na lista correspondente para visualizar a página "Detalhes da instância"	spanner.instances.get
Criar uma instância	spanner.instanceConfigs.list spanner.instanceOperations.get spanner.instances.create
Excluir uma instância	spanner.instances.delete
Modificar uma instância	spanner.instanceOperations.get spanner.instances.update
Ver os gráficos na guia "Monitor" da página "Detalhes da instância" ou na página "Detalhes do banco de dados"	monitoring.metricDescriptors.get monitoring.metricDescriptors.list monitoring.timeSeries.list spanner.instances.get
Ver a lista de bancos de dados na página "Detalhes da instância"	spanner.databases.list
Ver a lista na guia "Permissões" da página "Detalhes do banco de dados"	spanner.databases.getIamPolicy
Adicionar membros na guia "Permissões" da página "Detalhes do banco de dados"	spanner.databases.setIamPolicy
Selecionar um banco de dados na lista de bancos de dados e ver o esquema na página "Detalhes do banco de dados"	spanner.databases.get spanner.databases.getDdl
Criar um banco de dados	spanner.databases.create
Excluir um banco de dados	spanner.databases.drop
Criar uma tabela Atualizar um esquema de tabela	spanner.databaseOperations.get spanner.databaseOperations.list spanner.databases.updateDdl
Visualizar dados na guia "Dados" da página "Detalhes do banco de dados" Criar e executar uma consulta	spanner.databases.select spanner.sessions.create spanner.sessions.delete
Modificar dados em uma tabela	spanner.databases.beginOrRollbackReadWriteTransaction spanner.databases.select spanner.databases.write spanner.sessions.create spanner.sessions.delete
Ver a página "Backup/restauração"	spanner.backups.list spanner.backups.get
Ver a lista de operações de backup	spanner.backupOperations.list
Ver a lista de operações de restauração	spanner.databaseOperations.list
Criar backup	spanner.backups.create spanner.databases.createBackup spanner.databases.list^1 spanner.backupOperations.list^1
Restaurar um banco de dados a partir de um backup	spanner.instanceConfigs.list spanner.instances.get spanner.backups.get spanner.backups.restoreDatabase spanner.instances.list spanner.databases.create
Atualizar um backup	spanner.backups.update
Excluir um backup	spanner.backups.delete

¹ Obrigatório se você estiver criando um backup a partir da página **Backup/restauração** no nível da instância, e não no nível do banco de dados.

Gerenciamento de políticas do IAM do Spanner

É possível receber, definir e testar as políticas do IAM usando as APIs REST ou RPC na instância, no banco de dados e nos recursos de backup do Spanner.

Instâncias

API REST	API RPC
projects.instances.getIamPolicy	GetIamPolicy
projects.instances.setIamPolicy	SetIamPolicy
projects.instances.testIamPermissions	TestIamPermissions

Bancos de dados

API REST	API RPC
projects.instances.databases.getIamPolicy	GetIamPolicy
projects.instances.databases.setIamPolicy	SetIamPolicy
projects.instances.databases.testIamPermissions	TestIamPermissions

Backups

API REST	API RPC
projects.instances.backups.getIamPolicy	GetIamPolicy
projects.instances.backups.setIamPolicy	SetIamPolicy
projects.instances.backups.testIamPermissions	TestIamPermissions

A seguir

• Saiba mais sobre o gerenciamento de identidade e acesso.
• Saiba como aplicar papéis do IAM a um banco de dados do Spanner, uma instância ou um projeto do Google Cloud.
• Saiba como controlar o acesso pela Internet aos recursos do Google Cloud, incluindo o Spanner.