Migrar para a v2 da API Security Command Center

Esta página explica as diferenças entre a versão 1 (v1) e a versão 2 (v2) da API Security Command Center. Ele também explica como migrar para a API Security Command Center v2 em combinação com a API Security Command Center Management v1.

A partir de 9 de dezembro de 2024, se você ativar o Security Command Center em uma organização pela primeira vez, precisará usar apenas a versão 2 da API Security Command Center nessa organização. Não há suporte para versões anteriores.

Se você ativou o Security Command Center no nível do projeto antes de 9 de dezembro de 2024, todos os projetos ativados na mesma organização vão oferecer suporte a todas as versões disponíveis da API do Security Command Center.

Para todas as integrações com o Security Command Center, recomendamos que você adote a API Security Command Center v2 e a API de gerenciamento do Security Command Center v1. Recomendamos o uso das bibliotecas de cliente do Cloud ou do Google Cloud provedor Terraform para chamar essas APIs. Para ver mais informações, consulte os seguintes tópicos:

Diferenças entre as APIs v1 e v2

Ao migrar para a API Security Command Center v2, observe as seguintes diferenças em relação à API v1.

Residência dos dados

A API Security Command Center v2 oferece suporte à residência de dados, o que oferece mais controle sobre onde seus dados do Security Command Center estão localizados:

Mesmo que você não tenha ativado a residência de dados para sua organização, recomendamos chamar a versão sensível à localização de cada método e especificar o local global. Isso facilita a adoção da residência de dados no futuro.

Se você tiver ativado a residência de dados para sua organização, é necessário usar os métodos com reconhecimento de local e, se aplicável, o endpoint de serviço regional para o local selecionado.

Para usar a versão com localização de cada método, faça o seguinte:

Console

O console do Google Cloud usa a versão com localização de cada método sempre que necessário.

gcloud

Ao executar comandos da CLI da gcloud que permitem especificar um local, como gcloud scc findings list, sempre forneça um local. Há algumas maneiras de fazer isso:

  • Use a sinalização --location.
  • Se você fornecer o caminho completo do nome do recurso, use um formato que especifique um local, como projects/123/sources/456/locations/global/findings/a1b2c3.

Terraform

Sempre forneça o argumento location para recursos que ofereçam suporte a ele, como google_scc_v2_organization_mute_config.

REST

Chame a versão do método com locations no nome. Por exemplo, chame organizations.locations.findings.bulkMute em vez de organizations.findings.bulkMute.

Bibliotecas de cliente

Consulte os exemplos de código do Security Command Center ou a referência da API para sua biblioteca de cliente.

Configurações de notificação e de exportação do BigQuery

A API Security Command Center v1 permite criar e gerenciar os seguintes tipos de configurações de exportação:

Também é possível criar e gerenciar essas configurações de exportação com a API Security Command Center v2. No entanto, se você criar uma configuração de exportação com a API Security Command Center v1, ela não vai aparecer na API Security Command Center v2. Da mesma forma, se você criar uma configuração de exportação com a API Security Command Center v2, ela não vai aparecer na API Security Command Center v1.

Além disso, as configurações de exportação criadas com a API Security Command Center v2 não podem usar o campo source_properties para filtrar descobertas. Use outro campo.

Console

No console do Google Cloud, se uma configuração de exportação foi criada com a API Security Command Center v1, ela terá o rótulo Legacy. É possível usar o console do Google Cloud para gerenciar esses recursos.

Se você criar uma nova configuração de exportação no console do Google Cloud, ela será sempre criada com a API do Security Command Center v2.

gcloud

Para gerenciar configurações de exportação criadas com a API Security Command Center v1, não especifique um local ao executar comandos da CLI gcloud, como gcloud scc notifications describe:

  • Não use a flag --location.
  • Se você fornecer o caminho completo para o ID de configuração, use um formato que não especifique um local, como organizations/123/notificationConfigs/456. Não use um formato como organizations/123/locations/global/notificationConfigs/456.

Da mesma forma, para criar ou gerenciar configurações de exportação com a API Security Command Center v2, especifique um local ao executar o comando da CLI gcloud. Ao criar novas configurações, recomendamos usar a API Security Command Center v2.

Terraform

O arquivo de configuração do Terraform define as configurações de exportação como recursos v1 ou v2. Por exemplo, consulte os recursos para configurações de notificação:

Ao criar novas configurações, recomendamos que você crie recursos da v2.

REST

