Method: organizations.locations.securityHealthAnalyticsCustomModules.patch

Atualiza o SecurityHealthAnalyticsCustomModule com o nome fornecido com base na máscara de atualização fornecida. A atualização do estado de ativação é compatível com módulos residentes e herdados, embora os residentes não possam ter um estado de ativação "herdado". A atualização do nome de exibição e da configuração personalizada de um módulo é compatível apenas com módulos residentes.

Solicitação HTTP

PATCH https://securitycentermanagement.googleapis.com/v1/{securityHealthAnalyticsCustomModule.name=organizations/*/locations/*/securityHealthAnalyticsCustomModules/*}

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
securityHealthAnalyticsCustomModule.name

string

Identificador. O nome completo do recurso do módulo personalizado em um dos seguintes formatos:

  • organizations/{organization}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}
  • folders/{folder}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}
  • projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}

Parâmetros de consulta

Parâmetros
updateMask

string (FieldMask format)

Obrigatório. Os campos a serem atualizados. Os seguintes valores são válidos:

  • customConfig
  • enablementState

Se você omitir esse campo ou definir o valor como *, todos os campos qualificados serão atualizados.

É uma lista separada por vírgulas de nomes de campos totalmente qualificados. Exemplo: "user.displayName,photo".
validateOnly

boolean

Opcional. Quando definido como true, a solicitação é validada (incluindo verificações do IAM), mas nenhum módulo é atualizado. Uma resposta OK indica que a solicitação é válida, enquanto uma resposta de erro indica que a solicitação é inválida.

Se a solicitação for válida, uma solicitação subsequente para atualizar o módulo ainda poderá falhar por um dos seguintes motivos:

  • O estado dos seus recursos na nuvem mudou. Por exemplo, você perdeu uma permissão necessária do IAM.
  • Ocorreu um erro durante a criação do módulo

O valor padrão é false.

Corpo da solicitação

O corpo da solicitação contém uma instância de SecurityHealthAnalyticsCustomModule.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de SecurityHealthAnalyticsCustomModule.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para saber mais, consulte a Visão geral da autenticação.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso name:

  • securitycentermanagement.securityHealthAnalyticsCustomModules.update

Para mais informações, consulte a documentação do IAM.