Migrar para a v2 da API Security Command Center

Nesta página, explicamos 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 Management do Security Command Center v1.

A partir de 9 de dezembro de 2024, se você ativar o Security Command Center em uma organização pela primeira vez, use apenas a versão 2 da API Security Command Center nessa organização. As versões anteriores não são compatíveis.

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 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 Security Command Center Management v1. Recomendamos usar as bibliotecas de cliente do Cloud ou o provedor do Terraform Google Cloud 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, fique atento às seguintes diferenças da API v1.

Residência dos dados

A API v2 do Security Command Center oferece suporte à residência de dados, que dá mais controle sobre a localização dos dados do Security Command Center.

Se a residência de dados estiver ativada na sua organização, faça o seguinte para acessar recursos sujeitos a controles de residência de dados:

Se a residência de dados não estiver ativada para sua organização, recomendamos que você chame a versão de cada método que reconhece a localização e especifique o local global. Isso facilita a adoção da residência de dados no futuro.

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

Console

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

gcloud

Ao executar comandos da CLI 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 o aceitam, 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 as amostras de código do Security Command Center ou a referência da API da biblioteca de cliente.

Para saber como usar endpoints regionais quando a residência de dados está ativada, consulte Endpoints regionais do Security Command Center.

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

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 v1 do Security Command Center, ela não vai aparecer na API 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 Google Cloud , se uma configuração de exportação foi criada com a API Security Command Center v1, ela tem um rótulo Legado. Use o console doGoogle Cloud para gerenciar esses recursos.

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

gcloud

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

  • Não use a sinalização --location.
  • Se você fornecer o caminho completo do 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 v2 do Security Command Center, 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 que você use 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 Cloud para a API Security Command Center v1.

Ao criar novas configurações, recomendamos que você use a API Security Command Center v2.

Serviços integrados e módulos personalizados

A API v1 do Security Command Center permite visualizar e atualizar estes tipos de recursos:

Para gerenciar esses tipos de recursos, 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 sua organização ativou o Security Command Center antes de 20 de junho de 2023, você pode usar a API Security Command Center v1 para ver recursos em uma organização, pasta ou projeto. Esses recursos de gerenciamento de recursos do Security Command Center estão 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 em 20 de junho de 2024 ou após essa data.

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 v2 do Security Command Center para atualizar as marcações de segurança dos seus recursos. Os métodos da API Security Command Center que atualizam marcas de segurança não estã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 mais detalhes, consulte a documentação do provedor.

Além disso, atualize o arquivo de configuração do Terraform para criar recursos que comecem com o prefixo google_scc_v2_ ou google_scc_management_. Não se esqueça de que os seguintes recursos 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 da v2, o Terraform vai excluir as configurações da v1 e criar novas configurações da 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 enums 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 enums 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 enumerações 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 seu 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 o 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.