Para gerenciar as configurações de exportação criadas com a API Security Command Center v1, use a API Security Command Center v1.

Ao criar novas configurações, recomendamos usar a API Security Command Center v2.

Bibliotecas de cliente

Para gerenciar as configurações de exportação criadas com a API Security Command Center v1, use as bibliotecas de cliente do Google Cloud para a API Security Command Center v1.

Ao criar novas configurações, recomendamos usar a API Security Command Center v2.

Serviços integrados e módulos personalizados

A API v1 do Security Command Center permite que você visualize e atualize estes tipos de recursos:

Para gerenciar esses tipos de recurso, use a API Security Command Center Management e as bibliotecas de cliente. A API Security Command Center v2 não pode gerenciar esses tipos de recursos.

Se a organização ativou o Security Command Center antes de 20 de junho de 2023, é possível usar a API Security Command Center v1 para visualizar recursos em uma organização, pasta ou projeto. Esses recursos de gerenciamento de recursos do Security Command Center foram descontinuados e não estão disponíveis na API Security Command Center v2. Esses recursos serão removidos da API Security Command Center v1 a partir de 20 de junho de 2024.

Em vez disso, use o Inventário de recursos do Cloud para conferir seus recursos, incluindo as marcas de segurança. Para mais detalhes, consulte Listar recursos.

Também é possível usar a API Security Command Center v2 para atualizar as marcações de segurança dos seus recursos. Os métodos da API Security Command Center que atualizam as marcas de segurança não são descontinuados.

Atualizar bibliotecas de cliente e o provedor do Terraform

Para atualizar seu código e usar a API Security Command Center v2, faça o seguinte:

Terraform

Instale a versão atual do provedor do Terraform para Google Cloud. Para saber mais, consulte a documentação do provedor.

Além disso, atualize o arquivo de configuração do Terraform para criar recursos que começam com o prefixo google_scc_v2_ ou google_scc_management_. Os recursos a seguir não são compartilhados entre as APIs v1 e v2:

Se você aplicar um plano de execução do Terraform que substitua esses recursos pelos equivalentes do v2, o Terraform vai excluir as configurações do v1 e criar novas configurações do v2.

C++

Atualize o aplicativo para incluir o arquivo de cabeçalho v2 da biblioteca de cliente:

#include "google/cloud/securitycenter/v2/security_center_client.h"

Além disso, atualize seu aplicativo para usar classes no namespace v2:

namespace securitycenter = ::google::cloud::securitycenter_v2;

C#

Instale a biblioteca de cliente v2 e atualize seu aplicativo para usar essa biblioteca:

Install-Package Google.Cloud.SecurityCenter.V2

Go

Instale a biblioteca de cliente v2 e atualize seu aplicativo para usar essa biblioteca:

go get cloud.google.com/go/securitycenter/apiv2

Java

Instale a versão atual da biblioteca de cliente. Para mais detalhes, consulte Instalar a biblioteca de cliente.

Além disso, atualize seu aplicativo para usar as classes, interfaces e enumerações no pacote com.google.cloud.securitycenter.v2.

Node.js

Instale a versão atual da biblioteca de cliente. Para mais detalhes, consulte Instalar a biblioteca de cliente.

Além disso, atualize seu aplicativo para usar v2.SecurityCenterClient e as classes, interfaces e enumerações no namespace protos.google.cloud.securitycenter.v2.

PHP

Instale a versão atual da biblioteca de cliente. Para mais detalhes, consulte Instalar a biblioteca de cliente.

Além disso, atualize seu aplicativo para usar as classes e os tipos enumerados no namespace Google \ Cloud \ SecurityCenter \ V2.

Python

Instale a versão atual da biblioteca de cliente. Para mais detalhes, consulte Instalar a biblioteca de cliente.

Além disso, atualize seu aplicativo para usar as classes no pacote google.cloud.securitycenter_v2.

Ruby

Instale a versão atual da biblioteca de cliente. Para mais detalhes, consulte Instalar a biblioteca de cliente.

Além disso, atualize o aplicativo para definir o parâmetro version como :v2 quando ele criar um objeto de cliente.

Se você precisar gerenciar de maneira programática os serviços integrados do Security Command Center e os estados de ativação deles ou módulos personalizados para o Event Threat Detection ou a Security Health Analytics, também será necessário instalar uma biblioteca de cliente para a API Security Command Center Management e atualizar seu aplicativo para usar essa biblioteca de cliente.